Package org.patternfly.component.form

Class Checkbox

java.lang.Object

org.patternfly.component.BaseComponent<HTMLElement,Checkbox>

org.patternfly.component.form.Checkbox

All Implemented Interfaces:

ElementAttributeMethods<HTMLElement,Checkbox>, ElementClassListMethods<HTMLElement,Checkbox>, ElementConsumerMethods<HTMLElement,Checkbox>, ElementContainerMethods<HTMLElement,Checkbox>, ElementEventMethods<HTMLElement,Checkbox>, ElementIdMethods<HTMLElement,Checkbox>, ElementQueryMethods<HTMLElement>, ElementTextDelegate<HTMLElement,Checkbox>, ElementTextMethods<HTMLElement,Checkbox>, HTMLElementAttributeMethods<HTMLElement,Checkbox>, HTMLElementDataMethods<HTMLElement,Checkbox>, HTMLElementStyleMethods<HTMLElement,Checkbox>, HTMLElementVisibilityMethods<HTMLElement,Checkbox>, IsElement<HTMLElement>, TypedBuilder<HTMLElement,Checkbox>, Component, HasValue<Boolean>, org.patternfly.style.Modifiers.Disabled<HTMLElement,Checkbox>, org.patternfly.style.Modifiers.Required<HTMLElement,Checkbox>

public class Checkbox
extends BaseComponent<HTMLElement,Checkbox>
implements org.patternfly.style.Modifiers.Disabled<HTMLElement,Checkbox>, ElementTextDelegate<HTMLElement,Checkbox>, HasValue<Boolean>, org.patternfly.style.Modifiers.Required<HTMLElement,Checkbox>

A checkbox is used to select a single item or multiple items, typically to choose elements to perform an action or to reflect a binary setting.

See Also:

• https://www.patternfly.org/components/forms/checkbox

Method Summary

Modifier and Type	Method	Description
Checkbox	addBody(CheckboxBody body)
Checkbox	addDescription(CheckboxDescription description)
Checkbox	applyTo(Consumer<HTMLInputElementBuilder<HTMLInputElement>> consumer)	Provides access to the underlying checkbox element using a fluent API style
static Checkbox	checkbox(String id, String name)
static Checkbox	checkbox(String id, String name, String label)
static Checkbox	checkboxWrapped(String id, String name)
static Checkbox	checkboxWrapped(String id, String name, String label)
Checkbox	disabled(boolean disabled)
HTMLInputElementBuilder<HTMLInputElement>	inputElement()
Checkbox	onChange(org.patternfly.handler.ChangeHandler<Checkbox,Boolean> changeHandler)	Defines a change handler that is called when the value() of this checkbox changes.
Checkbox	required(boolean required)
Checkbox	reversed()
Checkbox	standalone()	Same as standalone(true)
Checkbox	standalone(boolean removeLabel)
Checkbox	text(String text)
Element	textDelegate()
Checkbox	that()
Boolean	value()
Checkbox	value(boolean checked)	Same as value(checked, false)
Checkbox	value(boolean checked, boolean fireEvent)	Sets the checked attribute of the input element.

Methods inherited from class org.patternfly.component.BaseComponent

componentType, element

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.jboss.elemento.ElementAttributeMethods

aria, aria, aria, attr, attr, attr, role, role

Methods inherited from interface org.jboss.elemento.ElementClassListMethods

classList, classList, css, toggle, toggle, toggle

Methods inherited from interface org.jboss.elemento.ElementConsumerMethods

apply, run

Methods inherited from interface org.jboss.elemento.ElementContainerMethods

add, add, add, add, addAll, addAll, addAll, addAll, addAll, addAll

Methods inherited from interface org.jboss.elemento.ElementEventMethods

on, on, on

Methods inherited from interface org.jboss.elemento.ElementIdMethods

id, uniqueId

Methods inherited from interface org.jboss.elemento.ElementQueryMethods

closest, querySelector, querySelectorAll

Methods inherited from interface org.jboss.elemento.ElementTextDelegate

text

Methods inherited from interface org.jboss.elemento.HTMLElementAttributeMethods

title

Methods inherited from interface org.jboss.elemento.HTMLElementDataMethods

data

Methods inherited from interface org.jboss.elemento.HTMLElementStyleMethods

style, style, style, style, style, style

Methods inherited from interface org.jboss.elemento.HTMLElementVisibilityMethods

hidden

Methods inherited from interface org.jboss.elemento.IsElement

element

Methods inherited from interface org.patternfly.style.Modifiers.Disabled

disabled, isDisabled

Methods inherited from interface org.patternfly.style.Modifiers.Required

required

Method Details

checkbox

public static Checkbox checkbox(String id,
 String name)

checkboxWrapped

public static Checkbox checkboxWrapped(String id,
 String name)

checkbox

public static Checkbox checkbox(String id,
 String name,
 String label)

checkboxWrapped

public static Checkbox checkboxWrapped(String id,
 String name,
 String label)

textDelegate

public Element textDelegate()

Specified by:

textDelegate in interface ElementTextDelegate<HTMLElement,Checkbox>

addBody

public Checkbox addBody(CheckboxBody body)

addDescription

public Checkbox addDescription(CheckboxDescription description)

disabled

public Checkbox disabled(boolean disabled)

Specified by:

disabled in interface org.patternfly.style.Modifiers.Disabled<HTMLElement,Checkbox>

required

public Checkbox required(boolean required)

Specified by:

required in interface org.patternfly.style.Modifiers.Required<HTMLElement,Checkbox>

reversed

public Checkbox reversed()

standalone

public Checkbox standalone()

Same as standalone(true)

standalone

public Checkbox standalone(boolean removeLabel)

text

public Checkbox text(String text)

Specified by:

text in interface ElementTextDelegate<HTMLElement,Checkbox>

Specified by:

text in interface ElementTextMethods<HTMLElement,Checkbox>

value

public Checkbox value(boolean checked)

Same as value(checked, false)

value

public Checkbox value(boolean checked,
 boolean fireEvent)

Sets the checked attribute of the input element.

applyTo

public Checkbox applyTo(Consumer<HTMLInputElementBuilder<HTMLInputElement>> consumer)

Provides access to the underlying checkbox element using a fluent API style

that

public Checkbox that()

Specified by:

that in interface TypedBuilder<HTMLElement,Checkbox>

onChange

public Checkbox onChange(org.patternfly.handler.ChangeHandler<Checkbox,Boolean> changeHandler)

Defines a change handler that is called when the value() of this checkbox changes.

value

public Boolean value()

Specified by:

value in interface HasValue<Boolean>

inputElement

public HTMLInputElementBuilder<HTMLInputElement> inputElement()