Nuxeo ECM Projects 5.4.3-SNAPSHOT

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

java.lang.Object
  extended by org.nuxeo.ecm.platform.forms.layout.export.WidgetTypeResource

public class WidgetTypeResource
extends Object

Exports and presents documentation about widget type definitions

Since:
5.4
Author:
Anahide Tchertchian

Constructor Summary
WidgetTypeResource()
           
 
Method Summary
 Object doGet(String widgetTypeName, UriInfo uriInfo)
           
 TemplateView getTemplate(UriInfo uriInfo)
           
 List<String> getWidgetTypeCategories(WidgetTypeDefinition wTypeDef)
           
 String getWidgetTypeCategoriesAsString(WidgetTypeDefinition wTypeDef)
           
 Object getWidgetTypeDefinition(HttpServletRequest request, String name)
           
 Object getWidgetTypeDefinitions(HttpServletRequest request, String categories, String version, Boolean all)
          Returns widget types definitions for given categories
 Object getWidgetTypeDefinitionsForCategory(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(UriInfo uriInfo)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WidgetTypeResource

public WidgetTypeResource()
                   throws Exception
Throws:
Exception
Method Detail

getWidgetTypeDefinitions

public Object getWidgetTypeDefinitions(@Context
                                       HttpServletRequest request,
                                       String categories,
                                       String version,
                                       Boolean all)
Returns widget types definitions for given categories

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. Mutliple categories are extracted from the query parameter by splitting on the space character.

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


getWidgetTypeDefinitionsForCategory

public Object getWidgetTypeDefinitionsForCategory(@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 exclude all widget types that did not exist before this version.


getWidgetTypeDefinition

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

getTemplate

public TemplateView getTemplate(@Context
                                UriInfo uriInfo)

getWikiDocumentation

public Object getWikiDocumentation(@Context
                                   UriInfo uriInfo)

doGet

public Object doGet(String widgetTypeName,
                    @Context
                    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)

Nuxeo ECM Projects 5.4.3-SNAPSHOT

Copyright © 2011 Nuxeo SAS. All Rights Reserved.