Project Documentation

Summary

Tag name: <trh:frame>
UIComponent class: org.apache.myfaces.trinidad.component.html.HtmlFrame
Component type: org.apache.myfaces.trinidad.HtmlFrame
Required Ancestor Tag: trh:frameBorderLayout
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)

<trh:frameBorderLayout >
  <f:facet name="left">
    <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>

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.

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.HtmlFrameOnly 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.
heightStringYes 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.
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
longDescURLStringYes 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.
marginHeightintYes the width of the frame margin. The value must be greater than zero (pixels).
marginWidthintYes the width of the frame margin. The value must be greater than zero (pixels).
nameStringYes the name used to identify this frame
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.
scrollingStringYes 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"
shortDescStringYes the short description of the bean. This text is commonly used by user agents to display tooltip help text.
sourceStringYes the URI for the source of this frame
styleClassStringYes the CSS style class of the bean.
widthStringYes 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.