org.nuxeo.ecm.platform.forms.layout.export
Class WebLayoutResource

java.lang.Object
  org.nuxeo.ecm.platform.forms.layout.export.WebLayoutResource

public class WebLayoutResource
extends Object

Exports and presents documentation about widget type definitions

Since:

5.4

Author:

Anahide Tchertchian

Constructor Summary

WebLayoutResource()

Method Summary

Object	doGet(String widgetTypeName, javax.ws.rs.core.UriInfo uriInfo)
TemplateView	getTemplate(javax.ws.rs.core.UriInfo uriInfo)
List<String>	getWidgetTypeCategories(WidgetTypeDefinition wTypeDef)
String	getWidgetTypeCategoriesAsString(WidgetTypeDefinition wTypeDef)
Object	getWidgetTypeDefinition(HttpServletRequest request, String name)
Object	getWidgetTypeDefinitions(HttpServletRequest request, Boolean all)
Object	getWidgetTypeDefinitions(HttpServletRequest request, String category, String version, Boolean all) Returns widget types definitions for given category.
String	getWidgetTypeDescription(WidgetTypeDefinition wTypeDef)
String	getWidgetTypeLabel(WidgetTypeDefinition wTypeDef)
Object	getWikiDocumentation(javax.ws.rs.core.UriInfo uriInfo)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WebLayoutResource

public WebLayoutResource()
                  throws Exception

Throws:

Exception

Method Detail

getWidgetTypeDefinitions

public Object getWidgetTypeDefinitions(@Context
                                       HttpServletRequest request,
                                       Boolean all)

getWidgetTypeDefinitions

public Object getWidgetTypeDefinitions(@Context
                                       HttpServletRequest request,
                                       String category,
                                       String version,
                                       Boolean all)

Returns widget types definitions for given category.

If the category is null, the filter does not check the category. Widget types without a configuration are included if boolean 'all' is set to true.

If not null, the version parameter will exlude all widget types that did not exist before this version.

getWidgetTypeDefinition

public Object getWidgetTypeDefinition(@Context
                                      HttpServletRequest request,
                                      String name)

getTemplate

public TemplateView getTemplate(@Context
                                javax.ws.rs.core.UriInfo uriInfo)

getWikiDocumentation

public Object getWikiDocumentation(@Context
                                   javax.ws.rs.core.UriInfo uriInfo)

doGet

public Object doGet(String widgetTypeName,
                    @Context
                    javax.ws.rs.core.UriInfo uriInfo)

getWidgetTypeLabel

public String getWidgetTypeLabel(WidgetTypeDefinition wTypeDef)

getWidgetTypeDescription

public String getWidgetTypeDescription(WidgetTypeDefinition wTypeDef)

getWidgetTypeCategories

public List<String> getWidgetTypeCategories(WidgetTypeDefinition wTypeDef)

getWidgetTypeCategoriesAsString

public String getWidgetTypeCategoriesAsString(WidgetTypeDefinition wTypeDef)