org.nuxeo.ecm.platform.forms.layout.descriptors
Class WidgetSelectOptionsDescriptor

java.lang.Object
  org.nuxeo.ecm.platform.forms.layout.descriptors.WidgetSelectOptionsDescriptor

All Implemented Interfaces:

Serializable, WidgetSelectOption, WidgetSelectOptions

public class WidgetSelectOptionsDescriptor
extends Object
implements WidgetSelectOptions

Since:

5.4.2

Author:

Anahide Tchertchian

See Also:

Serialized Form

Constructor Summary

WidgetSelectOptionsDescriptor()

Method Summary

Boolean	getCaseSensitive() Returns true if ordering should be case sensitive?
Serializable	getItemDisabled() Returns the disabled behaviour for the select option.
String	getItemLabel() Returns the item label for the select option.
Serializable	getItemRendered() Returns the rendered behaviour for the select option.
String	getItemValue() Returns the item value for the select option.
String	getOrdering() Returns a string used for ordering of options.
String	getTagConfigId() Returns the unique identifier of this select option to be used in tag configuration.
Serializable	getValue() Returns the value representing the option.
String	getVar() Returns the var representing the value returned by WidgetSelectOption.getValue()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WidgetSelectOptionsDescriptor

public WidgetSelectOptionsDescriptor()

Method Detail

getValue

public Serializable getValue()

Description copied from interface: WidgetSelectOption

Returns the value representing the option.

This value is optional when using static label and values, it can be useful to use it in conjunction with the WidgetSelectOption.getVar() method to retrieve the id and label from the object.

Specified by:

getValue in interface WidgetSelectOption

getVar

public String getVar()

Description copied from interface: WidgetSelectOption

Returns the var representing the value returned by WidgetSelectOption.getValue()

This value can be used in the potential EL expressions returned by WidgetSelectOption.getItemLabel(), WidgetSelectOption.getItemValue(), WidgetSelectOption.getItemDisabled() and WidgetSelectOption.getItemRendered().

Specified by:

getVar in interface WidgetSelectOption

getItemLabel

public String getItemLabel()

Description copied from interface: WidgetSelectOption

Returns the item label for the select option.

This can be an EL expression if WidgetSelectOption.getValue() and WidgetSelectOption.getVar() return a non-null value.

Specified by:

getItemLabel in interface WidgetSelectOption

getItemValue

public String getItemValue()

Description copied from interface: WidgetSelectOption

Returns the item value for the select option.

This can be an EL expression if WidgetSelectOption.getValue() and WidgetSelectOption.getVar() return a non-null value.

Specified by:

getItemValue in interface WidgetSelectOption

getItemDisabled

public Serializable getItemDisabled()

Description copied from interface: WidgetSelectOption

Returns the disabled behaviour for the select option.

This value can either be an EL expression that should resolve to a boolean value, either a string representing a boolean ("true" or "false") either a Boolean value.

Specified by:

getItemDisabled in interface WidgetSelectOption

getItemRendered

public Serializable getItemRendered()

Description copied from interface: WidgetSelectOption

Returns the rendered behaviour for the select option.

This value can either be an EL expression that should resolve to a boolean value, either a string representing a boolean ("true" or "false") either a Boolean value.

Specified by:

getItemRendered in interface WidgetSelectOption

getOrdering

public String getOrdering()

Description copied from interface: WidgetSelectOptions

Returns a string used for ordering of options.

Sample possible values are 'id' and 'label'.

Specified by:

getOrdering in interface WidgetSelectOptions

getCaseSensitive

public Boolean getCaseSensitive()

Description copied from interface: WidgetSelectOptions

Returns true if ordering should be case sensitive?

Specified by:

getCaseSensitive in interface WidgetSelectOptions

getTagConfigId

public String getTagConfigId()

Description copied from interface: WidgetSelectOption

Returns the unique identifier of this select option to be used in tag configuration.

Specified by:

getTagConfigId in interface WidgetSelectOption

See Also:

Layout#getTagConfigId()}.