Skip navigation links

oracle.adf.view.rich.component.rich.fragment
Class RichPageTemplate

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.UIXInclude
oracle.adf.view.rich.component.fragment.UIXPageTemplate
oracle.adf.view.rich.component.rich.fragment.RichPageTemplate

All Implemented Interfaces:

javax.faces.component.NamingContainer, javax.faces.component.StateHolder, org.apache.myfaces.trinidad.component.FlattenedComponent

public class RichPageTemplate

extends UIXPageTemplate

implements javax.faces.component.NamingContainer

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 pageTemplate component does not support nesting (one af:pageTemplate component cannot contain another af:pageTemplate component). 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.

Example:

 <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="1.2">
   <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>
 

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.

• First, build up a structure of stretchable components (using panelSplitters and panelStretchLayouts).
• Second, inside of this structure, create islands of non-stretched content. These islands should be rooted with panelGroupLayouts with layout="scroll". This is an ideal component because it can be stretched and does not stretch its children--which likely don't support being stretched anyway.

Rules of thumb:

1. Never place a scrolling panelGroupLayout inside of another scrolling panelGroupLayout since users do not like nested scroll bars.
2. Never specify percentage heights in any component's inlineStyle attribute.
3. Never use the "position" style in any component's inlineStyle attribute.
4. Unless you are using fixed pixel heights on them, you would never place a panelSplitter or panelStretchLayout inside of any panelGroupLayout regardless of what you have set its layout attribute to.

If you believe that you need to break one of these rules, this is an indication that your page structure is not following the page structure guidelines and you will likely have troubles getting your application to render consistently across various web browsers and computing platforms.

• For specific details of about component stretching, please see the "geometry management" section in the tag documentation of each component.
• See the demo application for real world layout examples that you can use as a starting point in your application. A good starting point is the "Layout Basics" page listed under the "Framework Features" tab of the demo application.

Events:

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 events might include the width of a column that supported client-side resizing.

Field Summary

static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static org.apache.myfaces.trinidad.bean.PropertyKey	CUSTOMIZATION_ID_KEY Deprecated.
static org.apache.myfaces.trinidad.bean.PropertyKey	PARTIAL_TRIGGERS_KEY
static org.apache.myfaces.trinidad.bean.FacesBean.Type	TYPE

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

VALUE_KEY

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

COMPONENT_VAR_KEY, VAR_KEY, VIEW_ID_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

bindings

Fields inherited from interface javax.faces.component.NamingContainer

SEPARATOR_CHAR

Constructor Summary

	RichPageTemplate() Construct an instance of the RichPageTemplate.
protected	RichPageTemplate(java.lang.String rendererType) Construct an instance of the RichPageTemplate.

Method Summary

protected org.apache.myfaces.trinidad.bean.FacesBean.Type	getBeanType()
java.lang.String	getCustomizationId() Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.
java.lang.String	getFamily()
java.lang.String[]	getPartialTriggers() Gets the IDs of the components that should trigger a partial update.
void	setCustomizationId(java.lang.String customizationId) Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.
void	setPartialTriggers(java.lang.String[] partialTriggers) Sets the IDs of the components that should trigger a partial update.

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

getValue, getViewId, setupVisitingContext, setValue, tearDownVisitingContext

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

broadcast, createFacesBean, getAttribute, getComponentVar, getVar, invokeOnComponent, queueEvent, setAttribute, setComponentVar, setVar

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

encodeBegin, encodeEnd, finishComponentEncoding, isFlatteningChildren, processDecodes, processFlattenedChildren, processUpdates, processValidators, restoreContext, setupContext

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

adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addFacesListener, broadcastToMethodBinding, broadcastToMethodExpression, decode, decodeChildren, decodeChildrenImpl, encodeChildren, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getContainerClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getParent, getProperty, getPropertyKey, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, invokeOnChildrenComponents, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, processRestoreState, processSaveState, removeAttributeChangeListener, removeFacesListener, restoreState, satisfiesPartialTrigger, saveState, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setValueBinding, setValueExpression, toString, updateChildren, updateChildrenImpl, validateChildren, validateChildrenImpl

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

addPartialTarget, encodeFlattenedChild, encodeFlattenedChildren, getLogicalParent, getLogicalParent, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setUpEncodingContext, tearDownEncodingContext, visitTree, visitTree

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getContainerClientId

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

CUSTOMIZATION_ID_KEY

@Deprecated
public static final org.apache.myfaces.trinidad.bean.PropertyKey CUSTOMIZATION_ID_KEY

Deprecated.

PARTIAL_TRIGGERS_KEY

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

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY

See Also:

Constant Field Values

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

Constructor Detail

RichPageTemplate

public RichPageTemplate()

Construct an instance of the RichPageTemplate.

RichPageTemplate

protected RichPageTemplate(java.lang.String rendererType)

Construct an instance of the RichPageTemplate.

Method Detail

getCustomizationId

@Deprecated
public final java.lang.String getCustomizationId()

Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.

Gets This attribute is deprecated. The 'id' attribute should be used when applying persistent customizations. This attribute will be removed in the next release.

Returns:

the new customizationId value

setCustomizationId

@Deprecated
public final void setCustomizationId(java.lang.String customizationId)

Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.

Sets This attribute is deprecated. The 'id' attribute should be used when applying persistent customizations. This attribute will be removed in the next release.

Parameters:

customizationId - the new customizationId value

getPartialTriggers

public final java.lang.String[] getPartialTriggers()

Gets the IDs of the components that should trigger a partial update. This component will listen on the trigger components. If one of the trigger components receives an event that will cause it to update in some way, this component will request to be updated too. Identifiers are relative to the source component (this component), and must account for NamingContainers. If your component is already inside of a naming container, you can use a single colon to start the search from the root of the page, or multiple colons to move up through the NamingContainers - "::" will pop out of the component's naming container (or itself if the component is a naming container) and begin the search from there, ":::" will pop out of two naming containers (including itself if the component is a naming container) and begin the search from there, etc.

Returns:

the new partialTriggers value

setPartialTriggers

public final void setPartialTriggers(java.lang.String[] partialTriggers)

Sets the IDs of the components that should trigger a partial update. This component will listen on the trigger components. If one of the trigger components receives an event that will cause it to update in some way, this component will request to be updated too. Identifiers are relative to the source component (this component), and must account for NamingContainers. If your component is already inside of a naming container, you can use a single colon to start the search from the root of the page, or multiple colons to move up through the NamingContainers - "::" will pop out of the component's naming container (or itself if the component is a naming container) and begin the search from there, ":::" will pop out of two naming containers (including itself if the component is a naming container) and begin the search from there, etc.

Parameters:

partialTriggers - the new partialTriggers value

getFamily

public java.lang.String getFamily()

Overrides:

getFamily in class UIXPageTemplate

getBeanType

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

Overrides:

getBeanType in class UIXPageTemplate

Skip navigation links