javax.faces.component
Class UIComponent

java.lang.Object
  javax.faces.component.UIComponent

All Implemented Interfaces:

StateHolder

Direct Known Subclasses:

UIComponentBase

@JSFComponent(type="javax.faces.Component",
              family="javax.faces.Component",
              desc="abstract base component",
              configExcluded=true)
public abstract class UIComponent
extends Object
implements StateHolder

see Javadoc of JSF Specification

Version:

$Revision: 676298 $ $Date: 2008-07-13 05:31:48 -0500 (Sun, 13 Jul 2008) $

Author:

Manfred Geiler (latest modification by $Author: skitching $)

Field Summary

protected Map<String,javax.el.ValueExpression>

bindings

Constructor Summary

UIComponent()

Method Summary

protected abstract void	addFacesListener(FacesListener listener)
abstract void	broadcast(FacesEvent event)
abstract void	decode(FacesContext context)
void	encodeAll(FacesContext context)
abstract void	encodeBegin(FacesContext context)
abstract void	encodeChildren(FacesContext context)
abstract void	encodeEnd(FacesContext context)
abstract UIComponent	findComponent(String expr)
abstract Map<String,Object>	getAttributes()
abstract int	getChildCount()
abstract List<UIComponent>	getChildren()
abstract String	getClientId(FacesContext context)
String	getContainerClientId(FacesContext ctx)
protected abstract FacesContext	getFacesContext()
protected abstract FacesListener[]	getFacesListeners(Class clazz)
abstract UIComponent	getFacet(String name)
int	getFacetCount()
abstract Map<String,UIComponent>	getFacets()
abstract Iterator<UIComponent>	getFacetsAndChildren()
abstract String	getFamily()
abstract String	getId()
abstract UIComponent	getParent() Returns the parent of the component.
protected abstract Renderer	getRenderer(FacesContext context)
abstract String	getRendererType()
abstract boolean	getRendersChildren()
abstract ValueBinding	getValueBinding(String name) Deprecated. Replaced by getValueExpression
javax.el.ValueExpression	getValueExpression(String name)
boolean	invokeOnComponent(FacesContext context, String clientId, ContextCallback callback) Invokes the invokeContextCallback method with the component, specified by clientId.
abstract boolean	isRendered()
abstract void	processDecodes(FacesContext context)
abstract void	processRestoreState(FacesContext context, Object state)
abstract Object	processSaveState(FacesContext context)
abstract void	processUpdates(FacesContext context)
abstract void	processValidators(FacesContext context)
abstract void	queueEvent(FacesEvent event)
protected abstract void	removeFacesListener(FacesListener listener)
abstract void	setId(String id)
abstract void	setParent(UIComponent parent) For JSF-framework internal use only.
abstract void	setRendered(boolean rendered)
abstract void	setRendererType(String rendererType)
abstract void	setValueBinding(String name, ValueBinding binding) Deprecated. Replaced by setValueExpression
void	setValueExpression(String name, javax.el.ValueExpression expression)

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.faces.component.StateHolder

isTransient, restoreState, saveState, setTransient

Field Detail

bindings

protected Map<String,javax.el.ValueExpression> bindings

Constructor Detail

UIComponent

public UIComponent()

Method Detail

getAttributes

public abstract Map<String,Object> getAttributes()

getValueBinding

public abstract ValueBinding getValueBinding(String name)

Deprecated. Replaced by getValueExpression

getValueExpression

public javax.el.ValueExpression getValueExpression(String name)

setValueBinding

public abstract void setValueBinding(String name,
                                     ValueBinding binding)

Deprecated. Replaced by setValueExpression

setValueExpression

public void setValueExpression(String name,
                               javax.el.ValueExpression expression)

invokeOnComponent

public boolean invokeOnComponent(FacesContext context,
                                 String clientId,
                                 ContextCallback callback)
                          throws FacesException

Invokes the invokeContextCallback method with the component, specified by clientId.

Parameters:

context - FacesContext for the current request

clientId - the id of the desired UIComponent clazz

callback - Implementation of the ContextCallback to be called

Returns:

has component been found ?

Throws:

FacesException

getClientId

public abstract String getClientId(FacesContext context)

getFamily

public abstract String getFamily()

getId

public abstract String getId()

setId

public abstract void setId(String id)

getParent

public abstract UIComponent getParent()

Returns the parent of the component. Children can be added to or removed from a component even if this method returns null for the child.

setParent

public abstract void setParent(UIComponent parent)

For JSF-framework internal use only. Don't call this method to add components to the component tree. Use parent.getChildren().add(child) instead.

isRendered

public abstract boolean isRendered()

setRendered

public abstract void setRendered(boolean rendered)

getRendererType

public abstract String getRendererType()

setRendererType

public abstract void setRendererType(String rendererType)

getRendersChildren

public abstract boolean getRendersChildren()

getChildren

public abstract List<UIComponent> getChildren()

getChildCount

public abstract int getChildCount()

findComponent

public abstract UIComponent findComponent(String expr)

getFacets

public abstract Map<String,UIComponent> getFacets()

getFacet

public abstract UIComponent getFacet(String name)

getFacetsAndChildren

public abstract Iterator<UIComponent> getFacetsAndChildren()

broadcast

public abstract void broadcast(FacesEvent event)
                        throws AbortProcessingException

Throws:

AbortProcessingException

decode

public abstract void decode(FacesContext context)

encodeBegin

public abstract void encodeBegin(FacesContext context)
                          throws IOException

Throws:

IOException

encodeChildren

public abstract void encodeChildren(FacesContext context)
                             throws IOException

Throws:

IOException

encodeEnd

public abstract void encodeEnd(FacesContext context)
                        throws IOException

Throws:

IOException

encodeAll

public void encodeAll(FacesContext context)
               throws IOException

Throws:

IOException

addFacesListener

protected abstract void addFacesListener(FacesListener listener)

getFacesListeners

protected abstract FacesListener[] getFacesListeners(Class clazz)

removeFacesListener

protected abstract void removeFacesListener(FacesListener listener)

queueEvent

public abstract void queueEvent(FacesEvent event)

processRestoreState

public abstract void processRestoreState(FacesContext context,
                                         Object state)

processDecodes

public abstract void processDecodes(FacesContext context)

processValidators

public abstract void processValidators(FacesContext context)

processUpdates

public abstract void processUpdates(FacesContext context)

processSaveState

public abstract Object processSaveState(FacesContext context)

getFacesContext

protected abstract FacesContext getFacesContext()

getRenderer

protected abstract Renderer getRenderer(FacesContext context)

getFacetCount

public int getFacetCount()

Since:

1.2

getContainerClientId

public String getContainerClientId(FacesContext ctx)

Since:

1.2