|
Nuxeo Enterprise Platform 5.4 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Widget
Widget interface.
A widget is built from a WidgetDefinition
in a given mode.
Method Summary | |
---|---|
FieldDefinition[] |
getFieldDefinitions()
Returns the list of fields managed by this widget. |
java.lang.String |
getHelpLabel()
Return the help label to use in this mode. |
java.lang.String |
getId()
Returns the widget id, unique within the facelet context. |
java.lang.String |
getLabel()
Returns the label to use in this mode. |
java.lang.String |
getLayoutName()
Returns the layout name. |
int |
getLevel()
Returns the widget level in the widget hierarchy. |
java.lang.String |
getMode()
Returns the widget mode. |
java.lang.String |
getName()
Returns the widget name used to identify it within a layout. |
java.util.Map<java.lang.String,java.io.Serializable> |
getProperties()
Get properties to use in this mode. |
java.io.Serializable |
getProperty(java.lang.String name)
Returns property with given name in this mode. |
Widget[] |
getSubWidgets()
Returns sub widgets. |
java.lang.String |
getType()
Returns the widget type used to render it. |
java.lang.String |
getValueName()
Gets the value name used to compute tag attributes. |
boolean |
isRequired()
Returns true if the widget is required. |
boolean |
isTranslated()
Returns true if all labels are messages that need to be translated. |
void |
setId(java.lang.String id)
Sets the widget id, unique within the facelet context. |
void |
setProperty(java.lang.String name,
java.io.Serializable value)
Sets property with given name on the layout. |
void |
setValueName(java.lang.String valueName)
Sets the value name used to compute tag attributes. |
Method Detail |
---|
java.lang.String getId()
void setId(java.lang.String id)
java.lang.String getName()
java.lang.String getLayoutName()
java.lang.String getType()
java.lang.String getValueName()
void setValueName(java.lang.String valueName)
FieldDefinition[] getFieldDefinitions()
java.lang.String getMode()
This mode can be different from the layout mode.
java.lang.String getLabel()
java.lang.String getHelpLabel()
boolean isTranslated()
java.util.Map<java.lang.String,java.io.Serializable> getProperties()
The way that properties will be mapped to rendered components is managed by the widget type.
java.io.Serializable getProperty(java.lang.String name)
name
- the property name.
void setProperty(java.lang.String name, java.io.Serializable value)
name
- the property name.value
- the property value or null if not found.boolean isRequired()
This is a short link for the "required" property, already evaluated from an EL expression (if needed). Defaults to false.
Widget[] getSubWidgets()
int getLevel()
For instance a standard widget will have a level of 0, and its potential subwidgets will have a level of 1.
|
Nuxeo Enterprise Platform 5.4 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |