Class WidgetTypeResource
- java.lang.Object
-
- 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
-
-
Field Summary
Fields Modifier and Type Field Description protected String
category
protected LayoutStore
service
protected List<WidgetTypeDefinition>
widgetTypes
protected Map<String,List<WidgetTypeDefinition>>
widgetTypesByCat
-
Constructor Summary
Constructors Constructor Description WidgetTypeResource(String category)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Object
doGet(String widgetTypeName, javax.ws.rs.core.UriInfo uriInfo)
protected List<String>
getNuxeoVersions()
protected List<String>
getStudioCategories()
protected TemplateView
getTemplate(String name, 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(javax.servlet.http.HttpServletRequest request, String name)
Object
getWidgetTypeDefinitions(javax.servlet.http.HttpServletRequest request, String categories, String version, Boolean all)
Returns widget types definitions for given categoriesObject
getWidgetTypeDefinitionsForCategory(javax.servlet.http.HttpServletRequest request, String category, String version, Boolean all)
Returns widget types definitions for given category.String
getWidgetTypeDescription(WidgetTypeDefinition wTypeDef)
String
getWidgetTypeLabel(WidgetTypeDefinition wTypeDef)
protected Map<String,List<WidgetTypeDefinition>>
getWidgetTypesByCategory()
Object
getWikiDocumentation(javax.ws.rs.core.UriInfo uriInfo)
protected boolean
isStriclyBeforeVersion(String ref, String version)
-
-
-
Field Detail
-
service
protected LayoutStore service
-
widgetTypes
protected final List<WidgetTypeDefinition> widgetTypes
-
widgetTypesByCat
protected final Map<String,List<WidgetTypeDefinition>> widgetTypesByCat
-
-
Constructor Detail
-
WidgetTypeResource
public WidgetTypeResource(String category)
-
-
Method Detail
-
getWidgetTypesByCategory
protected Map<String,List<WidgetTypeDefinition>> getWidgetTypesByCategory()
-
getWidgetTypeDefinitions
public Object getWidgetTypeDefinitions(@Context javax.servlet.http.HttpServletRequest request, String categories, String version, Boolean all)
Returns widget types definitions for given categoriesIf 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.
-
isStriclyBeforeVersion
protected boolean isStriclyBeforeVersion(String ref, String version)
-
getWidgetTypeDefinitionsForCategory
public Object getWidgetTypeDefinitionsForCategory(@Context javax.servlet.http.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 javax.servlet.http.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)
-
getNuxeoVersions
protected List<String> getNuxeoVersions()
-
getStudioCategories
protected List<String> getStudioCategories()
-
getTemplate
protected TemplateView getTemplate(String name, 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)
-
-