javax.faces.component
Class UIComponent

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

All Implemented Interfaces:

StateHolder

Direct Known Subclasses:

UIComponentBase

public abstract class UIComponent
extends Object
implements StateHolder

A base class for all JSF component classes.

See Javadoc of JSF Specification

Version:

$Revision: 676278 $ $Date: 2008-07-13 03:35:04 -0500 (Sun, 13 Jul 2008) $

Author:

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

Constructor Summary

UIComponent()

Method Summary

protected abstract void	addFacesListener(FacesListener listener)
abstract void	broadcast(FacesEvent event)
abstract void	decode(FacesContext context)
abstract void	encodeBegin(FacesContext context)
abstract void	encodeChildren(FacesContext context)
abstract void	encodeEnd(FacesContext context)
abstract UIComponent	findComponent(String expr)
abstract Map	getAttributes()
abstract int	getChildCount()
abstract List	getChildren()
abstract String	getClientId(FacesContext context)
protected abstract FacesContext	getFacesContext()
protected abstract FacesListener[]	getFacesListeners(Class clazz)
abstract UIComponent	getFacet(String name)
abstract Map	getFacets()
abstract Iterator	getFacetsAndChildren()
abstract String	getFamily()
abstract String	getId()
abstract UIComponent	getParent()
protected abstract Renderer	getRenderer(FacesContext context)
abstract String	getRendererType()
abstract boolean	getRendersChildren()
abstract ValueBinding	getValueBinding(String name)
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)

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

Constructor Detail

UIComponent

public UIComponent()

Method Detail

getAttributes

public abstract Map getAttributes()

getValueBinding

public abstract ValueBinding getValueBinding(String name)

setValueBinding

public abstract void setValueBinding(String name,
                                     ValueBinding binding)

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

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

getChildCount

public abstract int getChildCount()

findComponent

public abstract UIComponent findComponent(String expr)

getFacets

public abstract Map getFacets()

getFacet

public abstract UIComponent getFacet(String name)

getFacetsAndChildren

public abstract Iterator 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

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)