JavaFX 24 · javafx.scene.control.skin.ScrollPaneSkin

Field Summary

Modifier and Type	Field and Description
private final BehaviorBase<ScrollPane>	behavior
private final ChangeListener<Bounds>	boundsChangeListener
pack-priv Rectangle	clipRect
private double	contentHeight
private DoubleProperty	contentPosX
private DoubleProperty	contentPosY
pack-priv KeyFrame	contentsToViewKF1
pack-priv KeyFrame	contentsToViewKF2
pack-priv KeyFrame	contentsToViewKF3
pack-priv Timeline	contentsToViewTimeline
private double	contentWidth
private StackPane	corner
private static final double	DEFAULT_EMBEDDED_SB_BREADTH
private static final double	DEFAULT_MIN_SIZE
private static final double	DEFAULT_PREF_SIZE
private static final double	DEFAULT_SB_BREADTH
private boolean	dragDetected
pack-priv ScrollBar	hsb
private double	hsbHeight
private boolean	hsbvis
private boolean	mouseDown
private double	nodeHeight
private final InvalidationListener	nodeListener
private boolean	nodeSizeInvalid
private double	nodeWidth
pack-priv double	ohvalue
pack-priv double	ovvalue
private static final double	PAN_THRESHOLD
private double	posX
private double	posY
pack-priv double	pressX
pack-priv double	pressY
private Cursor	saveCursor
pack-priv KeyFrame	sbTouchKF1
pack-priv KeyFrame	sbTouchKF2
pack-priv Timeline	sbTouchTimeline
private Node	scrollNode
private boolean	tempVisibility
private boolean	touchDetected
private StackPane	viewContent
private StackPane	viewRect
pack-priv ScrollBar	vsb
private boolean	vsbvis
private double	vsbWidth
private final WeakChangeListener<Bounds>	weakBoundsChangeListener
private final WeakInvalidationListener	weakNodeListener

Constructor Summary

Access	Constructor and Description
public	ScrollPaneSkin(final ScrollPane The control that this skin should be installed onto. control) Creates a new ScrollPaneSkin instance, installing the necessary child nodes into the Control `children` list, as well as the necessary input mappings for handling key, mouse, etc events.

Method Summary

Modifier and Type	Method and Description
private double	computeHsbSizeHint(ScrollPane sp) Computes the size that should be reserved for horizontal scrollbar in size hints (min/pref height)
protected double	computeMinHeight(double The width of the Skin, in case this value might dictate the minimum height. width, double the pixel snapped top inset topInset, double the pixel snapped right inset rightInset, double the pixel snapped bottom inset bottomInset, double the pixel snapped left inset leftInset) Overrides javafx.scene.control.SkinBase.computeMinHeight. Computes the minimum allowable height of the Skin, based on the provided width.
protected double	computeMinWidth(double The height of the Skin, in case this value might dictate the minimum width. height, double the pixel snapped top inset topInset, double the pixel snapped right inset rightInset, double the pixel snapped bottom inset bottomInset, double the pixel snapped left inset leftInset) Overrides javafx.scene.control.SkinBase.computeMinWidth. Computes the minimum allowable width of the Skin, based on the provided height.
protected double	computePrefHeight(double the width that should be used if preferred height depends on it width, double the pixel snapped top inset topInset, double the pixel snapped right inset rightInset, double the pixel snapped bottom inset bottomInset, double the pixel snapped left inset leftInset) Overrides javafx.scene.control.SkinBase.computePrefHeight. Calculates the preferred height of this `SkinBase`.
protected double	computePrefWidth(double the height that should be used if preferred width depends on it height, double the pixel snapped top inset topInset, double the pixel snapped right inset rightInset, double the pixel snapped bottom inset bottomInset, double the pixel snapped left inset leftInset) Overrides javafx.scene.control.SkinBase.computePrefWidth. Calculates the preferred width of this `SkinBase`.
private void	computeScrollBarSize()
private void	computeScrollNodeSize(double contentWidth, double contentHeight)
private double	computeVsbSizeHint(ScrollPane sp) Computes the size that should be reserved for vertical scrollbar in size hints (min/pref width)
private final DoubleProperty	contentPosXProperty()
private final DoubleProperty	contentPosYProperty()
private boolean	determineHorizontalSBVisible()
private boolean	determineVerticalSBVisible()
public void	dispose() Overrides javafx.scene.control.SkinBase.dispose. Implements javafx.scene.control.Skin.dispose. Called when a previously installed skin is about to be removed from its associated control.
private final double	getContentPosX()
private final double	getContentPosY()
public final ScrollBar	Returns: the horizontal ScrollBar used in this ScrollPaneSkin instance getHorizontalScrollBar() Returns the horizontal `ScrollBar` used in this ScrollPaneSkin instance.
public final ScrollBar	Returns: the vertical ScrollBar used in this ScrollPaneSkin instance getVerticalScrollBar() Returns the vertical `ScrollBar` used in this ScrollPaneSkin instance.
private void	initialize()
private boolean	isReverseNodeOrientation()
protected void	layoutChildren(final double the x position x, final double the y position y, final double the width w, final double the height h) Overrides javafx.scene.control.SkinBase.layoutChildren. Called during the layout pass of the scenegraph.
protected Object	queryAccessibleAttribute(AccessibleAttribute the requested attribute attribute, Object... optional list of parameters parameters) Overrides javafx.scene.control.SkinBase.queryAccessibleAttribute. This method is called by the assistive technology to request the value for an attribute.
private void	resetClip()
pack-priv void	scrollBoundsIntoView(Bounds b)
private final void	setContentPosX(double value)
private final void	setContentPosY(double value)
private void	startContentsToViewport()
private void	startSBReleasedAnimation()
private void	updateHorizontalSB()
private double	updatePosX()
private double	updatePosY()
private void	updateVerticalSB()

Field Detail

behavior	back to summary
private final BehaviorBase<ScrollPane> behavior

boundsChangeListener	back to summary
private final ChangeListener<Bounds> boundsChangeListener

clipRect	back to summary
pack-priv Rectangle clipRect

contentHeight	back to summary
private double contentHeight

contentPosX	back to summary
private DoubleProperty contentPosX

contentPosY	back to summary
private DoubleProperty contentPosY

contentsToViewKF1	back to summary
pack-priv KeyFrame contentsToViewKF1

contentsToViewKF2	back to summary
pack-priv KeyFrame contentsToViewKF2

contentsToViewKF3	back to summary
pack-priv KeyFrame contentsToViewKF3

contentsToViewTimeline	back to summary
pack-priv Timeline contentsToViewTimeline

contentWidth	back to summary
private double contentWidth

corner	back to summary
private StackPane corner

DEFAULT_EMBEDDED_SB_BREADTH	back to summary
private static final double DEFAULT_EMBEDDED_SB_BREADTH

DEFAULT_MIN_SIZE	back to summary
private static final double DEFAULT_MIN_SIZE

DEFAULT_PREF_SIZE	back to summary
private static final double DEFAULT_PREF_SIZE

DEFAULT_SB_BREADTH	back to summary
private static final double DEFAULT_SB_BREADTH

dragDetected	back to summary
private boolean dragDetected

hsb	back to summary
pack-priv ScrollBar hsb

hsbHeight	back to summary
private double hsbHeight

hsbvis	back to summary
private boolean hsbvis

mouseDown	back to summary
private boolean mouseDown

nodeHeight	back to summary
private double nodeHeight

nodeListener	back to summary
private final InvalidationListener nodeListener

nodeSizeInvalid	back to summary
private boolean nodeSizeInvalid

nodeWidth	back to summary
private double nodeWidth

ohvalue	back to summary
pack-priv double ohvalue

ovvalue	back to summary
pack-priv double ovvalue

PAN_THRESHOLD	back to summary
private static final double PAN_THRESHOLD

posX	back to summary
private double posX

posY	back to summary
private double posY

pressX	back to summary
pack-priv double pressX

pressY	back to summary
pack-priv double pressY

saveCursor	back to summary
private Cursor saveCursor

sbTouchKF1	back to summary
pack-priv KeyFrame sbTouchKF1

sbTouchKF2	back to summary
pack-priv KeyFrame sbTouchKF2

sbTouchTimeline	back to summary
pack-priv Timeline sbTouchTimeline

scrollNode	back to summary
private Node scrollNode

tempVisibility	back to summary
private boolean tempVisibility

touchDetected	back to summary
private boolean touchDetected

viewContent	back to summary
private StackPane viewContent

viewRect	back to summary
private StackPane viewRect

vsb	back to summary
pack-priv ScrollBar vsb

vsbvis	back to summary
private boolean vsbvis

vsbWidth	back to summary
private double vsbWidth

weakBoundsChangeListener	back to summary
private final WeakChangeListener<Bounds> weakBoundsChangeListener

weakNodeListener	back to summary
private final WeakInvalidationListener weakNodeListener

Constructor Detail

ScrollPaneSkin back to summary

ScrollPaneSkin	back to summary
public ScrollPaneSkin(final ScrollPane control) Creates a new ScrollPaneSkin instance, installing the necessary child nodes into the Control `children` list, as well as the necessary input mappings for handling key, mouse, etc events. Parameters control:ScrollPane The control that this skin should be installed onto.

public ScrollPaneSkin(final ScrollPane control)

Creates a new ScrollPaneSkin instance, installing the necessary child nodes into the Control children list, as well as the necessary input mappings for handling key, mouse, etc events.

Parameters

control:ScrollPane: The control that this skin should be installed onto.

Method Detail

computeHsbSizeHint	back to summary
private double computeHsbSizeHint(ScrollPane sp) Computes the size that should be reserved for horizontal scrollbar in size hints (min/pref height)

computeMinHeight

back to summary

protected double computeMinHeight(double width, double topInset, double rightInset, double bottomInset, double leftInset)

Overrides javafx.scene.control.SkinBase.computeMinHeight.

Doc from javafx.scene.control.SkinBase.computeMinHeight.

Computes the minimum allowable height of the Skin, based on the provided width.

Parameters

width:double: The width of the Skin, in case this value might dictate the minimum height.
topInset:double: the pixel snapped top inset
rightInset:double: the pixel snapped right inset
bottomInset:double: the pixel snapped bottom inset
leftInset:double: the pixel snapped left inset

Returns:double

A double representing the minimum height of this Skin.

Annotations

@Override

computeMinWidth

back to summary

protected double computeMinWidth(double height, double topInset, double rightInset, double bottomInset, double leftInset)

Overrides javafx.scene.control.SkinBase.computeMinWidth.

Doc from javafx.scene.control.SkinBase.computeMinWidth.

Computes the minimum allowable width of the Skin, based on the provided height.

Parameters

height:double: The height of the Skin, in case this value might dictate the minimum width.
topInset:double: the pixel snapped top inset
rightInset:double: the pixel snapped right inset
bottomInset:double: the pixel snapped bottom inset
leftInset:double: the pixel snapped left inset

Returns:double

A double representing the minimum width of this Skin.

Annotations

@Override

computePrefHeight back to summary

protected double computePrefHeight(double width, double topInset, double rightInset, double bottomInset, double leftInset)

Overrides javafx.scene.control.SkinBase.computePrefHeight.

Doc from javafx.scene.control.SkinBase.computePrefHeight.

Calculates the preferred height of this SkinBase. The default implementation calculates this height as the height of the area occupied by its managed children when they are positioned at their current positions at their preferred heights.

Parameters

width:double: the width that should be used if preferred height depends on it
topInset:double: the pixel snapped top inset
rightInset:double: the pixel snapped right inset
bottomInset:double: the pixel snapped bottom inset
leftInset:double: the pixel snapped left inset

Returns:double

the calculated preferred height

Annotations

@Override

computePrefWidth back to summary

protected double computePrefWidth(double height, double topInset, double rightInset, double bottomInset, double leftInset)

Overrides javafx.scene.control.SkinBase.computePrefWidth.

Doc from javafx.scene.control.SkinBase.computePrefWidth.

Calculates the preferred width of this SkinBase. The default implementation calculates this width as the width of the area occupied by its managed children when they are positioned at their current positions at their preferred widths.

Parameters

height:double: the height that should be used if preferred width depends on it
topInset:double: the pixel snapped top inset
rightInset:double: the pixel snapped right inset
bottomInset:double: the pixel snapped bottom inset
leftInset:double: the pixel snapped left inset

Returns:double

the calculated preferred width

Annotations

@Override

computeScrollBarSize	back to summary
private void computeScrollBarSize()

computeScrollNodeSize	back to summary
private void computeScrollNodeSize(double contentWidth, double contentHeight)

computeVsbSizeHint	back to summary
private double computeVsbSizeHint(ScrollPane sp) Computes the size that should be reserved for vertical scrollbar in size hints (min/pref width)

contentPosXProperty	back to summary
private final DoubleProperty contentPosXProperty()

contentPosYProperty	back to summary
private final DoubleProperty contentPosYProperty()

determineHorizontalSBVisible	back to summary
private boolean determineHorizontalSBVisible()

determineVerticalSBVisible	back to summary
private boolean determineVerticalSBVisible()

dispose back to summary

public void dispose()

Overrides javafx.scene.control.SkinBase.dispose.

Implements javafx.scene.control.Skin.dispose.

Doc from javafx.scene.control.SkinBase.dispose.

Called when a previously installed skin is about to be removed from its associated control. This allows the skin to do clean up, like removing listeners and bindings, and undo any changes to the control's properties. After this method completes, getSkinnable() and getNode() should return null.

Calling dispose() more than once has no effect.

Annotations

@Override

getContentPosX	back to summary
private final double getContentPosX()

getContentPosY	back to summary
private final double getContentPosY()

getHorizontalScrollBar back to summary

public final ScrollBar getHorizontalScrollBar()

Returns the horizontal ScrollBar used in this ScrollPaneSkin instance.

Returns:ScrollBar: the horizontal ScrollBar used in this ScrollPaneSkin instance

getVerticalScrollBar back to summary

public final ScrollBar getVerticalScrollBar()

Returns the vertical ScrollBar used in this ScrollPaneSkin instance.

Returns:ScrollBar: the vertical ScrollBar used in this ScrollPaneSkin instance

initialize	back to summary
private void initialize()

isReverseNodeOrientation	back to summary
private boolean isReverseNodeOrientation()

layoutChildren

back to summary

protected void layoutChildren(final double x, final double y, final double w, final double h)

Overrides javafx.scene.control.SkinBase.layoutChildren.

Doc from javafx.scene.control.SkinBase.layoutChildren.

Called during the layout pass of the scenegraph.

Parameters

x:double: the x position
y:double: the y position
w:double: the width
h:double: the height

Annotations

@Override

queryAccessibleAttribute

back to summary

protected Object queryAccessibleAttribute(AccessibleAttribute attribute, Object... parameters)

Overrides javafx.scene.control.SkinBase.queryAccessibleAttribute.

Doc from javafx.scene.control.SkinBase.queryAccessibleAttribute.

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.

Parameters

attribute:AccessibleAttribute: the requested attribute
parameters:Object[]: optional list of parameters

Returns:Object

the value for the requested attribute

Annotations

@Override

resetClip	back to summary
private void resetClip()

scrollBoundsIntoView	back to summary
pack-priv void scrollBoundsIntoView(Bounds b)

setContentPosX	back to summary
private final void setContentPosX(double value)

setContentPosY	back to summary
private final void setContentPosY(double value)

startContentsToViewport	back to summary
private void startContentsToViewport()

startSBReleasedAnimation	back to summary
private void startSBReleasedAnimation()

updateHorizontalSB	back to summary
private void updateHorizontalSB()

updatePosX	back to summary
private double updatePosX()

updatePosY	back to summary
private double updatePosY()

updateVerticalSB	back to summary
private void updateVerticalSB()

public Class ScrollPaneSkin

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail