Summary

The frame is used to specify attributes needed by an HTML frame. It does not render any child nodes, and should only be used as a facet on a frameBorderLayout component. The contents of a frame is selected by using the source attribute.

On mobile devices a list links to each frame is rendered for a frameBorderLayout, and each frame is brought up as a separate page.

Code Example(s)

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.

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.HtmlFrame	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.
height	String	Yes	the proposed height of this frame. This can be in pixels or percentage. This attribute is used only if this frame is a top/bottom facet of a frameBorderLayout component.
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
longDescURL	String	Yes	This attribute specifies a link to a long description of the frame. This description should supplement the short description provided using the shortDesc attribute, and may be particularly useful for non-visual user agents.
marginHeight	int	Yes	the width of the frame margin. The value must be greater than zero (pixels).
marginWidth	int	Yes	the width of the frame margin. The value must be greater than zero (pixels).
name	String	Yes	the name used to identify this frame
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.
scrolling	String	Yes	Default Value: auto whether or not scrollbars are available on this frame. Valid values for this attribute are the following constants: "yes" specifies that scrollbars are always available. "no" specifies that scrollbars are never available. "auto" specifies that the browser determines whether to display scroll bars based on the size of the frame and its content. If you do not specify a value for scrolling, the default value is "auto"
shortDesc	String	Yes	the short description of the bean. This text is commonly used by user agents to display tooltip help text.
source	String	Yes	the URI for the source of this frame
styleClass	String	Yes	the CSS style class of the bean.
width	String	Yes	the proposed width of this frame This can be in pixels or percentage. This attribute is used only if this frame is a left/right facet of a frameBorderLayout component.