oracle.adf.view.faces.component
Class UIXComponentBase

java.lang.Object
  javax.faces.component.UIComponent
      oracle.adf.view.faces.component.UIXComponent
          oracle.adf.view.faces.component.UIXComponentBase

All Implemented Interfaces:

StateHolder

Direct Known Subclasses:

CoreImportScript, CoreStyleSheet, HtmlBody, HtmlCellFormat, HtmlFrame, HtmlFrameBorderLayout, HtmlHead, HtmlHtml, HtmlRowLayout, HtmlScript, HtmlTableLayout, UIXChoose, UIXCollection, UIXColumn, UIXCommand, UIXDocument, UIXForm, UIXGo, UIXMessage, UIXMessages, UIXObject, UIXPanel, UIXPoll, UIXProgress, UIXRegion, UIXReset, UIXSelectItem, UIXSelectRange, UIXShowDetail, UIXShowOne, UIXSingleStep, UIXSubform, UIXSwitcher, UIXTableSelectMany, UIXTableSelectOne, UIXValue

public abstract class UIXComponentBase

extends UIXComponent

Field Summary

static PropertyKey	BINDING_KEY
static PropertyKey	ID_KEY
static PropertyKey	RENDERED_KEY
static PropertyKey	RENDERER_TYPE_KEY
static PropertyKey	TRANSIENT_KEY
static FacesBean.Type	TYPE

Constructor Summary

UIXComponentBase()

UIXComponentBase(java.lang.String rendererType)

Method Summary

protected void	addAttributeChange(PropertyKey attribute, java.lang.Object attributeValue)
protected void	addAttributeChange(java.lang.String attributeName, java.lang.Object attributeValue)
void	addAttributeChangeListener(AttributeChangeListener acl)
protected void	addFacesListener(FacesListener listener)
void	broadcast(FacesEvent event)
protected FacesBean	createFacesBean(java.lang.String rendererType)
void	decode(FacesContext context)
protected void	decodeChildren(FacesContext context) Delegates to LifecycleRenderer, if present, otherwise calls decodeChildrenImpl.
protected void	decodeChildrenImpl(FacesContext context) Calls processDecodes on all facets and children of this component.
void	encodeAll(FacesContext context) Encodes a component and all of its children, whether getRendersChildren() is true or false.
void	encodeBegin(FacesContext context)
void	encodeChildren(FacesContext context)
void	encodeEnd(FacesContext context)
UIComponent	findComponent(java.lang.String id)
MethodBinding	getAttributeChangeListener()
AttributeChangeListener[]	getAttributeChangeListeners()
java.util.Map	getAttributes()
protected FacesBean.Type	getBeanType()
protected boolean	getBooleanProperty(PropertyKey key, boolean defaultValue)
int	getChildCount()
java.util.List	getChildren() Create (if necessary) and return a List of the children associated with this component.
java.lang.String	getClientId(FacesContext context)
FacesBean	getFacesBean()
protected FacesContext	getFacesContext() Return the FacesContext instance for the current request.
protected FacesListener[]	getFacesListeners(java.lang.Class clazz)
UIComponent	getFacet(java.lang.String facetName)
int	getFacetCount() Return the number of facets.
java.util.Iterator	getFacetNames() Returns an Iterator over the names of all facets.
java.util.Map	getFacets() Create (if necessary) and return a Map of the facets associated with this component.
java.util.Iterator	getFacetsAndChildren()
abstract java.lang.String	getFamily()
java.lang.String	getId()
protected int	getIntProperty(PropertyKey key, int defaultValue)
protected LifecycleRenderer	getLifecycleRenderer(FacesContext context)
protected java.lang.String	getLocalClientId() Returns the default local client identifier, relative to the current naming container.
UIComponent	getParent()
protected java.lang.Object	getProperty(PropertyKey key)
protected PropertyKey	getPropertyKey(java.lang.String name)
protected Renderer	getRenderer(FacesContext context)
java.lang.String	getRendererType()
boolean	getRendersChildren()
ValueBinding	getValueBinding(java.lang.String name)
boolean	isRendered()
boolean	isTransient()
void	processDecodes(FacesContext context)
void	processRestoreState(FacesContext context, java.lang.Object state)
java.lang.Object	processSaveState(FacesContext context)
void	processUpdates(FacesContext context)
void	processValidators(FacesContext context)
void	queueEvent(FacesEvent event)
void	removeAttributeChangeListener(AttributeChangeListener acl)
protected void	removeFacesListener(FacesListener listener)
void	restoreState(FacesContext context, java.lang.Object stateObj)
java.lang.Object	saveState(FacesContext context)
void	setAttributeChangeListener(MethodBinding mb)
protected void	setBooleanProperty(PropertyKey key, boolean value)
void	setId(java.lang.String id)
protected void	setIntProperty(PropertyKey key, int value)
void	setParent(UIComponent parent) Set the parent UIComponent of this UIComponent.
protected void	setProperty(PropertyKey key, java.lang.Object value)
void	setRendered(boolean rendered)
void	setRendererType(java.lang.String rendererType)
void	setTransient(boolean newTransient)
void	setValueBinding(java.lang.String name, ValueBinding binding)
java.lang.String	toString()
protected void	updateChildren(FacesContext context) Delegates to LifecycleRenderer, if present, otherwise calls upateChildrenImpl.
protected void	updateChildrenImpl(FacesContext context)
protected void	validateChildren(FacesContext context) Delegates to LifecycleRenderer, if present, otherwise calls validateChildrenImpl.
protected void	validateChildrenImpl(FacesContext context) Calls processValidators on all facets and children of this component.

Methods inherited from class java.lang.Object

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

Field Detail

TYPE

public static final FacesBean.Type TYPE

ID_KEY

public static final PropertyKey ID_KEY

RENDERED_KEY

public static final PropertyKey RENDERED_KEY

BINDING_KEY

public static final PropertyKey BINDING_KEY

TRANSIENT_KEY

public static final PropertyKey TRANSIENT_KEY

RENDERER_TYPE_KEY

public static final PropertyKey RENDERER_TYPE_KEY

Constructor Detail

UIXComponentBase

public UIXComponentBase()

UIXComponentBase

public UIXComponentBase(java.lang.String rendererType)

Method Detail

createFacesBean

protected FacesBean createFacesBean(java.lang.String rendererType)

getPropertyKey

protected PropertyKey getPropertyKey(java.lang.String name)

getBeanType

protected FacesBean.Type getBeanType()

getFacesBean

public FacesBean getFacesBean()

Specified by:

getFacesBean in class UIXComponent

addAttributeChangeListener

public void addAttributeChangeListener(AttributeChangeListener acl)

Specified by:

addAttributeChangeListener in class UIXComponent

removeAttributeChangeListener

public void removeAttributeChangeListener(AttributeChangeListener acl)

Specified by:

removeAttributeChangeListener in class UIXComponent

getAttributeChangeListeners

public AttributeChangeListener[] getAttributeChangeListeners()

Specified by:

getAttributeChangeListeners in class UIXComponent

setAttributeChangeListener

public void setAttributeChangeListener(MethodBinding mb)

Specified by:

setAttributeChangeListener in class UIXComponent

getAttributeChangeListener

public MethodBinding getAttributeChangeListener()

Specified by:

getAttributeChangeListener in class UIXComponent

getValueBinding

public ValueBinding getValueBinding(java.lang.String name)

Specified by:

getValueBinding in class UIXComponent

setValueBinding

public void setValueBinding(java.lang.String name,
                            ValueBinding binding)

Specified by:

setValueBinding in class UIXComponent

getAttributes

public java.util.Map getAttributes()

Specified by:

getAttributes in class UIXComponent

getClientId

public java.lang.String getClientId(FacesContext context)

Specified by:

getClientId in class UIXComponent

getId

public java.lang.String getId()

Specified by:

getId in class UIXComponent

setId

public void setId(java.lang.String id)

Specified by:

setId in class UIXComponent

getFamily

public abstract java.lang.String getFamily()

Specified by:

getFamily in class UIXComponent

getParent

public UIComponent getParent()

Specified by:

getParent in class UIXComponent

setParent

public void setParent(UIComponent parent)

Set the parent UIComponent of this UIComponent.

Specified by:

setParent in class UIXComponent

Parameters:

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

isRendered

public boolean isRendered()

Specified by:

isRendered in class UIXComponent

setRendered

public void setRendered(boolean rendered)

Specified by:

setRendered in class UIXComponent

isTransient

public boolean isTransient()

Specified by:

isTransient in interface StateHolder

Specified by:

isTransient in class UIXComponent

setTransient

public void setTransient(boolean newTransient)

Specified by:

setTransient in interface StateHolder

Specified by:

setTransient in class UIXComponent

getRendererType

public java.lang.String getRendererType()

Specified by:

getRendererType in class UIXComponent

setRendererType

public void setRendererType(java.lang.String rendererType)

Specified by:

setRendererType in class UIXComponent

getRendersChildren

public boolean getRendersChildren()

Specified by:

getRendersChildren in class UIXComponent

findComponent

public UIComponent findComponent(java.lang.String id)

Specified by:

findComponent in class UIXComponent

Throws:

java.lang.NullPointerException

getChildren

public java.util.List getChildren()

Create (if necessary) and return a List of the children associated with this component.

Specified by:

getChildren in class UIXComponent

getChildCount

public int getChildCount()

Specified by:

getChildCount in class UIXComponent

getFacets

public java.util.Map getFacets()

Create (if necessary) and return a Map of the facets associated with this component.

Specified by:

getFacets in class UIXComponent

getFacet

public UIComponent getFacet(java.lang.String facetName)

Specified by:

getFacet in class UIXComponent

getFacetNames

public java.util.Iterator getFacetNames()

Returns an Iterator over the names of all facets. Unlike getFacets().keySet().iterator(), this does not require instantiating a Map if there are no facets. (Note that this is not part of the UIComponent API.)

getFacetsAndChildren

public java.util.Iterator getFacetsAndChildren()

Specified by:

