Project Documentation

Summary

Tag name: <tr:navigationPane>
UIComponent class: org.apache.myfaces.trinidad.component.core.nav.CoreNavigationPane
Component type: org.apache.myfaces.trinidad.CoreNavigationPane

Naming container: Yes. When referring to children of this component ("partialTriggers", findComponent(), etc.), you must prefix the child's ID with this component's ID and a colon (':').

The navigationPane component creates a series of navigation items representing one level in a navigation hierarchy. These items may either be added as children or a menu model may be bound to the navigationPane component. If a menu model is bound, of class org.apache.myfaces.trinidad.model.XMLMenuModel or org.apache.myfaces.trinidad.model.MenuModel, a level along the focus path, or the next level down, will be rendered. A node that is on the focus path will be rendered as "selected".

Note: The 'level' attribute is temporary. It is used to indicate the level along the focusPath to render. It will likely be replaced with an el expression in a future release.

XMLMenuModel extends TreeModel, but it also knows how to go from the current viewId to the focus path. Notice that the xmlMenuModel has no special knowledge of page navigation and places no requirements on the nodes that go into the tree. The nodes in the tree are stamped out with the 'nodeStamp' facet, which should contain a commandNavigationItem component, which allows the default actionListener mechanism to be used for page navigation.

Code Example(s)

<tr:navigationPane var="foo" value="#{xmlMenuModel}">
  <f:facet name="nodeStamp">
    <tr:commandNavigationItem
      text="#{foo.label}"
      action="#{foo.doAction}"
      destination="#{foo.destination}"/>
  </f:facet>
</tr:navigationPane>

Supported Client Events for Client Behaviors

  • click (default)
  • dblclick
  • keydown
  • keypress
  • keyup
  • mousedown
  • mousemove
  • mouseout
  • mouseover
  • mouseup

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.

Supported Facets

Name Description
nodeStampthe component to use to stamp each element in the navigation. A CommandNavigationItem is expected.

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.core.nav.CoreNavigationPaneOnly 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.
disabledbooleanYes Default Value: false

Whether the component is disabled.
hintStringYes Valid Values: tabs, bar, buttons, choice, list

How the navigational items are displayed. Options are:
  • bar
  • buttons
  • choice
  • list
  • tabs
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 CSS styles to use for this component.
levelintYes Default Value: 0

the level, based on a 0 based index, in the menuModel to render based on the focusPath of the menuModel.
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.
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.
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.

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".

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 component. This text is commonly used by user agents to display tooltip help text.
styleClassStringYes a CSS style class to use for this component.
titleStringYes Text that describes the items. (This attribute is only applicable if the rendering hint supports it, e.g. "choice".)
valueObjectYes the hierarchy of navigation data - must be of type org.apache.myfaces.trinidad.model.MenuModel
varStringNo Name of the EL variable used to reference each element of this collection. Once this component has completed rendering, this variable is removed (or reverted back to its previous value).
varStatusStringNo Name of the EL variable used to reference the varStatus information. Once this component has completed rendering, this variable is removed (or reverted back to its previous value). The VarStatus provides contextual information about the state of the component to EL expressions. For components that iterate, varStatus also provides loop counter information. Please see the this component's documentation for the specific properties on the varStatus. The common properties on varStatus include:
  • "model" - returns the CollectionModel for this component
  • "index" - returns the zero based row index