Class VFXScrollBar

java.lang.Object
javafx.scene.Node
javafx.scene.Parent
javafx.scene.layout.Region
javafx.scene.control.Control
io.github.palexdev.mfxcore.controls.Control<VFXScrollBarBehavior>
io.github.palexdev.virtualizedfx.controls.VFXScrollBar
All Implemented Interfaces:
io.github.palexdev.mfxcore.behavior.WithBehavior<VFXScrollBarBehavior>, io.github.palexdev.mfxcore.controls.MFXSkinnable<io.github.palexdev.mfxcore.controls.SkinBase<?,?>>, io.github.palexdev.mfxcore.controls.MFXStyleable, Styleable, EventTarget, Skinnable
public class VFXScrollBar extends io.github.palexdev.mfxcore.controls.Control<VFXScrollBarBehavior> implements io.github.palexdev.mfxcore.controls.MFXStyleable
My personal custom implementation of a scroll bar from scratch, follows the MVC pattern as enforced by Control. The default skin is VFXScrollBarSkin. The default behavior is VFXScrollBarBehavior. Also implements MFXStyleable.

In addition to an appealing style, the component offers many new features compared to the boring standard JavaFX' scroll bar, such as:

- standard or slim appearance (depends on the stylesheet!), layoutModeProperty()

- the possibility of showing/hiding the increase and decrease buttons, showButtonsProperty()

- the possibility of controlling the gap between the buttons and the thumb, buttonsGapProperty()

- inbuilt smooth scroll both for the thumb and the track, smoothScrollProperty(), trackSmoothScrollProperty()

- the possibility of querying the scroll direction, scrollDirectionProperty()

Three PseudoClass worth mentioning:

- ":compact": active when the layoutModeProperty() is set to ScrollPaneEnums.LayoutMode.COMPACT

- ":buttons": active when the increment and decrement buttons are visible, showButtonsProperty()

- ":dragging": active when the thumb is being dragged

- ":horizontal": active when the scroll bar's orientation is HORIZONTAL

- ":vertical": active when the scroll bar's orientation is VERTICAL

For the sake of simplicity and abstraction, the bar's values are expressed as percentages. The minimum and maximum values can be set by using setMin(double) and setMax(double) but cannot go below 0.0 and above 1.0 respectively. The valueProperty() is automatically clamped between the min and max values.

  • Property Details

  • Field Details

    • DRAGGING_PSEUDO_CLASS

      public static final PseudoClass DRAGGING_PSEUDO_CLASS

    • VERTICAL_PSEUDO_CLASS

      public static final PseudoClass VERTICAL_PSEUDO_CLASS

    • HORIZONTAL_PSEUDO_CLASS

      public static final PseudoClass HORIZONTAL_PSEUDO_CLASS

    • BUTTONS_PSEUDO_CLASS

      public static final PseudoClass BUTTONS_PSEUDO_CLASS

  • Constructor Details

    • VFXScrollBar

      public VFXScrollBar()

    • VFXScrollBar

      public VFXScrollBar(Orientation orientation)

  • Method Details

    • defaultSkinProvider

      public Supplier<io.github.palexdev.mfxcore.controls.SkinBase<?,?>> defaultSkinProvider()
      Specified by:
      defaultSkinProvider in interface io.github.palexdev.mfxcore.controls.MFXSkinnable<io.github.palexdev.mfxcore.controls.SkinBase<?,?>>

    • defaultBehaviorProvider

      public Supplier<VFXScrollBarBehavior> defaultBehaviorProvider()
      Specified by:
      defaultBehaviorProvider in interface io.github.palexdev.mfxcore.behavior.WithBehavior<VFXScrollBarBehavior>

    • defaultStyleClasses

      public List<String> defaultStyleClasses()
      Specified by:
      defaultStyleClasses in interface io.github.palexdev.mfxcore.controls.MFXStyleable

    • getLayoutMode

      public ScrollPaneEnums.LayoutMode getLayoutMode()
      Gets the value of the layoutMode property.
      Property description:
      Specifies the scroll bar's appearance. Setting this to ScrollPaneEnums.LayoutMode.COMPACT will activate the extra PseudoClass ':compact' on the control.

      Note however that this depends entirely on the stylesheet used.

      This is also settable via CSS with the "-vfx-layout-mode" property.

      Returns:
      the value of the layoutMode property
      See Also:

    • layoutModeProperty

      public io.github.palexdev.mfxcore.base.properties.styleable.StyleableObjectProperty<ScrollPaneEnums.LayoutMode> layoutModeProperty()
      Specifies the scroll bar's appearance. Setting this to ScrollPaneEnums.LayoutMode.COMPACT will activate the extra PseudoClass ':compact' on the control.

      Note however that this depends entirely on the stylesheet used.

      This is also settable via CSS with the "-vfx-layout-mode" property.

      Returns:
      the layoutMode property
      See Also:

    • setLayoutMode

      public void setLayoutMode(ScrollPaneEnums.LayoutMode layoutMode)
      Sets the value of the layoutMode property.
      Property description:
      Specifies the scroll bar's appearance. Setting this to ScrollPaneEnums.LayoutMode.COMPACT will activate the extra PseudoClass ':compact' on the control.

      Note however that this depends entirely on the stylesheet used.

      This is also settable via CSS with the "-vfx-layout-mode" property.

      Parameters:
      layoutMode - the value for the layoutMode property
      See Also:

    • getOrientation

      public Orientation getOrientation()
      Gets the value of the orientation property.
      Property description:
      Specifies the scroll bar's orientation.

      This is also settable via CSS with the "-vfx-orientation" property.

      Returns:
      the value of the orientation property
      See Also:

    • orientationProperty

      public io.github.palexdev.mfxcore.base.properties.styleable.StyleableObjectProperty<Orientation> orientationProperty()
      Specifies the scroll bar's orientation.

      This is also settable via CSS with the "-vfx-orientation" property.

      Returns:
      the orientation property
      See Also:

    • setOrientation

      public void setOrientation(Orientation orientation)
      Sets the value of the orientation property.
      Property description:
      Specifies the scroll bar's orientation.

      This is also settable via CSS with the "-vfx-orientation" property.

      Parameters:
      orientation - the value for the orientation property
      See Also:

    • isShowButtons

      public boolean isShowButtons()
      Gets the value of the showButtons property.
      Property description:
      Specifies whether the increase/decrease buttons are visible.

      This is also settable via CSS with the "-vfx-show-buttons" property.

      Returns:
      the value of the showButtons property
      See Also:

    • showButtonsProperty

      public io.github.palexdev.mfxcore.base.properties.styleable.StyleableBooleanProperty showButtonsProperty()
      Specifies whether the increase/decrease buttons are visible.

      This is also settable via CSS with the "-vfx-show-buttons" property.

      Returns:
      the showButtons property
      See Also:

    • setShowButtons

      public void setShowButtons(boolean showButtons)
      Sets the value of the showButtons property.
      Property description:
      Specifies whether the increase/decrease buttons are visible.

      This is also settable via CSS with the "-vfx-show-buttons" property.

      Parameters:
      showButtons - the value for the showButtons property
      See Also:

    • getButtonsGap

      public double getButtonsGap()
      Gets the value of the buttonsGap property.
      Property description:
      Specifies the gap between the increase/decrease buttons and the track.

      This is also settable via CSS with the "-vfx-buttons-gap" property.

      Returns:
      the value of the buttonsGap property
      See Also:

    • buttonsGapProperty

      public io.github.palexdev.mfxcore.base.properties.styleable.StyleableDoubleProperty buttonsGapProperty()
      Specifies the gap between the increase/decrease buttons and the track.

      This is also settable via CSS with the "-vfx-buttons-gap" property.

      Returns:
      the buttonsGap property
      See Also:

    • setButtonsGap

      public void setButtonsGap(double buttonsGap)
      Sets the value of the buttonsGap property.
      Property description:
      Specifies the gap between the increase/decrease buttons and the track.

      This is also settable via CSS with the "-vfx-buttons-gap" property.

      Parameters:
      buttonsGap - the value for the buttonsGap property
      See Also:

    • getTrackIncrement

      public double getTrackIncrement()
      Gets the value of the trackIncrement property.
      Property description:
      Specifies the amount added/subtracted to the valueProperty() used by the scroll bar's track.

      This is also settable via CSS with the "-vfx-track-increment" property.

      Returns:
      the value of the trackIncrement property
      See Also:

    • trackIncrementProperty

      public io.github.palexdev.mfxcore.base.properties.styleable.StyleableDoubleProperty trackIncrementProperty()
      Specifies the amount added/subtracted to the valueProperty() used by the scroll bar's track.

      This is also settable via CSS with the "-vfx-track-increment" property.

      Returns:
      the trackIncrement property
      See Also:

    • setTrackIncrement

      public void setTrackIncrement(double trackIncrement)
      Sets the value of the trackIncrement property.
      Property description:
      Specifies the amount added/subtracted to the valueProperty() used by the scroll bar's track.

      This is also settable via CSS with the "-vfx-track-increment" property.

      Parameters:
      trackIncrement - the value for the trackIncrement property
      See Also:

    • getUnitIncrement

      public double getUnitIncrement()
      Gets the value of the unitIncrement property.
      Property description:
      Specifies the amount added/subtracted to the valueProperty() used by the increment/decrement buttons and by scrolling.

      This is also settable via CSS with the "-vfx-unit-increment" property.

      Returns:
      the value of the unitIncrement property
      See Also:

    • unitIncrementProperty

      public io.github.palexdev.mfxcore.base.properties.styleable.StyleableDoubleProperty unitIncrementProperty()
      Specifies the amount added/subtracted to the valueProperty() used by the increment/decrement buttons and by scrolling.

      This is also settable via CSS with the "-vfx-unit-increment" property.

      Returns:
      the unitIncrement property
      See Also:

    • setUnitIncrement

      public void setUnitIncrement(double unitIncrement)
      Sets the value of the unitIncrement property.
      Property description:
      Specifies the amount added/subtracted to the valueProperty() used by the increment/decrement buttons and by scrolling.

      This is also settable via CSS with the "-vfx-unit-increment" property.

      Parameters:
      unitIncrement - the value for the unitIncrement property
      See Also:

    • isSmoothScroll

      public boolean isSmoothScroll()
      Gets the value of the smoothScroll property.
      Property description:
      Specifies whether the scrolling should be smooth, done by animations.

      This is also settable via CSS with the "-vfx-smooth-scroll" property.

      Returns:
      the value of the smoothScroll property
      See Also:

    • smoothScrollProperty

      public io.github.palexdev.mfxcore.base.properties.styleable.StyleableBooleanProperty smoothScrollProperty()
      Specifies whether the scrolling should be smooth, done by animations.

      This is also settable via CSS with the "-vfx-smooth-scroll" property.

      Returns:
      the smoothScroll property
      See Also:

    • setSmoothScroll

      public void setSmoothScroll(boolean smoothScroll)
      Sets the value of the smoothScroll property.
      Property description:
      Specifies whether the scrolling should be smooth, done by animations.

      This is also settable via CSS with the "-vfx-smooth-scroll" property.

      Parameters:
      smoothScroll - the value for the smoothScroll property
      See Also:

    • isTrackSmoothScroll

      public boolean isTrackSmoothScroll()
      Gets the value of the trackSmoothScroll property.
      Property description:
      Specifies if the scrolling made by the track should be smooth, done by animations.

      The default behavior considers this feature an addition to the smoothScrollProperty(), meaning that for this to work the aforementioned feature must be enabled too.

      This is also settable via CSS with the "-vfx-track-smooth-scroll" property.

      Returns:
      the value of the trackSmoothScroll property
      See Also:

    • trackSmoothScrollProperty

      public io.github.palexdev.mfxcore.base.properties.styleable.StyleableBooleanProperty trackSmoothScrollProperty()
      Specifies if the scrolling made by the track should be smooth, done by animations.

      The default behavior considers this feature an addition to the smoothScrollProperty(), meaning that for this to work the aforementioned feature must be enabled too.

      This is also settable via CSS with the "-vfx-track-smooth-scroll" property.

      Returns:
      the trackSmoothScroll property
      See Also:

    • setTrackSmoothScroll

      public void setTrackSmoothScroll(boolean trackSmoothScroll)
      Sets the value of the trackSmoothScroll property.
      Property description:
      Specifies if the scrolling made by the track should be smooth, done by animations.

      The default behavior considers this feature an addition to the smoothScrollProperty(), meaning that for this to work the aforementioned feature must be enabled too.

      This is also settable via CSS with the "-vfx-track-smooth-scroll" property.

      Parameters:
      trackSmoothScroll - the value for the trackSmoothScroll property
      See Also:

    • getClassCssMetaData

      public static List<CssMetaData<? extends Styleable, ?>> getClassCssMetaData()

    • getControlCssMetaData

      protected List<CssMetaData<? extends Styleable, ?>> getControlCssMetaData()
      Overrides:
      getControlCssMetaData in class Control

    • getMin

      public double getMin()
      Gets the value of the min property.
      Property description:
      Specifies the minimum possible value for valueProperty().
      Returns:
      the value of the min property
      See Also:

    • minProperty

      public DoubleProperty minProperty()
      Specifies the minimum possible value for valueProperty().
      Returns:
      the min property
      See Also:

    • setMin

      public void setMin(double min)
      Sets the value of the min property.
      Property description:
      Specifies the minimum possible value for valueProperty().
      Parameters:
      min - the value for the min property
      See Also:

    • getValue

      public double getValue()
      Gets the value of the value property.
      Property description:
      Specifies the scroll value, clamped between minProperty() and maxProperty().
      Returns:
      the value of the value property
      See Also:

    • valueProperty

      public DoubleProperty valueProperty()
      Specifies the scroll value, clamped between minProperty() and maxProperty().
      Returns:
      the value property
      See Also:

    • setValue

      public void setValue(double value)
      Sets the value of the value property.
      Property description:
      Specifies the scroll value, clamped between minProperty() and maxProperty().
      Parameters:
      value - the value for the value property
      See Also:

    • getMax

      public double getMax()
      Gets the value of the max property.
      Property description:
      Specifies the maximum possible value for valueProperty().
      Returns:
      the value of the max property
      See Also:

    • maxProperty

      public DoubleProperty maxProperty()
      Specifies the maximum possible value for valueProperty().
      Returns:
      the max property
      See Also:

    • setMax

      public void setMax(double max)
      Sets the value of the max property.
      Property description:
      Specifies the maximum possible value for valueProperty().
      Parameters:
      max - the value for the max property
      See Also:

    • getVisibleAmount

      public double getVisibleAmount()
      Gets the value of the visibleAmount property.
      Property description:
      Specifies how much content is visible. Depends on the components using the scroll bar and determines the length of the scroll bar's thumb relative to the track.

      Not setting this property does not compromise the component's functionality but as a consequence the bar does not indicate clearly to the user how much content is hidden.

      Returns:
      the value of the visibleAmount property
      See Also:

    • visibleAmountProperty

      public DoubleProperty visibleAmountProperty()
      Specifies how much content is visible. Depends on the components using the scroll bar and determines the length of the scroll bar's thumb relative to the track.

      Not setting this property does not compromise the component's functionality but as a consequence the bar does not indicate clearly to the user how much content is hidden.

      Returns:
      the visibleAmount property
      See Also:

    • setVisibleAmount

      public void setVisibleAmount(double visibleAmount)
      Sets the value of the visibleAmount property.
      Property description:
      Specifies how much content is visible. Depends on the components using the scroll bar and determines the length of the scroll bar's thumb relative to the track.

      Not setting this property does not compromise the component's functionality but as a consequence the bar does not indicate clearly to the user how much content is hidden.

      Parameters:
      visibleAmount - the value for the visibleAmount property
      See Also:

    • getScrollDirection

      public io.github.palexdev.mfxcore.utils.fx.ScrollUtils.ScrollDirection getScrollDirection()
      Gets the value of the scrollDirection property.
      Property description:
      Specifies the current scroll direction. The default behavior implementation manages this.
      Returns:
      the value of the scrollDirection property
      See Also:

    • scrollDirectionProperty

      public ReadOnlyObjectProperty<io.github.palexdev.mfxcore.utils.fx.ScrollUtils.ScrollDirection> scrollDirectionProperty()
      Specifies the current scroll direction. The default behavior implementation manages this.
      Returns:
      the scrollDirection property
      See Also: