Parent Project
Project Documentation

Summary

Tag Name: <tr:panelBorderLayout>
Java Class: org.apache.myfaces.trinidad.component.core.layout.CorePanelBorderLayout
Component Type: org.apache.myfaces.trinidad.CorePanelBorderLayout
The panelBorderLayout component is a layout element which lays out all of its children consecutively in its middle, and supports twelve other facets: top, bottom, left, right, start and end. Clients should use only one of left/right or start/end for each side, in any one container, but if both are used, left/right "wins".

Code Example(s)

<tr:panelBorderLayout>
  <f:facet name="top">
    <tr:image source="/images/globalhelp.gif"/>
  </f:facet>

  <f:facet name="bottom">
    <tr:image source="/images/warnl.gif"/>
  </f:facet>

  <f:facet name="end">
    <tr:image source="/images/cobrand.gif"/>
  </f:facet>

  <f:facet name="start">
    <tr:image source="/images/info.gif"/>
  </f:facet>

  <tr:outputText value="Here is some content"
                 styleClass="AFInstructionText"/>
</tr:panelBorderLayout>

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
bottom Content to be rendered below the children.
end Content to be rendered to the right of the children and between any top and bottom facets, if the reading direction is left-to-right, on the left otherwise.
innerBottom Content to be rendered below the children, but above 'bottom'.
innerEnd the equivalent of innerRight on left-to-right clients and innerLeft on right-to-left clients.
innerLeft Content to be rendered to the left of the children and between any innerTop and innerBottom facets, to the right of the left facet.
innerRight Content to be rendered to the right of the children and between any innerTop and innerBottom facets.
innerStart the equivalent of innerLeft on left-to-right clients and innerRight on right-to-left clients.
innerTop Content to be rendered above the children, inside of 'top'.
left Content to be rendered to the left of the children and between any top and bottom facets.
right Content to be rendered to the right of the children and between any top and bottom facets.
start Content to be rendered to the left of the children and between any top and bottom facets, if the reading direction is left-to-right, on the right otherwise.
top Content to be rendered above the children.

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.
binding org.apache.myfaces.trinidad.component.core.layout.CorePanelBorderLayout 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.
bottomHeight String Yes Default Value: 25%

Specifies the CSS height to give to the bottom facet in valid CSS units. Used if the layout is positioned and the bottom facet is present and rendered. Defaults to 25%.
endWidth String Yes Default Value: 25%

Specifies the CSS width to give to the end facet in valid CSS units. Used if the layout is positioned and the end facet is present and rendered and the left or right facet is not used instead. Defaults to 25%.
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.
innerBottomHeight String Yes Default Value: 25%

Specifies the CSS height to give to the inner bottom facet in valid CSS units. Used if the layout is positioned and the inner bottom facet is present and rendered. Defaults to 25%.
innerEndWidth String Yes Default Value: 25%

Specifies the CSS width to give to the inner end facet in valid CSS units. Used if the layout is positioned and the inner end facet is present and rendered and the inner left or right facet is not used instead. Defaults to 25%.
innerLeftWidth String Yes Default Value: 25%

Specifies the CSS width to give to the inner left facet in valid CSS units. Used if the layout is positioned and the inner left facet is present and rendered. Defaults to 25%.
innerRightWidth String Yes Default Value: 25%

Specifies the CSS width to give to the inner right facet in valid CSS units. Used if the layout is positioned and the inner right facet is present and rendered. Defaults to 25%.
innerStartWidth String Yes Default Value: 25%

Specifies the CSS width to give to the inner start facet in valid CSS units. Used if the layout is positioned and the inner start facet is present and rendered and the inner left or right facet is not used instead. Defaults to 25%.
innerTopHeight String Yes Default Value: 25%

Specifies the CSS height to give to the inner top facet in valid CSS units. Used if the layout is positioned and the inner top facet is present and rendered. Defaults to 25%.
layout String Yes Valid Values: expand, positioned
Default Value: expand

Changes how the panel is rendered. The default is to expand the panel to fix the size of its contents. Setting the value to positioned will force the panel to use the size given to it via CSS (either via the styleClass, inlineStyle or via the skin). The facets are sized using the height and width attributes and the center is given the remainder. With a positioned layout the height and width should be set and the position should be set to relative or absolute. Note that due to limitations in IE6, the positioned layout uses JavaScript resizing that will affect performance. Expand is the default.
leftWidth String Yes Default Value: 25%

Specifies the CSS width to give to the left facet in valid CSS units. Used if the layout is positioned and the left facet is present and rendered. Defaults to 25%.
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.
rightWidth String Yes Default Value: 25%

Specifies the CSS width to give to the right facet in valid CSS units. Used if the layout is positioned and the right facet is present and rendered. Defaults to 25%.
shortDesc String Yes The short description of the component. This text is commonly used by user agents to display tooltip help text.
startWidth String Yes Default Value: 25%

Specifies the CSS width to give to the start facet in valid CSS units. Used if the layout is positioned and the start facet is present and rendered and the left or right facet is not used instead. Defaults to 25%.
styleClass String Yes a CSS style class to use for this component.
topHeight String Yes Default Value: 25%

Specifies the CSS height to give to the top facet in valid CSS units. Used if the layout is positioned and the top facet is present and rendered. Defaults to 25%.