Parent Project
Project Documentation

Summary

Tag name: <tr:document>
UIComponent class: org.apache.myfaces.trinidad.component.core.CoreDocument
Component type: org.apache.myfaces.trinidad.CoreDocument
The CoreDocument creates each of the standard root elements of an HTML page: <html>, <body>, and <head>, but by abstracting away from those components, can be used in non-HTML pages as well.

Code Example(s)

<f:view>
  <tr:document>
    <tr:form> ... </tr:form>
  </tr:document>
</f:view>

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.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
metaContainer Content to be rendered as meta data inside the "head" section.

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.core.CoreDocument 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.
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).
initialFocusId String Yes 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.
inlineStyle String Yes the CSS styles to use for this component.
mode String Yes Valid Values: default, strict, quirks
Default Value: default

Set if the page should render in default standards mode, quirks mode, or strict mode. Behavior of the modes are:
  • "default": renders as transitional doctypes for both XHTML and HTML, with "almost standards" rendering mode
  • "strict": renders as a strict doctype for both XHTML and HTML, also in standards rendering mode
  • "quirks": renders HTML pages in quirks mode, and XHTML with a transitional doctype, but standards mode (there is no quirks mode for XHTML).
onclick String Yes an onclick Javascript handler.
ondblclick String Yes an ondblclick Javascript handler.
onkeydown String Yes an onkeydown Javascript handler.
onkeypress String Yes an onkeypress Javascript handler.
onkeyup String Yes an onkeyup Javascript handler.
onload String Yes an onload Javascript handler.
onmousedown String Yes an onmousedown Javascript handler.
onmousemove String Yes an onmousemove Javascript handler.
onmouseout String Yes an onmouseout Javascript handler.
onmouseover String Yes an onmouseover Javascript handler.
onmouseup String Yes an onmouseup 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.

Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"

Identifiers must account for NamingContainers. You can use a single colon to start the search from the root, or use multiple colons to move up through the NamingContainer. For example, "::" will pop out of this component's naming container (it pops out of itself if it is a naming container), ":::" will pop out of two naming containers, etc. The search for the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the component with id = commandButton1 after popping out of two naming containers relative to this component. To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".

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 component. This text is commonly used by user agents to display tooltip help text.
stateSaving String Yes Valid Values: default, client, server
Default Value: default

Specify the state saving behavior for this page. client=force to be (full) client; server=force to be server-side; default=follows the settings of the web.xml
styleClass String Yes a CSS style class to use for this component.
title String Yes The title of the document. (This title doesn't have to match the title on any contained panelPage.)