Package jakarta.faces.component
Class UINamingContainer
java.lang.Object
jakarta.faces.component.UIComponent
jakarta.faces.component.UIComponentBase
jakarta.faces.component.UINamingContainer
- All Implemented Interfaces:
NamingContainer
,PartialStateHolder
,StateHolder
,TransientStateHolder
,UniqueIdVendor
,ComponentSystemEventListener
,FacesListener
,SystemEventListenerHolder
,EventListener
@JSFComponent(name="f:subview")
@JSFJspProperty(name="id",
required=true)
public class UINamingContainer
extends UIComponentBase
implements NamingContainer, UniqueIdVendor
Base class for components that provide a new "namespace" for the ids of their
child components.
See the javadocs for interface NamingContainer for further details.
-
Field Summary
FieldsFields 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
Fields inherited from interface jakarta.faces.component.NamingContainer
SEPARATOR_CHAR
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncreateUniqueId
(FacesContext context, String seed) static char
getSeparatorChar
(FacesContext context) boolean
A boolean value that indicates whether this component should be rendered.boolean
visitTree
(VisitContext context, VisitCallback callback) The visit tree method, visit tree walks over a subtree and processes the callback object to perform some operation on the subtreeMethods inherited from class jakarta.faces.component.UIComponentBase
addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, invokeOnComponent, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient
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, setValueExpression, subscribeToEvent, unsubscribeFromEvent
-
Field Details
-
COMPONENT_TYPE
- See Also:
-
COMPONENT_FAMILY
- See Also:
-
SEPARATOR_CHAR_PARAM_NAME
- See Also:
-
-
Constructor Details
-
UINamingContainer
public UINamingContainer()Construct an instance of the UINamingContainer.
-
-
Method Details
-
getFamily
- Specified by:
getFamily
in classUIComponent
-
createUniqueId
- Specified by:
createUniqueId
in interfaceUniqueIdVendor
- Since:
- 2.0
-
getSeparatorChar
- Parameters:
context
-- Returns:
- Since:
- 2.0
-
isRendered
@JSFProperty(deferredValueType="java.lang.Boolean") public boolean isRendered()Description copied from class:UIComponentBase
A boolean value that indicates whether this component should be rendered. Default value: true.- Overrides:
isRendered
in classUIComponentBase
-
visitTree
Description copied from class:UIComponent
The visit tree method, visit tree walks over a subtree and processes the callback object to perform some operation on the subtreethere are some details in the implementation which according to the spec have to be in place: a) before calling the callback and traversing into the subtree pushComponentToEL has to be called b) after the processing popComponentFromEL has to be performed to remove the component from the el
The tree traversal optimizations are located in the visit context and can be replaced via the VisitContextFactory in the faces-config factory section
- Overrides:
visitTree
in classUIComponentBase
- Parameters:
context
- the visit context which handles the processing detailscallback
- the callback to be performed- Returns:
- false if the processing is not done true if we can shortcut the visiting because we are done with everything
-