Summary

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)

Supported Client Events for Client Behaviors

load (default)

unload

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
alternateContent	These contents will be rendered inside HTML NOFRAMES tags. Browsers that do not support frames will render these contents.
bottom	The frame to be rendered below the center frame. This frame's height attribute is used to allocate its height.
center	The frame to be rendered in the center.
end	The 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.
innerEnd	The 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.
innerLeft	The frame to be rendered between the left frame and the center frame. This frame's width attribute is used to allocate its width.
innerRight	The frame to be rendered between the right frame and the center frame. This frame's width attribute is used to allocate its width.
innerStart	The 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.
left	The frame to be rendered to the left of the center frame. This frame's width attribute is used to allocate its width.
right	The frame to be rendered to the right of the center frame. This frame's width attribute is used to allocate its width.
start	The 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.
top	The 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
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.html.HtmlFrameBorderLayout	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.
borderWidth	int	Yes	The size for the border width to be rendered.
frameBorderWidth	int	Yes	The size for the frame border width to be rendered.
frameSpacing	int	Yes	The size of frame spacing to be rendered.
height	String	Yes	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.
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 inline CSS style for this element
onload	String	Yes	an onload Javascript handler.
onunload	String	Yes	an onunload 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.
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 bean. This text is commonly used by user agents to display tooltip help text.
styleClass	String	Yes	the CSS style class of the bean.
width	String	Yes	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.