oracle.adf.view.rich.component.fragment

Class ContextSwitchingComponent

java.lang.Object

javax.faces.component.UIComponent

org.apache.myfaces.trinidad.component.UIXComponent

org.apache.myfaces.trinidad.component.UIXComponentBase

oracle.adf.view.rich.component.fragment.ContextSwitchingComponent

All Implemented Interfaces:

EventListener, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, org.apache.myfaces.trinidad.component.FlattenedComponent

Direct Known Subclasses:

PartialUIXInclude

public abstract class ContextSwitchingComponent
extends org.apache.myfaces.trinidad.component.UIXComponentBase
implements org.apache.myfaces.trinidad.component.FlattenedComponent

This class facilitates creating components that provide their own EL variables to child components.

The setupVisitingContext(javax.faces.context.FacesContext) method is called before a child component is being decoded, validated or updated. It is also called before an event is delivered to a child component. Implementations should provide an implmentation of this method that puts the EL variables into scope.

The tearDownVisitingContext(javax.faces.context.FacesContext) method is called after the child components have been processed. Implementations should restore any EL variables that were modified by setupVisitingContext(javax.faces.context.FacesContext).

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase

org.apache.myfaces.trinidad.component.UIXComponentBase.ComponentSystemEventListenerWrapper

Field Summary

Fields inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase

BINDING_KEY, ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY, TYPE

Fields inherited from class javax.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
ContextSwitchingComponent()
ContextSwitchingComponent(String rendererType)

Method Summary

Methods

Modifier and Type	Method and Description
void	broadcast(javax.faces.event.FacesEvent event)
protected void	finishComponentEncoding(javax.faces.context.FacesContext context)
boolean	invokeOnComponent(javax.faces.context.FacesContext context, String clientId, javax.faces.component.ContextCallback callback) Override to always setup the visiting context before invoking the callback, or our children
boolean	isFlatteningChildren(javax.faces.context.FacesContext context) Returns true if this FlattenedComponent is currently flattening its children
void	processDecodes(javax.faces.context.FacesContext context)
<S> boolean	processFlattenedChildren(javax.faces.context.FacesContext context, org.apache.myfaces.trinidad.component.ComponentProcessingContext cpContext, org.apache.myfaces.trinidad.component.ComponentProcessor<S> childProcessor, S callbackContext) Set up the component context, process all of the renderable children of this component, and the restore the previous context, returning true if any of the children were processed.
void	processUpdates(javax.faces.context.FacesContext context)
void	processValidators(javax.faces.context.FacesContext context)
void	queueEvent(javax.faces.event.FacesEvent event)
void	restoreContext(javax.faces.context.FacesContext context)
protected void	setupChildrenVisitingContext(javax.faces.context.FacesContext context)
void	setupContext(javax.faces.context.FacesContext context) Sets up the context of the component.
protected void	setupVisitingContext(javax.faces.context.FacesContext context)
protected void	tearDownChildrenVisitingContext(javax.faces.context.FacesContext context)
protected void	tearDownVisitingContext(javax.faces.context.FacesContext context)

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase

adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addClientBehavior, addComponentChange, addComponentChange, addComponentChangeFilter, addFacesListener, broadcastToMethodBinding, broadcastToMethodExpression, clearCachedClientIds, clearInitialState, createFacesBean, decode, decodeChildren, decodeChildrenImpl, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBeanType, getBooleanProperty, getChildCount, getChildren, getClientBehaviors, getClientId, getComponentChangeFilters, getContainerClientId, getDefaultEventName, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getFamily, getId, getIntProperty, getLifecycleRenderer, getListenersForEventClass, getParent, getProperty, getPropertyKey, getRenderedFacetsAndChildren, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, initialStateMarked, invokeOnChildrenComponents, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, processRestoreState, processSaveState, removeAttributeChangeListener, removeComponentChangeFilter, removeFacesListener, restoreState, satisfiesPartialTrigger, saveState, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setupFlattenedChildrenContext, setupFlattenedContext, setValueBinding, setValueExpression, subscribeToEvent, tearDownFlattenedChildrenContext, tearDownFlattenedContext, toString, unsubscribeFromEvent, updateChildren, updateChildrenImpl, validateChildren, validateChildrenImpl

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponent

addPartialTarget, broadcastInContext, clearCachedClientIds, defaultGetRenderedFacetsAndChildren, encodeFlattenedChild, encodeFlattenedChildren, getLogicalParent, getLogicalParent, getStateHelper, getStateHelper, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setupChildrenEncodingContext, setupEncodingContext, setUpEncodingContext, tearDownChildrenEncodingContext, tearDownEncodingContext, visitAllChildren, visitChildren, visitChildren, visitTree, visitTree

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getResourceBundleMap, getTransientStateHelper, getTransientStateHelper, isCompositeComponent, isInView, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView

Methods inherited from class java.lang.Object

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

Constructor Detail

ContextSwitchingComponent

public ContextSwitchingComponent()

ContextSwitchingComponent

public ContextSwitchingComponent(String rendererType)

Method Detail

setupContext

public final void setupContext(javax.faces.context.FacesContext context)

Sets up the context of the component.

This method is meant to be called from the tag or tag handler as is not meant to be for non-tag consumption.

Note that this will set up both the visiting context as well as the children visiting context.

restoreContext

public final void restoreContext(javax.faces.context.FacesContext context)

queueEvent

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

Overrides:

queueEvent in class org.apache.myfaces.trinidad.component.UIXComponentBase

setupVisitingContext

protected void setupVisitingContext(javax.faces.context.FacesContext context)

Overrides:

setupVisitingContext in class org.apache.myfaces.trinidad.component.UIXComponent

tearDownVisitingContext

protected void tearDownVisitingContext(javax.faces.context.FacesContext context)

Overrides:

tearDownVisitingContext in class org.apache.myfaces.trinidad.component.UIXComponent

setupChildrenVisitingContext

protected void setupChildrenVisitingContext(javax.faces.context.FacesContext context)

Overrides:

setupChildrenVisitingContext in class org.apache.myfaces.trinidad.component.UIXComponent

tearDownChildrenVisitingContext

protected void tearDownChildrenVisitingContext(javax.faces.context.FacesContext context)

Overrides:

tearDownChildrenVisitingContext in class org.apache.myfaces.trinidad.component.UIXComponent

broadcast

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

Overrides:

broadcast in class org.apache.myfaces.trinidad.component.UIXComponentBase

Throws:

javax.faces.event.AbortProcessingException

processDecodes

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

Overrides:

processDecodes in class org.apache.myfaces.trinidad.component.UIXComponentBase

processValidators

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

Overrides:

processValidators in class org.apache.myfaces.trinidad.component.UIXComponentBase

processUpdates

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

Overrides:

processUpdates in class org.apache.myfaces.trinidad.component.UIXComponentBase

invokeOnComponent

public boolean invokeOnComponent(javax.faces.context.FacesContext context,
                        String clientId,
                        javax.faces.component.ContextCallback callback)
                          throws javax.faces.FacesException

Override to always setup the visiting context before invoking the callback, or our children

Overrides:

invokeOnComponent in class org.apache.myfaces.trinidad.component.UIXComponentBase

Throws:

javax.faces.FacesException

See Also:

setupVisitingContext(javax.faces.context.FacesContext), tearDownVisitingContext(javax.faces.context.FacesContext)

finishComponentEncoding

protected final void finishComponentEncoding(javax.faces.context.FacesContext context)
                                      throws IOException

Throws:

IOException

processFlattenedChildren

public <S> boolean processFlattenedChildren(javax.faces.context.FacesContext context,
                                   org.apache.myfaces.trinidad.component.ComponentProcessingContext cpContext,
                                   org.apache.myfaces.trinidad.component.ComponentProcessor<S> childProcessor,
                                   S callbackContext)
                                 throws IOException

Set up the component context, process all of the renderable children of this component, and the restore the previous context, returning true if any of the children were processed.

Specified by:

processFlattenedChildren in interface org.apache.myfaces.trinidad.component.FlattenedComponent

Parameters:

context - Current FacesContext

cpContext - ComponentProcesingContext representing the current child iteration state

childProcessor - ComponentProcessor to call for each flattened child

callbackContext - childProcessor-specific context to be passed on each call to the childProcessor

Returns:

true if this FlattenedComponent actually processed any children

Throws:

IOException - if an error occurs while processing children

isFlatteningChildren

public boolean isFlatteningChildren(javax.faces.context.FacesContext context)

Returns true if this FlattenedComponent is currently flattening its children

Specified by:

isFlatteningChildren in interface org.apache.myfaces.trinidad.component.FlattenedComponent

Parameters:

context - FacesContext

Returns:

true if this FlattenedComponent is currently flattening its children