UISelectItem is a component that may be nested inside a UISelectMany or UISelectOne component, and causes the addition of a SelectItem instance to the list of available options for the parent component. The contents of the SelectItem can be specified in one of the following ways:

The value attribute's value is an instance of SelectItem.
The associated jakarta.el.ValueExpression points at a model data item of type SelectItem.
A new SelectItem instance is synthesized from the values of the itemDescription, itemDisabled, itemLabel, itemEscaped, and itemValue attributes.

Modifier and Type	Class and Description
pack-priv static enum	UISelectItem.PropertyKeys

Field Summary

Modifier and Type	Field and Description
public static final String	COMPONENT_FAMILY The standard component family for this component.
public static final String	COMPONENT_TYPE The standard component type for this component.

Constructor Summary

Access	Constructor and Description
public	UISelectItem() Create a new `UISelectItem` instance with default property values.

Method Summary

Modifier and Type	Method and Description
public String	getFamily() Implements abstract jakarta.faces.component.UIComponent.getFamily. Return the identifier of the component family to which this component belongs.
public String	Returns: the item description. getItemDescription() Return the description for this selection item.
public String	Returns: the item label. getItemLabel() Return the localized label for this selection item.
public Object	Returns: the item value. getItemValue() Return the server value for this selection item.
public Object	Returns: the value. getValue() Returns the `value` property of the `UISelectItem`.
public boolean	Returns: `true` is the item disabled, `false` otherwise. isItemDisabled() Return the disabled setting for this selection item.
public boolean	Returns: `true` if the item is escaped, `false` otherwise. isItemEscaped() Return the escape setting for the label of this selection item.
public boolean	Returns: the no selection option. isNoSelectionOption() Return the value of the `noSelectionOption` property.
public void	setItemDescription(String The new description itemDescription) Set the description for this selection item.
public void	setItemDisabled(boolean The new disabled flag itemDisabled) Set the disabled value for this selection item.
public void	setItemEscaped(boolean The new disabled flag itemEscaped) Set the escape value for the label of this selection item.
public void	setItemLabel(String The new localized label itemLabel) Set the localized label for this selection item.
public void	setItemValue(Object The new server value itemValue) Set the server value for this selection item.
public void	setNoSelectionOption(boolean the no selection option. noSelectionOption) Set the value of the `noSelectionOption` property.
public void	setValue(Object the new value value) Sets the `value` property of the `UISelectItem`.

Field Detail

COMPONENT_FAMILY	back to summary
public static final String COMPONENT_FAMILY The standard component family for this component.

COMPONENT_TYPE	back to summary
public static final String COMPONENT_TYPE The standard component type for this component.

Constructor Detail

UISelectItem	back to summary
public UISelectItem() Create a new `UISelectItem` instance with default property values.

Method Detail

getFamily back to summary

getFamily	back to summary
public String getFamily() Implements abstract jakarta.faces.component.UIComponent.getFamily. Doc from jakarta.faces.component.UIComponent.getFamily. Return the identifier of the component family to which this component belongs. This identifier, in conjunction with the value of the `rendererType` property, may be used to select the appropriate `Renderer` for this component instance. Note this method should NOT return `null` Returns:String the component family (not null). Annotations @Override

public String getFamily()

Implements abstract jakarta.faces.component.UIComponent.getFamily.

Doc from jakarta.faces.component.UIComponent.getFamily.

Return the identifier of the component family to which this component belongs. This identifier, in conjunction with the value of the rendererType property, may be used to select the appropriate Renderer for this component instance. Note this method should NOT return null

Returns:String

the component family (not null).

Annotations

@Override

getItemDescription	back to summary
public String getItemDescription() Return the description for this selection item. Returns:String the item description.

getItemDescription

back to summary

public String getItemDescription()

Return the description for this selection item.

Returns:String: the item description.

getItemLabel	back to summary
public String getItemLabel() Return the localized label for this selection item. Returns:String the item label.

getItemLabel

back to summary

public String getItemLabel()

Return the localized label for this selection item.

Returns:String: the item label.

getItemValue	back to summary
public Object getItemValue() Return the server value for this selection item. Returns:Object the item value.

getItemValue

back to summary

public Object getItemValue()

Return the server value for this selection item.

Returns:Object: the item value.

getValue back to summary

getValue	back to summary
public Object getValue() Returns the `value` property of the `UISelectItem`. Returns:Object the value.

public Object getValue()

Returns the value property of the UISelectItem.

Returns:Object: the value.

isItemDisabled back to summary

isItemDisabled	back to summary
public boolean isItemDisabled() Return the disabled setting for this selection item. Returns:boolean `true` is the item disabled, `false` otherwise.

public boolean isItemDisabled()

Return the disabled setting for this selection item.

Returns:boolean: true is the item disabled, false otherwise.

isItemEscaped back to summary

isItemEscaped	back to summary
public boolean isItemEscaped() Return the escape setting for the label of this selection item. Returns:boolean `true` if the item is escaped, `false` otherwise.

public boolean isItemEscaped()

Return the escape setting for the label of this selection item.

Returns:boolean: true if the item is escaped, false otherwise.

isNoSelectionOption back to summary

isNoSelectionOption	back to summary
public boolean isNoSelectionOption() Return the value of the `noSelectionOption` property. If the value of this property is `true`, the system interprets the option represented by this `UISelectItem` instance as representing a "no selection" option. See `UISelectOne#validateValue` and `UISelectMany#validateValue` for usage. Returns:boolean the no selection option. Since 2.0

public boolean isNoSelectionOption()

Return the value of the noSelectionOption property. If the value of this property is true, the system interprets the option represented by this UISelectItem instance as representing a "no selection" option. See UISelectOne#validateValue and UISelectMany#validateValue for usage.

Returns:boolean: the no selection option.
Since: 2.0

setItemDescription	back to summary
public void setItemDescription(String itemDescription) Set the description for this selection item. Parameters itemDescription:String The new description

setItemDescription

back to summary

public void setItemDescription(String itemDescription)

Set the description for this selection item.

Parameters

itemDescription:String: The new description

setItemDisabled	back to summary
public void setItemDisabled(boolean itemDisabled) Set the disabled value for this selection item. Parameters itemDisabled:boolean The new disabled flag

setItemDisabled

back to summary

public void setItemDisabled(boolean itemDisabled)

Set the disabled value for this selection item.

Parameters

itemDisabled:boolean: The new disabled flag

setItemEscaped	back to summary
public void setItemEscaped(boolean itemEscaped) Set the escape value for the label of this selection item. Parameters itemEscaped:boolean The new disabled flag

setItemEscaped

back to summary

public void setItemEscaped(boolean itemEscaped)

Set the escape value for the label of this selection item.

Parameters

itemEscaped:boolean: The new disabled flag

setItemLabel	back to summary
public void setItemLabel(String itemLabel) Set the localized label for this selection item. Parameters itemLabel:String The new localized label

setItemLabel

back to summary

public void setItemLabel(String itemLabel)

Set the localized label for this selection item.

Parameters

itemLabel:String: The new localized label

setItemValue	back to summary
public void setItemValue(Object itemValue) Set the server value for this selection item. Parameters itemValue:Object The new server value

setItemValue

back to summary

public void setItemValue(Object itemValue)

Set the server value for this selection item.

Parameters

itemValue:Object: The new server value

setNoSelectionOption back to summary

setNoSelectionOption	back to summary
public void setNoSelectionOption(boolean noSelectionOption) Set the value of the `noSelectionOption` property. Parameters noSelectionOption:boolean the no selection option. Since 2.0

public void setNoSelectionOption(boolean noSelectionOption)

Set the value of the noSelectionOption property.

Parameters

noSelectionOption:boolean: the no selection option.

Since

2.0

setValue back to summary

setValue	back to summary
public void setValue(Object value) Sets the `value` property of the `UISelectItem`. Parameters value:Object the new value

public void setValue(Object value)

Sets the value property of the UISelectItem.

Parameters

value:Object: the new value

jakarta.faces.component back to summary

pack-priv final Enum UISelectItem.PropertyKeys

Class Inheritance

extends Enum<UISelectItem.PropertyKeys>

java.lang.Object
java.lang.Enum
jakarta.faces.component.UISelectItem.PropertyKeys

Field Summary

Modifier and Type	Field and Description
public static final UISelectItem.PropertyKeys	itemDescription
public static final UISelectItem.PropertyKeys	itemDisabled
public static final UISelectItem.PropertyKeys	itemEscaped
public static final UISelectItem.PropertyKeys	itemLabel
public static final UISelectItem.PropertyKeys	itemValue
public static final UISelectItem.PropertyKeys	noSelectionOption
public static final UISelectItem.PropertyKeys	value

Constructor Summary

Access	Constructor and Description
private	PropertyKeys()

Method Summary

Modifier and Type	Method and Description
public static UISelectItem.PropertyKeys	valueOf(String name)
public static UISelectItem.PropertyKeys[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

itemDescription	back to summary
public static final UISelectItem.PropertyKeys itemDescription

itemDisabled	back to summary
public static final UISelectItem.PropertyKeys itemDisabled

itemEscaped	back to summary
public static final UISelectItem.PropertyKeys itemEscaped

itemLabel	back to summary
public static final UISelectItem.PropertyKeys itemLabel

itemValue	back to summary
public static final UISelectItem.PropertyKeys itemValue

noSelectionOption	back to summary
public static final UISelectItem.PropertyKeys noSelectionOption

value	back to summary
public static final UISelectItem.PropertyKeys value

Constructor Detail

PropertyKeys	back to summary
private PropertyKeys()

Method Detail

valueOf	back to summary
public static UISelectItem.PropertyKeys valueOf(String name)

values	back to summary
public static UISelectItem.PropertyKeys[] values()

public Class UISelectItem

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv final Enum UISelectItem.PropertyKeys

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail