SelectItemGroup

java.lang.Object
- jakarta.faces.model.SelectItem
- - jakarta.faces.model.SelectItemGroup

All Implemented Interfaces:

java.io.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 and Description
`SelectItemGroup()` Construct a `SelectItemGroup` with no initialized property values.
`SelectItemGroup(java.lang.String label)` Construct a `SelectItemGroup` with the specified label and no associated `selectItem`s.
`SelectItemGroup(java.lang.String label, java.lang.String description, boolean disabled, java.util.Collection<? extends SelectItem> selectItems)` Construct a `SelectItemGroup` with the specified properties.
`SelectItemGroup(java.lang.String label, java.lang.String description, boolean disabled, SelectItem... selectItems)` Construct a `SelectItemGroup` with the specified properties.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SelectItem[]`	`getSelectItems()` Return the set of subordinate `SelectItem`s for this group.
`void`	`setSelectItems(java.util.Collection<? extends SelectItem> selectItems)` Set the set of subordinate `SelectItem`s for this group as a collection.
`void`	`setSelectItems(SelectItem... selectItems)` Set the set of subordinate `SelectItem`s for this group as a variable array.

Methods inherited from class jakarta.faces.model.SelectItem
getDescription, getLabel, getValue, isDisabled, isEscape, isNoSelectionOption, setDescription, setDisabled, setEscape, setLabel, setNoSelectionOption, setValue

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SelectItemGroup
```
public SelectItemGroup()
```
    Construct a SelectItemGroup with no initialized property values.
  - SelectItemGroup
```
public SelectItemGroup(java.lang.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:
    
    java.lang.NullPointerException - if label is false
  - SelectItemGroup
```
public SelectItemGroup(java.lang.String label,
                       java.lang.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:
    
    java.lang.NullPointerException - if label or selectItems is false
  - SelectItemGroup
```
public SelectItemGroup(java.lang.String label,
                       java.lang.String description,
                       boolean disabled,
                       java.util.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:
    
    java.lang.NullPointerException - if label or selectItems is false
    
    Since:
    
    4.0
- Method Detail
  - 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:
    
    java.lang.NullPointerException - if selectItems is null
  - setSelectItems
```
public void setSelectItems(java.util.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:
    
    java.lang.NullPointerException - if selectItems is null
    
    Since:
    
    4.0

Class SelectItemGroup

Constructor Summary

Method Summary

Methods inherited from class jakarta.faces.model.SelectItem

Methods inherited from class java.lang.Object

Constructor Detail

SelectItemGroup

SelectItemGroup

SelectItemGroup

SelectItemGroup

Method Detail

getSelectItems

setSelectItems

setSelectItems