Project Documentation

Summary

Tag name: <trh:frameBorderLayout>
UIComponent class: org.apache.myfaces.trinidad.component.html.HtmlFrameBorderLayout
Component type: org.apache.myfaces.trinidad.HtmlFrameBorderLayout
Required Ancestor Tag: trh:html
Unsupported agents: pda
frameBorderLayout is a layout bean which can be used to place seven frames at left, right, top, bottom, innerLeft, innerRight and center positions. It does not render any children except for the specified facets which must all be either frames or frameBorderLayouts. The user may use either left/right or start/end as facets, but not both. Left/right takes precedence over start/end.

On mobile devices a list linking to each frame is rendered.

Code Example(s)

<trh:frameBorderLayout>
 <f:facet name="Lleft">
  <trh:frame source="frame_leftTest.jspx" name="left" width="30%" />
 </f:facet>

 <f:facet name="center">
  <trh:frame source="frame_centerTest.jspx" name="contents" />
 </f:facet>
</trh:frameBorderLayout>

Supported Client Events for Client Behaviors

  • load (default)
  • unload

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
alternateContentThese contents will be rendered inside HTML NOFRAMES tags. Browsers that do not support frames will render these contents.
bottomThe frame to be rendered below the center frame. This frame's height attribute is used to allocate its height.
centerThe frame to be rendered in the center.
endThe frame to be rendered to the right of the center frame, if the reading direction is left-to-right, or left otherwise. This frame's width attribute is used to allocate its width.
innerEndThe frame to be rendered as the innerRight frame, if the reading direction is left-to-right, or innerLeft frame otherwise. This frame's width attribute is used to allocate its width.
innerLeftThe frame to be rendered between the left frame and the center frame. This frame's width attribute is used to allocate its width.
innerRightThe frame to be rendered between the right frame and the center frame. This frame's width attribute is used to allocate its width.
innerStartThe frame to be rendered as the innerLeft frame, if the reading direction is left-to-right, or innerRight frame otherwise. This frame's width attribute is used to allocate its width.
leftThe frame to be rendered to the left of the center frame. This frame's width attribute is used to allocate its width.
rightThe frame to be rendered to the right of the center frame. This frame's width attribute is used to allocate its width.
startThe frame to be rendered to the left of the center frame, if the reading direction is left-to-right, or right otherwise. This frame's width attribute is used to allocate its width.
topThe frame to be rendered above the center frame. This frame's height attribute is used to allocate its height.

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.html.HtmlFrameBorderLayoutOnly 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.
borderWidthintYes The size for the border width to be rendered.
frameBorderWidthintYes The size for the frame border width to be rendered.
frameSpacingintYes The size of frame spacing to be rendered.
heightStringYes The proposed height of this frameBorderLayout. This can be in pixels or percentage. This attribute is used only if this a nested frameBorderLayout in a top/bottom facet of a frameBorderLayout.
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 inline CSS style for this element
onloadStringYes an onload Javascript handler.
onunloadStringYes an onunload 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.
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.
shortDescStringYes the short description of the bean. This text is commonly used by user agents to display tooltip help text.
styleClassStringYes the CSS style class of the bean.
widthStringYes The proposed width of this frameBorderLayout. This can be in pixels or percentage. This attribute is used only if this a nested frameBorderLayout in a left/right facet of a frameBorderLayout.