Package org.vaadin.addons.componentfactory

Class PaperSlider

java.lang.Object
com.vaadin.flow.component.Component
com.vaadin.flow.component.AbstractField<com.vaadin.flow.component.customfield.CustomField<Integer>,Integer>
com.vaadin.flow.component.customfield.CustomField<Integer>
org.vaadin.addons.componentfactory.PaperSlider
All Implemented Interfaces:
com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.BlurNotifier<com.vaadin.flow.component.customfield.CustomField<Integer>>, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.Focusable<com.vaadin.flow.component.customfield.CustomField<Integer>>, com.vaadin.flow.component.FocusNotifier<com.vaadin.flow.component.customfield.CustomField<Integer>>, 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.HasTheme, com.vaadin.flow.component.HasValidation, com.vaadin.flow.component.HasValue<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.customfield.CustomField<Integer>,Integer>,Integer>, com.vaadin.flow.component.HasValueAndElement<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.customfield.CustomField<Integer>,Integer>,Integer>, 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.customfield.CustomField<Integer>,Integer>,Integer>, Serializable
@CssImport("./paper-slider-field.css") public class PaperSlider extends com.vaadin.flow.component.customfield.CustomField<Integer>
A slider field component.
See Also:

  • Nested Class Summary

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

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

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

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

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

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

    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 extends com.vaadin.flow.component.HasValue.ValueChangeEvent<?>>

  • Constructor Summary

    Constructors
    Constructor
    Description
    PaperSlider()
    Default constructor
    PaperSlider(String label)
    Create slider with label.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addThemeVariants(PaperSliderVariant... variants)
    Adds theme variants to the component.
    void
    blur()
     
    void
    focus()
     
    protected Integer
    generateModelValue()
     
    Integer
    getEmptyValue()
     
    int
    getMax()
    Get current maximum value
    int
    getMaxMarkers()
    Get maximum number of markers
    int
    getMin()
    Get current minimum value
    int
    getSecondaryProgress()
    Get value of the secondary progress indicator
    boolean
    hasSnaps()
    Get marker state
    void
    isPinned(boolean pin)
    Get pin state
    void
    removeThemeVariants(PaperSliderVariant... variants)
    Removes theme variants from the component.
    void
    setEmptyValue(Integer emptyValue)
    Set value that represent empty value, default is 0.
    void
    setMax(int max)
    Set maximum value of the slider range
    void
    setMaxMarkers(int markers)
    Set maximum number of markers
    void
    setMin(int min)
    Set the minimum value of the range.
    void
    setPinned(boolean pin)
    Enable pin marker
    protected void
    setPresentationValue(Integer value)
     
    void
    setReadOnly(boolean readOnly)
     
    void
    setSecondaryProgress(int secondary)
    Set secondary progress indicator
    void
    setSnaps(boolean snaps)
    Enable snaps
    void
    setValue(Integer value)
    Set the value.

    Methods inherited from class com.vaadin.flow.component.customfield.CustomField

    add, addThemeVariants, getLabel, remove, removeThemeVariants, setLabel, updateValue

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

    addValueChangeListener, getValue, isEmpty, setModelValue, 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, onAttach, onDetach, onEnabledStateChanged, removeFromParent, scrollIntoView, scrollIntoView, set, setElement, setId, setVisible

    Methods inherited from class java.lang.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.DetachNotifier

    addDetachListener

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

    addFocusShortcut, getTabIndex, setTabIndex

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

    addFocusListener

    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.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, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassName

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

    addThemeName, addThemeNames, getThemeName, getThemeNames, hasThemeName, removeThemeName, removeThemeNames, setThemeName, setThemeName

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

    getTooltip, setTooltipText

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

    setManualValidation

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

    getErrorMessage, isInvalid, setErrorMessage, setInvalid

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

    addValueChangeListener, clear, getOptionalValue, getValue, isEmpty

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

    isReadOnly, isRequiredIndicatorVisible, setRequiredIndicatorVisible

  • Constructor Details

    • PaperSlider

      public PaperSlider()
      Default constructor

    • PaperSlider

      public PaperSlider(String label)
      Create slider with label.
      Parameters:
      label - The label.

  • Method Details

    • setMin

      public void setMin(int min)
      Set the minimum value of the range.
      Parameters:
      min - int value

    • getMin

      public int getMin()
      Get current minimum value
      Returns:
      int value

    • setMax

      public void setMax(int max)
      Set maximum value of the slider range
      Parameters:
      max - int value

    • getMax

      public int getMax()
      Get current maximum value
      Returns:
      value

    • setSecondaryProgress

      public void setSecondaryProgress(int secondary)
      Set secondary progress indicator
      Parameters:
      secondary - int value between min and max

    • getSecondaryProgress

      public int getSecondaryProgress()
      Get value of the secondary progress indicator
      Returns:
      int value between min and max

    • setPinned

      public void setPinned(boolean pin)
      Enable pin marker
      Parameters:
      pin - use true to enable pin, false to disable

    • isPinned

      public void isPinned(boolean pin)
      Get pin state
      Parameters:
      pin - boolean value

    • setSnaps

      public void setSnaps(boolean snaps)
      Enable snaps

      See: setMaxMarkers

      Parameters:
      snaps - use true to enable markers

    • hasSnaps

      public boolean hasSnaps()
      Get marker state
      Returns:
      boolean value

    • setMaxMarkers

      public void setMaxMarkers(int markers)
      Set maximum number of markers
      Parameters:
      markers - int value between 0 and length of range

    • getMaxMarkers

      public int getMaxMarkers()
      Get maximum number of markers
      Returns:
      int value

    • generateModelValue

      protected Integer generateModelValue()
      Specified by:
      generateModelValue in class com.vaadin.flow.component.customfield.CustomField<Integer>

    • setPresentationValue

      protected void setPresentationValue(Integer value)
      Specified by:
      setPresentationValue in class com.vaadin.flow.component.customfield.CustomField<Integer>

    • setValue

      public void setValue(Integer value)
      Set the value. Can be null, null is interpreted as 0.
      Specified by:
      setValue in interface com.vaadin.flow.component.HasValue<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.customfield.CustomField<Integer>,Integer>,Integer>
      Overrides:
      setValue in class com.vaadin.flow.component.AbstractField<com.vaadin.flow.component.customfield.CustomField<Integer>,Integer>
      Parameters:
      value - Integer value, null is converted to 0.
      Throws:
      IllegalArgumentException - when value is out of min - max bounds.

    • setReadOnly

      public void setReadOnly(boolean readOnly)

    • addThemeVariants

      public void addThemeVariants(PaperSliderVariant... variants)
      Adds theme variants to the component.
      Parameters:
      variants - theme variants to add

    • removeThemeVariants

      public void removeThemeVariants(PaperSliderVariant... variants)
      Removes theme variants from the component.
      Parameters:
      variants - theme variants to remove

    • setEmptyValue

      public void setEmptyValue(Integer emptyValue)
      Set value that represent empty value, default is 0.
      Parameters:
      emptyValue - Integer value

    • getEmptyValue

      public Integer getEmptyValue()
      Specified by:
      getEmptyValue in interface com.vaadin.flow.component.HasValue<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.customfield.CustomField<Integer>,Integer>,Integer>
      Overrides:
      getEmptyValue in class com.vaadin.flow.component.AbstractField<com.vaadin.flow.component.customfield.CustomField<Integer>,Integer>

    • focus

      public void focus()

    • blur

      public void blur()