org.nuxeo.ecm.platform.forms.layout.api

Interface WidgetSelectOption

All Superinterfaces:

Serializable

All Known Subinterfaces:

WidgetSelectOptions

All Known Implementing Classes:

WidgetSelectOptionImpl, WidgetSelectOptionsImpl

public interface WidgetSelectOption
extends Serializable

Single select option top be held by the WidgetDefinition and Widget generated from the definition.

Since:

5.4.2

Author:

Anahide Tchertchian

Method Summary

Modifier and Type	Method and Description
WidgetSelectOption	clone()
Serializable	getItemDisabled() Returns the disabled behaviour for the select option.
String	getItemLabel() Returns the item label for the select option.
String	getItemLabel(String locale) Getter to handle l10n localization of select options.
Map<String,String>	getItemLabels() Getter to handle l10n localization of select options.
Serializable	getItemRendered() Returns the rendered behaviour for the select option.
String	getItemValue() Returns the item value for the select option.
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 getValue()

Method Detail

getValue

Serializable getValue()

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 getVar() method to retrieve the id and label from the object.

getVar

String getVar()

Returns the var representing the value returned by getValue()

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

getItemLabel

String getItemLabel()

Returns the item label for the select option.

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

getItemLabel

String getItemLabel(String locale)

Getter to handle l10n localization of select options.

Since:

6.0

getItemLabels

Map<String,String> getItemLabels()

Getter to handle l10n localization of select options.

Since:

6.0

getItemValue

String getItemValue()

Returns the item value for the select option.

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

getItemDisabled

Serializable getItemDisabled()

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.

getItemRendered

Serializable getItemRendered()

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.

getTagConfigId

String getTagConfigId()

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

See Also:

Layout#getTagConfigId()}.

clone

WidgetSelectOption clone()

Since:

5.5