oracle.adf.view.rich.component.fragment

Class UIXPageTemplate

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

oracle.adf.view.rich.component.fragment.PartialUIXPageTemplate

oracle.adf.view.rich.component.fragment.UIXPageTemplate

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:

RichPageTemplate

public class UIXPageTemplate
extends PartialUIXPageTemplate

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 oracle.adf.view.rich.component.fragment.PartialUIXPageTemplate

COMPONENT_FAMILY, COMPONENT_TYPE, TYPE, VALUE_KEY

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

VIEW_ID_KEY

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

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
	UIXPageTemplate() Construct an instance of the UIXPageTemplate.
protected	UIXPageTemplate(String rendererType) Construct an instance of the UIXPageTemplate.

Method Summary

Methods

Modifier and Type	Method and Description
String	getViewId() Gets the view ID.
void	resumeContext(javax.faces.context.FacesContext facesContext) Resume the include's context that has been suspended.
protected void	setPartialTarget(javax.faces.context.FacesContext facesContext, org.apache.myfaces.trinidad.context.PartialPageContext partialContext) When asked to be PPR-ed, Page Template should PPR its parent since it renders no DOM
protected void	setupChildrenVisitingContext(javax.faces.context.FacesContext context) Setups EL variables including the attribute map for use by the children of this page templete.
protected org.apache.myfaces.trinidad.context.SuspendCallback.SuspendResult	suspendChange(org.apache.myfaces.trinidad.context.ComponentContextChange contextChange) Called by the UIXInclude.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 context) Restores the previous values of all the EL variables maintained by this component.

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

getBeanType, getFamily, getValue, setValue

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

broadcast, createFacesBean, getAttribute, getRenderedFacetsAndChildren, invokeOnComponent, queueEvent, setAttribute

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

getComponentVar, 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, 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, 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, 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

Constructor Detail

UIXPageTemplate

public UIXPageTemplate()

Construct an instance of the UIXPageTemplate.

UIXPageTemplate

protected UIXPageTemplate(String rendererType)

Construct an instance of the UIXPageTemplate.

Method Detail

getViewId

public String getViewId()

Gets the view ID.

If the value attribute of the page template resolves to an instance of PageTemplateModel then the view ID will be retrieved from the the model instead of using the viewId tag attribute.

Overrides:

getViewId in class UIXInclude

Returns:

the view ID

setupChildrenVisitingContext

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

Setups EL variables including the attribute map for use by the children of this page templete.

Overrides:

setupChildrenVisitingContext in class UIXInclude

tearDownChildrenVisitingContext

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

Restores the previous values of all the EL variables maintained by this component.

Overrides:

tearDownChildrenVisitingContext in class UIXInclude

setPartialTarget

protected void setPartialTarget(javax.faces.context.FacesContext facesContext,
                    org.apache.myfaces.trinidad.context.PartialPageContext partialContext)

When asked to be PPR-ed, Page Template should PPR its parent since it renders no DOM

Overrides:

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

suspendContext

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

Description copied from class: UIXInclude

Suspend the include component that is currently in context.

Overrides:

suspendContext in class UIXInclude

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

Description copied from class: UIXInclude

Resume the include's context that has been suspended.

Overrides:

resumeContext in class UIXInclude

Parameters:

facesContext - the faces context

Throws:

IllegalStateException - if the include is not suspended

suspendChange

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

Description copied from class: UIXInclude

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

Overrides:

suspendChange in class UIXInclude

Parameters:

contextChange - The change to consider

Returns:

How the suspension should continue