|
Java EE 5 SDK | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectjavax.faces.model.SelectItem
javax.faces.model.SelectItemGroup
public class SelectItemGroup
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.
| Constructor Summary | |
|---|---|
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. |
|
| Method Summary | |
|---|---|
SelectItem[] |
getSelectItems()
Return the set of subordinate SelectItems for this group. |
void |
setSelectItems(SelectItem[] selectItems)
Set the set of subordinate SelectItems for this group. |
| Methods inherited from class javax.faces.model.SelectItem |
|---|
getDescription, getLabel, getValue, isDisabled, isEscape, setDescription, setDisabled, setEscape, setLabel, setValue |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public SelectItemGroup()
Construct a SelectItemGroup with no initialized property
values.
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.
label - Label to be rendered for this group in the response
NullPointerException - if label
is false
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.
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 of SelectItem describing the
items available in this group
NullPointerException - if label
or selectItems is false| Method Detail |
|---|
public SelectItem[] getSelectItems()
Return the set of subordinate SelectItems for this group.
public void setSelectItems(SelectItem[] selectItems)
Set the set of subordinate SelectItems for this group.
selectItems - The new set of subordinate items
NullPointerException - if selectItems
is null
|
Java EE 5 SDK | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
Copyright 2006 Sun Microsystems, Inc. All rights reserved.