|
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.WidgetImpl
public class WidgetImpl
Implementation for widgets.
Constructor Summary | |
---|---|
WidgetImpl(java.lang.String layoutName,
java.lang.String name,
java.lang.String mode,
java.lang.String type,
java.lang.String valueName,
FieldDefinition[] fields,
java.lang.String label,
java.lang.String helpLabel,
boolean translated,
java.util.Map<java.lang.String,java.io.Serializable> properties,
boolean required,
Widget[] subWidgets,
int level)
|
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. |
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public WidgetImpl(java.lang.String layoutName, java.lang.String name, java.lang.String mode, java.lang.String type, java.lang.String valueName, FieldDefinition[] fields, java.lang.String label, java.lang.String helpLabel, boolean translated, java.util.Map<java.lang.String,java.io.Serializable> properties, boolean required, Widget[] subWidgets, int level)
Method Detail |
---|
public java.lang.String getId()
Widget
getId
in interface Widget
public void setId(java.lang.String id)
Widget
setId
in interface Widget
public java.lang.String getLayoutName()
Widget
getLayoutName
in interface Widget
public java.lang.String getName()
Widget
getName
in interface Widget
public java.lang.String getMode()
Widget
This mode can be different from the layout mode.
getMode
in interface Widget
public java.lang.String getType()
Widget
getType
in interface Widget
public java.lang.String getLabel()
Widget
getLabel
in interface Widget
public java.lang.String getHelpLabel()
Widget
getHelpLabel
in interface Widget
public boolean isTranslated()
Widget
isTranslated
in interface Widget
public java.util.Map<java.lang.String,java.io.Serializable> getProperties()
Widget
The way that properties will be mapped to rendered components is managed by the widget type.
getProperties
in interface Widget
public java.io.Serializable getProperty(java.lang.String name)
Widget
getProperty
in interface Widget
name
- the property name.
public void setProperty(java.lang.String name, java.io.Serializable value)
Widget
setProperty
in interface Widget
name
- the property name.value
- the property value or null if not found.public boolean isRequired()
Widget
This is a short link for the "required" property, already evaluated from an EL expression (if needed). Defaults to false.
isRequired
in interface Widget
public FieldDefinition[] getFieldDefinitions()
Widget
getFieldDefinitions
in interface Widget
public Widget[] getSubWidgets()
Widget
getSubWidgets
in interface Widget
public java.lang.String getValueName()
Widget
getValueName
in interface Widget
public void setValueName(java.lang.String valueName)
Widget
setValueName
in interface Widget
public int getLevel()
Widget
For instance a standard widget will have a level of 0, and its potential subwidgets will have a level of 1.
getLevel
in interface Widget
public java.lang.String toString()
toString
in class java.lang.Object
|
Nuxeo Enterprise Platform 5.4 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |