public class UINamingContainer extends UIComponentBase implements NamingContainer, UniqueIdVendor, StateHolder
UINamingContainer is a convenience base class for components that wish
to implement NamingContainer functionality.
| Modifier and Type | Field and Description |
|---|---|
static java.lang.String |
COMPONENT_FAMILY
The standard component family for this component.
|
static java.lang.String |
COMPONENT_TYPE
The standard component type for this component.
|
static java.lang.String |
SEPARATOR_CHAR_PARAM_NAME
The context-param that allows the separator char for clientId strings to be set on a per-web application basis. |
ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEYSEPARATOR_CHAR| Constructor and Description |
|---|
UINamingContainer()
Create a new
UINamingContainer instance with default property values. |
| Modifier and Type | Method and Description |
|---|---|
java.lang.String |
createUniqueId(FacesContext context,
java.lang.String seed)
Generate an identifier for a component.
|
java.lang.String |
getFamily()
Return the identifier of the component family to which this component belongs. |
static char |
getSeparatorChar(FacesContext context)
Return the character used to separate segments of a clientId. |
boolean |
visitTree(VisitContext context,
VisitCallback callback)
Perform a tree visit starting at this node in the tree. |
addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEventencodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpressionclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitisTransient, restoreState, saveState, setTransientpublic static final java.lang.String COMPONENT_TYPE
The standard component type for this component.
public static final java.lang.String COMPONENT_FAMILY
The standard component family for this component.
public static final java.lang.String SEPARATOR_CHAR_PARAM_NAME
The context-param that allows the separator char for clientId strings to be set on a per-web application basis.
public UINamingContainer()
Create a new UINamingContainer instance with default property values.
public java.lang.String getFamily()
UIComponent
Return the identifier of the component family to which this component belongs. This identifier, in conjunction with
the value of the rendererType property, may be used to select the appropriate Renderer for this
component instance. Note this method should NOT return null
getFamily in class UIComponentpublic static char getSeparatorChar(FacesContext context)
Return the character used to separate segments of a clientId. The implementation must determine if there is a
<context-param> with the value given by the value of the symbolic constant
SEPARATOR_CHAR_PARAM_NAME. If there is a value for this param, the first character of the value must be
returned from this method. Otherwise, the value of the symbolic constant NamingContainer.SEPARATOR_CHAR must
be returned.
context - the FacesContext for the current requestpublic boolean visitTree(VisitContext context, VisitCallback callback)
UIComponentPerform a tree visit starting at this node in the tree.
UIComponent.visitTree() implementations do not invoke the VisitCallback directly, but instead call
VisitContext.invokeVisitCallback(jakarta.faces.component.UIComponent, jakarta.faces.component.visit.VisitCallback) to invoke the callback. This allows VisitContext implementations to
provide optimized tree traversals, for example by only calling the VisitCallback for a subset of components.
UIComponent.visitTree() implementations must call UIComponent.pushComponentToEL() before performing the visit and UIComponent.popComponentFromEL() after the visit.
visitTree in class UIComponentcontext - the VisitContext for this visitcallback - the VisitCallback instance whose visit method will be called for each node
visited.true if tree should be visited, false otherwise.UIComponent.visitTree(jakarta.faces.component.visit.VisitContext, jakarta.faces.component.visit.VisitCallback)public java.lang.String createUniqueId(FacesContext context, java.lang.String seed)
UniqueIdVendorGenerate an identifier for a component. The identifier will be prefixed with UNIQUE_ID_PREFIX, and will be unique within this component-container. Optionally, a unique seed value can be supplied by component creators which should be included in the generated unique id.
createUniqueId in interface UniqueIdVendorcontext - FacesContextseed - an optional seed value - e.g. based on the position of the component in the VDL-template