Summary

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 navigationTree is used to display navigation data that is structured in a
hierarchical format. The features of the Tree component include mechanisms for
expanding and collapsing portions of the hierarchy. The focus path of the
navigationTree is visually indicated and by default the nodes along the
focus path are added to the expandedRowKeys pathSet.

The "nodeStamp" facet of the navigationTree is used to render the
data for each node in the tree. The "nodeStamp" is repeatedly
rendered (stamped) once per node.

Code Example(s)

In the following
example, the data for each tree node is placed under the EL property
"node". The "nodeStamp" displays the data for each tree node by
getting further properties from the "node" property:

Supported Client Events for Client Behaviors

Events

Type

Phases

Description

org.apache.myfaces.trinidad.event.RowDisclosureEvent

Apply Request Values,Invoke Application

The expansion event is generated for a table when the detail facet of a row is expanded or collapsed. For tree or a treeTable, the expansion
event is generated when tree nodes are expanded or collapsed.

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

nodeStamp

the component to use to stamp each element in the
tree. Only certain types of components are supported,
including all
components with no behavior and most components that implement the
EditableValueHolder or ActionSource interfaces.

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.nav.CoreNavigationTree

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.

disclosedRowKeys

org.apache.myfaces.trinidad.model.RowKeySet

Yes

the set of disclosed rows for this component.
Each entry in the set is a rowKey.

id

String

No

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 ('-').

immediate

boolean

Yes

Default Value: false

whether data validation
should be skipped when row disclosure
events are generated by this component.
When immediate is false (the default), events will
be delivered during the Invoke Application phase, which
will trigger validation. When set to true, events
will be executed during the Apply Request Values phase.

inlineStyle

String

Yes

the CSS styles to use for this component.

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.

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.

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.

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.

rowDisclosureListener

javax.el.MethodExpression

Only EL

a method reference to an ExpansionListener

shortDesc

String

Yes

The short description of the component. This text is commonly used by user agents to display tooltip help text.

startLevel

int

Yes

Default Value: 0

the starting level, based on a 0 based index, in the menuModel to render based on the focusPath of the menuModel.

styleClass

String

Yes

a CSS style class to use for this component.

value

Object

Yes

the hierarchy of tree data - must be of type
org.apache.myfaces.trinidad.model.MenuModel

var

String

No

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

varStatus

String

No

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: