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

Class WidgetSelectOptionsImpl

java.lang.Object

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

All Implemented Interfaces:

Serializable, WidgetSelectOption, WidgetSelectOptions

public class WidgetSelectOptionsImpl
extends Object
implements WidgetSelectOptions

Since:

5.4.2

Author:

Anahide Tchertchian

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Boolean	caseSensitive
protected Serializable	itemDisabled
protected String	itemLabel
protected Serializable	itemRendered
protected String	itemValue
protected Map<String,String>	labels
protected String	ordering
protected Serializable	value
protected String	var

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	WidgetSelectOptionsImpl()
	WidgetSelectOptionsImpl(Serializable value, String var, String itemLabel, String itemValue)
	WidgetSelectOptionsImpl(Serializable value, String var, String itemLabel, String itemValue, Serializable itemDisabled, Serializable itemRendered)
	WidgetSelectOptionsImpl(Serializable value, String var, String itemLabel, String itemValue, Serializable itemDisabled, Serializable itemRendered, String ordering, Boolean caseSensitive)

Method Summary

Modifier and Type	Method	Description
WidgetSelectOptions	clone()
boolean	equals(Object obj)
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.
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	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()
void	setItemLabels(Map<String,String> labels)

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

value

protected Serializable value

var

protected String var

itemLabel

protected String itemLabel

labels

protected Map<String,String> labels

itemValue

protected String itemValue

itemDisabled

protected Serializable itemDisabled

itemRendered

protected Serializable itemRendered

ordering

protected String ordering

caseSensitive

protected Boolean caseSensitive

Constructor Details

WidgetSelectOptionsImpl

protected WidgetSelectOptionsImpl()

WidgetSelectOptionsImpl

public WidgetSelectOptionsImpl(Serializable value,
 String var,
 String itemLabel,
 String itemValue)

WidgetSelectOptionsImpl

public WidgetSelectOptionsImpl(Serializable value,
 String var,
 String itemLabel,
 String itemValue,
 Serializable itemDisabled,
 Serializable itemRendered)

WidgetSelectOptionsImpl

public WidgetSelectOptionsImpl(Serializable value,
 String var,
 String itemLabel,
 String itemValue,
 Serializable itemDisabled,
 Serializable itemRendered,
 String ordering,
 Boolean caseSensitive)

Method Details

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

getItemLabel

public String getItemLabel(String locale)

Description copied from interface: WidgetSelectOption

Getter to handle l10n localization of select options.

Specified by:

getItemLabel in interface WidgetSelectOption

getItemLabels

public Map<String,String> getItemLabels()

Description copied from interface: WidgetSelectOption

Getter to handle l10n localization of select options.

Specified by:

getItemLabels in interface WidgetSelectOption

setItemLabels

public void setItemLabels(Map<String,String> labels)

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()

clone

public WidgetSelectOptions clone()

Specified by:

clone in interface WidgetSelectOption

Overrides:

clone in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

Since:

7.2