javafx.scene.control

Class ScrollBar

java.lang.Object

javafx.scene.Node

javafx.scene.Parent

javafx.scene.control.Control

javafx.scene.control.ScrollBar

All Implemented Interfaces:

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 :

 import javafx.scene.control.ScrollBar;

 ScrollBar s1 = new ScrollBar();
 s1.setOrientation(Orientation.VERTICAL);
 

Implementation of ScrollBar According to JavaFX UI Control API Specification

Property Summary

Properties

Type	Property and Description
DoubleProperty	blockIncrement The amount by which to adjust the scrollbar if the track of the bar is clicked.
DoubleProperty	max The maximum value represented by this ScrollBar.
DoubleProperty	min The minimum value represented by this ScrollBar.
ObjectProperty<Orientation>	orientation The orientation of the ScrollBar can either be HORIZONTAL or VERTICAL.
DoubleProperty	unitIncrement The amount by which to adjust the ScrollBar when the increment or decrement methods are called.
DoubleProperty	value The current value represented by this ScrollBar.
DoubleProperty	visibleAmount Visible amount of the scrollbar's range, typically represented by the size of the scroll bar's thumb.

Properties inherited from class javafx.scene.control.Control

contextMenu, height, maxHeight, maxWidth, minHeight, minWidth, prefHeight, prefWidth, skinClassName, skin, tooltip, width

Properties inherited from class javafx.scene.Parent

needsLayout

Properties inherited from class javafx.scene.Node

blendMode, boundsInLocal, boundsInParent, cacheHint, cache, clip, cursor, depthTest, disabled, disable, effect, eventDispatcher, focused, focusTraversable, hover, id, inputMethodRequests, layoutBounds, layoutX, layoutY, localToParentTransform, localToSceneTransform, managed, mouseTransparent, onContextMenuRequested, onDragDetected, onDragDone, onDragDropped, onDragEntered, onDragExited, onDragOver, onInputMethodTextChanged, onKeyPressed, onKeyReleased, onKeyTyped, onMouseClicked, onMouseDragEntered, onMouseDragExited, onMouseDragged, onMouseDragOver, onMouseDragReleased, onMouseEntered, onMouseExited, onMouseMoved, onMousePressed, onMouseReleased, onRotate, onRotationFinished, onRotationStarted, onScrollFinished, onScroll, onScrollStarted, onSwipeDown, onSwipeLeft, onSwipeRight, onSwipeUp, onTouchMoved, onTouchPressed, onTouchReleased, onTouchStationary, onZoomFinished, onZoom, onZoomStarted, opacity, parent, pickOnBounds, pressed, rotate, rotationAxis, scaleX, scaleY, scaleZ, scene, style, translateX, translateY, translateZ, visible

Field Summary

Fields inherited from class javafx.scene.control.Control

USE_COMPUTED_SIZE, USE_PREF_SIZE

Constructor Summary

Constructors

Constructor and Description
ScrollBar() Creates a new horizontal (i.e.

Method Summary

Methods

Modifier and Type	Method and Description
void	adjustValue(double position) Adjusts the value property by blockIncrement.
DoubleProperty	blockIncrementProperty() The amount by which to adjust the scrollbar if the track of the bar is clicked.
void	decrement() Decrements the value of the ScrollBar by the unitIncrement
double	getBlockIncrement() Gets the value of the property blockIncrement.
double	getMax() Gets the value of the property max.
double	getMin() Gets the value of the property min.
Orientation	getOrientation() Gets the value of the property orientation.
double	getUnitIncrement() Gets the value of the property unitIncrement.
double	getValue() Gets the value of the property value.
double	getVisibleAmount() Gets the value of the property visibleAmount.
void	increment() Increments the value of the ScrollBar by the unitIncrement
DoubleProperty	maxProperty() The maximum value represented by this ScrollBar.
DoubleProperty	minProperty() The minimum value represented by this ScrollBar.
ObjectProperty<Orientation>	orientationProperty() The orientation of the ScrollBar can either be HORIZONTAL or VERTICAL.
void	setBlockIncrement(double value) Sets the value of the property blockIncrement.
void	setMax(double value) Sets the value of the property max.
void	setMin(double value) Sets the value of the property min.
void	setOrientation(Orientation value) Sets the value of the property orientation.
void	setUnitIncrement(double value) Sets the value of the property unitIncrement.
void	setValue(double value) Sets the value of the property value.
void	setVisibleAmount(double value) Sets the value of the property visibleAmount.
DoubleProperty	unitIncrementProperty() The amount by which to adjust the ScrollBar when the increment or decrement methods are called.
DoubleProperty	valueProperty() The current value represented by this ScrollBar.
DoubleProperty	visibleAmountProperty() Visible amount of the scrollbar's range, typically represented by the size of the scroll bar's thumb.

Methods inherited from class javafx.scene.control.Control

computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, contextMenuProperty, getBaselineOffset, getContextMenu, getHeight, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getPrefHeight, getPrefWidth, getSkin, getTooltip, getUserAgentStylesheet, getWidth, heightProperty, intersects, isResizable, layoutChildren, maxHeight, maxHeightProperty, maxWidth, maxWidthProperty, minHeight, minHeightProperty, minWidth, minWidthProperty, prefHeight, prefHeightProperty, prefWidth, prefWidthProperty, resize, setContextMenu, setHeight, setMaxHeight, setMaxSize, setMaxWidth, setMinHeight, setMinSize, setMinWidth, setPrefHeight, setPrefSize, setPrefWidth, setSkin, setSkinClassName, setTooltip, setWidth, skinClassNameProperty, skinProperty, tooltipProperty, widthProperty

Methods inherited from class javafx.scene.Parent

getChildren, getChildrenUnmodifiable, getManagedChildren, getStylesheets, isNeedsLayout, layout, lookup, needsLayoutProperty, requestLayout, setNeedsLayout

Methods inherited from class javafx.scene.Node

addEventFilter, addEventHandler, autosize, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, buildEventDispatchChain, cacheHintProperty, cacheProperty, clipProperty, contains, contains, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectProperty, eventDispatcherProperty, fireEvent, focusedProperty, focusTraversableProperty, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClip, getContentBias, getCursor, getDepthTest, getEffect, getEventDispatcher, getId, getInputMethodRequests, getLayoutBounds, getLayoutX, getLayoutY, getLocalToParentTransform, getLocalToSceneTransform, getOnContextMenuRequested, getOnDragDetected, getOnDragDone, getOnDragDropped, getOnDragEntered, getOnDragExited, getOnDragOver, getOnInputMethodTextChanged, getOnKeyPressed, getOnKeyReleased, getOnKeyTyped, getOnMouseClicked, getOnMouseDragEntered, getOnMouseDragExited, getOnMouseDragged, getOnMouseDragOver, getOnMouseDragReleased, getOnMouseEntered, getOnMouseExited, getOnMouseMoved, getOnMousePressed, getOnMouseReleased, getOnRotate, getOnRotationFinished, getOnRotationStarted, getOnScroll, getOnScrollFinished, getOnScrollStarted, getOnSwipeDown, getOnSwipeLeft, getOnSwipeRight, getOnSwipeUp, getOnTouchMoved, getOnTouchPressed, getOnTouchReleased, getOnTouchStationary, getOnZoom, getOnZoomFinished, getOnZoomStarted, getOpacity, getParent, getProperties, getRotate, getRotationAxis, getScaleX, getScaleY, getScaleZ, getScene, getStyle, getStyleClass, getTransforms, getTranslateX, getTranslateY, getTranslateZ, getUserData, hasProperties, hoverProperty, idProperty, inputMethodRequestsProperty, intersects, isCache, isDisable, isDisabled, isFocused, isFocusTraversable, isHover, isManaged, isMouseTransparent, isPickOnBounds, isPressed, isVisible, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParent, localToParent, localToParent, localToParentTransformProperty, localToScene, localToScene, localToScene, localToSceneTransformProperty, lookupAll, managedProperty, mouseTransparentProperty, onContextMenuRequestedProperty, onDragDetectedProperty, onDragDoneProperty, onDragDroppedProperty, onDragEnteredProperty, onDragExitedProperty, onDragOverProperty, onInputMethodTextChangedProperty, onKeyPressedProperty, onKeyReleasedProperty, onKeyTypedProperty, onMouseClickedProperty, onMouseDragEnteredProperty, onMouseDragExitedProperty, onMouseDraggedProperty, onMouseDragOverProperty, onMouseDragReleasedProperty, onMouseEnteredProperty, onMouseExitedProperty, onMouseMovedProperty, onMousePressedProperty, onMouseReleasedProperty, onRotateProperty, onRotationFinishedProperty, onRotationStartedProperty, onScrollFinishedProperty, onScrollProperty, onScrollStartedProperty, onSwipeDownProperty, onSwipeLeftProperty, onSwipeRightProperty, onSwipeUpProperty, onTouchMovedProperty, onTouchPressedProperty, onTouchReleasedProperty, onTouchStationaryProperty, onZoomFinishedProperty, onZoomProperty, onZoomStartedProperty, opacityProperty, parentProperty, parentToLocal, parentToLocal, parentToLocal, pickOnBoundsProperty, pressedProperty, relocate, removeEventFilter, removeEventHandler, requestFocus, resizeRelocate, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, sceneToLocal, sceneToLocal, sceneToLocal, setBlendMode, setCache, setCacheHint, setClip, setCursor, setDepthTest, setDisable, setDisabled, setEffect, setEventDispatcher, setEventHandler, setFocused, setFocusTraversable, setHover, setId, setInputMethodRequests, setLayoutX, setLayoutY, setManaged, setMouseTransparent, setOnContextMenuRequested, setOnDragDetected, setOnDragDone, setOnDragDropped, setOnDragEntered, setOnDragExited, setOnDragOver, setOnInputMethodTextChanged, setOnKeyPressed, setOnKeyReleased, setOnKeyTyped, setOnMouseClicked, setOnMouseDragEntered, setOnMouseDragExited, setOnMouseDragged, setOnMouseDragOver, setOnMouseDragReleased, setOnMouseEntered, setOnMouseExited, setOnMouseMoved, setOnMousePressed, setOnMouseReleased, setOnRotate, setOnRotationFinished, setOnRotationStarted, setOnScroll, setOnScrollFinished, setOnScrollStarted, setOnSwipeDown, setOnSwipeLeft, setOnSwipeRight, setOnSwipeUp, setOnTouchMoved, setOnTouchPressed, setOnTouchReleased, setOnTouchStationary, setOnZoom, setOnZoomFinished, setOnZoomStarted, setOpacity, setPickOnBounds, setPressed, setRotate, setRotationAxis, setScaleX, setScaleY, setScaleZ, setStyle, setTranslateX, setTranslateY, setTranslateZ, setUserData, setVisible, snapshot, snapshot, startDragAndDrop, startFullDrag, styleProperty, toBack, toFront, toString, translateXProperty, translateYProperty, translateZProperty, visibleProperty

Methods inherited from class java.lang.Object

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

Property Detail

min

public final DoubleProperty minProperty

The minimum value represented by this ScrollBar. This should be a value less than or equal to max.

See Also:

getMin(), setMin(double)

max

public final DoubleProperty maxProperty

The maximum value represented by this ScrollBar. This should be a value greater than or equal to min.

See Also:

getMax(), setMax(double)

value

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)

orientation

public final ObjectProperty<Orientation> orientationProperty

The orientation of the ScrollBar can either be HORIZONTAL or VERTICAL.

See Also:

getOrientation(), setOrientation(Orientation)

unitIncrement

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)

blockIncrement

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)

visibleAmount

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)

Constructor Detail

ScrollBar

public ScrollBar()

Creates a new horizontal (i.e. getOrientation() == Orientation.HORIZONTAL) ScrollBar.

Method Detail

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.

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.

minProperty

public final DoubleProperty minProperty()

The minimum value represented by this ScrollBar. This should be a value less than or equal to max.

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.

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.

maxProperty

public final DoubleProperty maxProperty()

The maximum value represented by this ScrollBar. This should be a value greater than or equal to min.

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.

_{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.}

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