Summary
Tag name: <t:commandButton>
UIComponent class: org.apache.myfaces.component.html.ext.HtmlCommandButton
Tag class: org.apache.myfaces.generated.taglib.html.ext.HtmlCommandButtonTag
Component type: org.apache.myfaces.HtmlCommandButton
Component family: javax.faces.Command
Renderer type: org.apache.myfaces.Button
Renderer class: org.apache.myfaces.renderkit.html.ext.HtmlButtonRenderer
Extends standard commandButton by user role support.
Unless otherwise specified, all attributes accept static values or EL expressions.
Attributes
Name | Type | Supports EL? | Description |
---|---|---|---|
accesskey | String | Yes | HTML: Sets the access key for this element. |
action | javax.el.MethodExpression | Yes | The action to take when this command is invoked.
If the value is an expression, it is expected to be a method binding EL expression that identifies an action method. An action method accepts no parameters and has a String return value, called the action outcome, that identifies the next view displayed. The phase that this event is fired in can be controlled via the immediate attribute. If the value is a string literal, it is treated as a navigation outcome for the current view. This is functionally equivalent to a reference to an action method that returns the string literal. |
actionFor | String | Yes | Comma separated list of subForm-ids for which validation and model update should take place when this command is executed. You need to wrap your input components in org.apache.myfaces.custom.subform.SubForm instances for this to work. |
actionListener | javax.faces.el.MethodBinding | Only EL | |
alt | String | Yes | HTML: Specifies alternative text that can be used by a browser that can't show this element. |
binding | org.apache.myfaces.component.html.ext.HtmlCommandButton | Only EL | Identifies a backing bean property (of type UIComponent or appropriate subclass) to bind " + "to this component instance. This value must be an EL expression. |
dir | String | Yes | HTML: The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left). |
disabled | boolean | Yes | HTML: When true, this element cannot receive focus. |
enabledOnUserRole | String | Yes | If user is in given role, this component will be rendered normally. If not, no hyperlink is rendered but all nested tags (=body) are rendered. |
forceId | boolean | No | If true, this component will force the use of the specified id when rendering. |
forceIdIndex | boolean | No | If false, this component will not append a '[n]' suffix (where 'n' is the row index) to components that are contained within a "list." This value will be true by default and the value will be ignored if the value of forceId is false (or not specified.) |
id | String | Yes | Get a string which uniquely identifies this UIComponent within the scope of the nearest ancestor NamingContainer component. The id is not necessarily unique across all components in the current view. |
image | String | Yes | HTML: The URL of an image that renders in place of the button. |
immediate | boolean | Yes | A boolean value that identifies the phase during which action events
should fire.
During normal event processing, action methods and action listener methods are fired during the "invoke application" phase of request processing. If this attribute is set to "true", these methods are fired instead at the end of the "apply request values" phase. |
label | String | Yes | A display name for this component. |
lang | String | Yes | HTML: The base language of this document. |
onblur | String | Yes | HTML: Specifies a script to be invoked when the element loses focus. |
onchange | String | Yes | HTML: Specifies a script to be invoked when the element is modified. |
onclick | String | Yes | HTML: Script to be invoked when the element is clicked. |
ondblclick | String | Yes | HTML: Script to be invoked when the element is double-clicked. |
onfocus | String | Yes | HTML: Specifies a script to be invoked when the element receives focus. |
onkeydown | String | Yes | HTML: Script to be invoked when a key is pressed down over this element. |
onkeypress | String | Yes | HTML: Script to be invoked when a key is pressed over this element. |
onkeyup | String | Yes | HTML: Script to be invoked when a key is released over this element. |
onmousedown | String | Yes | HTML: Script to be invoked when the pointing device is pressed over this element. |
onmousemove | String | Yes | HTML: Script to be invoked when the pointing device is moved while it is in this element. |
onmouseout | String | Yes | HTML: Script to be invoked when the pointing device is moves out of this element. |
onmouseover | String | Yes | HTML: Script to be invoked when the pointing device is moved into this element. |
onmouseup | String | Yes | HTML: Script to be invoked when the pointing device is released over this element. |
onselect | String | Yes | HTML: Specifies a script to be invoked when the element is selected. |
readonly | boolean | Yes | HTML: When true, indicates that this component cannot be modified by the user. The element may receive focus unless it has also been disabled. |
rendered | boolean | Yes | A boolean value that indicates whether this component should be rendered. Default value: true. |
style | String | Yes | HTML: CSS styling instructions. |
styleClass | String | Yes | The CSS class for this element. Corresponds to the HTML 'class' attribute. |
tabindex | String | Yes | HTML: Specifies the position of this element within the tab order of the document. |
title | String | Yes | HTML: An advisory title for this element. Often used by the user agent as a tooltip. |
type | String | Yes | HTML: A hint to the user agent about the content type of the linked resource. |
value | Object | Yes | The text to display to the user for this command component. |
visibleOnUserRole | String | Yes | If user is in given role, this component will be rendered normally. If not, nothing is rendered and the body of this tag will be skipped. |