| Info | Value |
|---|---|
| Component Type | org.primefaces.component.CommandButton |
| Display Name | None |
| Handler Class | None |
| Renderer Type | org.primefaces.component.CommandButtonRenderer |
| Description | None |
| Name | Required | Type | Description |
|---|---|---|---|
id | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Unique identifier of the component in a namingContainer. |
rendered | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Boolean value to specify the rendering of the component, when set to false component will not be rendered. |
binding | false | javax.el.ValueExpression
(must evaluate to javax.faces.component.UIComponent)
| An el expression referring to a server side UIComponent instance in a backing bean. |
value | false | javax.el.ValueExpression
(must evaluate to java.lang.Object)
| Label of the component. |
actionListener | false | javax.el.ValueExpression
(must evaluate to javax.faces.event.ActionListener)
| An actionlistener to process when command is executed. |
action | false | javax.el.ValueExpression
(must evaluate to javax.el.MethodExpression)
| A method expression or a string outcome to process when command is executed. |
immediate | false | javax.el.ValueExpression
(must evaluate to boolean)
| Boolean value that determines the phaseId of the action event, when true actions are processed at "Apply Request Values", when false at "Invoke Application" phase. |
widgetVar | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Name of the client side widget. |
ajax | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Specifies the submit mode, when set to true (default), submit would be made with Ajax. |
async | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| When set to true, ajax requests are not queued. |
process | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Component(s) to process partially instead of whole view. |
update | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Component(s) to be updated with ajax. |
onstart | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute before ajax request is begins. |
oncomplete | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when ajax request is completed. |
onerror | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when ajax request fails. |
onsuccess | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when ajax request succeeds. |
global | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Defines whether to trigger ajaxStatus or not. |
delay | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| If less than delay milliseconds elapses between calls to request() only the most recent one is sent and all other requests are discarded. The default value of this option is null. If the value of delay is the literal string 'none' without the quotes or the default, no delay is used. |
timeout | false | javax.el.ValueExpression
(must evaluate to java.lang.Integer)
| Defines the timeout for the ajax request. |
partialSubmit | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| When enabled, only values related to partially processed components would be serialized for ajax instead of whole form. |
resetValues | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| If true, indicate that this particular Ajax transaction is a value reset transaction. This will cause resetValue() to be called on any EditableValueHolder instances encountered as a result of this ajax transaction. If not specified, or the value is false, no such indication is made. |
ignoreAutoUpdate | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| If true, components which autoUpdate="true" will not be updated for this request. If not specified, or the value is false, no such indication is made. |
accesskey | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Access key that when pressed transfers focus to the button. |
alt | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Alternate textual description of the button. |
dir | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Direction indication for text that does not inherit directionality. Valid values are LTR and RTL. |
disabled | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Disables the button. |
image | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Style class representing the button icon. |
label | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| A localized user presentable name. |
lang | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Code describing the language used in the generated markup for this component. |
tabindex | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Position of the button element in the tabbing order. |
title | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Advisory tooltip informaton. |
type | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Sets the behavior of the button. Default is submit. |
style | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Inline style of the button element. |
styleClass | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Style class of the button element. |
onblur | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when button loses focus. |
onchange | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when button loses focus and its value has been modified since gaining focus. |
onclick | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when button is clicked. |
ondblclick | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when button is double clicked. |
onfocus | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when button receives focus. |
onkeydown | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when a key is pressed down over button. |
onkeypress | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when a key is pressed and released over button. |
onkeyup | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when a key is released over button. |
onmousedown | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when a pointer button is pressed down over button. |
onmousemove | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when a pointer button is moved within button. |
onmouseout | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when a pointer button is moved away from button. |
onmouseover | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when a pointer button is moved onto button. |
onmouseup | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when a pointer button is released over button. |
onselect | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when text within button is selected by user. |
icon | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Icon of the button. |
iconPos | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Position of the icon, default value is left. |
inline | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Displays button inline instead of fitting the content width, only used by mobile. |
escape | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Defines if label of the component is escaped or not. |
validateClient | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| When set to true client side validation is enabled, global setting is required to be enabled as a prerequisite. |
partialSubmitFilter | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Selector to use when partial submit is on, default is ":input" to select all descendant inputs of a partially processed components. |
form | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Form to serialize for an ajax request. Default is the enclosing form. |
renderDisabledClick | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| When enabled, click event can be added to disabled button |
Output generated by Vdldoc View Declaration Language Documentation Generator.