Project Documentation

Summary

Tag name: <tr:singleStepButtonBar>
UIComponent class: org.apache.myfaces.trinidad.component.core.nav.CoreSingleStepButtonBar
Component type: org.apache.myfaces.trinidad.CoreSingleStepButtonBar
SingleStepButtonBar renders a Previous button, text indicating the current step and the maximum steps, and a Next button. SingleStepButtonBar is used to navigate forward and back in a series of steps, like steps in a checkout process.

Events and Listeners

SingleStepButtonBar implements javax.faces.component.ActionSource, which means it is a source of javax.faces.event.ActionEvent's.

The ActionEvent is delivered during the Apply Request Values phase when navigating back, and during the Invoke Application phase when navigating forward.

The nextAction/previousAction attributes are of type MethodBinding and must (if non-null) point to an action method. The nextAction method will be called when navigating forward, and the previousAction method will be called when navigating back with a singleStep component.

JSF has a default javax.faces.event.ActionListener that passes the nextAction or previousAction outcome to the NavigationHandler.

The nextActionListener/previousActionListener attributes are of type MethodBinding and must (in non-null) point to a method accepting an ActionEvent, with a return type of void. When navigating to the previous step, then the previousActionListener method is called. When navigating to the next step, the nextActionListener method is called.

Code Example(s)

A simple example of a singleStepButtonBar.

<tr:form>
  <tr:singleStepButtonBar selectedStep="2" maxStep="5" previousAction="cart"
                          nextAction="checkout"/>
</tr:form>

Supported Client Events for Client Behaviors

  • 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.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.core.nav.CoreSingleStepButtonBarOnly 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.
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.
maxStepintYes Default Value: -1

the last possible step. If this value is not known, it should be set to MAX_VALUE_UNKNOWN (-1), which is also the default value. If maxStep is MAX_VALUE_UNKNOWN, then no text is rendered between the Back/Next buttons. When maxStep is 2 and selectedStep is 1, then only a Continue button is rendered.
nextActionjavax.faces.el.MethodBindingOnly EL a reference to an action method that will be called when the singleStep component navigates to the next step, or the static outcome of the action.
nextActionListenerjavax.faces.el.MethodBindingOnly EL a method reference to an action listener that will be called when the singleStep component navigates to the next step.
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".

previousActionjavax.faces.el.MethodBindingOnly EL a reference to an action method that will be called when the singleStep component navigates to the previous step, or the static outcome of the action.
previousActionListenerjavax.faces.el.MethodBindingOnly EL a method reference to an action listener that will be called when the singleStep component navigates to the previous step.
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.
selectedStepintYes Default Value: 1

the current step. The valid range is 1 to maxStep. It defaults to 1.
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.
textStringYes the text description of items being navigated. The default is "Step".