Module org.omnifaces

Package org.omnifaces.component.model

Class SelectItemGroups

java.lang.Object

jakarta.faces.component.UIComponent

jakarta.faces.component.UIComponentBase

jakarta.faces.component.UISelectItems

org.omnifaces.component.model.SelectItemGroups

All Implemented Interfaces:

PartialStateHolder, StateHolder, TransientStateHolder, ComponentSystemEventListener, FacesListener, SystemEventListenerHolder, EventListener

public class SelectItemGroups
extends UISelectItems

The o:selectItemGroups is an extension of UISelectItems which allows you to iterate over a nested collection representing groups of select items. This is basically the UIComponent counterpart of jakarta.faces.model.SelectItemGroup. There is no equivalent (yet) in the standard Faces API. Currently the only way to represent SelectItemGroup in UI is to manually create and populate them in a backing bean which can end up to be quite verbose.

Usage

Below example assumes a List<Category> as value wherein Category in turn has a List<Product>.

 <h:selectOneMenu value="#{bean.selectedProduct}" converter="omnifaces.SelectItemsConverter">
     <f:selectItem itemValue="#{null}" />
     <o:selectItemGroups value="#{bean.categories}" var="category" itemLabel="#{category.name}">
         <f:selectItems value="#{category.products}" var="product" itemLabel="#{product.name}" />
     </o:selectItemGroups>
 </h:selectOneMenu>
 

Since:

3.0

Author:

Bauke Scholtz

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COMPONENT_TYPE	The component type, which is "org.omnifaces.component.model.SelectItemGroups".

Fields inherited from class jakarta.faces.component.UISelectItems

COMPONENT_FAMILY

Fields inherited from class jakarta.faces.component.UIComponent

ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, FACETS_KEY, VIEW_LOCATION_KEY

Constructor Summary

Constructors

Constructor	Description
SelectItemGroups()

Method Summary

Modifier and Type	Method	Description
Object	getValue()	An override which wraps each UISelectItem(s) child in a SelectItemGroup.
void	setValueExpression(String name, ValueExpression binding)	An override which checks if this isn't been invoked on var attribute.

Methods inherited from class jakarta.faces.component.UISelectItems

getFacesContext, getFamily, setValue

Methods inherited from class jakarta.faces.component.UIComponentBase

addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, visitTree

Methods inherited from class jakarta.faces.component.UIComponent

getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

COMPONENT_TYPE

public static final String COMPONENT_TYPE

The component type, which is "org.omnifaces.component.model.SelectItemGroups".

See Also:

• Constant Field Values

Constructor Details

SelectItemGroups

public SelectItemGroups()

Method Details

setValueExpression

public void setValueExpression(String name,
 ValueExpression binding)

An override which checks if this isn't been invoked on var attribute. Finally it delegates to the super method.

Overrides:

setValueExpression in class UIComponent

Throws:

IllegalArgumentException - When this value expression is been set on var attribute.

getValue

public Object getValue()

An override which wraps each UISelectItem(s) child in a SelectItemGroup.

Overrides:

getValue in class UISelectItems