Apache MyFaces Trinidad – <tr:panelPage>

Parent Project

Apache MyFaces Trinidad

Project Documentation

Summary

Tag Name:	<tr:panelPage>
Java Class:	org.apache.myfaces.trinidad.component.core.layout.CorePanelPage
Component Type:	org.apache.myfaces.trinidad.CorePanelPage

PanelPage lays out an entire page. It supports several navigation and content areas for the creation of pages. When the panelPage is geometry managed, the last indexed child will be stretched vertically to fit in the leftover space not consumed by the other indexed children. If you do not want this stretching behavior, you must wrap your indexed children with a panelGroup with layout="vertical" and inlineStyle="overflow: auto;". This way, the panelGroup will be stretched to fit and scrollbars will appear when the content inside is larger than the allocated space.

Code Example(s)

<tr:panelPage>
  <f:facet name="branding">
    <tr:panelGroupLayout layout="horizontal">
      <tr:image source="/images/corporateBrand.gif"/>
      <tr:outputText value="My Company"/>
    </tr:panelGroupLayout>
  </f:facet>
  <f:facet name="location">
    <tr:breadCrumbs>
      <tr:commandNavigationItem text="crumb 1" action="guide.navigationLevel"/>
      <tr:commandNavigationItem text="crumb 2" action="guide.navigationLevel"/>
      <tr:commandNavigationItem text="crumb 3" action="guide.navigationLevel"/>
      <tr:commandNavigationItem text="crumb 4" action="guide.navigationLevel"/>
    </tr:breadCrumbs>
  </f:facet>
  <f:facet name="navigation1">
    <tr:navigationPane>
      <tr:commandNavigationItem text="tab 1" action="guide.navigationLevel"/>
      <tr:commandNavigationItem text="tab 2" action="guide.navigationLevel"
        selected="true"/>
      <tr:commandNavigationItem text="tab 3" action="guide.navigationLevel"/>
      <tr:commandNavigationItem text="tab 4" action="guide.navigationLevel"/>
      <tr:commandNavigationItem text="tab 5" action="guide.navigationLevel"/>
      <tr:commandNavigationItem text="tab 6" action="guide.navigationLevel"
        disabled="true"/>
    </tr:navigationPane>
  </f:facet>
  <f:facet name="navigation2">
    <tr:navigationPane>
      <tr:commandNavigationItem text="item 1" action="guide.navigationLevel"
        selected="true"/>
      <tr:commandNavigationItem text="item 2" action="guide.navigationLevel"
        disabled="true"/>
      <tr:commandNavigationItem text="item 3" action="guide.navigationLevel"/>
      <tr:commandNavigationItem text="item 4" action="guide.navigationLevel"/>
    </tr:navigationPane>
  </f:facet>
  <f:facet name="navigation3">
    <tr:navigationPane>
      <tr:commandNavigationItem text="item 1" action="guide.navigationLevel"/>
      <tr:commandNavigationItem text="item 2" action="guide.navigationLevel"/>
      <tr:commandNavigationItem text="item 3" action="guide.navigationLevel"/>
    </tr:navigationPane>
  </f:facet>
  <f:facet name="navigationGlobal">
    <tr:navigationPane>
      <tr:commandNavigationItem text="Home" action="guide.navigationLevel"/>
      <tr:commandNavigationItem text="Help" action="guide.navigationLevel"/>
      <tr:commandNavigationItem text="Sign Out" action="guide.navigationLevel"/>
    </tr:navigationPane>
  </f:facet>
  <tr:outputText value="Content here"/>
</tr:panelPage>

Supported Client Events for Client Behaviors

click (default)
dblclick
keydown
keypress

keyup
mousedown
mousemove
mouseout

mouseover
mouseup

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.

Supported Facets

Name	Description
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 an outputText with the copyright information.
appPrivacy	The privacy region of the page. If present, this area typically contains a commandLink to the privacy policy for the application.
branding	The branding region of the page. This section typically contains a horizontal panelGroup for an image of a logo and an outputText for a title.
infoFootnote	The footnote information region. This region provides a location for page-level information that is ancillary to the user's task.
infoReturn	The return information region. Typically this will contain a "return to [X]" link.
infoStatus	The status information region. This region provides a location for page-level status that is important to the user's task.
infoUser	The user information region. This region provides a location for presenting user sign-in and connection information.
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 navigationPath, 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.
navigation1	This location typically contains tabs for the primary layer.
navigation2	This location typically contains tabs for the secondary layer.
navigation3	An optional vertically oriented region of contexual components for the main content. Often this contains a list or tree of links for deeper navigation structure than the global, primary, and secondary regions can provide.
navigationGlobal	This section typically contains global application links or otherwise top level navigation structure links, e.g. "Home", "Preferences", "Help", and "Sign Out".
search	The search region of the page. Typically used for application or system-wide searches.

Attributes

Name	Type	Supports EL?	Description
attributeChangeListener	javax.el.MethodExpression	Only EL	a method reference to an attribute change listener. 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.
auxiliary1Size	int	Yes	Default Value: 200 Specifies the number of pixels that the auxiliary1 content should consume (this is a width if the orientationis "start" or "end" or a height if the orientation is "bottom").
auxiliary2Size	int	Yes	Default Value: 200 Specifies the number of pixels that the auxiliary2 content should consume (this is a width if the orientationis "start" or "end" or a height if the orientation is "bottom").
auxiliaryGlobalSize	int	Yes	Default Value: 200 Specifies the number of pixels that the auxiliaryGlobal content should consume (this is a width if the orientationis "start" or "end" or a height if the orientation is "bottom").
binding	org.apache.myfaces.trinidad.component.core.layout.CorePanelPage	Only EL	an EL reference that will store the component instance on a bean. This can be used to give programmatic access to a component from a backing bean, or to move creation of the component to a backing bean.
id	String	No	the identifier for the component. Every component may be named by a component identifier that must conform to the following rules: They must start with a letter (as defined by the Character.isLetter() method) or underscore ( _ ). Subsequent characters must be letters (as defined by the Character.isLetter() method), digits as defined by the Character.isDigit() method, dashes ( - ), or underscores ( _ ). To minimize the size of responses generated by JavaServer Faces, it is recommended that component identifiers be as short as possible. If a component has been given an identifier, it must be unique in the namespace of the closest ancestor to that component that is a NamingContainer (if any).
inlineStyle	String	Yes	the CSS styles to use for this component.
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.
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. Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2" Identifiers must account for NamingContainers. You can use a single colon to start the search from the root, or use multiple colons to move up through the NamingContainer. For example, "::" will pop out of this component's naming container (it pops out of itself if it is a naming container), ":::" will pop out of two naming containers, etc. The search for the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the component with id = commandButton1 after popping out of two naming containers relative to this component. To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".
rendered	boolean	Yes	Default Value: true whether the component is rendered. When set to false, no output will be delivered for this component (the component will not in any way be rendered, and cannot be made visible on the client). If you want to change a component's rendered attribute from false to true using PPR, set the partialTrigger attribute of its parent component so the parent refreshes and in turn will render this component.
shortDesc	String	Yes	The short description of the component. This text is commonly used by user agents to display tooltip help text.
styleClass	String	Yes	a CSS style class to use for this component.