Package org.patternfly.component.form

Class Checkbox

java.lang.Object

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

org.patternfly.component.form.Checkbox

All Implemented Interfaces:

Container<HTMLElement,Checkbox>, Finder<HTMLElement>, HasElement<HTMLElement,Checkbox>, HasHTMLElement<HTMLElement,Checkbox>, IsElement<HTMLElement>, TypedBuilder<HTMLElement,Checkbox>, Component, HasValue<Boolean>, Modifiers.Disabled<HTMLElement,Checkbox>, Modifiers.Required<HTMLElement,Checkbox>

public class Checkbox
extends BaseComponent<HTMLElement,Checkbox>
implements HasValue<Boolean>, Modifiers.Disabled<HTMLElement,Checkbox>, 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/html

Method Summary

Modifier and Type	Method	Description
Checkbox	addBody(CheckboxBody body)
Checkbox	addDescription(CheckboxDescription description)
static Checkbox	checkbox(String id)
static Checkbox	checkbox(String id, boolean checked)
static Checkbox	checkbox(String id, String label)
static Checkbox	checkbox(String id, String label, boolean checked)
Checkbox	disabled(boolean disabled)	Adds/removes modifier(disabled)
Checkbox	onChange(ChangeHandler<Checkbox,Boolean> handler)
Checkbox	required(boolean required)	Adds/removes modifier(required)
Checkbox	reversed()
Checkbox	that()
Boolean	value()
Checkbox	value(boolean checked)

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.Container

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

Methods inherited from interface org.jboss.elemento.Finder

closest, find, findAll

Methods inherited from interface org.jboss.elemento.HasElement

add, apply, aria, aria, aria, attr, attr, attr, css, id, id, innerHtml, on, textContent, toggle, toggle, toggle

Methods inherited from interface org.jboss.elemento.HasHTMLElement

data, hidden, style, title

Methods inherited from interface org.jboss.elemento.IsElement

element

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

disabled

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

required

Method Detail

checkbox

public static Checkbox checkbox(String id)

checkbox

public static Checkbox checkbox(String id,
                                boolean checked)

checkbox

public static Checkbox checkbox(String id,
                                String label)

checkbox

public static Checkbox checkbox(String id,
                                String label,
                                boolean checked)

that

public Checkbox that()

Specified by:

that in interface TypedBuilder<HTMLElement,Checkbox>

value

public Boolean value()

Specified by:

value in interface HasValue<Boolean>

value

public Checkbox value(boolean checked)

onChange

public Checkbox onChange(ChangeHandler<Checkbox,Boolean> handler)

addBody

public Checkbox addBody(CheckboxBody body)

addDescription

public Checkbox addDescription(CheckboxDescription description)

disabled

public Checkbox disabled(boolean disabled)

Description copied from interface: Modifiers.Disabled

Adds/removes modifier(disabled)

Specified by:

disabled in interface Modifiers.Disabled<HTMLElement,Checkbox>

required

public Checkbox required(boolean required)

Description copied from interface: Modifiers.Required

Adds/removes modifier(required)

Specified by:

required in interface Modifiers.Required<HTMLElement,Checkbox>

reversed

public Checkbox reversed()