public abstract class PartialUIXPageTemplate extends UIXInclude
Renders a pageTemplate. If you want a common UI for all your pages, you may use a pageTemplate. This allows you to define your common UI in a pageTemplate definition file using the <af:pageTemplateDef>
tag, and reusing the common definition on all your other pages using this tag. The document component needs to be the root component and must not be placed inside of a af:pageTemplateDef.
You can pass attributes using JSP tag attributes, or by using <f:attribute>
. Facets can also be set as normal using <f:facet>
tags. The definition can refer to the attributes of the component by using the "var" EL variable and the component itself using the "componentVar" EL variable that are setup on the <af:componentDef>
tag. The definition can reference a facet using the <af:facetRef>
tag. Each facet can only be referenced once.
<af:pageTemplate id="weather" viewid="pagefragments_weatherBox_jspx"> <f:attribute name="zip" value="94065"/> <f:attribute name="description" value="Redwood Shores, CA"/> <f:facet name="forecastSummary"> <af:outputText value="Partly Cloudy"/> </f:facet> <f:facet name="forecastDetail"> <af:panelGroupLayout layout="vertical"> <af:outputText value="72'F"/> <af:outputText value="Partly Cloudy"/> <af:outputText value="Wind: W at 16 mph"/> <af:outputText value="Humidity: 46%"/> </af:panelGroupLayout> </f:facet> </af:pageTemplate>And this is the corresponding pagefragments/weatherBox.jspx:
<jsp:root xmlns:jsp="http://java.sun.com/JSP/Page" xmlns:f="http://java.sun.com/jsf/core" xmlns:af="http://xmlns.oracle.com/adf/faces/rich" version="2.0"> <af:pageTemplateDef var="attrs"> <af:xmlContent> <component xmlns="http://xmlns.oracle.com/adf/faces/rich/component"> <description> This component will show weather forecasts in a box. </description> <facet> <facet-name>forecastSummary</facet-name> <description>This child draws out the summary forecast</description> </facet> <facet> <facet-name>forecastDetail</facet-name> <description>This child draws out the detailed forecast</description> </facet> <attribute> <attribute-name>zip</attribute-name> <description>The Zip code of the area</description> <required>true</required> </attribute> <attribute> <attribute-name>description</attribute-name> <default-value>Unknown</default-value> <description>The city/state of the zip code </description> </attribute> </component> </af:xmlContent> <af:panelHeader text="Weather Forecast for Zip:#{attrs.zip}, #{attrs.description}"> <af:facetRef facetname="forecastSummary"/> <af:showDetail> <af:facetRef facetname="forecastDetail"/> </af:showDetail> </af:panelHeader> </af:pageTemplateDef> </jsp:root>
The pageTemplate component does not support nesting a bound template inside of a non-bound page template. When using ADF model binding, the entire hierarchy of page templates must be bound. If this is not done, the page template will inherit the bindings of its including page and not use the page definition defined for the template.
Bound page templates may not be placed inside stamping components like the <af:iterator> component as the page template model does not currently supported being stamped. If necessary, page templates can be replicated using <af:forEach>, provided that each iteration has its own model.
Note about stretching layouts and flowing/scrolling layouts:
With today's web browsers, it is not reliable to have vertically-stretched content inside of areas that also have scroll bars. If you want the outer areas of your page structure to stretch, you need to be careful of how you assemble your component tree.
Type | Phases | Description |
---|---|---|
org.apache.myfaces.trinidad.event.AttributeChangeEvent |
Invoke Application Apply Request Values |
Event delivered to describe an attribute change. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change event might include the width of a column that supported client-side resizing. |
Modifier and Type | Field and Description |
---|---|
static String |
COMPONENT_FAMILY |
static String |
COMPONENT_TYPE |
static org.apache.myfaces.trinidad.bean.FacesBean.Type |
TYPE |
static org.apache.myfaces.trinidad.bean.PropertyKey |
VALUE_KEY |
VIEW_ID_KEY
COMPONENT_VAR_KEY, VAR_KEY
BINDING_KEY, ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY
Modifier | Constructor and Description |
---|---|
protected |
PartialUIXPageTemplate(String rendererType)
Construct an instance of the PartialUIXPageTemplate.
|
Modifier and Type | Method and Description |
---|---|
protected org.apache.myfaces.trinidad.bean.FacesBean.Type |
getBeanType() |
String |
getFamily() |
Object |
getValue()
Gets If this attribute is set to an instance of
oracle.adf.view.rich.model.PageTemplateModel , the view ID will be taken from the model and the model will receive notifications of the starting and stopping of the template context. |
void |
setValue(Object value)
Sets If this attribute is set to an instance of
oracle.adf.view.rich.model.PageTemplateModel , the view ID will be taken from the model and the model will receive notifications of the starting and stopping of the template context. |
broadcast, createFacesBean, getAttribute, getRenderedFacetsAndChildren, getViewId, invokeOnComponent, queueEvent, resumeContext, setAttribute, setupChildrenVisitingContext, suspendChange, suspendContext, tearDownChildrenVisitingContext
getComponentVar, getVar, setComponentVar, setVar
finishComponentEncoding, isFlatteningChildren, processDecodes, processFlattenedChildren, processUpdates, processValidators, restoreContext, setupContext, setupVisitingContext, tearDownVisitingContext
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
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
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getPassThroughAttributes, getResourceBundleMap, getTransientStateHelper, getTransientStateHelper, isCompositeComponent, isInView, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView
public static final org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE
public static final org.apache.myfaces.trinidad.bean.PropertyKey VALUE_KEY
public static final String COMPONENT_FAMILY
public static final String COMPONENT_TYPE
protected PartialUIXPageTemplate(String rendererType)
public final Object getValue()
oracle.adf.view.rich.model.PageTemplateModel
, the view ID will be taken from the model and the model will receive notifications of the starting and stopping of the template context. Otherwise, if the value is non-null the value is assigned to the "bindings" EL variable while this template is rendering or decoding.public final void setValue(Object value)
oracle.adf.view.rich.model.PageTemplateModel
, the view ID will be taken from the model and the model will receive notifications of the starting and stopping of the template context. Otherwise, if the value is non-null the value is assigned to the "bindings" EL variable while this template is rendering or decoding.value
- the new value valuepublic String getFamily()
getFamily
in class PartialUIXInclude
protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
getBeanType
in class UIXInclude