|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.faces.component.UIComponent
javax.faces.component.UIComponentBase
javax.faces.component.UINamingContainer
public class UINamingContainer
UINamingContainer is a
convenience base class for components that wish to implement NamingContainer
functionality.
Field Summary | |
---|---|
static String |
COMPONENT_FAMILY
The standard component family for this component. |
static String |
COMPONENT_TYPE
The standard component type for this component. |
static 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. |
Fields inherited from class javax.faces.component.UIComponent |
---|
BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY |
Fields inherited from interface javax.faces.component.NamingContainer |
---|
SEPARATOR_CHAR |
Constructor Summary | |
---|---|
UINamingContainer()
Create a new UINamingContainer instance with default property
values. |
Method Summary | |
---|---|
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. |
Methods inherited from class javax.faces.component.UIComponent |
---|
encodeAll, getClientId, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getResourceBundleMap, getValueExpression, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, setInView, setValueExpression, subscribeToEvent, unsubscribeFromEvent |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String COMPONENT_TYPE
The standard component type for this component.
public static final String COMPONENT_FAMILY
The standard component family for this component.
public static final 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.
Constructor Detail |
---|
public UINamingContainer()
Create a new UINamingContainer
instance with default property
values.
Method Detail |
---|
public 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.
getFamily
in class UIComponent
public 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)
UIComponent
Perform a tree visit starting at this node in the tree.
UIComponent.visitTree() implementations do not invoke the
VisitCallback
directly, but instead cal
VisitContext.invokeVisitCallback()
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 UIComponent
context
- the VisitContext
for this visitcallback
- the VisitCallback
instance
whose visit
method will be called
for each node visited.
true
to indicate that the tree visit is complete (eg. all components
that need to be visited have been visited). This results in
the tree visit being short-circuited such that no more components
are visited.UIComponent.visitTree(javax.faces.component.visit.VisitContext, javax.faces.component.visit.VisitCallback)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |