Package org.nuxeo.ecm.platform.forms.layout.descriptors

Class WidgetDescriptor

java.lang.Object

org.nuxeo.ecm.platform.forms.layout.descriptors.WidgetDescriptor

public class WidgetDescriptor
extends Object

Widget definition descriptor.

Author:

Anahide Tchertchian

Constructor Summary

Constructors

Constructor	Description
WidgetDescriptor()

Method Summary

Modifier and Type	Method	Description
List<String>	getAliases()
String[]	getCategories()	Returns the categories for this widget type, so that it can be stored in the corresponding registry.
Map<String,Map<String,Serializable>>	getControls()
FieldDefinition[]	getFieldDefinitions()
String	getHelpLabel(String mode)
Map<String,String>	getHelpLabels()
String	getLabel(String mode)
Map<String,String>	getLabels()
String	getMode(String layoutMode)
Map<String,String>	getModes()
String	getName()
Map<String,Map<String,Serializable>>	getProperties()
Map<String,Serializable>	getProperties(String layoutMode, String mode)
static Map<String,Map<String,Serializable>>	getProperties(Map<String,PropertiesDescriptor> map)
static Map<String,Serializable>	getProperties(Map<String,PropertiesDescriptor> map, String mode)
String	getRequired(String layoutMode, String mode)
WidgetSelectOption[]	getSelectOptions()
WidgetDefinition[]	getSubWidgetDefinitions()
WidgetReference[]	getSubWidgetReferences()
String	getType()
WidgetDefinition	getWidgetDefinition()
Map<String,Map<String,Serializable>>	getWidgetModeProperties()
boolean	isTranslated()
void	setSelectOptions(DocumentFragment selectOptionsDOM)

Methods inherited from class java.lang.Object

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

Constructor Detail

WidgetDescriptor

public WidgetDescriptor()

Method Detail

getName

public String getName()

getType

public String getType()

getFieldDefinitions

public FieldDefinition[] getFieldDefinitions()

getMode

public String getMode(String layoutMode)

getModes

public Map<String,String> getModes()

getRequired

public String getRequired(String layoutMode,
                          String mode)

getLabel

public String getLabel(String mode)

getLabels

public Map<String,String> getLabels()

getHelpLabel

public String getHelpLabel(String mode)

getHelpLabels

public Map<String,String> getHelpLabels()

isTranslated

public boolean isTranslated()

getProperties

public Map<String,Serializable> getProperties(String layoutMode,
                                                    String mode)

getProperties

public Map<String,Map<String,Serializable>> getProperties()

getWidgetModeProperties

public Map<String,Map<String,Serializable>> getWidgetModeProperties()

getControls

public Map<String,Map<String,Serializable>> getControls()

Since:

5.7

See Also:

WidgetDefinition.getControls()

getSubWidgetDefinitions

public WidgetDefinition[] getSubWidgetDefinitions()

getSubWidgetReferences

public WidgetReference[] getSubWidgetReferences()

getProperties

public static Map<String,Serializable> getProperties(Map<String,PropertiesDescriptor> map,
                                                           String mode)

getProperties

public static Map<String,Map<String,Serializable>> getProperties(Map<String,PropertiesDescriptor> map)

getSelectOptions

public WidgetSelectOption[] getSelectOptions()

setSelectOptions

public void setSelectOptions(DocumentFragment selectOptionsDOM)

getCategories

public String[] getCategories()

Returns the categories for this widget type, so that it can be stored in the corresponding registry.

Since:

5.5

getAliases

public List<String> getAliases()

Since:

6.0

getWidgetDefinition

public WidgetDefinition getWidgetDefinition()