Apache MyFaces Trinidad – <tr:commandButton>

Parent Project

Apache MyFaces Trinidad

Project Documentation

Summary

Tag Name:	<tr:commandButton>
Java Class:	org.apache.myfaces.trinidad.component.core.nav.CoreCommandButton
Component Type:	org.apache.myfaces.trinidad.CoreCommandButton

The commandButton control creates a button representation of a UIXCommand.

Code Example(s)

A simple example of a button saying "Enter" that submits an input field.

<tr:form>
  <tr:inputText value="Default input text" />
  <tr:commandButton text="Enter"/>
</tr:form>

An button which submits the form without doing any validation.

<tr:form>
  <tr:inputText value="Default input text"/>
  <tr:commandButton text="Unvalidated Submit"
                    immediate="true" />
</tr:form>

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.ActionEvent	Invoke 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.ReturnEvent	Apply Request Values	Event delivered when the dialog has completed successfully.
org.apache.myfaces.trinidad.event.LaunchEvent	Invoke Application, Apply Request Values	Event delivered to prompt the command to launch a dialog.
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.

Attributes

Name	Type	Supports EL?	Description
accessKey	char	Yes	Character used to gain quick access to this button. For accessibility reasons, this functionality is not supported in screen reader mode. If the same access key appears in multiple input fields 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 button 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.
action	javax.el.MethodExpression	Yes	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.
actionListener	javax.faces.el.MethodBinding	Only EL	a method reference to an action listener
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.CoreCommandButton	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.
blocking	boolean	Yes	Default Value: false If set to TRUE the component will start blocking user input when the action is initiated. The blocking will stop when a response is received from the server.
disabled	boolean	Yes	Default Value: false whether the button should be disabled.
icon	String	Yes	An URL to an image to use for an icon displayed in the button.
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).
immediate	boolean	Yes	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.
inlineStyle	String	Yes	the CSS styles to use for this component.
launchListener	javax.el.MethodExpression	Only EL	a method reference to a launch listener
onblur	String	Yes	the event handler for the component losing the focus. Not supported on the following agents: pda
onclick	String	Yes	an onclick Javascript handler.
ondblclick	String	Yes	an ondblclick Javascript handler.
onfocus	String	Yes	the event handler for the component gaining the focus. Not supported on the following agents: pda
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.
partialSubmit	boolean	Yes	Default Value: false whether the action should be done through a partial page submit or not. Default is false: no partial page submit.
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.
returnListener	javax.el.MethodExpression	Only 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.
shortDesc	String	Yes	The short description of the component. This text is commonly used by user agents to display tooltip help text.
styleClass	String	Yes	a CSS style class to use for this component.
text	String	Yes	the textual label of the button.
textAndAccessKey	String	Yes	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&ext" will set the text to "Text" and the access key to 'e'.
useWindow	boolean	Yes	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.
windowHeight	int	Yes	Height of the window, if this command is used to launch a window.
windowWidth	int	Yes	Width of the window, if this command is used to launch a window.