commandButton (PrimeFaces VDL Documentation)

Description:

CommandButton is an extended version of standard Faces commandButton with ajax and skinning features.

Component Information
Info	Value
Component Type	`org.primefaces.component.CommandButton`
Handler Class	None
Renderer Type	`org.primefaces.component.CommandButtonRenderer`
Description	None

Attributes
Name	Required	Type	Description
`accesskey`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.String`)	Access key that when pressed transfers focus to the button.
`action`	`false`	`jakarta.el.ValueExpression` (must evaluate to `javax.el.MethodExpression`)	A method expression or a string outcome to process when command is executed.
`actionListener`	`false`	`jakarta.el.ValueExpression` (must evaluate to `javax.faces.event.ActionListener`)	An actionlistener to process when command is executed.
`ajax`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	Specifies the submit mode, when set to true (default), submit would be made with Ajax.
`alt`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.String`)	Alternate textual description of the button.
`ariaLabel`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.String`)	The aria-label attribute is used to define a string that labels the current element for accessibility.
`async`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	When set to true, ajax requests are not queued.
`binding`	`false`	`jakarta.el.ValueExpression` (must evaluate to `javax.faces.component.UIComponent`)	An el expression referring to a server side UIComponent instance in a backing bean.
`delay`	`false`	`jakarta.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.
`dir`	`false`	`jakarta.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`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	Disables the button.
`disableOnAjax`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	If true, the button will be disabled during Ajax requests triggered by the button. Default is 'true'.
`enabledByValidateClient`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	When set to true this button is only enabled after successful client side validation. Used together with p:clientValidator on all relevant input-components.
`escape`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	Defines if label of the component is escaped or not.
`form`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.String`)	Form to serialize for an ajax request. Default is the enclosing form.
`global`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	Defines whether to trigger ajaxStatus or not.
`icon`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.String`)	Icon of the button.
`iconPos`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.String`)	Position of the icon, default value is left.
`id`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.String`)	Unique identifier of the component in a namingContainer.
`ignoreAutoUpdate`	`false`	`jakarta.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.
`ignoreComponentNotFound`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	If true, unresolvable components referenced in the update/process attribute are ignored. Default is 'false' and therefore a ComponentNotFoundException will be thrown.
`immediate`	`false`	`jakarta.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.
`inline`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	Displays button inline instead of fitting the content width, only used by mobile.
`label`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.String`)	A localized user presentable name.
`lang`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.String`)	Code describing the language used in the generated markup.
`onblur`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.String`)	Client side callback to execute when button loses focus.
`onchange`	`false`	`jakarta.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`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.String`)	Client side callback to execute when button is clicked.
`oncomplete`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.String`)	Client side callback to execute when ajax request is completed.
`ondblclick`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.String`)	Client side callback to execute when button is double clicked.
`onerror`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.String`)	Client side callback to execute when ajax request fails.
`onfocus`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.String`)	Client side callback to execute when button receives focus.
`onkeydown`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.String`)	Client side callback to execute when a key is pressed down over button.
`onkeypress`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.String`)	Client side callback to execute when a key is pressed and released over button.
`onkeyup`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.String`)	Client side callback to execute when a key is released over button.
`onmousedown`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.String`)	Client side callback to execute when a pointer button is pressed down over button.
`onmousemove`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.String`)	Client side callback to execute when a pointer button is moved within button.
`onmouseout`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.String`)	Client side callback to execute when a pointer button is moved away from button.
`onmouseover`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.String`)	Client side callback to execute when a pointer button is moved onto button.
`onmouseup`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.String`)	Client side callback to execute when a pointer button is released over button.
`onselect`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.String`)	Client side callback to execute when text within button is selected by user.
`onstart`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.String`)	Client side callback to execute before ajax request begins.
`onsuccess`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.String`)	Client side callback to execute when ajax request succeeds.
`partialSubmit`	`false`	`jakarta.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.
`partialSubmitFilter`	`false`	`jakarta.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.
`process`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.String`)	Component(s) to process partially instead of whole view.
`renderDisabledClick`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	When enabled, click event can be added to disabled button
`rendered`	`false`	`jakarta.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.
`resetValues`	`false`	`jakarta.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.
`style`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.String`)	Inline style of the button element.
`styleClass`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.String`)	Style class of the button element.
`tabindex`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.String`)	Position of the button element in the tabbing order.
`timeout`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.Integer`)	Defines the timeout for the ajax request.
`title`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.String`)	Advisory tooltip information.
`type`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.String`)	Sets the behavior of the button. Default is submit.
`update`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.String`)	Component(s) to be updated with ajax.
`validateClient`	`false`	`jakarta.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.
`value`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.Object`)	Label of the component.
`widgetVar`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.String`)	Name of the client side widget.

p

Tag commandButton