Class SelectItemGroup
- java.lang.Object
-
- javax.faces.model.SelectItem
-
- javax.faces.model.SelectItemGroup
-
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 theUISelectMany
orUISelectOne
renderer that is actually used. In general, thevalue
property of this instance will be ignored, and thelabel
property of this instance will be used to label the submenu.Although it is feasible to incorporate
SelectItemGroup
instances in heselectItems
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 aSelectItemGroup
with no initialized property values.SelectItemGroup(java.lang.String label)
Construct aSelectItemGroup
with the specified label and no associatedselectItem
s.SelectItemGroup(java.lang.String label, java.lang.String description, boolean disabled, SelectItem[] selectItems)
Construct aSelectItemGroup
with the specified properties.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SelectItem[]
getSelectItems()
Return the set of subordinateSelectItem
s for this group.void
setSelectItems(SelectItem[] selectItems)
Set the set of subordinateSelectItem
s for this group.-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from class javax.faces.model.SelectItem
getDescription, getLabel, getValue, isDisabled, isEscape, isNoSelectionOption, setDescription, setDisabled, setEscape, setLabel, setNoSelectionOption, setValue
-
-
-
-
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 associatedselectItem
s. Thevalue
property will be set to a zero-length String, thedescription
property will be set tonull
, and thedisabled
property will be set to false.- Parameters:
label
- Label to be rendered for this group in the response- Throws:
java.lang.NullPointerException
- iflabel
isfalse
-
SelectItemGroup
public SelectItemGroup(java.lang.String label, java.lang.String description, boolean disabled, SelectItem[] selectItems)
Construct a
SelectItemGroup
with the specified properties. Thevalue
property will be set to a zero-length String.- Parameters:
label
- Label to be rendered for this group in the responsedescription
- Description of this group, for use in toolsdisabled
- Flag indicating that this group is disabledselectItems
- Array ofSelectItem
describing the items available in this group- Throws:
java.lang.NullPointerException
- iflabel
orselectItems
isfalse
-
-
Method Detail
-
getSelectItems
public SelectItem[] getSelectItems()
Return the set of subordinate
SelectItem
s for this group.- Returns:
- the set of subordinate
SelectItem
s for this group
-
setSelectItems
public void setSelectItems(SelectItem[] selectItems)
Set the set of subordinate
SelectItem
s for this group.- Parameters:
selectItems
- The new set of subordinate items- Throws:
java.lang.NullPointerException
- ifselectItems
isnull
-
-