Class SelectItemGroup

java.lang.Object

jakarta.faces.model.SelectItem

jakarta.faces.model.SelectItemGroup

All Implemented Interfaces:

Serializable

public class SelectItemGroup
extends SelectItem

SelectItemGroup is a subclass of SelectItem that identifies a set of options that will be made available as a subordinate "submenu" or "options list", depending upon the requirements of the UISelectMany or UISelectOne renderer that is actually used. In general, the value property of this instance will be ignored, and the label property of this instance will be used to label the submenu.

Although it is feasible to incorporate SelectItemGroup instances in he selectItems property of this instance (thereby creating a data structure suitable for cascading submenus), some renderers may place restrictions on the level of nesting they support. For example, HTML based renderers that create an <select> element will typically render this instance as an <optgroup> element, but the HTML 4.01 Specification disallows nested option groups.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
SelectItemGroup()	Construct a SelectItemGroup with no initialized property values.
SelectItemGroup(String label)	Construct a SelectItemGroup with the specified label and no associated selectItems.
SelectItemGroup(String label, String description, boolean disabled, SelectItem... selectItems)	Construct a SelectItemGroup with the specified properties.
SelectItemGroup(String label, String description, boolean disabled, Collection<? extends SelectItem> selectItems)	Construct a SelectItemGroup with the specified properties.

Method Summary

Modifier and Type	Method	Description
SelectItem[]	getSelectItems()	Return the set of subordinate SelectItems for this group.
void	setSelectItems(SelectItem... selectItems)	Set the set of subordinate SelectItems for this group as a variable array.
void	setSelectItems(Collection<? extends SelectItem> selectItems)	Set the set of subordinate SelectItems for this group as a collection.

Methods inherited from class SelectItem

getDescription, getLabel, getValue, isDisabled, isEscape, isNoSelectionOption, setDescription, setDisabled, setEscape, setLabel, setNoSelectionOption, setValue

Modifier and Type	Method	Description
String	getDescription()	Return a description of this item, for use in development tools.
String	getLabel()	Return the label of this item, to be rendered visibly for the user.
Object	getValue()	Return the value of this item, to be delivered to the model if this item is selected by the user.
boolean	isDisabled()	Return the disabled flag for this item, which should modify the rendered output to make this item unavailable for selection by the user if set to true.
boolean	isEscape()	If and only if this returns true, the code that renders this select item must escape the label using escaping syntax appropriate to the content type being rendered.
boolean	isNoSelectionOption()	Return the value of the noSelectionOption property.
void	setDescription(String description)	Set the description of this item, for use in development tools.
void	setDisabled(boolean disabled)	Set the disabled flag for this item, which should modify the rendered output to make this item unavailable for selection by the user if set to true.
void	setEscape(boolean escape)	Set the value of the escape property.
void	setLabel(String label)	Set the label of this item, to be rendered visibly for the user.
void	setNoSelectionOption(boolean noSelectionOption)	Set the value of the noSelectionOption property.
void	setValue(Object value)	Set the value of this item, to be delivered to the model if this item is selected by this user.

Methods inherited from class Object

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

Constructor Details

SelectItemGroup

public SelectItemGroup()

Construct a SelectItemGroup with no initialized property values.

SelectItemGroup

public SelectItemGroup(String label)

Construct a SelectItemGroup with the specified label and no associated selectItems. The value property will be set to a zero-length String, the description property will be set to null, and the disabled property will be set to false.

Parameters:

label - Label to be rendered for this group in the response

Throws:

NullPointerException - if label is false

SelectItemGroup

public SelectItemGroup(String label,
 String description,
 boolean disabled,
 SelectItem... selectItems)

Construct a SelectItemGroup with the specified properties. The value property will be set to a zero-length String.

Parameters:

label - Label to be rendered for this group in the response

description - Description of this group, for use in tools

disabled - Flag indicating that this group is disabled

selectItems - Variable array of SelectItem describing the items available in this group

Throws:

NullPointerException - if label or selectItems is false

SelectItemGroup

public SelectItemGroup(String label,
 String description,
 boolean disabled,
 Collection<? extends SelectItem> selectItems)

Construct a SelectItemGroup with the specified properties. The value property will be set to a zero-length String.

Parameters:

label - Label to be rendered for this group in the response

description - Description of this group, for use in tools

disabled - Flag indicating that this group is disabled

selectItems - Collection of SelectItem describing the items available in this group

Throws:

NullPointerException - if label or selectItems is false

Since:

4.0

Method Details

getSelectItems

public SelectItem[] getSelectItems()

Return the set of subordinate SelectItems for this group.

Returns:

the set of subordinate SelectItems for this group

setSelectItems

public void setSelectItems(SelectItem... selectItems)

Set the set of subordinate SelectItems for this group as a variable array.

Parameters:

selectItems - The new set of subordinate items as a variable array

Throws:

NullPointerException - if selectItems is null

setSelectItems

public void setSelectItems(Collection<? extends SelectItem> selectItems)

Set the set of subordinate SelectItems for this group as a collection.

Parameters:

selectItems - The new set of subordinate items as a collection.

Throws:

NullPointerException - if selectItems is null

Since:

4.0