	Language
	English
	English
	English
	French
	German
	German
	German
	Italian
	Korean
	Spanish
	Catalan
	Dutch
	Portuguese
	Portuguese
	Arabic
	Arabic
	Bulgarian
	Bangla
	Bosnian
	Czech
	Greek
	Estonian
	Persian
	Finnish
	Danish
	Hindi
	Indonesian
	Icelandic
	Croatian
	Japanese
	Hungarian
	Hebrew
	Georgian
	Central Kurdish
	Khmer
	Kyrgyz
	Kazakh
	Lithuanian
	Latvian
	Malay
	Norwegian
	Polish
	Romanian
	Russian
	Slovak
	Slovenian
	Serbian
	Serbian
	Swedish
	Thai
	Turkish
	Ukrainian
	Uzbek
	Vietnamese
	Chinese
	Chinese

SelectBooleanCheckbox

SelectBooleanCheckbox is used to select a boolean value.

SelectBooleanCheckbox Tag Documentation

SelectBooleanCheckbox is an extended version of the standard checkbox with theme integration.

Name	Type	Required	Default	Description
id	String	false	generated	Unique identifier of the component in a namingContainer.
rendered	boolean	false	true	Boolean value to specify the rendering of the component, when set to false component will not be rendered.
binding	UIComponent	false	generated	An EL expression referring to a server side UIComponent instance in a backing bean.
widgetVar	String	false	generated ('widget_' + componentClientId)	Name of the client side widget.
accesskey	String	false		Access key to transfer focus to the input element.
ariaDescribedBy	String	false		The aria-describedby attribute is used to define a component id that describes the current element for accessibility.
ariaLabel	String	false		The aria-label attribute is used to define a string that labels the current element for accessibility.
ariaLabelledBy	String	false
converter	Converter	false		EL expression resolves to a converter instance or literal converter ID defining a component converter.
converterMessage	String	false
dir	String	false		Direction indication for text that does not inherit directionality.
disabled	boolean	false	false	Specifies that an element should be disabled.
escape	boolean	false	true	Defines if label of the component is escaped or not.
hideNoSelectionOption	boolean	false	false	Flag indicating that, if this component is activated by the user, The "no selection option", if any, must be hidden.
immediate	boolean	false	false	When set true, process validations logic is executed at apply request values phase for this component.
itemLabel	String	false		Label to display next to checkbox.
label	String	false		A localized user presentable name.
lang	String	false
onblur	String	false		Fires when an element loses focus.
onchange	String	false		Fires when the value of an element has been changed.
onclick	String	false		Fires when a mouse click on the element.
ondblclick	String	false		Fires when a mouse double-click on the element.
onfocus	String	false		Fires when an element gets focus.
onkeydown	String	false		Fires when a user is pressing a key.
onkeypress	String	false		Fires when a user presses a key.
onkeyup	String	false		Fires when a user releases a key.
onmousedown	String	false		Fires when a mouse button is pressed down on an element.
onmousemove	String	false		Fires when the mouse pointer is moving while it is over an element.
onmouseout	String	false		Fires when the mouse pointer moves out of an element.
onmouseover	String	false		Fires when the mouse pointer moves onto an element.
onmouseup	String	false		Fires when a mouse button is released over an element.
onselect	String	false
readonly	boolean	false	false	Specifies that an input field is read-only.
required	boolean	false	false	Marks component as required.
requiredMessage	String	false
role	String	false
style	String	false		Specifies an inline CSS style for an element.
styleClass	String	false		Specifies one or more CSS class names for an element.
submittedValue	Object	false
tabindex	String	false		Specifies the tab order of an element.
title	String	false		Specifies extra information about an element (displayed as a tooltip).
validator	Validator	false		A method expression referring to a method validating the input.
validatorMessage	String	false
value	Object	false		Value of the component.
valueChangeListener	ValueChangeListener	false		A method binding expression referring to a method for handling a valuchangeevent.

Name	Description
No records found.

Name	Type	Default	Description
blur	AjaxBehaviorEvent	false	Fires when the element loses focus.
change	AjaxBehaviorEvent	false	Fires when the element's value changes.
click	AjaxBehaviorEvent	false	Fires when the element is clicked.
valueChange	AjaxBehaviorEvent	true	Fires when the element's value is changed.
dblclick	AjaxBehaviorEvent	false	Fires when the element is double-clicked.
focus	AjaxBehaviorEvent	false	Fires when the element gains focus.
keydown	AjaxBehaviorEvent	false	Fires when a key is pressed down on the element.
keypress	AjaxBehaviorEvent	false	Fires when a key is pressed and released on the element.
keyup	AjaxBehaviorEvent	false	Fires when a key is released on the element.
mousedown	AjaxBehaviorEvent	false	Fires when a mouse button is pressed down on the element.
mousemove	AjaxBehaviorEvent	false	Fires when the mouse is moved over the element.
mouseout	AjaxBehaviorEvent	false	Fires when the mouse leaves the element.
mouseover	AjaxBehaviorEvent	false	Fires when the mouse enters the element.
mouseup	AjaxBehaviorEvent	false	Fires when a mouse button is released over the element.
select	AjaxBehaviorEvent	false	Fires when some text is selected in the element.

Name	Library	Target
components.css	primefaces
jquery/jquery.js	primefaces
core.js	primefaces
components.js	primefaces

Family org.primefaces.component

Type org.primefaces.component.SelectBooleanCheckbox

Class org.primefaces.component.selectbooleancheckbox.SelectBooleanCheckbox

Renderer Type org.primefaces.component.SelectBooleanCheckboxRenderer

Renderer Class org.primefaces.component.selectbooleancheckbox.SelectBooleanCheckboxRenderer

RESOURCES

Tag DocumentationNew DocumentationNew Documentation JSDoc


<div class="card">
    <h:form>
        <p:growl id="msg"/>

        <h5 class="mt-0">Basic</h5>
        <p:selectBooleanCheckbox value="#{selectBooleanView.value1}" itemLabel="Basic"/>

        <h5>Remote</h5>
        <p:selectBooleanCheckbox value="#{selectBooleanView.value2}" itemLabel="Ajax">
            <p:ajax update="msg" listener="#{selectBooleanView.addMessage}"/>
        </p:selectBooleanCheckbox>
    </h:form>
</div>


package org.primefaces.showcase.view.input;

import jakarta.enterprise.context.RequestScoped;
import jakarta.faces.application.FacesMessage;
import jakarta.faces.component.UIComponent;
import jakarta.faces.component.UIInput;
import jakarta.faces.context.FacesContext;
import jakarta.faces.event.AjaxBehaviorEvent;
import jakarta.inject.Named;

@Named
@RequestScoped
public class SelectBooleanView {

    private boolean value1;
    private boolean value2;
    private boolean value3;

    public boolean isValue1() {
        return value1;
    }

    public void setValue1(boolean value1) {
        this.value1 = value1;
    }

    public boolean isValue2() {
        return value2;
    }

    public void setValue2(boolean value2) {
        this.value2 = value2;
    }

    public boolean isValue3() {
        return value3;
    }

    public void setValue3(boolean value3) {
        this.value3 = value3;
    }

    public void addMessage(AjaxBehaviorEvent event) {
        UIComponent component = event.getComponent();
        if (component instanceof UIInput inputComponent) {
            Boolean value = (Boolean) inputComponent.getValue();
            String summary = value ? "Checked" : "Unchecked";
            FacesContext.getCurrentInstance().addMessage(null, new FacesMessage(summary));
        }
    }
}

SelectBooleanCheckbox

SelectBooleanCheckbox Tag Documentation

Basic

Remote

Usage

Reloading page