com.sun.faces.facelets.compiler

Class UILeaf

java.lang.Object

jakarta.faces.component.UIComponent

jakarta.faces.component.UIComponentBase

com.sun.faces.facelets.compiler.UILeaf

All Implemented Interfaces:

jakarta.faces.component.PartialStateHolder, jakarta.faces.component.search.UntargetableComponent, jakarta.faces.component.StateHolder, jakarta.faces.component.TransientStateHolder, jakarta.faces.event.ComponentSystemEventListener, jakarta.faces.event.FacesListener, jakarta.faces.event.SystemEventListenerHolder, EventListener

Direct Known Subclasses:

UIInstructions, UILiteralText, UIText

public class UILeaf
extends jakarta.faces.component.UIComponentBase
implements jakarta.faces.component.search.UntargetableComponent

Field Summary

Fields inherited from class jakarta.faces.component.UIComponent

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_KEY

Constructor Summary

Constructors

Constructor and Description
UILeaf()

Method Summary

Modifier and Type	Method and Description
protected void	addFacesListener(jakarta.faces.event.FacesListener faces) Add the specified FacesListener to the set of listeners registered to receive event notifications from this UIComponent.
void	broadcast(jakarta.faces.event.FacesEvent event) Broadcast the specified FacesEvent to all registered event listeners who have expressed an interest in events of this type.
void	decode(jakarta.faces.context.FacesContext faces) Decode any new state of this UIComponent from the request contained in the specified FacesContext, and store this state as needed.
void	encodeAll(jakarta.faces.context.FacesContext faces) If this component returns true from UIComponent.isRendered(), take the following action.
void	encodeBegin(jakarta.faces.context.FacesContext faces) If our rendered property is true, render the beginning of the current state of this UIComponent to the response contained in the specified FacesContext.
void	encodeChildren(jakarta.faces.context.FacesContext faces) If our rendered property is true, render the child UIComponents of this UIComponent.
void	encodeEnd(jakarta.faces.context.FacesContext faces) If our rendered property is true, render the ending of the current state of this UIComponent.
jakarta.faces.component.UIComponent	findComponent(String id) Search for and return the UIComponent with an id that matches the specified search expression (if any), according to the algorithm described below.
int	getChildCount() Return the number of child UIComponents that are associated with this UIComponent.
List<jakarta.faces.component.UIComponent>	getChildren() Return a mutable List representing the child UIComponents associated with this component.
protected jakarta.faces.context.FacesContext	getFacesContext() Convenience method to return the FacesContext instance for the current request.
protected jakarta.faces.event.FacesListener[]	getFacesListeners(Class faces) Return an array of registered FacesListeners that are instances of the specified class.
jakarta.faces.component.UIComponent	getFacet(String name) Convenience method to return the named facet, if it exists, or null otherwise.
int	getFacetCount() Return the number of facet UIComponents that are associated with this UIComponent.
Map<String,jakarta.faces.component.UIComponent>	getFacets() Return a mutable Map representing the facet UIComponents associated with this UIComponent, keyed by facet name (which must be a String).
Iterator<jakarta.faces.component.UIComponent>	getFacetsAndChildren() Return an Iterator over the facet followed by child UIComponents of this UIComponent.
String	getFamily() Return the identifier of the component family to which this component belongs.
jakarta.faces.component.UIComponent	getParent() Return the parent UIComponent of this UIComponent, if any.
protected jakarta.faces.render.Renderer	getRenderer(jakarta.faces.context.FacesContext faces) Convenience method to return the Renderer instance associated with this component, if any; otherwise, return null.
String	getRendererType() Return the Renderer type for this UIComponent (if any).
boolean	getRendersChildren() Return a flag indicating whether this component is responsible for rendering its child components.
jakarta.faces.el.ValueBinding	getValueBinding(String binding) Call through to UIComponent.getValueExpression(java.lang.String) and examine the result.
jakarta.el.ValueExpression	getValueExpression(String name) Return the ValueExpression used to calculate the value for the specified attribute or property name, if any.
boolean	isTransient() If true, the Object implementing this interface must not participate in state saving or restoring.
void	processDecodes(jakarta.faces.context.FacesContext faces) Perform the component tree processing required by the Apply Request Values phase of the request processing lifecycle for all facets of this component, all children of this component, and this component itself, as follows.
void	processUpdates(jakarta.faces.context.FacesContext faces) Perform the component tree processing required by the Update Model Values phase of the request processing lifecycle for all facets of this component, all children of this component, and this component itself, as follows.
void	processValidators(jakarta.faces.context.FacesContext faces) Perform the component tree processing required by the Process Validations phase of the request processing lifecycle for all facets of this component, all children of this component, and this component itself, as follows.
void	queueEvent(jakarta.faces.event.FacesEvent event) Queue an event for broadcast at the end of the current request processing lifecycle phase.
protected void	removeFacesListener(jakarta.faces.event.FacesListener faces) Remove the specified FacesListener from the set of listeners registered to receive event notifications from this UIComponent.
void	setParent(jakarta.faces.component.UIComponent parent) Set the parent UIComponent of this UIComponent.
void	setRendererType(String rendererType) Set the Renderer type for this UIComponent, or null for components that render themselves.
void	setTransient(boolean tranzient) Denotes whether or not the Object implementing this interface must or must not participate in state saving or restoring.
void	setValueBinding(String name, jakarta.faces.el.ValueBinding binding) Wrap the argument binding in an implementation of ValueExpression and call through to UIComponent.setValueExpression(java.lang.String, jakarta.el.ValueExpression).
void	setValueExpression(String name, jakarta.el.ValueExpression arg1) Set the ValueExpression used to calculate the value for the specified attribute or property name, if any.

Methods inherited from class jakarta.faces.component.UIComponentBase

addClientBehavior, clearInitialState, getAttributes, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getId, getListenersForEventClass, getPassThroughAttributes, invokeOnComponent, isRendered, markInitialState, processRestoreState, processSaveState, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setRendered, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class jakarta.faces.component.UIComponent

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

Methods inherited from class java.lang.Object

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

Constructor Detail

UILeaf

public UILeaf()

Method Detail

getValueBinding

public jakarta.faces.el.ValueBinding getValueBinding(String binding)

Description copied from class: jakarta.faces.component.UIComponentBase

Call through to UIComponent.getValueExpression(java.lang.String) and examine the result. If the result is an instance of the wrapper class mandated in UIComponent.setValueBinding(java.lang.String, jakarta.faces.el.ValueBinding), extract the ValueBinding instance and return it. Otherwise, wrap the result in an implementation of ValueBinding, and return it.

Overrides:

getValueBinding in class jakarta.faces.component.UIComponentBase

Parameters:

binding - Name of the attribute or property for which to retrieve a ValueBinding

Returns:

the value binding.

setValueBinding

public void setValueBinding(String name,
                            jakarta.faces.el.ValueBinding binding)

Description copied from class: jakarta.faces.component.UIComponentBase

Wrap the argument binding in an implementation of ValueExpression and call through to UIComponent.setValueExpression(java.lang.String, jakarta.el.ValueExpression).

Overrides:

setValueBinding in class jakarta.faces.component.UIComponentBase

Parameters:

name - Name of the attribute or property for which to set a ValueBinding

binding - The ValueBinding to set, or null to remove any currently set ValueBinding

getValueExpression

public jakarta.el.ValueExpression getValueExpression(String name)

Description copied from class: jakarta.faces.component.UIComponent

Return the ValueExpression used to calculate the value for the specified attribute or property name, if any.

This method must be overridden and implemented for components that comply with Jakarta Server Faces 1.2 and later.

Overrides:

getValueExpression in class jakarta.faces.component.UIComponent

Parameters:

name - Name of the attribute or property for which to retrieve a ValueExpression

Returns:

the value expression, or null.

setValueExpression

public void setValueExpression(String name,
                               jakarta.el.ValueExpression arg1)

Description copied from class: jakarta.faces.component.UIComponent

Set the ValueExpression used to calculate the value for the specified attribute or property name, if any.

The implementation must call Expression.isLiteralText() on the argument expression. If isLiteralText() returns true, invoke ValueExpression.getValue(jakarta.el.ELContext) on the argument expression and pass the result as the value parameter in a call to this.UIComponent.getAttributes().put(name, value) where name is the argument name. If an exception is thrown as a result of calling ValueExpression.getValue(jakarta.el.ELContext), wrap it in a FacesException and re-throw it. If isLiteralText() returns false, simply store the un-evaluated expression argument in the collection of ValueExpressions under the key given by the argument name.

This method must be overridden and implemented for components that comply with Jakarta Server Faces 1.2 and later.

Overrides:

setValueExpression in class jakarta.faces.component.UIComponent

Parameters:

name - Name of the attribute or property for which to set a ValueExpression

arg1 - The ValueExpression to set, or null to remove any currently set ValueExpression

getFamily

public String getFamily()

Description copied from class: jakarta.faces.component.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

Specified by:

getFamily in class jakarta.faces.component.UIComponent

Returns:

the component family (not null).

getParent

public jakarta.faces.component.UIComponent getParent()

Description copied from class: jakarta.faces.component.UIComponent

Return the parent UIComponent of this UIComponent, if any. A component must allow child components to be added to and removed from the list of children of this component, even though the child component returns null from getParent( ).

Overrides:

getParent in class jakarta.faces.component.UIComponentBase

Returns:

the parent component.

setParent

public void setParent(jakarta.faces.component.UIComponent parent)

Description copied from class: jakarta.faces.component.UIComponent

Set the parent UIComponent of this UIComponent. If parent.isInView() returns true, calling this method will first cause a PreRemoveFromViewEvent to be published, for this node, and then the children of this node. Then, once the re-parenting has occurred, a PostAddToViewEvent will be published as well, first for this node, and then for the node's children, but only if any of the following conditions are true.

• FacesContext.getCurrentPhaseId() returns PhaseId.RESTORE_VIEW and partial state saving is enabled.

• FacesContext.isPostback() returns false and FacesContext.getCurrentPhaseId() returns something other than PhaseId.RESTORE_VIEW

This method must never be called by developers; a UIComponent's internal implementation will call it as components are added to or removed from a parent's child List or facet Map.

Overrides:

setParent in class jakarta.faces.component.UIComponentBase

Parameters:

parent - The new parent, or null for the root node of a component tree

getRendererType

public String getRendererType()

Description copied from class: jakarta.faces.component.UIComponent

Return the Renderer type for this UIComponent (if any).

Overrides:

getRendererType in class jakarta.faces.component.UIComponentBase

Returns:

the renderer type.

setRendererType

public void setRendererType(String rendererType)

Description copied from class: jakarta.faces.component.UIComponent

Set the Renderer type for this UIComponent, or null for components that render themselves.

Overrides:

setRendererType in class jakarta.faces.component.UIComponentBase

Parameters:

rendererType - Logical identifier of the type of Renderer to use, or null for components that render themselves

getRendersChildren

public boolean getRendersChildren()

Description copied from class: jakarta.faces.component.UIComponent

Return a flag indicating whether this component is responsible for rendering its child components. The default implementation in UIComponentBase.getRendersChildren() tries to find the renderer for this component. If it does, it calls Renderer.getRendersChildren() and returns the result. If it doesn't, it returns false. As of version 1.2 of the Jakarta Server Faces Specification, component authors are encouraged to return true from this method and rely on UIComponentBase.encodeChildren(jakarta.faces.context.FacesContext).

Overrides:

getRendersChildren in class jakarta.faces.component.UIComponentBase

Returns:

true if the component renders its children, false otherwise.

getChildren

public List<jakarta.faces.component.UIComponent> getChildren()

Description copied from class: jakarta.faces.component.UIComponent

Return a mutable List representing the child UIComponents associated with this component. The returned implementation must support all of the standard and optional List methods, plus support the following additional requirements:

• The List implementation must implement the java.io.Serializable interface.
• Any attempt to add a null must throw a NullPointerException
• Any attempt to add an object that does not implement UIComponent must throw a ClassCastException.
• Whenever a new child component is added, the parent property of the child must be set to this component instance. If the parent property of the child was already non-null, the child must first be removed from its previous parent (where it may have been either a child or a facet).
• Whenever an existing child component is removed, the parent property of the child must be set to null.

• After the child component has been added to the view, Application.publishEvent(jakarta.faces.context.FacesContext, java.lang.Class<? extends jakarta.faces.event.SystemEvent>, java.lang.Object) must be called, passing PostAddToViewEvent.class as the first argument and the newly added component as the second argument if any the following cases are true.

  • FacesContext.getCurrentPhaseId() returns PhaseId.RESTORE_VIEW and partial state saving is enabled.

  • FacesContext.isPostback() returns false and FacesContext.getCurrentPhaseId() returns something other than PhaseId.RESTORE_VIEW

Overrides:

getChildren in class jakarta.faces.component.UIComponentBase

Returns:

the list of children.

getChildCount

public int getChildCount()

Description copied from class: jakarta.faces.component.UIComponent

Return the number of child UIComponents that are associated with this UIComponent. If there are no children, this method must return 0. The method must not cause the creation of a child component list.

Overrides:

getChildCount in class jakarta.faces.component.UIComponentBase

Returns:

the number of child components.

findComponent

public jakarta.faces.component.UIComponent findComponent(String id)

Description copied from class: jakarta.faces.component.UIComponent

Search for and return the UIComponent with an id that matches the specified search expression (if any), according to the algorithm described below.

WARNING: The found UIComponent instance, if any, is returned without regard for its tree traversal context. Retrieving an Jakarta Expression Language-bound attribute from the component is not safe. Jakarta Expression Language expressions can contain implicit objects, such as #{component}, which assume they are being evaluated within the scope of a tree traversal context. Evaluating expressions with these kinds of implicit objects outside of a tree traversal context produces undefined results. See UIComponent.invokeOnComponent(jakarta.faces.context.FacesContext, java.lang.String, jakarta.faces.component.ContextCallback) for a method that does correctly account for the tree traversal context when operating on the found UIComponent instance. UIComponent.invokeOnComponent(jakarta.faces.context.FacesContext, java.lang.String, jakarta.faces.component.ContextCallback) is also useful to find components given a simple clientId.

Component identifiers are required to be unique within the scope of the closest ancestor NamingContainer that encloses this component (which might be this component itself). If there are no NamingContainer components in the ancestry of this component, the root component in the tree is treated as if it were a NamingContainer, whether or not its class actually implements the NamingContainer interface.

A search expression consists of either an identifier (which is matched exactly against the id property of a UIComponent, or a series of such identifiers linked by the UINamingContainer.getSeparatorChar(jakarta.faces.context.FacesContext) character value. The search algorithm should operates as follows, though alternate alogrithms may be used as long as the end result is the same:

• Identify the UIComponent that will be the base for searching, by stopping as soon as one of the following conditions is met:
  • If the search expression begins with the the separator character (called an "absolute" search expression), the base will be the root UIComponent of the component tree. The leading separator character will be stripped off, and the remainder of the search expression will be treated as a "relative" search expression as described below.
  • Otherwise, if this UIComponent is a NamingContainer it will serve as the basis.
  • Otherwise, search up the parents of this component. If a NamingContainer is encountered, it will be the base.
  • Otherwise (if no NamingContainer is encountered) the root UIComponent will be the base.
• The search expression (possibly modified in the previous step) is now a "relative" search expression that will be used to locate the component (if any) that has an id that matches, within the scope of the base component. The match is performed as follows:
  • If the search expression is a simple identifier, this value is compared to the id property, and then recursively through the facets and children of the base UIComponent (except that if a descendant NamingContainer is found, its own facets and children are not searched).
  • If the search expression includes more than one identifier separated by the separator character, the first identifier is used to locate a NamingContainer by the rules in the previous bullet point. Then, the findComponent() method of this NamingContainer will be called, passing the remainder of the search expression.

Overrides:

findComponent in class jakarta.faces.component.UIComponentBase

Parameters:

id - Search expression identifying the UIComponent to be returned

Returns:

the found UIComponent, or null if the component was not found.

getFacets

public Map<String,jakarta.faces.component.UIComponent> getFacets()

Description copied from class: jakarta.faces.component.UIComponent

Return a mutable Map representing the facet UIComponents associated with this UIComponent, keyed by facet name (which must be a String). The returned implementation must support all of the standard and optional Map methods, plus support the following additional requirements:

• The Map implementation must implement the java.io.Serializable interface.
• Any attempt to add a null key or value must throw a NullPointerException.
• Any attempt to add a key that is not a String must throw a ClassCastException.
• Any attempt to add a value that is not a UIComponent must throw a ClassCastException.
• Whenever a new facet UIComponent is added:
  • The parent property of the component must be set to this component instance.
  • If the parent property of the component was already non-null, the component must first be removed from its previous parent (where it may have been either a child or a facet).
• Whenever an existing facet UIComponent is removed:
  • The parent property of the facet must be set to null.

Overrides:

getFacets in class jakarta.faces.component.UIComponentBase

Returns:

the map of facets.

getFacetCount

public int getFacetCount()

Description copied from class: jakarta.faces.component.UIComponent

Return the number of facet UIComponents that are associated with this UIComponent. If there are no facets, this method must return 0. The method must not cause the creation of a facet component map.

For backwards compatability with classes that extend UIComponent directly, a default implementation is provided that simply calls UIComponent.getFacets() and then calls the size() method on the returned Map. A more optimized version of this method is provided in UIComponentBase.getFacetCount().

Overrides:

getFacetCount in class jakarta.faces.component.UIComponentBase

Returns:

the number of facets.

getFacet

public jakarta.faces.component.UIComponent getFacet(String name)

Description copied from class: jakarta.faces.component.UIComponent

Convenience method to return the named facet, if it exists, or null otherwise. If the requested facet does not exist, the facets Map must not be created.

Overrides:

getFacet in class jakarta.faces.component.UIComponentBase

Parameters:

name - Name of the desired facet

Returns:

the component, or null.

getFacetsAndChildren

public Iterator<jakarta.faces.component.UIComponent> getFacetsAndChildren()

Description copied from class: jakarta.faces.component.UIComponent

Return an Iterator over the facet followed by child UIComponents of this UIComponent. Facets are returned in an undefined order, followed by all the children in the order they are stored in the child list. If this component has no facets or children, an empty Iterator is returned.

The returned Iterator must not support the remove() operation.

Overrides:

getFacetsAndChildren in class jakarta.faces.component.UIComponentBase

Returns:

the facets and children iterator.

broadcast

public void broadcast(jakarta.faces.event.FacesEvent event)
               throws jakarta.faces.event.AbortProcessingException

Description copied from class: jakarta.faces.component.UIComponent

Broadcast the specified FacesEvent to all registered event listeners who have expressed an interest in events of this type. Listeners are called in the order in which they were added.

If the event is an instance of BehaviorEvent and the current component is the source of the event call BehaviorEvent.getBehavior() to get the Behavior for the event. Call Behavior.broadcast(jakarta.faces.event.BehaviorEvent) on the Behavior instance.

Overrides:

broadcast in class jakarta.faces.component.UIComponentBase

Parameters:

event - The FacesEvent to be broadcast

Throws:

jakarta.faces.event.AbortProcessingException - Signal the Jakarta Server Faces implementation that no further processing on the current event should be performed

decode

public void decode(jakarta.faces.context.FacesContext faces)

Description copied from class: jakarta.faces.component.UIComponent

Decode any new state of this UIComponent from the request contained in the specified FacesContext, and store this state as needed.

During decoding, events may be enqueued for later processing (by event listeners who have registered an interest), by calling queueEvent().

Overrides:

decode in class jakarta.faces.component.UIComponentBase

Parameters:

faces - FacesContext for the request we are processing

encodeBegin

public void encodeBegin(jakarta.faces.context.FacesContext faces)
                 throws IOException

Description copied from class: jakarta.faces.component.UIComponent

If our rendered property is true, render the beginning of the current state of this UIComponent to the response contained in the specified FacesContext. Call UIComponent.pushComponentToEL(jakarta.faces.context.FacesContext,jakarta.faces.component.UIComponent). Call Application.publishEvent(jakarta.faces.context.FacesContext, java.lang.Class<? extends jakarta.faces.event.SystemEvent>, java.lang.Object), passing PreRenderComponentEvent.class as the first argument and the component instance to be rendered as the second argument.

If a Renderer is associated with this UIComponent, the actual encoding will be delegated to Renderer.encodeBegin(FacesContext, UIComponent).

If our rendered property is false, call UIComponent.pushComponentToEL(jakarta.faces.context.FacesContext,jakarta.faces.component.UIComponent) and return immediately.

Overrides:

encodeBegin in class jakarta.faces.component.UIComponentBase

Parameters:

faces - FacesContext for the response we are creating

Throws:

IOException - if an input/output error occurs while rendering

encodeChildren

public void encodeChildren(jakarta.faces.context.FacesContext faces)
                    throws IOException

Description copied from class: jakarta.faces.component.UIComponent

If our rendered property is true, render the child UIComponents of this UIComponent. This method will only be called if the rendersChildren property is true.

If a Renderer is associated with this UIComponent, the actual encoding will be delegated to Renderer.encodeChildren(FacesContext, UIComponent). If no Renderer is associated with this UIComponent, iterate over each of the children of this component and call UIComponent.encodeAll(jakarta.faces.context.FacesContext).

Overrides:

encodeChildren in class jakarta.faces.component.UIComponentBase

Parameters:

faces - FacesContext for the response we are creating

Throws:

IOException - if an input/output error occurs while rendering

encodeEnd

public void encodeEnd(jakarta.faces.context.FacesContext faces)
               throws IOException

Description copied from class: jakarta.faces.component.UIComponent

If our rendered property is true, render the ending of the current state of this UIComponent.

If a Renderer is associated with this UIComponent, the actual encoding will be delegated to Renderer.encodeEnd(FacesContext, UIComponent).

Call UIComponent.popComponentFromEL(jakarta.faces.context.FacesContext). before returning regardless of the value of the rendered property.

Overrides:

encodeEnd in class jakarta.faces.component.UIComponentBase

Parameters:

faces - FacesContext for the response we are creating

Throws:

IOException - if an input/output error occurs while rendering

encodeAll

public void encodeAll(jakarta.faces.context.FacesContext faces)
               throws IOException

Description copied from class: jakarta.faces.component.UIComponent

If this component returns true from UIComponent.isRendered(), take the following action.

Render this component and all its children that return true from isRendered(), regardless of the value of the UIComponent.getRendersChildren() flag.

Overrides:

encodeAll in class jakarta.faces.component.UIComponent

Parameters:

faces - the Faces context.

Throws:

IOException - if an input/output error occurs while rendering

addFacesListener

protected void addFacesListener(jakarta.faces.event.FacesListener faces)

Description copied from class: jakarta.faces.component.UIComponentBase

Add the specified FacesListener to the set of listeners registered to receive event notifications from this UIComponent. It is expected that UIComponent classes acting as event sources will have corresponding typesafe APIs for registering listeners of the required type, and the implementation of those registration methods will delegate to this method. For example:

 public class FooEvent extends FacesEvent {
   ...
   protected boolean isAppropriateListener(FacesListener listener) {
     return (listener instanceof FooListener);
   }
   protected void processListener(FacesListener listener) {
     ((FooListener) listener).processFoo(this);
   }
   ...
 }

 public interface FooListener extends FacesListener {
   public void processFoo(FooEvent event);
 }

 public class FooComponent extends UIComponentBase {
   ...
   public void addFooListener(FooListener listener) {
     addFacesListener(listener);
   }
   public void removeFooListener(FooListener listener) {
     removeFacesListener(listener);
   }
   ...
 }
 

Overrides:

addFacesListener in class jakarta.faces.component.UIComponentBase

Parameters:

faces - The FacesListener to be registered

getFacesListeners

protected jakarta.faces.event.FacesListener[] getFacesListeners(Class faces)

Description copied from class: jakarta.faces.component.UIComponent

Return an array of registered FacesListeners that are instances of the specified class. If there are no such registered listeners, a zero-length array is returned. The returned array can be safely be cast to an array strongly typed to an element type of clazz.

Overrides:

getFacesListeners in class jakarta.faces.component.UIComponentBase

Parameters:

faces - Class that must be implemented by a FacesListener for it to be returned

Returns:

the Faces listeners, or a zero-length array.

removeFacesListener

protected void removeFacesListener(jakarta.faces.event.FacesListener faces)

Description copied from class: jakarta.faces.component.UIComponentBase

Remove the specified FacesListener from the set of listeners registered to receive event notifications from this UIComponent.

Overrides:

removeFacesListener in class jakarta.faces.component.UIComponentBase

Parameters:

faces - The FacesListener to be deregistered

queueEvent

public void queueEvent(jakarta.faces.event.FacesEvent event)

Description copied from class: jakarta.faces.component.UIComponent

Queue an event for broadcast at the end of the current request processing lifecycle phase. The default implementation in UIComponentBase must delegate this call to the queueEvent() method of the parent UIComponent.

Overrides:

queueEvent in class jakarta.faces.component.UIComponentBase

Parameters:

event - FacesEvent to be queued

processDecodes

public void processDecodes(jakarta.faces.context.FacesContext faces)

Description copied from class: jakarta.faces.component.UIComponent

Perform the component tree processing required by the Apply Request Values phase of the request processing lifecycle for all facets of this component, all children of this component, and this component itself, as follows.

• If the rendered property of this UIComponent is false, skip further processing.
• Call UIComponent.pushComponentToEL(jakarta.faces.context.FacesContext, jakarta.faces.component.UIComponent).
• Call the processDecodes() method of all facets and children of this UIComponent, in the order determined by a call to getFacetsAndChildren().
• Call the decode() method of this component.
• Call UIComponent.popComponentFromEL(jakarta.faces.context.FacesContext) from inside of a finally block, just before returning.
• If a RuntimeException is thrown during decode processing, call FacesContext.renderResponse() and re-throw the exception.

Overrides:

processDecodes in class jakarta.faces.component.UIComponentBase

Parameters:

faces - FacesContext for the request we are processing

processValidators

public void processValidators(jakarta.faces.context.FacesContext faces)

Description copied from class: jakarta.faces.component.UIComponent

Perform the component tree processing required by the Process Validations phase of the request processing lifecycle for all facets of this component, all children of this component, and this component itself, as follows.

• If the rendered property of this UIComponent is false, skip further processing.
• Call UIComponent.pushComponentToEL(jakarta.faces.context.FacesContext, jakarta.faces.component.UIComponent).
• Call the processValidators() method of all facets and children of this UIComponent, in the order determined by a call to getFacetsAndChildren().
• After returning from calling getFacetsAndChildren() call UIComponent.popComponentFromEL(jakarta.faces.context.FacesContext).

Overrides:

processValidators in class jakarta.faces.component.UIComponentBase

Parameters:

faces - FacesContext for the request we are processing

See Also:

PreValidateEvent, PostValidateEvent

processUpdates

public void processUpdates(jakarta.faces.context.FacesContext faces)

Description copied from class: jakarta.faces.component.UIComponent

Perform the component tree processing required by the Update Model Values phase of the request processing lifecycle for all facets of this component, all children of this component, and this component itself, as follows.

• If the rendered property of this UIComponent is false, skip further processing.
• Call UIComponent.pushComponentToEL(jakarta.faces.context.FacesContext, jakarta.faces.component.UIComponent).
• Call the processUpdates() method of all facets and children of this UIComponent, in the order determined by a call to getFacetsAndChildren(). After returning from the processUpdates() method on a child or facet, call UIComponent.popComponentFromEL(jakarta.faces.context.FacesContext)

Overrides:

processUpdates in class jakarta.faces.component.UIComponentBase

Parameters:

faces - FacesContext for the request we are processing

getFacesContext

protected jakarta.faces.context.FacesContext getFacesContext()

Description copied from class: jakarta.faces.component.UIComponent

Convenience method to return the FacesContext instance for the current request.

Overrides:

getFacesContext in class jakarta.faces.component.UIComponentBase

Returns:

the Faces context.

getRenderer

protected jakarta.faces.render.Renderer getRenderer(jakarta.faces.context.FacesContext faces)

Description copied from class: jakarta.faces.component.UIComponent

Convenience method to return the Renderer instance associated with this component, if any; otherwise, return null.

Overrides:

getRenderer in class jakarta.faces.component.UIComponentBase

Parameters:

faces - FacesContext for the current request

Returns:

the renderer, or null.

isTransient

public boolean isTransient()

Description copied from interface: jakarta.faces.component.StateHolder

If true, the Object implementing this interface must not participate in state saving or restoring.

Specified by:

isTransient in interface jakarta.faces.component.StateHolder

Overrides:

isTransient in class jakarta.faces.component.UIComponentBase

Returns:

true if transient, false otherwise.

setTransient

public void setTransient(boolean tranzient)

Description copied from interface: jakarta.faces.component.StateHolder

Denotes whether or not the Object implementing this interface must or must not participate in state saving or restoring.

Specified by:

setTransient in interface jakarta.faces.component.StateHolder

Overrides:

setTransient in class jakarta.faces.component.UIComponentBase

Parameters:

tranzient - boolean pass true if this Object will not participate in state saving or restoring, otherwise pass false.