Package org.patternfly.component.switch_

Class Switch

java.lang.Object

org.patternfly.component.BaseComponentFlat<HTMLLabelElement,Switch>

org.patternfly.component.switch_.Switch

All Implemented Interfaces:

Attachable, Finder<HTMLLabelElement>, HasElement<HTMLLabelElement,Switch>, HasHTMLElement<HTMLLabelElement,Switch>, IsElement<HTMLLabelElement>, TypedBuilder<HTMLLabelElement,Switch>, Component, HasValue<Boolean>, Modifiers.Disabled<HTMLLabelElement,Switch>, Modifiers.Readonly<HTMLLabelElement,Switch>

public class Switch
extends BaseComponentFlat<HTMLLabelElement,Switch>
implements HasValue<Boolean>, Modifiers.Disabled<HTMLLabelElement,Switch>, Modifiers.Readonly<HTMLLabelElement,Switch>, Attachable

A switch toggles the state of a setting (between on and off). Switches and checkboxes can often be used interchangeably, but the switch provides a more explicit, visible representation of a setting.

See Also:

• https://www.patternfly.org/components/switch

Method Summary

Modifier and Type	Method	Description
Switch	applyTo(Consumer<InputElementBuilder<HTMLInputElement>> consumer)	Provides access to the underlying checkbox element using a fluent API style
Switch	ariaLabel(String label)
void	attach(MutationRecord mutationRecord)
Switch	checkIcon()	Same as checkIcon(true)
Switch	checkIcon(boolean checkIcon)
Switch	disabled(boolean disabled)
InputElementBuilder<HTMLInputElement>	inputElement()
Switch	label(String label)
Switch	label(String labelOn, String labelOff)
Switch	onChange(ChangeHandler<Switch,Boolean> changeHandler)
Switch	readonly(boolean readonly)
Switch	reversed()	Same as reversed(true)
Switch	reversed(boolean reversed)
static Switch	switch_(String id, String name)
static Switch	switch_(String id, String name, boolean checked)
Switch	that()
Boolean	value()
Switch	value(boolean checked)	Same as value(checked, false)
Switch	value(boolean checked, boolean fireEvent)	Sets the checked attribute of the input element.

Methods inherited from class org.patternfly.component.BaseComponentFlat

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

detach

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, classList, classList, css, id, innerHtml, on, on, on, run, textContent, textNode, toggle, toggle, toggle, uniqueId

Methods inherited from interface org.jboss.elemento.HasHTMLElement

data, hidden, style, style, style, style, style, style, title

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

readonly

Method Details

switch_

public static Switch switch_(String id,
 String name)

switch_

public static Switch switch_(String id,
 String name,
 boolean checked)

attach

public void attach(MutationRecord mutationRecord)

Specified by:

attach in interface Attachable

disabled

public Switch disabled(boolean disabled)

Specified by:

disabled in interface Modifiers.Disabled<HTMLLabelElement,Switch>

checkIcon

public Switch checkIcon()

Same as checkIcon(true)

checkIcon

public Switch checkIcon(boolean checkIcon)

label

public Switch label(String label)

label

public Switch label(String labelOn,
 String labelOff)

readonly

public Switch readonly(boolean readonly)

Specified by:

readonly in interface Modifiers.Readonly<HTMLLabelElement,Switch>

reversed

public Switch reversed()

Same as reversed(true)

reversed

public Switch reversed(boolean reversed)

value

public Switch value(boolean checked)

Same as value(checked, false)

value

public Switch value(boolean checked,
 boolean fireEvent)

Sets the checked attribute of the input element.

applyTo

public Switch applyTo(Consumer<InputElementBuilder<HTMLInputElement>> consumer)

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

that

public Switch that()

Specified by:

that in interface TypedBuilder<HTMLLabelElement,Switch>

ariaLabel

public Switch ariaLabel(String label)

onChange

public Switch onChange(ChangeHandler<Switch,Boolean> changeHandler)

value

public Boolean value()

Specified by:

value in interface HasValue<Boolean>

inputElement

public InputElementBuilder<HTMLInputElement> inputElement()