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:
  • 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 - Array of SelectItem describing the items available in this group
      Throws:
      NullPointerException - if label or selectItems is false
  • 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.

      Parameters:
      selectItems - The new set of subordinate items
      Throws:
      NullPointerException - if selectItems is null