Project Documentation

Summary

Tag name: <tr:panelBorderLayout>
UIComponent 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.AttributeChangeEventInvoke 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
bottomContent to be rendered below the children.
endContent 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.
innerBottomContent to be rendered below the children, but above 'bottom'.
innerEndthe equivalent of innerRight on left-to-right clients and innerLeft on right-to-left clients.
innerLeftContent to be rendered to the left of the children and between any innerTop and innerBottom facets, to the right of the left facet.
innerRightContent to be rendered to the right of the children and between any innerTop and innerBottom facets.
innerStartthe equivalent of innerLeft on left-to-right clients and innerRight on right-to-left clients.
innerTopContent to be rendered above the children, inside of 'top'.
leftContent to be rendered to the left of the children and between any top and bottom facets.
rightContent to be rendered to the right of the children and between any top and bottom facets.
startContent 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.
topContent to be rendered above the children.

Attributes

Name Type Supports EL? Description
attributeChangeListenerjavax.el.MethodExpressionOnly 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.
bindingorg.apache.myfaces.trinidad.component.core.layout.CorePanelBorderLayoutOnly 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.
bottomHeightStringYes 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%.
endWidthStringYes 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%.
idStringNo the identifier for the component. The identifier must follow a subset of the syntax allowed in HTML:
  • Must not be a zero-length String.
  • First character must be an ASCII letter (A-Za-z) or an underscore ('_').
  • Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').
inlineStyleStringYes the CSS styles to use for this component.
innerBottomHeightStringYes 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%.
innerEndWidthStringYes 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%.
innerLeftWidthStringYes 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%.
innerRightWidthStringYes 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%.
innerStartWidthStringYes 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%.
innerTopHeightStringYes 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%.
layoutStringYes 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.
leftWidthStringYes 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%.
onclickStringYes an onclick Javascript handler.
ondblclickStringYes an ondblclick Javascript handler.
onkeydownStringYes an onkeydown Javascript handler.
onkeypressStringYes an onkeypress Javascript handler.
onkeyupStringYes an onkeyup Javascript handler.
onmousedownStringYes an onmousedown Javascript handler.
onmousemoveStringYes an onmousemove Javascript handler.
onmouseoutStringYes an onmouseout Javascript handler.
onmouseoverStringYes an onmouseover Javascript handler.
onmouseupStringYes an onmouseup Javascript handler.
partialTriggersString[]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".

renderedbooleanYes 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.
rightWidthStringYes 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%.
shortDescStringYes The short description of the component. This text is commonly used by user agents to display tooltip help text.
startWidthStringYes 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%.
styleClassStringYes a CSS style class to use for this component.
topHeightStringYes 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%.