EE4J Web API 10.0.0 · jakarta.faces.model.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.

Modifier and Type	Field and Description
private SelectItem[]	selectItems
private static final long	serialVersionUID Hides jakarta.faces.model.SelectItem.serialVersionUID.

Constructor Summary

Access	Constructor and Description
public	SelectItemGroup() Construct a `SelectItemGroup` with no initialized property values.
public	SelectItemGroup(String Label to be rendered for this group in the response label) Construct a `SelectItemGroup` with the specified label and no associated `selectItem`s.
public	SelectItemGroup(String Label to be rendered for this group in the response label, String Description of this group, for use in tools description, boolean Flag indicating that this group is disabled disabled, SelectItem... Variable array of `SelectItem` describing the items available in this group selectItems) Construct a `SelectItemGroup` with the specified properties.
public	SelectItemGroup(String Label to be rendered for this group in the response label, String Description of this group, for use in tools description, boolean Flag indicating that this group is disabled disabled, Collection<? extends SelectItem> Collection of `SelectItem` describing the items available in this group selectItems) Construct a `SelectItemGroup` with the specified properties.

Method Summary

Modifier and Type	Method and Description
public SelectItem[]	Returns: the set of subordinate `SelectItem`s for this group getSelectItems() Return the set of subordinate `SelectItem`s for this group.
public void	setSelectItems(SelectItem... The new set of subordinate items as a variable array selectItems) Set the set of subordinate `SelectItem`s for this group as a variable array.
public void	setSelectItems(Collection<? extends SelectItem> The new set of subordinate items as a collection. selectItems) Set the set of subordinate `SelectItem`s for this group as a collection.

Inherited from jakarta.faces.model.SelectItem:: getDescription getLabel getValue isDisabled isEscape isNoSelectionOption setDescription setDisabled setEscape setLabel setNoSelectionOption setValue

Field Detail

selectItems	back to summary
private SelectItem[] selectItems

serialVersionUID	back to summary
private static final long serialVersionUID Hides jakarta.faces.model.SelectItem.serialVersionUID.

Constructor Detail

SelectItemGroup	back to summary
public SelectItemGroup() Construct a `SelectItemGroup` with no initialized property values.

SelectItemGroup back to summary

SelectItemGroup	back to summary
public SelectItemGroup(String label) Construct a `SelectItemGroup` with the specified label and no associated `selectItem`s. 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:String Label to be rendered for this group in the response Exceptions NullPointerException: if `label` is `false`

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:String: Label to be rendered for this group in the response

Exceptions

NullPointerException:: if label is false

SelectItemGroup back to summary

SelectItemGroup	back to summary
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:String Label to be rendered for this group in the response description:String Description of this group, for use in tools disabled:boolean Flag indicating that this group is disabled selectItems:SelectItem[] Variable array of `SelectItem` describing the items available in this group Exceptions NullPointerException: if `label` or `selectItems` 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.

Parameters

label:String: Label to be rendered for this group in the response
description:String: Description of this group, for use in tools
disabled:boolean: Flag indicating that this group is disabled
selectItems:SelectItem[]: Variable array of SelectItem describing the items available in this group

Exceptions

NullPointerException:: if label or selectItems is false

SelectItemGroup back to summary

SelectItemGroup	back to summary
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:String Label to be rendered for this group in the response description:String Description of this group, for use in tools disabled:boolean Flag indicating that this group is disabled selectItems:Collection<? extends SelectItem> Collection of `SelectItem` describing the items available in this group Exceptions NullPointerException: if `label` or `selectItems` is `false` Since 4.0

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:String: Label to be rendered for this group in the response
description:String: Description of this group, for use in tools
disabled:boolean: Flag indicating that this group is disabled
selectItems:Collection<? extends SelectItem>: Collection of SelectItem describing the items available in this group

Exceptions

NullPointerException:: if label or selectItems is false

Since

4.0

Method Detail

getSelectItems back to summary

getSelectItems	back to summary
public SelectItem[] getSelectItems() Return the set of subordinate `SelectItem`s for this group. Returns:SelectItem[] the set of subordinate `SelectItem`s for this group

public SelectItem[] getSelectItems()

Return the set of subordinate SelectItems for this group.

Returns:SelectItem[]: the set of subordinate SelectItems for this group

setSelectItems back to summary

setSelectItems	back to summary
public void setSelectItems(SelectItem... selectItems) Set the set of subordinate `SelectItem`s for this group as a variable array. Parameters selectItems:SelectItem[] The new set of subordinate items as a variable array Exceptions NullPointerException: if `selectItems` is `null`

public void setSelectItems(SelectItem... selectItems)

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

Parameters

selectItems:SelectItem[]: The new set of subordinate items as a variable array

Exceptions

NullPointerException:: if selectItems is null

setSelectItems back to summary

setSelectItems	back to summary
public void setSelectItems(Collection<? extends SelectItem> selectItems) Set the set of subordinate `SelectItem`s for this group as a collection. Parameters selectItems:Collection<? extends SelectItem> The new set of subordinate items as a collection. Exceptions NullPointerException: if `selectItems` is `null` Since 4.0

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

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

Parameters

selectItems:Collection<? extends SelectItem>: The new set of subordinate items as a collection.

Exceptions

NullPointerException:: if selectItems is null

Since

4.0

public Class SelectItemGroup

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail