Top Fields Constructors Methods
com.sun.faces.facelets.compiler

public Class UILeaf

extends UIComponentBase
implements UntargetableComponent
Class Inheritance
All Implemented Interfaces
javax.faces.component.search.UntargetableComponent
Known Direct Subclasses
com.sun.faces.facelets.compiler.UILiteralText, com.sun.faces.facelets.compiler.UIText, com.sun.faces.facelets.compiler.UIInstructions
Annotations
@SuppressWarnings:deprecation
Imports
javax.el.ValueExpression, javax.faces.component.UIComponent, .UIComponentBase, javax.faces.context.FacesContext, javax.faces.el.ValueBinding, javax.faces.event.AbortProcessingException, .FacesEvent, .FacesListener, javax.faces.render.Renderer, java.io.IOException, java.util.Collections, .HashMap, .Iterator, .List, .Map, javax.faces.component.search.UntargetableComponent

Field Summary

Modifier and TypeField and Description
private static final Map<String, UIComponent>
facets

Hides javax.faces.component.UIComponentBase.facets.

private UIComponent
parent

Hides javax.faces.component.UIComponentBase.parent.

private boolean
returnLocalTransient

Constructor Summary

AccessConstructor and Description
public
UILeaf()

Method Summary

Modifier and TypeMethod and Description
protected void
addFacesListener(FacesListener
The FacesListener to be registered
faces)

Overrides javax.faces.component.UIComponentBase.addFacesListener.

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

public void
broadcast(FacesEvent
The FacesEvent to be broadcast
event)

Overrides javax.faces.component.UIComponentBase.broadcast.

Broadcast the specified FacesEvent to all registered event listeners who have expressed an interest in events of this type.

public void
decode(FacesContext
FacesContext for the request we are processing
faces)

Overrides javax.faces.component.UIComponentBase.decode.

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

public void
encodeAll(FacesContext
the Faces context.
faces)

Overrides javax.faces.component.UIComponent.encodeAll.

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

public void
encodeBegin(FacesContext
FacesContext for the response we are creating
faces)

Overrides javax.faces.component.UIComponentBase.encodeBegin.

If our rendered property is true, render the beginning of the current state of this UIComponent to the response contained in the specified FacesContext.

public void
encodeChildren(FacesContext
FacesContext for the response we are creating
faces)

Overrides javax.faces.component.UIComponentBase.encodeChildren.

If our rendered property is true, render the child UIComponents of this UIComponent.

public void
encodeEnd(FacesContext
FacesContext for the response we are creating
faces)

Overrides javax.faces.component.UIComponentBase.encodeEnd.

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

public UIComponent
findComponent(String
Search expression identifying the UIComponent to be returned
id)

Overrides javax.faces.component.UIComponentBase.findComponent.

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

public int
getChildCount()

Overrides javax.faces.component.UIComponentBase.getChildCount.

Return the number of child UIComponents that are associated with this UIComponent.

public List<UIComponent>
getChildren()

Overrides javax.faces.component.UIComponentBase.getChildren.

Return a mutable List representing the child UIComponents associated with this component.

protected FacesContext
getFacesContext()

Overrides javax.faces.component.UIComponentBase.getFacesContext.

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

protected FacesListener[]
getFacesListeners(Class<T>
Class that must be implemented by a FacesListener for it to be returned
faces)

Overrides javax.faces.component.UIComponentBase.getFacesListeners.

Return an array of registered FacesListeners that are instances of the specified class.

public UIComponent
getFacet(String
Name of the desired facet
name)

Overrides javax.faces.component.UIComponentBase.getFacet.

Convenience method to return the named facet, if it exists, or null otherwise.

public int
getFacetCount()

Overrides javax.faces.component.UIComponentBase.getFacetCount.

Return the number of facet UIComponents that are associated with this UIComponent.

public Map<String, UIComponent>
getFacets()

Overrides javax.faces.component.UIComponentBase.getFacets.

Return a mutable Map representing the facet UIComponents associated with this UIComponent, keyed by facet name (which must be a String).

public Iterator<UIComponent>
getFacetsAndChildren()

Overrides javax.faces.component.UIComponentBase.getFacetsAndChildren.

Return an Iterator over the facet followed by child UIComponents of this UIComponent.

public String
getFamily()

Implements abstract javax.faces.component.UIComponent.getFamily.

Return the identifier of the component family to which this component belongs.

public UIComponent
getParent()

Overrides javax.faces.component.UIComponentBase.getParent.

Return the parent UIComponent of this UIComponent, if any.

protected Renderer
getRenderer(FacesContext
FacesContext for the current request
faces)

Overrides javax.faces.component.UIComponentBase.getRenderer.

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

public String
getRendererType()

Overrides javax.faces.component.UIComponentBase.getRendererType.

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

public boolean
getRendersChildren()

Overrides javax.faces.component.UIComponentBase.getRendersChildren.

Return a flag indicating whether this component is responsible for rendering its child components.

public ValueBinding
getValueBinding(String
Name of the attribute or property for which to retrieve a ValueBinding
binding)

Overrides javax.faces.component.UIComponentBase.getValueBinding.

Deprecated as a consequence of ValueBinding being deprecated.

Call through to getValueExpression and examine the result.

public ValueExpression
getValueExpression(String
Name of the attribute or property for which to retrieve a ValueExpression
name)

Overrides javax.faces.component.UIComponent.getValueExpression.

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

public boolean
isTransient()

Overrides javax.faces.component.UIComponentBase.isTransient.

Implements javax.faces.component.StateHolder.isTransient.

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

public void
processDecodes(FacesContext
FacesContext for the request we are processing
faces)

Overrides javax.faces.component.UIComponentBase.processDecodes.

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.

public void
processUpdates(FacesContext
FacesContext for the request we are processing
faces)

Overrides javax.faces.component.UIComponentBase.processUpdates.

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.

public void
processValidators(FacesContext
FacesContext for the request we are processing
faces)

Overrides javax.faces.component.UIComponentBase.processValidators.

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.

public void
queueEvent(FacesEvent
FacesEvent to be queued
event)

Overrides javax.faces.component.UIComponentBase.queueEvent.

Queue an event for broadcast at the end of the current request processing lifecycle phase.

protected void
removeFacesListener(FacesListener
The FacesListener to be deregistered
faces)

Overrides javax.faces.component.UIComponentBase.removeFacesListener.

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

public void
setParent(UIComponent
The new parent, or null for the root node of a component tree
parent)

Overrides javax.faces.component.UIComponentBase.setParent.

Set the parent UIComponent of this UIComponent.

public void
setRendererType(String
Logical identifier of the type of Renderer to use, or null for components that render themselves
rendererType)

Overrides javax.faces.component.UIComponentBase.setRendererType.

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

public void
setTransient(boolean
boolean pass true if this Object will not participate in state saving or restoring, otherwise pass false.
tranzient)

Overrides javax.faces.component.UIComponentBase.setTransient.

Implements javax.faces.component.StateHolder.setTransient.

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

public void
setValueBinding(String
Name of the attribute or property for which to set a ValueBinding
name, ValueBinding
The ValueBinding to set, or null to remove any currently set ValueBinding
binding)

Overrides javax.faces.component.UIComponentBase.setValueBinding.

Deprecated as a consequence of ValueBinding being deprecated.

Wrap the argument binding in an implementation of ValueExpression and call through to setValueExpression.

public void
setValueExpression(String
Name of the attribute or property for which to set a ValueExpression
name, ValueExpression
The ValueExpression to set, or null to remove any currently set ValueExpression
arg1)

Overrides javax.faces.component.UIComponent.setValueExpression.

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

Inherited from javax.faces.component.UIComponentBase:
addClientBehaviorclearInitialStategetAttributesgetClientBehaviorsgetClientIdgetDefaultEventNamegetEventNamesgetIdgetListenersForEventClassgetPassThroughAttributesinvokeOnComponentisRenderedmarkInitialStateprocessRestoreStateprocessSaveStaterestoreAttachedStaterestoreStatesaveAttachedStatesaveStatesetIdsetRenderedsubscribeToEventunsubscribeFromEvent

Field Detail

facetsback to summary
private static final Map<String, UIComponent> facets

Hides javax.faces.component.UIComponentBase.facets.

parentback to summary
private UIComponent parent

Hides javax.faces.component.UIComponentBase.parent.

returnLocalTransientback to summary
private boolean returnLocalTransient

Constructor Detail

UILeafback to summary
public UILeaf()

Method Detail

addFacesListenerback to summary
protected void addFacesListener(FacesListener faces)

Overrides javax.faces.component.UIComponentBase.addFacesListener.

Doc from javax.faces.component.UIComponentBase.addFacesListener.

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);
  }
  ...
}
Parameters
faces:FacesListener

The FacesListener to be registered

Annotations
@Override
broadcastback to summary
public void broadcast(FacesEvent event) throws AbortProcessingException

Overrides javax.faces.component.UIComponentBase.broadcast.

Doc from javax.faces.component.UIComponent.broadcast.

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 javax.faces.event.BehaviorEvent and the current component is the source of the event call javax.faces.event.BehaviorEvent#getBehavior to get the javax.faces.component.behavior.Behavior for the event. Call javax.faces.component.behavior.Behavior#broadcast(javax.faces.event.BehaviorEvent) on the Behavior instance.

Parameters
event:FacesEvent

The FacesEvent to be broadcast

Annotations
@Override
Exceptions
AbortProcessingException:

Doc from javax.faces.component.UIComponentBase.broadcast.

Signal the JavaServer Faces implementation that no further processing on the current event should be performed

decodeback to summary
public void decode(FacesContext faces)

Overrides javax.faces.component.UIComponentBase.decode.

Doc from javax.faces.component.UIComponent.decode.

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().

Parameters
faces:FacesContext

FacesContext for the request we are processing

Annotations
@Override
encodeAllback to summary
public void encodeAll(FacesContext faces) throws IOException

Overrides javax.faces.component.UIComponent.encodeAll.

Doc from javax.faces.component.UIComponent.encodeAll.

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

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

Parameters
faces:FacesContext

the Faces context.

Annotations
@Override
Exceptions
IOException:
if an input/output error occurs while rendering
encodeBeginback to summary
public void encodeBegin(FacesContext faces) throws IOException

Overrides javax.faces.component.UIComponentBase.encodeBegin.

Doc from javax.faces.component.UIComponent.encodeBegin.

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 pushComponentToEL(javax.faces.context.FacesContext, javax.faces.component.UIComponent). Call javax.faces.application.Application#publishEvent, passing javax.faces.event.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 pushComponentToEL(javax.faces.context.FacesContext, javax.faces.component.UIComponent) and return immediately.

Parameters
faces:FacesContext

FacesContext for the response we are creating

Annotations
@Override
Exceptions
IOException:
if an input/output error occurs while rendering
encodeChildrenback to summary
public void encodeChildren(FacesContext faces) throws IOException

Overrides javax.faces.component.UIComponentBase.encodeChildren.

Doc from javax.faces.component.UIComponent.encodeChildren.

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 encodeAll(javax.faces.context.FacesContext).

Parameters
faces:FacesContext

FacesContext for the response we are creating

Annotations
@Override
Exceptions
IOException:
if an input/output error occurs while rendering
encodeEndback to summary
public void encodeEnd(FacesContext faces) throws IOException

Overrides javax.faces.component.UIComponentBase.encodeEnd.

Doc from javax.faces.component.UIComponent.encodeEnd.

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. before returning regardless of the value of the rendered property.

Parameters
faces:FacesContext

FacesContext for the response we are creating

Annotations
@Override
Exceptions
IOException:

Doc from javax.faces.component.UIComponentBase.encodeEnd.

if an input/output error occurs while rendering

findComponentback to summary
public UIComponent findComponent(String id)

Overrides javax.faces.component.UIComponentBase.findComponent.

Doc from javax.faces.component.UIComponent.findComponent.

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 EL-bound attribute from the component is not safe. EL 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 invokeOnComponent for a method that does correctly account for the tree traversal context when operating on the found UIComponent instance. invokeOnComponent 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 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.
Parameters
id:String

Search expression identifying the UIComponent to be returned

Returns:UIComponent

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

Annotations
@Override
getChildCountback to summary
public int getChildCount()

Overrides javax.faces.component.UIComponentBase.getChildCount.

Doc from javax.faces.component.UIComponent.getChildCount.

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.

Returns:int

the number of child components.

Annotations
@Override
getChildrenback to summary
public List<UIComponent> getChildren()

Overrides javax.faces.component.UIComponentBase.getChildren.

Doc from javax.faces.component.UIComponent.getChildren.

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:

Returns:List<UIComponent>

the list of children.

Annotations
@Override
getFacesContextback to summary
protected FacesContext getFacesContext()

Overrides javax.faces.component.UIComponentBase.getFacesContext.

Doc from javax.faces.component.UIComponent.getFacesContext.

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

Returns:FacesContext

the Faces context.

Annotations
@Override
getFacesListenersback to summary
protected FacesListener[] getFacesListeners(Class<T> faces)

Overrides javax.faces.component.UIComponentBase.getFacesListeners.

Doc from javax.faces.component.UIComponent.getFacesListeners.

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.

Parameters
faces:Class<T>

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

Returns:FacesListener[]

the Faces listeners, or a zero-length array.

Annotations
@Override
getFacetback to summary
public UIComponent getFacet(String name)

Overrides javax.faces.component.UIComponentBase.getFacet.

Doc from javax.faces.component.UIComponent.getFacet.

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.

Parameters
name:String

Name of the desired facet

Returns:UIComponent

the component, or null.

Annotations
@Override
getFacetCountback to summary
public int getFacetCount()

Overrides javax.faces.component.UIComponentBase.getFacetCount.

Doc from javax.faces.component.UIComponent.getFacetCount.

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 getFacets and then calls the size() method on the returned Map. A more optimized version of this method is provided in UIComponentBase#getFacetCount.

Returns:int

the number of facets.

Annotations
@Override
getFacetsback to summary
public Map<String, UIComponent> getFacets()

Overrides javax.faces.component.UIComponentBase.getFacets.

Doc from javax.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). 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.
Returns:Map<String, UIComponent>

the map of facets.

Annotations
@Override
getFacetsAndChildrenback to summary
public Iterator<UIComponent> getFacetsAndChildren()

Overrides javax.faces.component.UIComponentBase.getFacetsAndChildren.

Doc from javax.faces.component.UIComponent.getFacetsAndChildren.

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.

Returns:Iterator<UIComponent>

the facets and children iterator.

Annotations
@Override
getFamilyback to summary
public String getFamily()

Implements abstract javax.faces.component.UIComponent.getFamily.

Doc from javax.faces.component.UIComponent.getFamily.

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

Returns:String

the component family (not null).

Annotations
@Override
getParentback to summary
public UIComponent getParent()

Overrides javax.faces.component.UIComponentBase.getParent.

Doc from javax.faces.component.UIComponent.getParent.

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( ).

Returns:UIComponent

the parent component.

Annotations
@Override
getRendererback to summary
protected Renderer getRenderer(FacesContext faces)

Overrides javax.faces.component.UIComponentBase.getRenderer.

Doc from javax.faces.component.UIComponent.getRenderer.

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

Parameters
faces:FacesContext

FacesContext for the current request

Returns:Renderer

the renderer, or null.

Annotations
@Override
getRendererTypeback to summary
public String getRendererType()

Overrides javax.faces.component.UIComponentBase.getRendererType.

Doc from javax.faces.component.UIComponent.getRendererType.

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

Returns:String

the renderer type.

Annotations
@Override
getRendersChildrenback to summary
public boolean getRendersChildren()

Overrides javax.faces.component.UIComponentBase.getRendersChildren.

Doc from javax.faces.component.UIComponent.getRendersChildren.

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 JavaServer Faces Specification, component authors are encouraged to return true from this method and rely on UIComponentBase#encodeChildren.

Returns:boolean

true if the component renders its children, false otherwise.

Annotations
@Override
getValueBindingback to summary
public ValueBinding getValueBinding(String binding)

Overrides javax.faces.component.UIComponentBase.getValueBinding.

Doc from javax.faces.component.UIComponentBase.getValueBinding.

Deprecated

as a consequence of ValueBinding being deprecated. See corresponding docs for further information.

Call through to getValueExpression and examine the result. If the result is an instance of the wrapper class mandated in setValueBinding, extract the ValueBinding instance and return it. Otherwise, wrap the result in an implementation of ValueBinding, and return it.

Parameters
binding:String

Doc from javax.faces.component.UIComponent.getValueBinding.

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

Returns:ValueBinding

Doc from javax.faces.component.UIComponent.getValueBinding.

the value binding.

Annotations
@Override
getValueExpressionback to summary
public ValueExpression getValueExpression(String name)

Overrides javax.faces.component.UIComponent.getValueExpression.

Doc from javax.faces.component.UIComponent.getValueExpression.

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 JSF 1.2 and later.

Parameters
name:String

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

