Oracle ADF Faces - af:panelPage
Summary

Tag name: < af:panelPage >

UIComponent class: oracle.adf.view.faces.component.core.layout.CorePanelPage

Component type: oracle.adf.CorePanelPage

PanelPage lays out an entire page. It supports several navigation and content areas for the creation of pages.

Example:



            <af:panelPage title="Title">
              <f:facet name="menu1">
                <af:menuTabs>
                  <af:commandMenuItem text="tab 1" action="guide.menuTabs"/>
                  <af:commandMenuItem text="tab 2" action="guide.menuTabs" 
                                   selected="true" />
                  <af:commandMenuItem text="tab 3" action="guide.menuTabs"/>
                  <af:commandMenuItem text="tab 4" action="guide.menuTabs"/>
                  <af:commandMenuItem text="tab 5" action="guide.menuTabs"/>
                  <af:commandMenuItem text="tab 6" action="guide.menuTabs"
                                   disabled="true" />
                </af:menuTabs>
              </f:facet>
              <f:facet name="menu2">
                <af:menuBar>
                  <af:commandMenuItem text="item 1" action="guide.menuBar" 
                                   selected="true" />
                  <af:commandMenuItem text="item 2" action="guide.menuBar"
                                   disabled="true" />
                  <af:commandMenuItem text="item 3" action="guide.menuBar"/>
                  <af:commandMenuItem text="item 4" action="guide.menuBar"/>
                </af:menuBar>
              </f:facet>
              <f:facet name="menu3">
                <af:menuList>
                  <af:commandMenuItem text="item 1" action="guide.menuList" />
                  <af:commandMenuItem text="item 2" action="guide.menuList" />
                  <af:commandMenuItem text="item 3" action="guide.menuList" />
                </af:menuList>
              </f:facet>
              <f:facet name="menuGlobal">
                <af:menuButtons>
                  <af:commandMenuItem text="help"
                                    icon="/components/images/globalhelp.gif"
                                    action="guide.menuButtons"/>
                  <af:commandMenuItem text="help more"
                                    icon="/components/images/globalhelp.gif"
                                    action="guide.menuButtons"/>
                </af:menuButtons>
              </f:facet>
              <f:facet name="branding">
                <af:objectImage source="/components/images/corporateBrand.gif"/>
              </f:facet>
              <f:facet name="brandingApp">
                <af:objectImage source="/components/images/applicationBrand.gif"/>
              </f:facet>
              <f:facet name="brandingAppContextual">
                <af:outputFormatted value="Customer &lt;b&gt;Contextual Application Branding - Menlo Park&lt;/b&gt;"
                                   styleUsage="inContextBranding"/>
              </f:facet>
              <f:facet name="location">
                <af:menuPath>
                  <af:commandMenuItem text="crumb 1" action="guide.menuPath" />
                  <af:commandMenuItem text="crumb 2" action="guide.menuPath" />
                  <af:commandMenuItem text="crumb 3" action="guide.menuPath" />
                  <af:commandMenuItem text="crumb 4" action="guide.menuPath" />
                </af:menuPath>
              </f:facet>
              <f:facet name="appCopyright">
                <af:outputText value="copyright facet"/>
              </f:facet>
              <f:facet name="appPrivacy">
                <af:commandLink text="privacy facet" action="action.none" />
              </f:facet>
              <f:facet name="appAbout">
                <af:commandLink text="about facet" action="action.none" />
              </f:facet>
              <af:outputText value="Content here" />
            </af:panelPage>


Supported Facets

Name Description
actions The page-level actions of the page. If present, this area typically contains either a panelButtonBar containing buttons that operate on the entire page, or a processChoiceBar allowing the user to move to the next or previous step in a process.

On certain look and feels, this child is shown twice, once under the page title and once at the bottom of the page. The only form element allowed in this area is a selectOneChoice which must have a name.

appAbout Area to put a commandLink to more information about the application.
appCopyright The copyright region of the page. If present, this area typically contains a outputText with the copyright information. This child is not supported on the following agent types: pda, phone, voice.
appPrivacy The privacy region of the page. If present, this area typically contains a commandLink to the privacy policy for the application.
branding The corporate or organization branding regio n of the page. This section typically contains a medium size objectImage of the logo of the organization owning the page.
brandingApp The application, module, or product branding region of the page. This section typically contains a objectImage of the application logo.
brandingAppContextual The application's contextual branding region of the page. This section typically contains formatted text indicating that ONE context exists between the persistent tabs. The user selects the context from a centralized aggregate home page of multiple contexts, then navigates into a tabbed application pertaining to that specific context. This child is not supported on the following agent types: pda, phone, voice.
contextSwitcher The context switcher of a page. This child is not supported on the following agent types: pda, phone, voice.
infoFootnote The footnote information region. This region provides a location for page-level information that is ancillary to the user's task. This child is not supported on the following agent types: pda, phone, voice.
infoReturn The return information region. Typically this will contain a "return to [X ] " link. This child is not supported on the following agent types: pda, phone, voice.
infoStatus The status information region. This region provides a location for page-level status that is important to the user's task. It also provides a location for a key notation. A ke y notation is a legend used to define icons, elements, or terms used within the page content.
infoSupplemental This region provides a location for presenting additional information for the user. It often contains a panelBox. This child is not supported on the following agent types: pda, phone, voice.
infoUser The user information region. This region provides a location for presenting user login and connection information. This child is not supported on the following agent types: pda, phone, voice.
location The locator region of the page. If present, this section typically contains either a processTrain, indicating the user's location in a multistep process, or menuPath, containing links that will bring the user back to each of the parent pages of a tree of pages that he has navigated down into.
menu1 This location typically contains a menuTabs.
menu2 This location typically contains a menuBar.
menu3 This location typically contains a menuList. This child is not supported on the following agent types: pda, phone, voice.
menuGlobal This section typically contains a menuButtons.
menuSwitch This location typically contains a menuChoice. This child is not supported on the following agent types: pda, phone, voice.
messages The node to display messages. Usually contains a messages component.
search The search region of the page. This child is not supported on the following agent types: pda, phone, voice.

Attributes
Ungrouped attributes
Name Type Supports EL? Description
attributeChangeListener javax.faces.el.MethodBinding Only EL a method reference to an attribute change listener
chromeType String Yes what the chromeType is for the page: compact or expanded. If compact, the brandingApp will be shown alongside the branding instead of below the branding.
messageType String Yes whether page is a messaging dialog. Legal values are "error", "info", "confirmation", "warning", "processing" and "none".
partialTriggers String[ ] Yes 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.
quickLinksShown boolean Yes whether "quick links" will be shown for this page.

When "quickLinksShown" is set to true, the panelPage will automatically search for panelHeader's inside its contents. One quicklink will be added to each - minus the first header, and minus any headers inside other headers (a.k.a. "subheaders").

In addition, panelPage will automatically add a top-level header if the "title" att ribute is set. This header is skipped over when looking for quicklinks.

This attribute is not supported on the following agent types: pda, phone, voice.
title String Yes The title to display for this page.
Core attributes
Name Type Supports EL? Description
binding oracle.adf.view.faces.component. core.layout.CorePanelPage Only EL a binding reference to store the component instance
id String No the identifier for the component. This must be a valid XML ID, and therefore may not contain whitespace or start with a number. Also, JSF requires that IDs must not contain any colons (":").
inlineStyle String Yes the inline CSS style for this element
rendered boolean Yes whether the bean is rendered. When set to false, no output will be delivered for this bean.
shortDesc String Yes the short description of the bean. This text is commonly used by user agents to display tooltip help text.
styleClass String Yes the CSS style class of the bean.
Javascript attributes
Name Type Supports EL? Description
onclick String Yes an onclick Javascript handler.
ondblclick String Yes an ondblclick Javascript handler.
onkeydown String Yes an onkeydown Javascript handler.
onkeypress String Yes an onkeypress Javascript handler.
onkeyup String Yes an onkeyup Javascript handler.
onmousedown String Yes an onmousedown Javascript handler.
onmousemove String Yes an onmousemove Javascript handler.
onmouseout String Yes an onmouseout Javascript handler.
onmouseover String Yes an onmouseover Javascript handler.
onmouseup String Yes an onmouseup Javascript handler.
Copyright © 2003-2006, Oracle Corporation. All Rights Reserved.

E-mail this page
Printer View Printer View
Oracle Is The Information Company About Oracle | Oracle RSS Feeds | Careers | Contact Us | Site Maps | Legal Notices | Terms of Use | Privacy