Class ToggleButton

java.lang.Object
com.vaadin.flow.component.Component
com.vaadin.flow.component.AbstractField<com.vaadin.flow.component.checkbox.Checkbox, Boolean>
com.vaadin.flow.component.AbstractSinglePropertyField<com.vaadin.flow.component.checkbox.Checkbox, Boolean>
com.vaadin.flow.component.checkbox.Checkbox
org.vaadin.firitin.components.checkbox.VCheckBox
org.vaadin.firitin.components.checkbox.ToggleButton
All Implemented Interfaces:
com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.BlurNotifier<com.vaadin.flow.component.checkbox.Checkbox>, com.vaadin.flow.component.ClickNotifier<com.vaadin.flow.component.checkbox.Checkbox>, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.Focusable<com.vaadin.flow.component.checkbox.Checkbox>, com.vaadin.flow.component.FocusNotifier<com.vaadin.flow.component.checkbox.Checkbox>, com.vaadin.flow.component.HasAriaLabel, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasEnabled, com.vaadin.flow.component.HasHelper, com.vaadin.flow.component.HasLabel, com.vaadin.flow.component.HasSize, com.vaadin.flow.component.HasStyle, com.vaadin.flow.component.HasValidation, com.vaadin.flow.component.HasValue<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.checkbox.Checkbox, Boolean>, Boolean>, com.vaadin.flow.component.HasValueAndElement<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.checkbox.Checkbox, Boolean>, Boolean>, com.vaadin.flow.component.shared.HasClientValidation, com.vaadin.flow.component.shared.HasTooltip, com.vaadin.flow.component.shared.HasValidationProperties, com.vaadin.flow.component.shared.InputField<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.checkbox.Checkbox, Boolean>, Boolean>, com.vaadin.flow.data.binder.HasValidator<Boolean>, Serializable, FluentAttachNotifier<VCheckBox>, FluentBlurNotifier<com.vaadin.flow.component.checkbox.Checkbox, VCheckBox>, FluentClickNotifier<com.vaadin.flow.component.checkbox.Checkbox, VCheckBox>, FluentComponent<VCheckBox>, FluentDetachNotifier<VCheckBox>, FluentFocusable<com.vaadin.flow.component.checkbox.Checkbox, VCheckBox>, FluentFocusNotifier<com.vaadin.flow.component.checkbox.Checkbox, VCheckBox>, FluentHasEnabled<VCheckBox>, FluentHasHelper<VCheckBox>, FluentHasSize<VCheckBox>, FluentHasStyle<VCheckBox>, FluentHasTooltip<VCheckBox>, FluentHasValueAndElement<VCheckBox, com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.checkbox.Checkbox, Boolean>, Boolean>, FluentHasAutofocus<VCheckBox>, FluentHasLabel<VCheckBox>
@StyleSheet("context://frontend/org/vaadin/firitin/components/toggle-button.css") public class ToggleButton extends VCheckBox
A toggle button that is essentially a styled checkbox. CSS derived from similarly named Vaadin add-on to be compatible with the latest Vaadin 24.7.
See Also:

  • Nested Class Summary

    Nested classes/interfaces inherited from class com.vaadin.flow.component.checkbox.Checkbox

    com.vaadin.flow.component.checkbox.Checkbox.CheckboxI18n

    Nested classes/interfaces inherited from class com.vaadin.flow.component.AbstractField

    com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<C,V>

    Nested classes/interfaces inherited from interface com.vaadin.flow.component.BlurNotifier

    com.vaadin.flow.component.BlurNotifier.BlurEvent<C>

    Nested classes/interfaces inherited from interface com.vaadin.flow.component.FocusNotifier

    com.vaadin.flow.component.FocusNotifier.FocusEvent<C>

    Nested classes/interfaces inherited from interface com.vaadin.flow.component.shared.HasClientValidation

    com.vaadin.flow.component.shared.HasClientValidation.ClientValidatedEvent

    Nested classes/interfaces inherited from interface com.vaadin.flow.component.HasValue

    com.vaadin.flow.component.HasValue.ValueChangeEvent<V>, com.vaadin.flow.component.HasValue.ValueChangeListener<E>

  • Constructor Summary

    Constructors
    Constructor
    Description
    ToggleButton()
     
    ToggleButton(boolean initialValue)
     
    ToggleButton(String labelText)
     
    ToggleButton(String labelText, boolean initialValue)
     
    ToggleButton(String label, com.vaadin.flow.component.HasValue.ValueChangeListener<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.checkbox.Checkbox, Boolean>> listener)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected void
    addClassName()
     
    protected void
    onAttach(com.vaadin.flow.component.AttachEvent attachEvent)
     

    Methods inherited from class VCheckBox

    withAriaLabel, withIndeterminate

    Methods inherited from class com.vaadin.flow.component.checkbox.Checkbox

    getAriaLabel, getAriaLabelledBy, getDefaultValidator, getI18n, getLabel, isAutofocus, isIndeterminate, isRequiredIndicatorVisible, setAriaLabel, setAriaLabelledBy, setAutofocus, setI18n, setIndeterminate, setLabel, setLabelComponent, setManualValidation, setRequiredIndicatorVisible, validate

    Methods inherited from class com.vaadin.flow.component.AbstractSinglePropertyField

    getSynchronizationRegistration, hasValidValue, setPresentationValue, setSynchronizedEvent

    Methods inherited from class com.vaadin.flow.component.AbstractField

    addValueChangeListener, getEmptyValue, getValue, isEmpty, setModelValue, setValue, valueEquals

    Methods 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, onDetach, onEnabledStateChanged, removeFromParent, scrollIntoView, scrollIntoView, set, setElement, setId, setVisible

    Methods inherited from class Object

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

    Methods inherited from interface com.vaadin.flow.component.AttachNotifier

    addAttachListener

    Methods inherited from interface com.vaadin.flow.component.BlurNotifier

    addBlurListener

    Methods inherited from interface com.vaadin.flow.component.ClickNotifier

    addClickListener, addClickShortcut, addDoubleClickListener, addSingleClickListener

    Methods inherited from interface com.vaadin.flow.component.DetachNotifier

    addDetachListener

    Methods inherited from interface FluentAttachNotifier

    withAttachListener

    Methods inherited from interface FluentBlurNotifier

    withBlurListener

    Methods inherited from interface FluentClickNotifier

    withClickListener

    Methods inherited from interface FluentComponent

    navigate, setId, setVisible, withId, withVisible

    Methods inherited from interface FluentDetachNotifier

    withDetachListener

    Methods inherited from interface FluentFocusable

    withTabIndex

    Methods inherited from interface FluentFocusNotifier

    withFocusListener

    Methods inherited from interface FluentHasAutofocus

    isAutofocus, setAutofocus, withAutofocus

    Methods inherited from interface FluentHasEnabled

    withEnabled

    Methods inherited from interface FluentHasHelper

    withHelperComponent, withHelperText

    Methods inherited from interface FluentHasLabel

    withLabel

    Methods inherited from interface FluentHasSize

    addResizeListener, withFullHeight, withFullWidth, withHeight, withMaxHeight, withMaxSize, withMaxWidth, withMinHeight, withMinSize, withMinWidth, withSize, withSizeFull, withSizeUndefined, withWidth

    Methods inherited from interface FluentHasStyle

    getStyle, withAddedClassName, withClassName, withStyle

    Methods inherited from interface FluentHasTooltip

    withTooltip

    Methods inherited from interface FluentHasValueAndElement

    withReadOnly, withRequiredIndicatorVisible, withValue, withValueChangeListener

    Methods inherited from interface com.vaadin.flow.component.Focusable

    addFocusShortcut, blur, focus, getTabIndex, setTabIndex

    Methods inherited from interface com.vaadin.flow.component.FocusNotifier

    addFocusListener

    Methods inherited from interface com.vaadin.flow.component.shared.HasClientValidation

    addClientValidatedEventListener

    Methods inherited from interface com.vaadin.flow.component.HasElement

    getElement

    Methods inherited from interface com.vaadin.flow.component.HasEnabled

    isEnabled, setEnabled

    Methods inherited from interface com.vaadin.flow.component.HasHelper

    getHelperComponent, getHelperText, setHelperComponent, setHelperText

    Methods inherited from interface com.vaadin.flow.component.HasLabel

    getLabel, setLabel

    Methods 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, setWidthFull

    Methods inherited from interface com.vaadin.flow.component.HasStyle

    addClassName, addClassNames, getClassName, getClassNames, hasClassName, removeClassName, removeClassNames, setClassName, setClassName

    Methods inherited from interface com.vaadin.flow.component.shared.HasTooltip

    getTooltip, setTooltipText

    Methods inherited from interface com.vaadin.flow.component.shared.HasValidationProperties

    getErrorMessage, isInvalid, setErrorMessage, setInvalid

    Methods inherited from interface com.vaadin.flow.data.binder.HasValidator

    addValidationStatusChangeListener

    Methods inherited from interface com.vaadin.flow.component.HasValue

    addValueChangeListener, clear, getEmptyValue, getOptionalValue, getValue, isEmpty, setValue

    Methods inherited from interface com.vaadin.flow.component.HasValueAndElement

    isReadOnly, setReadOnly

  • Constructor Details

    • ToggleButton

      public ToggleButton()

    • ToggleButton

      public ToggleButton(boolean initialValue)

    • ToggleButton

      public ToggleButton(String labelText, boolean initialValue)

    • ToggleButton

      public ToggleButton(String label, com.vaadin.flow.component.HasValue.ValueChangeListener<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.checkbox.Checkbox, Boolean>> listener)

    • ToggleButton

      public ToggleButton(String labelText)

  • Method Details

    • addClassName

      protected void addClassName()

    • onAttach

      protected void onAttach(com.vaadin.flow.component.AttachEvent attachEvent)
      Overrides:
      onAttach in class com.vaadin.flow.component.Component