Project Documentation

Summary

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

The commandNavigationItem control creates a navigation item representation of a UIXCommand. The item could be rendered as a link, an option, a button, etc. This component is normally used as a stamp for a component that takes a MenuModel or XMLMenuModel object.

Code Example(s)

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

Supported Client Events for Client Behaviors

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

Events

Type Phases Description
javax.faces.event.ActionEventInvoke Application,
Apply Request Values
Event delivered when the "action" of the component has been invoked; for example, by clicking on a button. The action may result in page navigation.
org.apache.myfaces.trinidad.event.ReturnEventApply Request ValuesEvent delivered when the dialog has completed successfully.
org.apache.myfaces.trinidad.event.LaunchEventInvoke Application,
Apply Request Values
Event delivered to prompt the command to launch a dialog.
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
accessKeycharYes Character used to gain quick access to this item. For accessibility reasons, this functionality is not supported in screen reader mode.

If the same access key appears in multiple locations in the same page of output, the rendering user agent will cycle among the elements accessed by the similar keys. Note that user agents are inconsistent about dealing with two links having same access key, and so the cycling behavior is dependent on what the user agent provides.

This attribute is sometimes referred to as the "mnemonic".

The character specified by this attribute must exist in the text attribute of this item instance. If it does not, the user will receive no visual indication of the existence of the accessKey. The easiest, and most convenient way to specify both the text and the mnemonic together is to use textAndAccessKey.

actionjavax.el.MethodExpressionYes a reference to an action method sent by the command component, or the static outcome of an action. If the action starts with "dialog:", useWindow attribute must be set to true.
actionListenerjavax.faces.el.MethodBindingOnly EL a method reference to an action listener
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.CoreCommandNavigationItemOnly 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.
destinationStringYes The URI this component references when activated. This is an alternative to using an action.
disabledbooleanYes Default Value: false

If value is "true", the component becomes non-interactive. Otherwise,the default value is "false" and component assumes its expected behavior.
iconStringYes a URI specifying the location of a target image.
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 ('-').
immediatebooleanYes Default Value: false

whether data validation - client-side or server-side - will be skipped when events are generated by this component. When immediate is true, the command's action and ActionListeners, including the default ActionListener provided by the JavaServer Faces implementation, will be executed during Apply Request Values phase of the request processing lifecycle, rather than waiting until the Invoke Application phase. Because validation runs during Process Validators (after Apply Request Values, but before Invoke Application), setting immediate to true will skip validation.
inlineStyleStringYes the CSS styles to use for this component.
launchListenerjavax.el.MethodExpressionOnly EL a method reference to a launch listener
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.
partialSubmitbooleanYes Default Value: false

whether the action should be done through a partial page submit or not. Default is false: no partial page submit.
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.
returnListenerjavax.el.MethodExpressionOnly EL a method reference to a return listener.This method is used to process dialog returnEvents which are generated as a result of either calling org.apache.myfaces.trinidad.context.RequestContext.returnFromDialog directly or declaratively through the use of a returnActionListener tag.
selectedbooleanYes Default Value: false

whether the item is selected.
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.
targetFrameStringYes the target frame for the go component.
textStringYes the text of the item.
textAndAccessKeyStringYes An attribute that will simultaneously set both the "text" and "accessKey" attributes from a single value, using conventional ampersand ('&') notation.

For example, setting this attribute to "T&amp;ext" will set the text to "Text" and the access key to 'e'.

useWindowbooleanYes Default Value: false

Indicates whether processes launched by this command should be launched in a secondary dialog window. 'useWindow' requires that the "action" attribute start with "dialog:". Set useWindow to 'false' for the outcome of the action to be targeted to the existing window.
visitedbooleanYes Default Value: false

whether the item is in visited state. Depending on the renderer the item may appear in a visited style, if true. This property is currently used only within the a train component.
windowHeightintYes Height of the window, if this command is used to launch a window.
windowWidthintYes Width of the window, if this command is used to launch a window.