Package org.dwcj.controls.slider

Class Slider

java.lang.Object
org.dwcj.controls.AbstractControl
org.dwcj.controls.AbstractDwcControl
org.dwcj.controls.slider.Slider
All Implemented Interfaces:
Control, Enableable, Focusable, HasAttribute, HasClassName, HasComputedStyle, HasControlText, HasDestroy, HasMouseWheelCondition, HasStyle, HasTooltip, HasVisibility, TabTraversable
public final class Slider extends AbstractDwcControl implements Focusable, HasMouseWheelCondition, TabTraversable

  • Constructor Details

    • Slider

      public Slider()

  • Method Details

    • create

      protected void create(AbstractDwcjPanel p)
      Description copied from class: AbstractControl
      Create the object on a panel p. The preferred way of creating an object is using the Panel::add(Control) method, instead of this
      Overrides:
      create in class AbstractControl
      Parameters:
      p - the panel to add this control on

    • onScroll

      public Slider onScroll(Consumer<SliderOnControlScrollEvent> callback)
      Sets a callback to fire when the slider control is scrolled.
      Parameters:
      callback - Function written with behavior to be executed when the event is fired
      Returns:
      The object itself

    • isInverted

      public Boolean isInverted()
      This method gets the orientation of the ProgressBar control. By default, the minimum value of a vertical slider is at the bottom and the maximum value is at the top. For a horizontal slider, the minimum value is to the left and the maximum value is to the right. The orientation reverses for inverted sliders.
      Returns:
      Returns whether the control orientation is inverted.

    • getLabels

      public Map<Integer,String> getLabels()
      This method returns the labels from a ProgressBar control.
      Returns:
      Returns a Java Map<Integer,String> structure, where each Integer key is the slider position of the corresponding String label.

    • getMajorTickSpacing

      public Integer getMajorTickSpacing()
      This method queries the slider's major tick spacing.
      Returns:
      Returns the slider's major tick spacing.

    • getMaximum

      public Integer getMaximum()
      This method returns the maximum value of the ProgressBar control.
      Returns:
      Returns the maximum value of the control.

    • getMinimum

      public Integer getMinimum()
      This method returns the minimum value of the ProgressBar control.
      Returns:
      Returns the minimum value of the control.

    • getMinorTickSpacing

      public Integer getMinorTickSpacing()
      This method queries the minor tick spacing of the ProgressBar control.
      Returns:
      Returns the slider's minor tick spacing.

    • getOrientation

      public Integer getOrientation()
      This method returns the orientation of the ProgressBar control.
      Returns:
      Returns the orientation of the control (0 = HORIZONTAL, 1 = VERTICAL).

    • isPaintLabels

      public Boolean isPaintLabels()
      This method queries whether to paint labels on the ProgressBar control.
      Returns:
      Returns whether labels are painted on this slider.

    • isPaintTicks

      public Boolean isPaintTicks()
      This method queries whether to paint ticks on the ProgressBar control.
      Returns:
      Returns whether ticks are painted on this slider.

    • isSnapToTicks

      public Boolean isSnapToTicks()
      This method queries whether a ProgressBar control should snap to the nearest tick when the user drags the thumb.
      Returns:
      Returns whether the BBjSlider should snap to the nearest tick when the user drags the thumb.

    • getValue

      public Integer getValue()
      This method returns the current value of the ProgressBar control.
      Returns:
      Returns the current value of the control.

    • setInverted

      public Slider setInverted(Boolean inverted)
      This method sets the orientation of the ProgressBar control. By default, the minimum value of a vertical slider is at the bottom and the maximum value is at the top. For a horizontal slider, the minimum value is to the left and the maximum value is to the right. The orientation reverses for inverted sliders.
      Parameters:
      inverted - - Specifies whether the slider orientation is inverted.
      Returns:
      Returns this

    • setLabels

      public Slider setLabels(Map<Integer,String> labels)
      This method sets the custom labels for a ProgressBar control.
      Parameters:
      labels - - A Java Map<Integer,String> structure, where the Integer key is the slider position of the corresponding String label.
      Returns:
      Returns this

    • setMajorTickSpacing

      public Slider setMajorTickSpacing(Integer tick)
      This method sets the major tick spacing for a ProgressBar control.
      Parameters:
      prop - - Specifies the major tick spacing.
      Returns:
      Returns this

    • setMaximum

      public Slider setMaximum(Integer maximum)
      This method sets the maximum value of the ProgressBar control.
      Parameters:
      value - - Specifies the maximum value.
      Returns:
      Returns this

    • setMinimum

      public Slider setMinimum(Integer minimum)
      This method sets the minimum value of the ProgressBar control.
      Parameters:
      value - - Specifies the minimum value.
      Returns:
      Returns this

    • setMinorTickSpacing

      public Slider setMinorTickSpacing(Integer tick)
      This method sets the minor tick spacing of a ProgressBar control.
      Parameters:
      tick - - Specifies the minor tick spacing.
      Returns:
      Returns this

    • setOrientation

      public Slider setOrientation(Slider.Orientation orientation)
      Will set the slider to vertical if the string "vertical" is passed. Defaults to horizontal for any other string.
      Parameters:
      orientation - String "vertical" to set the slider's orientation to vertical, "horizontal" for horizontal(default)
      Returns:
      The object itself

    • setPaintLabels

      public Slider setPaintLabels(Boolean paint)
      This method sets whether labels are painted on a ProgressBar control.
      Parameters:
      paint - - Specifies whether labels are painted on the
      Returns:
      Returns this

    • setPaintTicks

      public Slider setPaintTicks(Boolean paint)
      This method sets whether ticks are painted on a ProgressBar control.
      Parameters:
      paint - - Specifies whether ticks are painted on the control.
      Returns:
      Returns this

    • setSnapToTicks

      public Slider setSnapToTicks(Boolean snap)
      This method sets whether a ProgressBar control should snap to the nearest tick when the user drags the thumb.
      Parameters:
      snap - - Specifies whether the control should snap to the nearest tick when the user drags the thumb.
      Returns:
      Returns this

    • setValue

      public Slider setValue(Integer value)
      This method sets the value of the ProgressBar control.
      Parameters:
      value - - Specifies the slider value.
      Returns:
      Returns this

    • isFocusable

      public Boolean isFocusable()
      Description copied from interface: Focusable
      isFocusable returns a value indicating whether or not the user can focus the control. Note: A focused control is the control to which keyboard interaction is directed. Typically, the focused control is indicated visually, often via a dotted grey border. A control which is not focusable, therefore, cannot be manipulated via the keyboard. It is still possible to interact with a non-focusable control via the mouse.
      Specified by:
      isFocusable in interface Focusable
      Returns:
      True if object can be focused, False if not.

    • setFocusable

      public Slider setFocusable(Boolean focusable)
      Description copied from interface: Focusable
      setFocusable sets whether a control can be focused. Note: A focused control is the control to which keyboard interaction is directed. Typically, the focused control is indicated visually, often via a dotted grey border. A control which is not focusable, therefore, cannot be manipulated via the keyboard. It is still possible to interact with a non-focusable control via the mouse. To disable all interaction, including the mouse, see setEnabled() and setReadOnly().
      Specified by:
      setFocusable in interface Focusable
      Parameters:
      focusable - Boolean True for allowing focusing, False to disable focus
      Returns:
      Object itself

    • isTabTraversable

      public Boolean isTabTraversable()
      Description copied from interface: TabTraversable
      Returns a boolean indicating whether or not the user can navigate to the control using the tab key.
      Specified by:
      isTabTraversable in interface TabTraversable
      Returns:
      True if user can navigate to control with Tab key, False if not

    • setTabTraversable

      public Slider setTabTraversable(Boolean traverse)
      Description copied from interface: TabTraversable
      Sets whether or not the user can navigate to the control using the tab key.
      Specified by:
      setTabTraversable in interface TabTraversable
      Parameters:
      traverse - Boolean dictating tab traversal. True if control can be navigated to with Tab, False if not.
      Returns:
      The control itself

    • getScrollWheelBehavior

      public HasMouseWheelCondition.MouseWheelCondition getScrollWheelBehavior()
      Description copied from interface: HasMouseWheelCondition
      getScrollWheelBehavior returns a constant indicating under what situations the control will respond to the mouse scroll wheel.
      Specified by:
      getScrollWheelBehavior in interface HasMouseWheelCondition
      Returns:
      Enum value of scroll behavior

    • setScrollWheelBehavior

      public Slider setScrollWheelBehavior(HasMouseWheelCondition.MouseWheelCondition condition)
      Description copied from interface: HasMouseWheelCondition
      setScrollWheelBehavior configures under what situations the control will respond to the mouse scroll wheel.
      Specified by:
      setScrollWheelBehavior in interface HasMouseWheelCondition
      Parameters:
      condition - Enum value for desired behavior
      Returns:
      The control itself

    • setText

      public Slider setText(String text)
      Description copied from interface: HasControlText
      set the text of the control Each control implementing this interface has a text property, which might be visible in different ways (caption, title, contents of edit) or sometimes not visible at all
      Specified by:
      setText in interface HasControlText
      Overrides:
      setText in class AbstractDwcControl
      Returns:
      the control itself

    • setVisible

      public Slider setVisible(Boolean visible)
      Description copied from interface: HasVisibility
      Set whether the control is visible or invisible
      Specified by:
      setVisible in interface HasVisibility
      Overrides:
      setVisible in class AbstractDwcControl
      Returns:
      the control itself

    • setEnabled

      public Slider setEnabled(Boolean enabled)
      Description copied from interface: Enableable
      Set whether the control is to be enabled
      Specified by:
      setEnabled in interface Enableable
      Overrides:
      setEnabled in class AbstractDwcControl
      Returns:
      the control itself

    • setTooltipText

      public Slider setTooltipText(String text)
      Description copied from interface: HasTooltip
      Set the tooltip text of the control
      Specified by:
      setTooltipText in interface HasTooltip
      Overrides:
      setTooltipText in class AbstractDwcControl
      Returns:
      the control itself

    • setAttribute

      public Slider setAttribute(String attribute, String value)
      Description copied from class: AbstractDwcControl
      set the value for an attribute in the control
      Specified by:
      setAttribute in interface HasAttribute
      Overrides:
      setAttribute in class AbstractDwcControl
      Parameters:
      attribute - the name of the attribute
      value - the value to be set
      Returns:
      the control itself

    • setId

      public Slider setId(String elementId)
      Description copied from interface: Control
      Assigns the ID of a control
      Specified by:
      setId in interface Control
      Overrides:
      setId in class AbstractControl
      Parameters:
      elementId - Desired ID designation
      Returns:
      The control itself

    • setStyle

      public Slider setStyle(String property, String value)
      Description copied from interface: HasStyle
      Assigns specified value to the specified CSS property
      Specified by:
      setStyle in interface HasStyle
      Overrides:
      setStyle in class AbstractDwcControl
      Parameters:
      property - The CSS property to be changed
      value - The value of the selected CSS property
      Returns:
      The control itself

    • addClassName

      public Slider addClassName(String selector)
      Description copied from interface: HasClassName
      Adds a CSS class to the list of CSS classes for the control.
      Specified by:
      addClassName in interface HasClassName
      Overrides:
      addClassName in class AbstractDwcControl
      Returns:
      The control itself

    • removeClassName

      public Slider removeClassName(String selector)
      Description copied from interface: HasClassName
      Removes a CSS class from the list of CSS classes for the control.
      Specified by:
      removeClassName in interface HasClassName
      Overrides:
      removeClassName in class AbstractDwcControl
      Returns:
      The control itself

    • setTheme

      public Slider setTheme(Slider.Theme theme)

    • catchUp

      protected void catchUp() throws IllegalAccessException
      Description copied from class: AbstractDwcControl
      The catchUp method is used to replay attributes and settings that the API user might have added to a control before its creation. A control is not created before it's added to a panel. Anything that is added between instantiation of a control and its addition to a panel has to be recorded and replayed in this method
      Overrides:
      catchUp in class AbstractDwcControl
      Throws:
      IllegalAccessException - - thrown if an attempt is made to call this method more than once