| Info | Value |
|---|---|
| Component Type | org.primefaces.component.ToggleSwitch |
| Handler Class | None |
| Renderer Type | org.primefaces.component.ToggleSwitchRenderer |
| Description | None |
| Name | Required | Type | 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 jakarta.faces.component.UIComponent)
| An el expression referring to a server side UIComponent instance in a backing bean. |
converter | false | jakarta.el.ValueExpression
(must evaluate to jakarta.faces.convert.Converter)
| An el expression or a literal text that defines a converter for the component. When it's an EL expression, it's resolved to a converter instance. In case it's a static text, it must refer to a converter id. |
converterMessage | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Message to display when conversion fails. |
disabled | false | jakarta.el.ValueExpression
(must evaluate to boolean)
| Disables or enables the switch. |
id | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Unique identifier of the component in a namingContainer. |
immediate | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| When set true, process validations logic is executed at apply request values phase for this component. Default is false. |
label | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| User presentable name. |
offIcon | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| The icon representing the "Off" position. |
onblur | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when component loses focus. |
onchange | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute on value change event. |
onfocus | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when component receives focus. |
onIcon | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| The icon representing the "On" position. |
readonly | false | jakarta.el.ValueExpression
(must evaluate to boolean)
| Flag indicating that this component will prevent changes by the user. |
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. |
required | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Marks component as required. |
requiredMessage | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Message to display when required field validation fails. |
style | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Inline style of the main container. |
styleClass | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Style class of the main container. |
tabindex | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| The tabindex attribute specifies the tab order of an element when the "tab" button is used for navigating. |
validator | false | jakarta.el.ValueExpression
(must evaluate to jakarta.faces.validator.Validator)
| A method expression referring to a method validating the input. |
validatorMessage | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Message to display when validation fails. |
value | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Object)
| Value of the component. |
valueChangeListener | false | jakarta.el.ValueExpression
(must evaluate to jakarta.faces.event.ValueChangeListener)
| A method binding expression referring to a method for handling a valuchangeevent. |
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.