Nuxeo ECM Projects 5.4.3-SNAPSHOT

org.nuxeo.ecm.platform.forms.layout.api.impl
Class WidgetImpl

java.lang.Object
  extended by org.nuxeo.ecm.platform.forms.layout.api.impl.WidgetImpl
All Implemented Interfaces:
Serializable, Widget

public class WidgetImpl
extends Object
implements Widget

Implementation for widgets.

Author:
Anahide Tchertchian
See Also:
Serialized Form

Constructor Summary
WidgetImpl(String layoutName, String name, String mode, String type, String valueName, FieldDefinition[] fields, String label, String helpLabel, boolean translated, Map<String,Serializable> properties, boolean required, Widget[] subWidgets, int level)
          Deprecated. since 5.4.3: use WidgetImpl(String, String, String, String, String, FieldDefinition[], String, String, boolean, Map, boolean, Widget[], int, WidgetSelectOption[], String)
WidgetImpl(String layoutName, String name, String mode, String type, String valueName, FieldDefinition[] fields, String label, String helpLabel, boolean translated, Map<String,Serializable> properties, boolean required, Widget[] subWidgets, int level, WidgetSelectOption[] selectOptions)
          Deprecated. since 5.4.3: use WidgetImpl(String, String, String, String, String, FieldDefinition[], String, String, boolean, Map, boolean, Widget[], int, WidgetSelectOption[], String)
WidgetImpl(String layoutName, String name, String mode, String type, String valueName, FieldDefinition[] fields, String label, String helpLabel, boolean translated, Map<String,Serializable> properties, boolean required, Widget[] subWidgets, int level, WidgetSelectOption[] selectOptions, String definitionId)
           
 
Method Summary
 FieldDefinition[] getFieldDefinitions()
          Returns the list of fields managed by this widget.
 String getHelpLabel()
          Return the help label to use in this mode.
 String getId()
          Returns the widget id, unique within the facelet context.
 String getLabel()
          Returns the label to use in this mode.
 String getLayoutName()
          Returns the layout name.
 int getLevel()
          Returns the widget level in the widget hierarchy.
 String getMode()
          Returns the widget mode.
 String getName()
          Returns the widget name used to identify it within a layout.
 Map<String,Serializable> getProperties()
          Get properties to use in this mode.
 Serializable getProperty(String name)
          Returns property with given name in this mode.
 WidgetSelectOption[] getSelectOptions()
          Returns the select options for this widget.
 Widget[] getSubWidgets()
          Returns sub widgets.
 String getTagConfigId()
          Returns the unique identifier of this widget to be used in tag configuration.
 String getType()
          Returns the widget type used to render it.
 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(String id)
          Sets the widget id, unique within the facelet context.
 void setProperty(String name, Serializable value)
          Sets property with given name on the layout.
 void setValueName(String valueName)
          Sets the value name used to compute tag attributes.
 String toString()
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

WidgetImpl

@Deprecated
public WidgetImpl(String layoutName,
                             String name,
                             String mode,
                             String type,
                             String valueName,
                             FieldDefinition[] fields,
                             String label,
                             String helpLabel,
                             boolean translated,
                             Map<String,Serializable> properties,
                             boolean required,
                             Widget[] subWidgets,
                             int level)
Deprecated. since 5.4.3: use WidgetImpl(String, String, String, String, String, FieldDefinition[], String, String, boolean, Map, boolean, Widget[], int, WidgetSelectOption[], String)


WidgetImpl

@Deprecated
public WidgetImpl(String layoutName,
                             String name,
                             String mode,
                             String type,
                             String valueName,
                             FieldDefinition[] fields,
                             String label,
                             String helpLabel,
                             boolean translated,
                             Map<String,Serializable> properties,
                             boolean required,
                             Widget[] subWidgets,
                             int level,
                             WidgetSelectOption[] selectOptions)
Deprecated. since 5.4.3: use WidgetImpl(String, String, String, String, String, FieldDefinition[], String, String, boolean, Map, boolean, Widget[], int, WidgetSelectOption[], String)

Since:
5.4.2

WidgetImpl

public WidgetImpl(String layoutName,
                  String name,
                  String mode,
                  String type,
                  String valueName,
                  FieldDefinition[] fields,
                  String label,
                  String helpLabel,
                  boolean translated,
                  Map<String,Serializable> properties,
                  boolean required,
                  Widget[] subWidgets,
                  int level,
                  WidgetSelectOption[] selectOptions,
                  String definitionId)
Method Detail

getId

public String getId()
Description copied from interface: Widget
Returns the widget id, unique within the facelet context.

Specified by:
getId in interface Widget

getTagConfigId

public String getTagConfigId()
Description copied from interface: Widget
Returns the unique identifier of this widget to be used in tag configuration.

Specified by:
getTagConfigId in interface Widget
See Also:
Layout#getTagConfigId()}.

setId

public void setId(String id)
Description copied from interface: Widget
Sets the widget id, unique within the facelet context.

Specified by:
setId in interface Widget

getLayoutName

public String getLayoutName()
Description copied from interface: Widget
Returns the layout name.

Specified by:
getLayoutName in interface Widget

getName

public String getName()
Description copied from interface: Widget
Returns the widget name used to identify it within a layout.

Specified by:
getName in interface Widget

getMode

public String getMode()
Description copied from interface: Widget
Returns the widget mode.

This mode can be different from the layout mode.

Specified by:
getMode in interface Widget

getType

public String getType()
Description copied from interface: Widget
Returns the widget type used to render it.

Specified by:
getType in interface Widget

getLabel

public String getLabel()
Description copied from interface: Widget
Returns the label to use in this mode.

Specified by:
getLabel in interface Widget

getHelpLabel

public String getHelpLabel()
Description copied from interface: Widget
Return the help label to use in this mode.

Specified by:
getHelpLabel in interface Widget

isTranslated

public boolean isTranslated()
Description copied from interface: Widget
Returns true if all labels are messages that need to be translated.

Specified by:
isTranslated in interface Widget

getProperties

public Map<String,Serializable> getProperties()
Description copied from interface: Widget
Get properties to use in this mode.

The way that properties will be mapped to rendered components is managed by the widget type.

Specified by:
getProperties in interface Widget

getProperty

public Serializable getProperty(String name)
Description copied from interface: Widget
Returns property with given name in this mode.

Specified by:
getProperty in interface Widget
Parameters:
name - the property name.
Returns:
the property value or null if not found.

setProperty

public void setProperty(String name,
                        Serializable value)
Description copied from interface: Widget
Sets property with given name on the layout. If there is already a property with this name on the widget, it will be overridden.

Specified by:
setProperty in interface Widget
Parameters:
name - the property name.
value - the property value or null if not found.

isRequired

public boolean isRequired()
Description copied from interface: Widget
Returns true if the widget is required.

This is a short link for the "required" property, already evaluated from an EL expression (if needed). Defaults to false.

Specified by:
isRequired in interface Widget

getFieldDefinitions

public FieldDefinition[] getFieldDefinitions()
Description copied from interface: Widget
Returns the list of fields managed by this widget.

Specified by:
getFieldDefinitions in interface Widget

getSubWidgets

public Widget[] getSubWidgets()
Description copied from interface: Widget
Returns sub widgets.

Specified by:
getSubWidgets in interface Widget

getValueName

public String getValueName()
Description copied from interface: Widget
Gets the value name used to compute tag attributes.

Specified by:
getValueName in interface Widget

setValueName

public void setValueName(String valueName)
Description copied from interface: Widget
Sets the value name used to compute tag attributes.

Specified by:
setValueName in interface Widget

getLevel

public int getLevel()
Description copied from interface: Widget
Returns the widget level in the widget hierarchy.

For instance a standard widget will have a level of 0, and its potential subwidgets will have a level of 1.

Specified by:
getLevel in interface Widget

getSelectOptions

public WidgetSelectOption[] getSelectOptions()
Description copied from interface: Widget
Returns the select options for this widget.

Specified by:
getSelectOptions in interface Widget

toString

public String toString()
Overrides:
toString in class Object

Nuxeo ECM Projects 5.4.3-SNAPSHOT

Copyright © 2011 Nuxeo SAS. All Rights Reserved.