getFacetsAndChildren in class UIXComponent

broadcast

public void broadcast(FacesEvent event)
               throws AbortProcessingException

Specified by:

broadcast in class UIXComponent

Throws:

AbortProcessingException

decode

public void decode(FacesContext context)

Specified by:

decode in class UIXComponent

encodeBegin

public void encodeBegin(FacesContext context)
                 throws java.io.IOException

Specified by:

encodeBegin in class UIXComponent

Throws:

java.io.IOException

encodeChildren

public void encodeChildren(FacesContext context)
                    throws java.io.IOException

Specified by:

encodeChildren in class UIXComponent

Throws:

java.io.IOException

encodeEnd

public void encodeEnd(FacesContext context)
               throws java.io.IOException

Specified by:

encodeEnd in class UIXComponent

Throws:

java.io.IOException

encodeAll

public void encodeAll(FacesContext context)
               throws java.io.IOException

Encodes a component and all of its children, whether getRendersChildren() is true or false. When rendersChildren is false, each child whose "rendered" property is true will be sequentially rendered; facets will be ignored.

Specified by:

encodeAll in class UIXComponent

Throws:

java.io.IOException

queueEvent

public void queueEvent(FacesEvent event)

Specified by:

queueEvent in class UIXComponent

Throws:

java.lang.IllegalStateException

java.lang.NullPointerException

processDecodes

public void processDecodes(FacesContext context)

Specified by:

processDecodes in class UIXComponent

processValidators

public void processValidators(FacesContext context)

Specified by:

processValidators in class UIXComponent

processUpdates

public void processUpdates(FacesContext context)

Specified by:

processUpdates in class UIXComponent

processSaveState

public java.lang.Object processSaveState(FacesContext context)

Specified by:

processSaveState in class UIXComponent

processRestoreState

public void processRestoreState(FacesContext context,
                                java.lang.Object state)

Specified by:

processRestoreState in class UIXComponent

saveState

public java.lang.Object saveState(FacesContext context)

Specified by:

saveState in interface StateHolder

Specified by:

saveState in class UIXComponent

restoreState

public void restoreState(FacesContext context,
                         java.lang.Object stateObj)

Specified by:

restoreState in interface StateHolder

Specified by:

restoreState in class UIXComponent

toString

public java.lang.String toString()

getFacesContext

protected FacesContext getFacesContext()

Return the FacesContext instance for the current request.

Specified by:

getFacesContext in class UIXComponent

decodeChildren

protected final void decodeChildren(FacesContext context)

Delegates to LifecycleRenderer, if present, otherwise calls decodeChildrenImpl.

Parameters:

context - the current FacesContext

decodeChildrenImpl

protected void decodeChildrenImpl(FacesContext context)

Calls processDecodes on all facets and children of this component.

Parameters:

context - the current FacesContext

validateChildren

protected final void validateChildren(FacesContext context)

Delegates to LifecycleRenderer, if present, otherwise calls validateChildrenImpl.

Parameters:

context - the current FacesContext

validateChildrenImpl

protected void validateChildrenImpl(FacesContext context)

Calls processValidators on all facets and children of this component.

Parameters:

context - the current FacesContext

updateChildren

protected final void updateChildren(FacesContext context)

Delegates to LifecycleRenderer, if present, otherwise calls upateChildrenImpl.

Parameters:

context - the current FacesContext

updateChildrenImpl

protected void updateChildrenImpl(FacesContext context)

addFacesListener

protected void addFacesListener(FacesListener listener)

Specified by:

addFacesListener in class UIXComponent

removeFacesListener

protected void removeFacesListener(FacesListener listener)

Specified by:

removeFacesListener in class UIXComponent

getFacesListeners

protected FacesListener[] getFacesListeners(java.lang.Class clazz)

Specified by:

getFacesListeners in class UIXComponent

addAttributeChange

protected final void addAttributeChange(java.lang.String attributeName,
                                        java.lang.Object attributeValue)

addAttributeChange

protected final void addAttributeChange(PropertyKey attribute,
                                        java.lang.Object attributeValue)

getRenderer

protected Renderer getRenderer(FacesContext context)

Specified by:

getRenderer in class UIXComponent

getLifecycleRenderer

protected LifecycleRenderer getLifecycleRenderer(FacesContext context)

setProperty

protected void setProperty(PropertyKey key,
                           java.lang.Object value)

getProperty

protected java.lang.Object getProperty(PropertyKey key)

setBooleanProperty

protected void setBooleanProperty(PropertyKey key,
                                  boolean value)

getBooleanProperty

protected boolean getBooleanProperty(PropertyKey key,
                                     boolean defaultValue)

setIntProperty

protected void setIntProperty(PropertyKey key,
                              int value)

getIntProperty

protected int getIntProperty(PropertyKey key,
                             int defaultValue)

getLocalClientId

protected java.lang.String getLocalClientId()

Returns the default local client identifier, relative to the current naming container.

getFacetCount

public int getFacetCount()

Return the number of facets. This is more efficient than calling getFacets().size();

Specified by:

getFacetCount in class UIXComponent