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.

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.

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:

Never place a scrolling panelGroupLayout inside of another scrolling panelGroupLayout since users do not like nested scroll bars.

Never specify percentage heights in any component's inlineStyle attribute.

Never use the "position" style in any component's inlineStyle attribute.

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

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.

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.

void

setValue(java.lang.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.

getValue

public final java.lang.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. Otherwise, if the value is non-null the value is assigned to the "bindings" EL variable while this template is rendering or decoding.

Returns:

the new value value

setValue

public final void setValue(java.lang.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. Otherwise, if the value is non-null the value is assigned to the "bindings" EL variable while this template is rendering or decoding.