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

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

public class WebLayoutResource
extends java.lang.Object

Exports and presents documentation about widget type definitions

Since:

5.4

Author:

Anahide Tchertchian

Constructor Summary

WebLayoutResource()

Method Summary

java.lang.Object	doGet(java.lang.String widgetTypeName)
TemplateView	getTemplate()
java.util.List<java.lang.String>	getWidgetTypeCategories(WidgetTypeDefinition wTypeDef)
java.lang.String	getWidgetTypeCategoriesAsString(WidgetTypeDefinition wTypeDef)
java.lang.Object	getWidgetTypeDefinition(javax.servlet.http.HttpServletRequest request, java.lang.String name)
java.lang.Object	getWidgetTypeDefinitions(javax.servlet.http.HttpServletRequest request, java.lang.Boolean all)
java.lang.Object	getWidgetTypeDefinitions(javax.servlet.http.HttpServletRequest request, java.lang.String category, java.lang.Boolean all) Returns widget types definitions for given category.
java.lang.String	getWidgetTypeDescription(WidgetTypeDefinition wTypeDef)
java.lang.String	getWidgetTypeLabel(WidgetTypeDefinition wTypeDef)
java.lang.Object	getWikiDocumentation()

Methods inherited from class java.lang.Object

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

Constructor Detail

WebLayoutResource

public WebLayoutResource()
                  throws java.lang.Exception

Throws:

java.lang.Exception

Method Detail

getWidgetTypeDefinitions

public java.lang.Object getWidgetTypeDefinitions(@Context
                                                 javax.servlet.http.HttpServletRequest request,
                                                 java.lang.Boolean all)

getWidgetTypeDefinitions

public java.lang.Object getWidgetTypeDefinitions(@Context
                                                 javax.servlet.http.HttpServletRequest request,
                                                 java.lang.String category,
                                                 java.lang.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.

getWidgetTypeDefinition

public java.lang.Object getWidgetTypeDefinition(@Context
                                                javax.servlet.http.HttpServletRequest request,
                                                java.lang.String name)

getTemplate

public TemplateView getTemplate()

getWikiDocumentation

public java.lang.Object getWikiDocumentation()

doGet

public java.lang.Object doGet(java.lang.String widgetTypeName)

getWidgetTypeLabel

public java.lang.String getWidgetTypeLabel(WidgetTypeDefinition wTypeDef)

getWidgetTypeDescription

public java.lang.String getWidgetTypeDescription(WidgetTypeDefinition wTypeDef)

getWidgetTypeCategories

public java.util.List<java.lang.String> getWidgetTypeCategories(WidgetTypeDefinition wTypeDef)

getWidgetTypeCategoriesAsString

public java.lang.String getWidgetTypeCategoriesAsString(WidgetTypeDefinition wTypeDef)