|
Nuxeo ECM Projects 5.4.3-SNAPSHOT | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface WidgetDefinition
Widget definition interface.
A widget knows how to render itself in a given mode.
Field Summary | |
---|---|
static String |
RENDERED_PROPERTY_NAME
|
static String |
REQUIRED_PROPERTY_NAME
|
Method Summary | |
---|---|
FieldDefinition[] |
getFieldDefinitions()
Returns the list of fields managed by this widget. |
String |
getHelpLabel(String mode)
Returns the help label to use in a given mode. |
Map<String,String> |
getHelpLabels()
Returns help labels by mode. |
String |
getLabel(String mode)
Returns the label to use in a given mode. |
Map<String,String> |
getLabels()
Returns labels by mode. |
String |
getMode(String layoutMode)
Returns the optional mode used to override the layout mode. |
Map<String,String> |
getModes()
|
String |
getName()
Returns the widget name used to identify it within a layout. |
Map<String,Map<String,Serializable>> |
getProperties()
Returns properties by mode. |
Map<String,Serializable> |
getProperties(String layoutMode,
String mode)
Returns a map of properties to use in a given mode. |
String |
getRequired(String layoutMode,
String mode)
Returns an EL expression evaluating to true if the widget is required in given mode. |
WidgetSelectOption[] |
getSelectOptions()
Returns the select options for this widget. |
WidgetDefinition[] |
getSubWidgetDefinitions()
Returns sub widget definitions. |
String |
getType()
Returns the widget type used to render it. |
Map<String,Map<String,Serializable>> |
getWidgetModeProperties()
Returns properties by widget mode. |
boolean |
isTranslated()
Returns true if all labels are messages that need to be translated. |
Field Detail |
---|
static final String RENDERED_PROPERTY_NAME
static final String REQUIRED_PROPERTY_NAME
Method Detail |
---|
String getName()
String getType()
FieldDefinition[] getFieldDefinitions()
String getMode(String layoutMode)
Can be a string or an EL ValueExpression.
layoutMode
- the layout (or parent widget) mode
Map<String,String> getModes()
String getRequired(String layoutMode, String mode)
This value is computed from the property "required" in given mode. and can be a string or an EL ValueExpression. Defaults to "false".
String getLabel(String mode)
Map<String,String> getLabels()
String getHelpLabel(String mode)
Map<String,String> getHelpLabels()
boolean isTranslated()
Default is true.
Map<String,Serializable> getProperties(String layoutMode, String mode)
A property value can be a string or an EL ValueExpression.
The way that properties will be mapped to rendered components is managed by the widget type.
Map<String,Map<String,Serializable>> getProperties()
Map<String,Map<String,Serializable>> getWidgetModeProperties()
WidgetDefinition[] getSubWidgetDefinitions()
WidgetSelectOption[] getSelectOptions()
|
Nuxeo ECM Projects 5.4.3-SNAPSHOT | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |