| Info | Value |
|---|---|
| Component Type | org.primefaces.component.Button |
| Handler Class | None |
| Renderer Type | org.primefaces.component.ButtonRenderer |
| Description | None |
| Name | Required | Type | Description |
|---|---|---|---|
accesskey | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Access key that when pressed transfers focus to button. |
alt | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Alternate textual description. |
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. |
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. |
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. |
disableClientWindow | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Disable appending the on the rendering of this element. |
disabled | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Disables button. |
escape | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Defines if label of the component is escaped or not. |
fragment | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Identifier of the target page which should be scrolled to. |
href | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Resource to link to. |
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. |
includeViewParams | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Whether to include page parameters in target URI. Default is false. |
inline | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Displays button inline instead of fitting the content width, only used by mobile. |
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. |
ondblclick | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when button is double clicked. |
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. |
outcome | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Used to resolve a navigation case. |
readonly | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Makes button read only. |
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. |
style | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Inline style of the button. |
styleClass | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Style class of the button. |
tabindex | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Position in the tabbing order. |
target | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| The window target. Default _self. |
title | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Advisory tooltip information. |
value | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Value of the component than can be either an EL expression of a literal text. |
widgetVar | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Name of the client side widget. |
Output generated by Vdldoc View Declaration Language Documentation Generator.