Returns:ValueExpression

the value expression, or null.

Annotations
@Override
isTransientback to summary
public boolean isTransient()

Overrides javax.faces.component.UIComponentBase.isTransient.

Implements javax.faces.component.StateHolder.isTransient.

Doc from javax.faces.component.StateHolder.isTransient.

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

Returns:boolean

true if transient, false otherwise.

Annotations
@Override
processDecodesback to summary
public void processDecodes(FacesContext faces)

Overrides javax.faces.component.UIComponentBase.processDecodes.

Doc from javax.faces.component.UIComponent.processDecodes.

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 pushComponentToEL.
  • 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 popComponentFromEL 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.
Parameters
faces:FacesContext

FacesContext for the request we are processing

Annotations
@Override
processUpdatesback to summary
public void processUpdates(FacesContext faces)

Overrides javax.faces.component.UIComponentBase.processUpdates.

Doc from javax.faces.component.UIComponent.processUpdates.

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 pushComponentToEL.
  • 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
Parameters
faces:FacesContext

FacesContext for the request we are processing

Annotations
@Override
processValidatorsback to summary
public void processValidators(FacesContext faces)

Overrides javax.faces.component.UIComponentBase.processValidators.

Doc from javax.faces.component.UIComponent.processValidators.

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.

Parameters
faces:FacesContext

FacesContext for the request we are processing

Annotations
@Override
queueEventback to summary
public void queueEvent(FacesEvent event)

Overrides javax.faces.component.UIComponentBase.queueEvent.

Doc from javax.faces.component.UIComponent.queueEvent.

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.

Parameters
event:FacesEvent

FacesEvent to be queued

Annotations
@Override
removeFacesListenerback to summary
protected void removeFacesListener(FacesListener faces)

Overrides javax.faces.component.UIComponentBase.removeFacesListener.

Doc from javax.faces.component.UIComponentBase.removeFacesListener.

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

Parameters
faces:FacesListener

The FacesListener to be deregistered

Annotations
@Override
setParentback to summary
public void setParent(UIComponent parent)

Overrides javax.faces.component.UIComponentBase.setParent.

Doc from javax.faces.component.UIComponent.setParent.

Set the parent UIComponent of this UIComponent. If parent.isInView() returns true, calling this method will first cause a javax.faces.event.PreRemoveFromViewEvent to be published, for this node, and then the children of this node. Then, once the re-parenting has occurred, a javax.faces.event.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.

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.

Parameters
parent:UIComponent

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

Annotations
@Override
setRendererTypeback to summary
public void setRendererType(String rendererType)

Overrides javax.faces.component.UIComponentBase.setRendererType.

Doc from javax.faces.component.UIComponent.setRendererType.

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

Parameters
rendererType:String

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

Annotations
@Override
setTransientback to summary
public void setTransient(boolean tranzient)

Overrides javax.faces.component.UIComponentBase.setTransient.

Implements javax.faces.component.StateHolder.setTransient.

Doc from javax.faces.component.StateHolder.setTransient.

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

Parameters
tranzient:boolean

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

Annotations
@Override
setValueBindingback to summary
public void setValueBinding(String name, ValueBinding binding)

Overrides javax.faces.component.UIComponentBase.setValueBinding.

Doc from javax.faces.component.UIComponentBase.setValueBinding.

Deprecated

as a consequence of ValueBinding being deprecated. See corresponding docs for further information.

Wrap the argument binding in an implementation of ValueExpression and call through to setValueExpression.

Parameters
name:String

Doc from javax.faces.component.UIComponent.setValueBinding.

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

binding:ValueBinding

Doc from javax.faces.component.UIComponent.setValueBinding.

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

Annotations
@Override
setValueExpressionback to summary
public void setValueExpression(String name, ValueExpression arg1)

Overrides javax.faces.component.UIComponent.setValueExpression.

Doc from javax.faces.component.UIComponent.setValueExpression.

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

The implementation must call ValueExpression#isLiteralText on the argument expression. If isLiteralText() returns true, invoke ValueExpression#getValue on the argument expression and pass the result as the value parameter in a call to this.getAttributes().put(name, value) where name is the argument name. If an exception is thrown as a result of calling ValueExpression#getValue, wrap it in a javax.faces.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 JSF 1.2 and later.

Parameters
name:String

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

arg1:ValueExpression

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

Annotations
@Override