Project Documentation

Summary

Tag name: <trh:body>
UIComponent class: org.apache.myfaces.trinidad.component.html.HtmlBody
Component type: org.apache.myfaces.trinidad.HtmlBody
Required Ancestor Tag: trh:html

Tag for the HTML body element. In addition to providing support for the standard HTML body functionality, the Trinidad body component enables partial-page rendering (PPR) support and assigning initial page focus.

The body component resets the Trinidad EL context when code re-enters the component via an invoke on component call or a visit tree call. See the org.apache.myfaces.trinidad.context.ComponentContextManager for more information.

Code Example(s)

<trh:html>
  <trh:body>
    <trh:outputText value="Here is some text inside a body element"/>
  </trh:body>
</trh:html>

Supported Client Events for Client Behaviors

  • click
  • dblclick
  • keydown
  • keypress
  • keyup
  • load (default)
  • mousedown
  • mousemove
  • mouseout
  • mouseover
  • mouseup
  • 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.

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.HtmlBodyOnly 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.
firstClickPassedbooleanYes Default Value: false

whether or not Trinidad will allow the first click to go through in certain instances. When a PPR event occurs, we block all subsequent user input until it completes. However, there may be instances where the client wants to receive the very first click. For example, if the user entered text in an inputText that fires a PPR request, then the user immediately clicked a submit button two events will be triggered - an onchange followed by an onclick. The onchange will trigger the client action which will immediately start the PPR blocking, so the onclick will get consumed by the blocking code and no submit will occur. Setting this value to true will allow the click to go through.
Not supported on the following agents: pda
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 ('-').
initialFocusIdStringYes the id of the component to which you want the focus to be when the full page renders. The accessibility-mode must be set to "inaccessible" for this feature to be on.
Not supported on the following agents: pda
inlineStyleStringYes the inline CSS style for this element
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.
onloadStringYes an onload 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.
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.