oracle.adf.view.rich.component.fragment

Class UIXInclude

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

oracle.adf.view.rich.component.fragment.PartialUIXInclude

oracle.adf.view.rich.component.fragment.UIXInclude

All Implemented Interfaces:

EventListener, javax.faces.component.NamingContainer, 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:

PartialUIXDeclarativeComponent, PartialUIXPageTemplate, UIXDynamicDeclarativeComponent

public class UIXInclude
extends PartialUIXInclude
implements javax.faces.component.NamingContainer

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

Modifier and Type	Field and Description
static org.apache.myfaces.trinidad.bean.FacesBean.Type	TYPE
static org.apache.myfaces.trinidad.bean.PropertyKey	VIEW_ID_KEY

Fields inherited from class oracle.adf.view.rich.component.fragment.PartialUIXInclude

COMPONENT_FAMILY, COMPONENT_TYPE, COMPONENT_VAR_KEY, VAR_KEY

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

BINDING_KEY, ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY

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

Fields inherited from interface javax.faces.component.NamingContainer

SEPARATOR_CHAR

Constructor Summary

Constructors

Modifier	Constructor and Description
	UIXInclude() Construct an instance of the UIXInclude.
protected	UIXInclude(String rendererType) Construct an instance of the UIXInclude.

Method Summary

Modifier and Type	Method and Description
void	broadcast(javax.faces.event.FacesEvent event)
protected org.apache.myfaces.trinidad.bean.FacesBean	createFacesBean(String rendererType)
protected Object	getAttribute(Object key)
protected org.apache.myfaces.trinidad.bean.FacesBean.Type	getBeanType()
protected Iterator<javax.faces.component.UIComponent>	getRenderedFacetsAndChildren(javax.faces.context.FacesContext facesContext)
String	getViewId() Gets the view ID.
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
void	queueEvent(javax.faces.event.FacesEvent evt)
void	resumeContext(javax.faces.context.FacesContext facesContext) Resume the include's context that has been suspended.
protected Object	setAttribute(Object key, Object value) Sets the attribute of a component via the value expression.
protected void	setupChildrenVisitingContext(javax.faces.context.FacesContext facesContext) Sets up EL variables including the attribute map for use by the children of this include.
protected org.apache.myfaces.trinidad.context.SuspendCallback.SuspendResult	suspendChange(org.apache.myfaces.trinidad.context.ComponentContextChange contextChange) Called by the suspendContext(FacesContext) method to determine how far back to suspend the application context changes.
void	suspendContext(javax.faces.context.FacesContext facesContext) Suspend the include component that is currently in context.
protected void	tearDownChildrenVisitingContext(javax.faces.context.FacesContext facesContext) Restores the previous values of all the EL variables maintained by this component.

Methods inherited from class oracle.adf.view.rich.component.fragment.PartialUIXInclude

getComponentVar, getFamily, getVar, setComponentVar, setVar

Methods inherited from class oracle.adf.view.rich.component.fragment.ContextSwitchingComponent

finishComponentEncoding, isFlatteningChildren, processDecodes, processFlattenedChildren, processUpdates, processValidators, restoreContext, setupContext, setupVisitingContext, tearDownVisitingContext

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

adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addClientBehavior, addComponentChange, addComponentChange, addComponentChangeFilter, addFacesListener, broadcastToMethodBinding, broadcastToMethodExpression, clearCachedClientIds, clearInitialState, decode, decodeChildren, decodeChildrenImpl, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientBehaviors, getClientId, getComponentChangeFilters, getContainerClientId, getDefaultEventName, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getListenersForEventClass, getParent, getPassThroughAttributes, getProperty, getPropertyKey, 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, getPassThroughAttributes, 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

Field Detail

TYPE

public static final org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE

VIEW_ID_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey VIEW_ID_KEY

Constructor Detail

UIXInclude

public UIXInclude()

Construct an instance of the UIXInclude.

UIXInclude

protected UIXInclude(String rendererType)

Construct an instance of the UIXInclude.

Parameters:

rendererType - the renderer type.

Method Detail

getBeanType

protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()

Overrides:

getBeanType in class PartialUIXInclude

queueEvent

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

Overrides:

queueEvent in class ContextSwitchingComponent

broadcast

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

Overrides:

broadcast in class ContextSwitchingComponent

Throws:

javax.faces.event.AbortProcessingException

invokeOnComponent

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

Description copied from class: ContextSwitchingComponent

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

Overrides:

invokeOnComponent in class ContextSwitchingComponent

Throws:

javax.faces.FacesException

See Also:

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

setupChildrenVisitingContext

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

Sets up EL variables including the attribute map for use by the children of this include. If you override this method, you will need to call super.setupChildrenVisitingContext() after any code that has EL dependencies or else you will be in danger of encountering an infinite loop.

Overrides:

setupChildrenVisitingContext in class ContextSwitchingComponent

tearDownChildrenVisitingContext

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

Restores the previous values of all the EL variables maintained by this component. If you override this method, you will need to call super.tearDownChildrenVisitingContext() before any code that has EL dependencies or else you will be in danger of encountering an infinite loop.

Overrides:

tearDownChildrenVisitingContext in class ContextSwitchingComponent

suspendContext

public void suspendContext(javax.faces.context.FacesContext facesContext)
                    throws IllegalStateException

Suspend the include component that is currently in context.

Parameters:

facesContext - the faces context

Throws:

IllegalStateException - if the include is not currently in context

resumeContext

public void resumeContext(javax.faces.context.FacesContext facesContext)
                   throws IllegalStateException

Resume the include's context that has been suspended.

Parameters:

facesContext - the faces context

Throws:

IllegalStateException - if the include is not suspended

getViewId

public String getViewId()

Gets the view ID.

Returns:

the view ID

suspendChange

protected org.apache.myfaces.trinidad.context.SuspendCallback.SuspendResult suspendChange(org.apache.myfaces.trinidad.context.ComponentContextChange contextChange)

Called by the suspendContext(FacesContext) method to determine how far back to suspend the application context changes.

Parameters:

contextChange - The change to consider

Returns:

How the suspension should continue

getAttribute

protected Object getAttribute(Object key)

setAttribute

protected Object setAttribute(Object key,
                              Object value)

Sets the attribute of a component via the value expression. The difference between calling this method and getAttributes().put(Object, Object) is that this method will update the value expression rather than updating the component attribute if the key corresponds to a writable value expression.

Parameters:

key - The key of the attribute to set (should be a string)

value - The value to set

Returns:

The current (previous) value

createFacesBean

protected org.apache.myfaces.trinidad.bean.FacesBean createFacesBean(String rendererType)

Overrides:

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

getRenderedFacetsAndChildren

protected Iterator<javax.faces.component.UIComponent> getRenderedFacetsAndChildren(javax.faces.context.FacesContext facesContext)

Overrides:

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