|
Nuxeo Enterprise Platform 5.4 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.nuxeo.ecm.platform.forms.layout.api.impl.WidgetDefinitionImpl
public class WidgetDefinitionImpl
Default implementation for a widget definition.
Useful to compute widgets independently from the layout service.
Field Summary |
---|
Fields inherited from interface org.nuxeo.ecm.platform.forms.layout.api.WidgetDefinition |
---|
RENDERED_PROPERTY_NAME, REQUIRED_PROPERTY_NAME |
Constructor Summary | |
---|---|
WidgetDefinitionImpl(java.lang.String name,
java.lang.String type,
java.util.Map<java.lang.String,java.lang.String> labels,
java.util.Map<java.lang.String,java.lang.String> helpLabels,
boolean translated,
java.util.Map<java.lang.String,java.lang.String> modes,
FieldDefinition[] fieldDefinitions,
java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.io.Serializable>> properties,
java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.io.Serializable>> widgetModeProperties,
WidgetDefinition[] subWidgets)
|
|
WidgetDefinitionImpl(java.lang.String name,
java.lang.String type,
java.util.Map<java.lang.String,java.lang.String> labels,
java.util.Map<java.lang.String,java.lang.String> helpLabels,
boolean translated,
java.util.Map<java.lang.String,java.lang.String> modes,
java.util.List<FieldDefinition> fieldDefinitions,
java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.io.Serializable>> properties,
java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.io.Serializable>> widgetModeProperties,
java.util.List<WidgetDefinition> subWidgets)
|
|
WidgetDefinitionImpl(java.lang.String name,
java.lang.String type,
java.lang.String label,
java.lang.String helpLabel,
boolean translated,
java.util.Map<java.lang.String,java.lang.String> modes,
java.util.List<FieldDefinition> fieldDefinitions,
java.util.Map<java.lang.String,java.io.Serializable> properties,
java.util.List<WidgetDefinition> subWidgets)
|
Method Summary | |
---|---|
FieldDefinition[] |
getFieldDefinitions()
Returns the list of fields managed by this widget. |
java.lang.String |
getHelpLabel(java.lang.String mode)
Returns the help label to use in a given mode. |
java.util.Map<java.lang.String,java.lang.String> |
getHelpLabels()
Returns help labels by mode. |
java.lang.String |
getLabel(java.lang.String mode)
Returns the label to use in a given mode. |
java.util.Map<java.lang.String,java.lang.String> |
getLabels()
Returns labels by mode. |
java.lang.String |
getMode(java.lang.String layoutMode)
Returns the optional mode used to override the layout mode. |
java.util.Map<java.lang.String,java.lang.String> |
getModes()
|
java.lang.String |
getName()
Returns the widget name used to identify it within a layout. |
java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.io.Serializable>> |
getProperties()
Returns properties by mode. |
static java.util.Map<java.lang.String,java.io.Serializable> |
getProperties(java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.io.Serializable>> properties,
java.lang.String mode)
|
java.util.Map<java.lang.String,java.io.Serializable> |
getProperties(java.lang.String layoutMode,
java.lang.String mode)
Returns a map of properties to use in a given mode. |
java.lang.String |
getRequired(java.lang.String layoutMode,
java.lang.String mode)
Returns an EL expression evaluating to true if the widget is required in given mode. |
WidgetDefinition[] |
getSubWidgetDefinitions()
Returns sub widget definitions. |
java.lang.String |
getType()
Returns the widget type used to render it. |
java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.io.Serializable>> |
getWidgetModeProperties()
Returns properties by widget mode. |
boolean |
isTranslated()
Returns true if all labels are messages that need to be translated. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public WidgetDefinitionImpl(java.lang.String name, java.lang.String type, java.lang.String label, java.lang.String helpLabel, boolean translated, java.util.Map<java.lang.String,java.lang.String> modes, java.util.List<FieldDefinition> fieldDefinitions, java.util.Map<java.lang.String,java.io.Serializable> properties, java.util.List<WidgetDefinition> subWidgets)
public WidgetDefinitionImpl(java.lang.String name, java.lang.String type, java.util.Map<java.lang.String,java.lang.String> labels, java.util.Map<java.lang.String,java.lang.String> helpLabels, boolean translated, java.util.Map<java.lang.String,java.lang.String> modes, java.util.List<FieldDefinition> fieldDefinitions, java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.io.Serializable>> properties, java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.io.Serializable>> widgetModeProperties, java.util.List<WidgetDefinition> subWidgets)
public WidgetDefinitionImpl(java.lang.String name, java.lang.String type, java.util.Map<java.lang.String,java.lang.String> labels, java.util.Map<java.lang.String,java.lang.String> helpLabels, boolean translated, java.util.Map<java.lang.String,java.lang.String> modes, FieldDefinition[] fieldDefinitions, java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.io.Serializable>> properties, java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.io.Serializable>> widgetModeProperties, WidgetDefinition[] subWidgets)
Method Detail |
---|
public FieldDefinition[] getFieldDefinitions()
WidgetDefinition
getFieldDefinitions
in interface WidgetDefinition
public java.lang.String getHelpLabel(java.lang.String mode)
WidgetDefinition
getHelpLabel
in interface WidgetDefinition
public java.util.Map<java.lang.String,java.lang.String> getHelpLabels()
WidgetDefinition
getHelpLabels
in interface WidgetDefinition
public java.lang.String getLabel(java.lang.String mode)
WidgetDefinition
getLabel
in interface WidgetDefinition
public java.util.Map<java.lang.String,java.lang.String> getLabels()
WidgetDefinition
getLabels
in interface WidgetDefinition
public java.lang.String getMode(java.lang.String layoutMode)
WidgetDefinition
Can be a string or an EL ValueExpression.
getMode
in interface WidgetDefinition
layoutMode
- the layout (or parent widget) mode
public java.util.Map<java.lang.String,java.lang.String> getModes()
getModes
in interface WidgetDefinition
public java.lang.String getName()
WidgetDefinition
getName
in interface WidgetDefinition
public java.util.Map<java.lang.String,java.io.Serializable> getProperties(java.lang.String layoutMode, java.lang.String mode)
WidgetDefinition
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.
getProperties
in interface WidgetDefinition
public java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.io.Serializable>> getProperties()
WidgetDefinition
getProperties
in interface WidgetDefinition
public java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.io.Serializable>> getWidgetModeProperties()
WidgetDefinition
getWidgetModeProperties
in interface WidgetDefinition
public java.lang.String getRequired(java.lang.String layoutMode, java.lang.String mode)
WidgetDefinition
This value is computed from the property "required" in given mode. and can be a string or an EL ValueExpression. Defaults to "false".
getRequired
in interface WidgetDefinition
public WidgetDefinition[] getSubWidgetDefinitions()
WidgetDefinition
getSubWidgetDefinitions
in interface WidgetDefinition
public java.lang.String getType()
WidgetDefinition
getType
in interface WidgetDefinition
public boolean isTranslated()
WidgetDefinition
Default is true.
isTranslated
in interface WidgetDefinition
public static final java.util.Map<java.lang.String,java.io.Serializable> getProperties(java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.io.Serializable>> properties, java.lang.String mode)
|
Nuxeo Enterprise Platform 5.4 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |