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

Direct Known Subclasses:

ScrollBarThemeImpl.ScrollBarWidget, VirtualScrollBar

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

Since:

JavaFX 2.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	ScrollBar.StyleableProperties

Field Summary

Fields

Modifier and Type	Field and Description
private DoubleProperty	blockIncrement The amount by which to adjust the scrollbar if the track of the bar is clicked.
private static java.lang.String	DEFAULT_STYLE_CLASS Initialize the style class to 'scroll-bar'.
private static PseudoClass	HORIZONTAL_PSEUDOCLASS_STATE Pseudo-class indicating this is a horizontal ScrollBar.
private DoubleProperty	max The maximum value represented by this ScrollBar.
private DoubleProperty	min The minimum value represented by this ScrollBar.
private ObjectProperty<Orientation>	orientation The orientation of the ScrollBar can either be HORIZONTAL or VERTICAL.
private DoubleProperty	unitIncrement The amount by which to adjust the ScrollBar when the increment or decrement methods are called.
private DoubleProperty	value The current value represented by this ScrollBar.
private static PseudoClass	VERTICAL_PSEUDOCLASS_STATE Pseud-class indicating this is a vertical ScrollBar.
private DoubleProperty	visibleAmount Visible amount of the scrollbar's range, typically represented by the size of the scroll bar's thumb.

Fields inherited from class javafx.scene.layout.Region

USE_COMPUTED_SIZE, USE_PREF_SIZE

Fields inherited from class javafx.scene.Node

BASELINE_OFFSET_SAME_AS_HEIGHT

Constructor Summary

Constructors

Constructor and Description
ScrollBar() Creates a new horizontal ScrollBar (ie getOrientation() == Orientation.HORIZONTAL).

Method Summary

Modifier and Type	Method and Description
void	adjustValue(double position) Adjusts the value property by blockIncrement.
private void	blockDecrement()
private void	blockIncrement()
DoubleProperty	blockIncrementProperty()
protected Skin<?>	createDefaultSkin() Create a new instance of the default skin for this control.
void	decrement() Decrements the value of the ScrollBar by the unitIncrement
void	executeAccessibleAction(AccessibleAction action, java.lang.Object... parameters) This method is called by the assistive technology to request the action indicated by the argument should be executed.
double	getBlockIncrement()
static java.util.List<CssMetaData<? extends Styleable,?>>	getClassCssMetaData()
java.util.List<CssMetaData<? extends Styleable,?>>	getControlCssMetaData()
double	getMax()
double	getMin()
Orientation	getOrientation()
double	getUnitIncrement()
double	getValue()
double	getVisibleAmount()
protected java.lang.Boolean	impl_cssGetFocusTraversableInitialValue() Deprecated.
void	increment() Increments the value of the ScrollBar by the unitIncrement
DoubleProperty	maxProperty()
DoubleProperty	minProperty()
ObjectProperty<Orientation>	orientationProperty()
java.lang.Object	queryAccessibleAttribute(AccessibleAttribute attribute, java.lang.Object... parameters) * Accessibility handling * *
void	setBlockIncrement(double value)
void	setMax(double value)
void	setMin(double value)
void	setOrientation(Orientation value)
void	setUnitIncrement(double value)
void	setValue(double value)
void	setVisibleAmount(double value)
DoubleProperty	unitIncrementProperty()
DoubleProperty	valueProperty()
DoubleProperty	visibleAmountProperty()

Methods inherited from class javafx.scene.control.Control

computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, contextMenuProperty, getBaselineOffset, getContextMenu, getControlChildren, getCssMetaData, getSkin, getTooltip, impl_processCSS, isResizable, layoutChildren, loadSkinClass, setContextMenu, setSkin, setTooltip, skinClassNameProperty, skinProperty, tooltipProperty

Methods inherited from class javafx.scene.layout.Region

backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, getBackground, getBorder, getHeight, getInsets, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOpaqueInsets, getPadding, getPrefHeight, getPrefWidth, getShape, getUserAgentStylesheet, getWidth, heightProperty, impl_computeContains, impl_computeGeomBounds, impl_computeLayoutBounds, impl_createPeer, impl_notifyLayoutBoundsChanged, impl_pickNodeLocal, impl_updatePeer, insetsProperty, isCacheShape, isCenterShape, isScaleShape, isSnapToPixel, layoutInArea, layoutInArea, layoutInArea, layoutInArea, maxHeight, maxHeightProperty, maxWidth, maxWidthProperty, minHeight, minHeightProperty, minWidth, minWidthProperty, opaqueInsetsProperty, paddingProperty, positionInArea, positionInArea, prefHeight, prefHeightProperty, prefWidth, prefWidthProperty, resize, scaleShapeProperty, setBackground, setBorder, setCacheShape, setCenterShape, setHeight, setMaxHeight, setMaxSize, setMaxWidth, setMinHeight, setMinSize, setMinWidth, setOpaqueInsets, setPadding, setPrefHeight, setPrefSize, setPrefWidth, setScaleShape, setShape, setSnapToPixel, setWidth, shapeProperty, snappedBottomInset, snappedLeftInset, snappedRightInset, snappedTopInset, snapPosition, snapSize, snapSpace, snapToPixelProperty, widthProperty

Methods inherited from class javafx.scene.Parent

getChildren, getChildrenUnmodifiable, getImpl_traversalEngine, getManagedChildren, getStylesheets, impl_getAllParentStylesheets, impl_processMXNode, impl_traversalEngineProperty, isNeedsLayout, layout, lookup, needsLayoutProperty, requestLayout, requestParentLayout, setImpl_traversalEngine, setNeedsLayout, updateBounds

Methods inherited from class javafx.scene.Node

accessibleHelpProperty, accessibleRoleDescriptionProperty, accessibleRoleProperty, accessibleTextProperty, addEventFilter, addEventHandler, applyCss, autosize, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, buildEventDispatchChain, cacheHintProperty, cacheProperty, clipProperty, computeAreaInScreen, contains, contains, containsBounds, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, fireEvent, focusedProperty, focusTraversableProperty, getAccessibleHelp, getAccessibleRole, getAccessibleRoleDescription, getAccessibleText, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClip, getContentBias, getCursor, getDepthTest, getEffect, getEffectiveNodeOrientation, getEventDispatcher, getId, getInputMethodRequests, getLayoutBounds, getLayoutX, getLayoutY, getLocalToParentTransform, getLocalToSceneTransform, getNodeOrientation, 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, getPseudoClassStates, getRotate, getRotationAxis, getScaleX, getScaleY, getScaleZ, getScene, getStyle, getStyleableParent, getStyleClass, getTransforms, getTranslateX, getTranslateY, getTranslateZ, getTypeSelector, getUserData, hasProperties, hoverProperty, idProperty, impl_clearDirty, impl_computeIntersects, impl_cssGetCursorInitialValue, impl_findStyles, impl_geomChanged, impl_getLeafTransform, impl_getMatchingStyles, impl_getPeer, impl_getPivotX, impl_getPivotY, impl_getPivotZ, impl_getStyleMap, impl_hasTransforms, impl_intersects, impl_intersectsBounds, impl_isDirty, impl_isDirtyEmpty, impl_isShowMnemonics, impl_isTreeVisible, impl_layoutBoundsChanged, impl_markDirty, impl_pickNode, impl_processCSS, impl_reapplyCSS, impl_setShowMnemonics, impl_setStyleMap, impl_showMnemonicsProperty, impl_syncPeer, impl_transformsChanged, impl_traverse, impl_treeVisibleProperty, inputMethodRequestsProperty, intersects, intersects, isCache, isDisable, isDisabled, isFocused, isFocusTraversable, isHover, isManaged, isMouseTransparent, isPickOnBounds, isPressed, isVisible, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParent, localToParent, localToParent, localToParent, localToParent, localToParentTransformProperty, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToSceneTransformProperty, localToScreen, localToScreen, localToScreen, localToScreen, localToScreen, lookupAll, managedProperty, mouseTransparentProperty, nodeOrientationProperty, notifyAccessibleAttributeChanged, 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, parentToLocal, parentToLocal, pickOnBoundsProperty, pressedProperty, pseudoClassStateChanged, relocate, removeEventFilter, removeEventHandler, requestFocus, resizeRelocate, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, screenToLocal, screenToLocal, screenToLocal, setAccessibleHelp, setAccessibleRole, setAccessibleRoleDescription, setAccessibleText, setBlendMode, setCache, setCacheHint, setClip, setCursor, setDepthTest, setDisable, setDisabled, setEffect, setEventDispatcher, setEventHandler, setFocused, setFocusTraversable, setHover, setId, setInputMethodRequests, setLayoutX, setLayoutY, setManaged, setMouseTransparent, setNodeOrientation, 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, usesMirroring, visibleProperty

Methods inherited from class java.lang.Object

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

Field Detail

min

private DoubleProperty min

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

max

private DoubleProperty max

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

value

private DoubleProperty value

The current value represented by this ScrollBar. This value should be between min and max, inclusive.

orientation

private ObjectProperty<Orientation> orientation

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

unitIncrement

private DoubleProperty unitIncrement

The amount by which to adjust the ScrollBar when the increment or decrement methods are called.

blockIncrement

private DoubleProperty blockIncrement

The amount by which to adjust the scrollbar if the track of the bar is clicked.

visibleAmount

private DoubleProperty visibleAmount

Visible amount of the scrollbar's range, typically represented by the size of the scroll bar's thumb.

DEFAULT_STYLE_CLASS

private static final java.lang.String DEFAULT_STYLE_CLASS

Initialize the style class to 'scroll-bar'. This is the selector class from which CSS can be used to style this control.

See Also:

Constant Field Values

VERTICAL_PSEUDOCLASS_STATE

private static final PseudoClass VERTICAL_PSEUDOCLASS_STATE

Pseud-class indicating this is a vertical ScrollBar.

HORIZONTAL_PSEUDOCLASS_STATE

private static final PseudoClass HORIZONTAL_PSEUDOCLASS_STATE

Pseudo-class indicating this is a horizontal ScrollBar.

Constructor Detail

ScrollBar

public ScrollBar()

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

Method Detail

setMin

public final void setMin(double value)

getMin

public final double getMin()

minProperty

public final DoubleProperty minProperty()

setMax

public final void setMax(double value)

getMax

public final double getMax()

maxProperty

public final DoubleProperty maxProperty()

setValue

public final void setValue(double value)

getValue

public final double getValue()

valueProperty

public final DoubleProperty valueProperty()

setOrientation

public final void setOrientation(Orientation value)

getOrientation

public final Orientation getOrientation()

orientationProperty

public final ObjectProperty<Orientation> orientationProperty()

setUnitIncrement

public final void setUnitIncrement(double value)

getUnitIncrement

public final double getUnitIncrement()

unitIncrementProperty

public final DoubleProperty unitIncrementProperty()

setBlockIncrement

public final void setBlockIncrement(double value)

getBlockIncrement

public final double getBlockIncrement()

blockIncrementProperty

public final DoubleProperty blockIncrementProperty()

setVisibleAmount

public final void setVisibleAmount(double value)

getVisibleAmount

public final double getVisibleAmount()

visibleAmountProperty

public final DoubleProperty visibleAmountProperty()

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.

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

blockIncrement

private void blockIncrement()

blockDecrement

private void blockDecrement()

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 java.util.List<CssMetaData<? extends Styleable,?>> getClassCssMetaData()

Returns:

The CssMetaData associated with this class, which may include the CssMetaData of its super classes.

Since:

JavaFX 8.0

getControlCssMetaData

public java.util.List<CssMetaData<? extends Styleable,?>> getControlCssMetaData()

Overrides:

getControlCssMetaData in class Control

Returns:

unmodifiable list of the controls css styleable properties

Since:

JavaFX 8.0

impl_cssGetFocusTraversableInitialValue

@Deprecated
protected java.lang.Boolean impl_cssGetFocusTraversableInitialValue()

Deprecated.

Most Controls return true for focusTraversable, so Control overrides this method to return true, but ScrollBar returns false for focusTraversable's initial value; hence the override of the override. This method is called from CSS code to get the correct initial value.

Overrides:

impl_cssGetFocusTraversableInitialValue in class Control

queryAccessibleAttribute

public java.lang.Object queryAccessibleAttribute(AccessibleAttribute attribute,
                                                 java.lang.Object... parameters)

* Accessibility handling * *

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,
                                    java.lang.Object... parameters)

Description copied from class: Node

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 super class implementation must be called.

Overrides:

executeAccessibleAction in class Control

Parameters:

action - the action to execute

parameters - optional list of parameters

See Also:

AccessibleAction