We use cookies to serve our customers and website visitors in the best possible way. Cookies are used for the proper functioning of the website and for improving the user experience, monitoring visitor traffic and marketing purposes. By continuing to browse the site, you agree to our use of cookies. You can read more about cookies here.
com.vaadin.flow.component.checkbox.
Class Checkbox
java.lang.Object
com.vaadin.flow.component.Component
com.vaadin.flow.component.AbstractField<C,T>
com.vaadin.flow.component.AbstractSinglePropertyField<Checkbox,Boolean>
com.vaadin.flow.component.checkbox.Checkbox
All Implemented Interfaces:
AttachNotifier, BlurNotifier<Checkbox>, ClickNotifier<Checkbox>, DetachNotifier, Focusable<Checkbox>, FocusNotifier<Checkbox>, HasElement, HasEnabled, HasLabel, HasSize, HasStyle, HasValue<AbstractField.ComponentValueChangeEvent<Checkbox,, HasValueAndElement<AbstractField.ComponentValueChangeEvent<Checkbox,, HasTooltip, Serializable
@Tag("vaadin-checkbox")
@NpmPackage(value="@vaadin/polymer-legacy-adapter",version="24.0.2") @NpmPackage(value="@vaadin/checkbox",version="24.0.2")
@JsModule("@vaadin/polymer-legacy-adapter/style-modules.js") @JsModule("@vaadin/checkbox/src/vaadin-checkbox.js")
public class Checkbox
extends AbstractSinglePropertyField<Checkbox,Boolean>
implements ClickNotifier<Checkbox>, Focusable<Checkbox>, HasLabel, HasSize, HasStyle, HasTooltip
Checkbox is an input field representing a binary choice.
Checkbox also has an indeterminate mode, see isIndeterminate() for
more info.
Use CheckboxGroup to group related
items. Individual checkboxes should be used for options that are not related
to each other in any way.
Author:
Vaadin Ltd
See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class com.vaadin.flow.component.AbstractField
AbstractField.ComponentValueChangeEvent<C extends Component,V> Nested classes/interfaces inherited from interface com.vaadin.flow.component.BlurNotifier
BlurNotifier.BlurEvent<C extends Component>Nested classes/interfaces inherited from interface com.vaadin.flow.component.FocusNotifier
FocusNotifier.FocusEvent<C extends Component>Nested classes/interfaces inherited from interface com.vaadin.flow.component.HasValue
HasValue.ValueChangeEvent<V>, HasValue.ValueChangeListener<E extends HasValue.ValueChangeEvent<?>> -
Constructor Summary
ConstructorsConstructorDescriptionCheckbox()Default constructor.
Checkbox(boolean initialValue) Constructs a checkbox with the initial value.
Checkbox(boolean initialValue, HasValue.ValueChangeListener<AbstractField.ComponentValueChangeEvent<Checkbox, Boolean>> listener) Constructs a checkbox with the initial value and value change listener.
Constructs a checkbox with the initial label text.
Constructs a checkbox with the initial value.
Checkbox(String labelText, boolean initialValue, HasValue.ValueChangeListener<AbstractField.ComponentValueChangeEvent<Checkbox, Boolean>> listener) Constructs a checkbox with the initial value, label text and value change listener.
Checkbox(String label, HasValue.ValueChangeListener<AbstractField.ComponentValueChangeEvent<Checkbox, Boolean>> listener) Constructs a checkbox with the initial label text and value change listener.
-
Method Summary
Modifier and TypeMethodDescriptiongetLabel()Get the current label text.
booleanGet the state for the auto-focus property of the checkbox.
booleanGet the indeterminate state of the checkbox.
voidsetAriaLabel(String ariaLabel) Set the accessibility label of this checkbox.
voidsetAutofocus(boolean autofocus) Set the checkbox to be input focused when the page loads.
voidsetIndeterminate(boolean indeterminate) Set the indeterminate state of the checkbox.
voidSet the current label text of this checkbox.
voidsetLabelComponent(Component component) Replaces the label content with the given label component.
Methods inherited from class com.vaadin.flow.component.AbstractSinglePropertyField
getSynchronizationRegistration, hasValidValue, setPresentationValue, setSynchronizedEventMethods inherited from class com.vaadin.flow.component.AbstractField
addValueChangeListener, getEmptyValue, getValue, isEmpty, setModelValue, setValue, valueEqualsMethods inherited from class com.vaadin.flow.component.Component
addListener, findAncestor, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getListeners, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onAttach, onDetach, onEnabledStateChanged, removeFromParent, scrollIntoView, scrollIntoView, set, setElement, setId, setVisibleMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface com.vaadin.flow.component.AttachNotifier
addAttachListenerMethods inherited from interface com.vaadin.flow.component.BlurNotifier
addBlurListenerMethods inherited from interface com.vaadin.flow.component.ClickNotifier
addClickListener, addClickShortcutMethods inherited from interface com.vaadin.flow.component.DetachNotifier
addDetachListenerMethods inherited from interface com.vaadin.flow.component.Focusable
addFocusShortcut, blur, focus, getTabIndex, setTabIndexMethods inherited from interface com.vaadin.flow.component.FocusNotifier
addFocusListenerMethods inherited from interface com.vaadin.flow.component.HasElement
getElementMethods inherited from interface com.vaadin.flow.component.HasEnabled
isEnabled, setEnabledMethods inherited from interface com.vaadin.flow.component.HasSize
getHeight, getHeightUnit, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getWidth, getWidthUnit, setHeight, setHeight, setHeightFull, setMaxHeight, setMaxHeight, setMaxWidth, setMaxWidth, setMinHeight, setMinHeight, setMinWidth, setMinWidth, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthFullMethods inherited from interface com.vaadin.flow.component.HasStyle
addClassName, addClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassNameMethods inherited from interface com.vaadin.flow.component.shared.HasTooltip
getTooltip, setTooltipTextMethods inherited from interface com.vaadin.flow.component.HasValue
clear, getOptionalValueMethods inherited from interface com.vaadin.flow.component.HasValueAndElement
isReadOnly, isRequiredIndicatorVisible, setReadOnly, setRequiredIndicatorVisible
-
Constructor Details
-
Checkbox
public Checkbox()Default constructor.
-
Checkbox
Constructs a checkbox with the initial label text.
Parameters:
labelText- the label text to setSee Also:
-
Checkbox
public Checkbox(boolean initialValue) Constructs a checkbox with the initial value.
Parameters:
initialValue- the initial valueSee Also:
-
Checkbox
Constructs a checkbox with the initial value.
Parameters:
labelText- the label text to setinitialValue- the initial valueSee Also:
-
Checkbox
public Checkbox(String label, HasValue.ValueChangeListener<AbstractField.ComponentValueChangeEvent<Checkbox, Boolean>> listener) Constructs a checkbox with the initial label text and value change listener.
Parameters:
label- the label text to setlistener- the value change listener to addSee Also:
-
Checkbox
public Checkbox(boolean initialValue, HasValue.ValueChangeListener<AbstractField.ComponentValueChangeEvent<Checkbox, Boolean>> listener) Constructs a checkbox with the initial value and value change listener.
Parameters:
initialValue- the initial valuelistener- the value change listener to addSee Also:
-
Checkbox
public Checkbox(String labelText, boolean initialValue, HasValue.ValueChangeListener<AbstractField.ComponentValueChangeEvent<Checkbox, Boolean>> listener) Constructs a checkbox with the initial value, label text and value change listener.
Parameters:
labelText- the label text to setinitialValue- the initial valuelistener- the value change listener to addSee Also:
-
-
Method Details
-
getLabel
Get the current label text.
-
setLabel
Set the current label text of this checkbox.
-
setLabelComponent
Replaces the label content with the given label component.
Parameters:
component- the component to be added to the label.Since:
23.1
-
setAriaLabel
Set the accessibility label of this checkbox.
Parameters:
ariaLabel- the accessibility label to setSee Also:
-
setAutofocus
public void setAutofocus(boolean autofocus) Set the checkbox to be input focused when the page loads.
Parameters:
autofocus- the boolean value to set -
isAutofocus
public boolean isAutofocus()Get the state for the auto-focus property of the checkbox.
This property is not synchronized automatically from the client side, so the returned value may not be the same as in client side.
Returns:
the
autofocusproperty from the checkbox -
setIndeterminate
public void setIndeterminate(boolean indeterminate) Set the indeterminate state of the checkbox.
NOTE: As according to the HTML5 standard, this has only effect on the visual appearance, not on the checked value!
Parameters:
indeterminate- the boolean value to setSee Also:
-
isIndeterminate
@Synchronize(property="indeterminate", value="indeterminate-changed") public boolean isIndeterminate()Get the indeterminate state of the checkbox. The default value is
false.An indeterminate checkbox is neither checked nor unchecked. A typical use case is a ?Select All? checkbox indicating that some, but not all, items are selected. When the user clicks an indeterminate checkbox, it is no longer indeterminate, and the
checkedvalue also changes.NOTE: As according to the HTML5 standard, this has only effect on the visual appearance, not on the checked value!
Returns:
the
indeterminateproperty from the checkbox
-