Module javafx.controls
Package javafx.scene.control

Class ScrollBar

java.lang.Object
javafx.scene.Node
javafx.scene.Parent
javafx.scene.layout.Region
javafx.scene.control.Control
javafx.scene.control.ScrollBar
All Implemented Interfaces:
Styleable, EventTarget, Skinnable
public class ScrollBar
extends Control
Either a horizontal or vertical bar with increment and decrement buttons and a "thumb" with which the user can interact. Typically not used alone but used for building up more complicated controls such as the ScrollPane and ListView.

ScrollBar sets focusTraversable to false.

This example creates a vertical ScrollBar: 

 ScrollBar s1 = new ScrollBar();
 s1.setOrientation(Orientation.VERTICAL);
Image of the ScrollBar control
Since:
JavaFX 2.0

  • Property Details

  • Constructor Details

    • ScrollBar

      public ScrollBar()
      Creates a new horizontal ScrollBar (ie getOrientation() == Orientation.HORIZONTAL).

  • Method Details

    • setMin

      public final void setMin​(double value)
      Sets the value of the property min.
      Property description:
      The minimum value represented by this ScrollBar. This should be a value less than or equal to max. Default value is 0.

    • getMin

      public final double getMin()
      Gets the value of the property min.
      Property description:
      The minimum value represented by this ScrollBar. This should be a value less than or equal to max. Default value is 0.

    • minProperty

      public final DoubleProperty minProperty()
      The minimum value represented by this ScrollBar. This should be a value less than or equal to max. Default value is 0.
      See Also:
      getMin(), setMin(double)

    • setMax

      public final void setMax​(double value)
      Sets the value of the property max.
      Property description:
      The maximum value represented by this ScrollBar. This should be a value greater than or equal to min. Default value is 100.

    • getMax

      public final double getMax()
      Gets the value of the property max.
      Property description:
      The maximum value represented by this ScrollBar. This should be a value greater than or equal to min. Default value is 100.

    • maxProperty

      public final DoubleProperty maxProperty()
      The maximum value represented by this ScrollBar. This should be a value greater than or equal to min. Default value is 100.
      See Also:
      getMax(), setMax(double)

    • setValue

      public final void setValue​(double value)
      Sets the value of the property value.
      Property description:
      The current value represented by this ScrollBar. This value should be between min and max, inclusive.

    • getValue

      public final double getValue()
      Gets the value of the property value.
      Property description:
      The current value represented by this ScrollBar. This value should be between min and max, inclusive.

    • valueProperty

      public final DoubleProperty valueProperty()
      The current value represented by this ScrollBar. This value should be between min and max, inclusive.
      See Also:
      getValue(), setValue(double)

    • setOrientation

      public final void setOrientation​(Orientation value)
      Sets the value of the property orientation.
      Property description:
      The orientation of the ScrollBar can either be HORIZONTAL or VERTICAL.

    • getOrientation

      public final Orientation getOrientation()
      Gets the value of the property orientation.
      Property description:
      The orientation of the ScrollBar can either be HORIZONTAL or VERTICAL.

    • orientationProperty

      public final ObjectProperty<Orientation> orientationProperty()
      The orientation of the ScrollBar can either be HORIZONTAL or VERTICAL.
      See Also:
      getOrientation(), setOrientation(Orientation)

    • setUnitIncrement

      public final void setUnitIncrement​(double value)
      Sets the value of the property unitIncrement.
      Property description:
      The amount by which to adjust the ScrollBar when the increment or decrement methods are called.

    • getUnitIncrement

      public final double getUnitIncrement()
      Gets the value of the property unitIncrement.
      Property description:
      The amount by which to adjust the ScrollBar when the increment or decrement methods are called.

    • unitIncrementProperty

      public final DoubleProperty unitIncrementProperty()
      The amount by which to adjust the ScrollBar when the increment or decrement methods are called.
      See Also:
      getUnitIncrement(), setUnitIncrement(double)

    • setBlockIncrement

      public final void setBlockIncrement​(double value)
      Sets the value of the property blockIncrement.
      Property description:
      The amount by which to adjust the scrollbar if the track of the bar is clicked.

    • getBlockIncrement

      public final double getBlockIncrement()
      Gets the value of the property blockIncrement.
      Property description:
      The amount by which to adjust the scrollbar if the track of the bar is clicked.

    • blockIncrementProperty

      public final DoubleProperty blockIncrementProperty()
      The amount by which to adjust the scrollbar if the track of the bar is clicked.
      See Also:
      getBlockIncrement(), setBlockIncrement(double)

    • setVisibleAmount

      public final void setVisibleAmount​(double value)
      Sets the value of the property visibleAmount.
      Property description:
      Visible amount of the scrollbar's range, typically represented by the size of the scroll bar's thumb.

    • getVisibleAmount

      public final double getVisibleAmount()
      Gets the value of the property visibleAmount.
      Property description:
      Visible amount of the scrollbar's range, typically represented by the size of the scroll bar's thumb.

    • visibleAmountProperty

      public final DoubleProperty visibleAmountProperty()
      Visible amount of the scrollbar's range, typically represented by the size of the scroll bar's thumb.
      See Also:
      getVisibleAmount(), setVisibleAmount(double)

    • adjustValue

      public void adjustValue​(double position)
      Adjusts the value property by blockIncrement. The position is the fractional amount between the min and max. For example, it might be 50%. If #minProperty min were 0 and #maxProperty max were 100 and value were 25, then a position of .5 would indicate that we should increment value by blockIncrement. If value were 75, then a position of .5 would indicate that we should decrement value by blockIncrement. Note: This function is intended to be used by experts, primarily by those implementing new Skins or Behaviors. It is not common for developers or designers to access this function directly.
      Parameters:
      position - the position

    • increment

      public void increment()
      Increments the value of the ScrollBar by the unitIncrement

    • decrement

      public void decrement()
      Decrements the value of the ScrollBar by the unitIncrement

    • createDefaultSkin

      protected Skin<?> createDefaultSkin()
      Create a new instance of the default skin for this control. This is called to create a skin for the control if no skin is provided via CSS -fx-skin or set explicitly in a sub-class with setSkin(...).
      Overrides:
      createDefaultSkin in class Control
      Returns:
      new instance of default skin for this control. If null then the control will have no skin unless one is provided by css.

    • getClassCssMetaData

      public static List<CssMetaData<? extends Styleable,​?>> getClassCssMetaData()
      Returns:
      The CssMetaData associated with this class, which may include the CssMetaData of its superclasses.
      Since:
      JavaFX 8.0

    • getControlCssMetaData

      public List<CssMetaData<? extends Styleable,​?>> getControlCssMetaData()
      Overrides:
      getControlCssMetaData in class Control
      Returns:
      unmodifiable list of the controls css styleable properties
      Since:
      JavaFX 8.0

    • getInitialFocusTraversable

      protected Boolean getInitialFocusTraversable()
      Returns the initial focus traversable state of this control, for use by the JavaFX CSS engine to correctly set its initial value. This method is overridden as by default UI controls have focus traversable set to true, but that is not appropriate for this control.
      Overrides:
      getInitialFocusTraversable in class Control
      Returns:
      the initial focus traversable state of this control
      Since:
      9

    • queryAccessibleAttribute

      public Object queryAccessibleAttribute​(AccessibleAttribute attribute, Object... parameters)
      This method is called by the assistive technology to request the value for an attribute.

      This method is commonly overridden by subclasses to implement attributes that are required for a specific role.
      If a particular attribute is not handled, the superclass implementation must be called.

      Overrides:
      queryAccessibleAttribute in class Control
      Parameters:
      attribute - the requested attribute
      parameters - optional list of parameters
      Returns:
      the value for the requested attribute
      See Also:
      AccessibleAttribute

    • executeAccessibleAction

      public void executeAccessibleAction​(AccessibleAction action, Object... parameters)
      This method is called by the assistive technology to request the action indicated by the argument should be executed.

      This method is commonly overridden by subclasses to implement action that are required for a specific role.
      If a particular action is not handled, the superclass implementation must be called.

      Overrides:
      executeAccessibleAction in class Control
      Parameters:
      action - the action to execute
      parameters - optional list of parameters
      See Also:
      AccessibleAction