Module javafx.controls

Package javafx.scene.control.skin

Class ScrollPaneSkin

java.lang.Object

javafx.scene.control.SkinBase<ScrollPane>

javafx.scene.control.skin.ScrollPaneSkin

All Implemented Interfaces:

Skin<ScrollPane>

public class ScrollPaneSkin
extends SkinBase<ScrollPane>

Default skin implementation for the ScrollPane control.

Since:

9

See Also:

ScrollPane

Constructor Summary

Constructors

Constructor	Description
ScrollPaneSkin(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.

Method Summary

Modifier and Type	Method	Description
protected double	computeMinHeight(double width, double topInset, double rightInset, double bottomInset, double leftInset)	Computes the minimum allowable height of the Skin, based on the provided width.
protected double	computeMinWidth(double height, double topInset, double rightInset, double bottomInset, double leftInset)	Computes the minimum allowable width of the Skin, based on the provided height.
protected double	computePrefHeight(double width, double topInset, double rightInset, double bottomInset, double leftInset)	Calculates the preferred height of this SkinBase.
protected double	computePrefWidth(double height, double topInset, double rightInset, double bottomInset, double leftInset)	Calculates the preferred width of this SkinBase.
void	dispose()	Called by a Skinnable when the Skin is replaced on the Skinnable.
ScrollBar	getHorizontalScrollBar()	Returns the horizontal ScrollBar used in this ScrollPaneSkin instance.
ScrollBar	getVerticalScrollBar()	Returns the vertical ScrollBar used in this ScrollPaneSkin instance.
protected void	layoutChildren(double x, double y, double w, double h)	Called during the layout pass of the scenegraph.
protected Object	queryAccessibleAttribute(AccessibleAttribute attribute, Object... parameters)	This method is called by the assistive technology to request the value for an attribute.

Methods inherited from class java.lang.Object

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

Methods inherited from class javafx.scene.control.SkinBase

computeBaselineOffset, computeMaxHeight, computeMaxWidth, consumeMouseEvents, executeAccessibleAction, getChildren, getClassCssMetaData, getCssMetaData, getNode, getSkinnable, layoutInArea, layoutInArea, layoutInArea, positionInArea, positionInArea, pseudoClassStateChanged, registerChangeListener, snappedBottomInset, snappedLeftInset, snappedRightInset, snappedTopInset, snapPosition, snapPositionX, snapPositionY, snapSize, snapSizeX, snapSizeY, snapSpace, snapSpaceX, snapSpaceY, unregisterChangeListeners

Constructor Detail

ScrollPaneSkin

public ScrollPaneSkin(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 - The control that this skin should be installed onto.

Method Detail

dispose

public void dispose()

Called by a Skinnable when the Skin is replaced on the Skinnable. This method allows a Skin to implement any logic necessary to clean up itself after the Skin is no longer needed. It may be used to release native resources. The methods Skin.getSkinnable() and Skin.getNode() should return null following a call to dispose. Calling dispose twice has no effect.

Specified by:

dispose in interface Skin<ScrollPane>

Overrides:

dispose in class SkinBase<ScrollPane>

getHorizontalScrollBar

public final ScrollBar getHorizontalScrollBar()

Returns the horizontal ScrollBar used in this ScrollPaneSkin instance.

Returns:

the horizontal ScrollBar used in this ScrollPaneSkin instance

getVerticalScrollBar

public final ScrollBar getVerticalScrollBar()

Returns the vertical ScrollBar used in this ScrollPaneSkin instance.

Returns:

the vertical ScrollBar used in this ScrollPaneSkin instance

computePrefWidth

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

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.

Overrides:

computePrefWidth in class SkinBase<ScrollPane>

Parameters:

height - the height that should be used if preferred width depends on it

topInset - the pixel snapped top inset

rightInset - the pixel snapped right inset

bottomInset - the pixel snapped bottom inset

leftInset - the pixel snapped left inset

Returns:

the calculated preferred width

computePrefHeight

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

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.

Overrides:

computePrefHeight in class SkinBase<ScrollPane>

Parameters:

width - the width that should be used if preferred height depends on it

topInset - the pixel snapped top inset

rightInset - the pixel snapped right inset

bottomInset - the pixel snapped bottom inset

leftInset - the pixel snapped left inset

Returns:

the calculated preferred height

computeMinWidth

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

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

Overrides:

computeMinWidth in class SkinBase<ScrollPane>

Parameters:

height - The height of the Skin, in case this value might dictate the minimum width.

topInset - the pixel snapped top inset

rightInset - the pixel snapped right inset

bottomInset - the pixel snapped bottom inset

leftInset - the pixel snapped left inset

Returns:

A double representing the minimum width of this Skin.

computeMinHeight

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

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

Overrides:

computeMinHeight in class SkinBase<ScrollPane>

Parameters:

width - The width of the Skin, in case this value might dictate the minimum height.

topInset - the pixel snapped top inset

rightInset - the pixel snapped right inset

bottomInset - the pixel snapped bottom inset

leftInset - the pixel snapped left inset

Returns:

A double representing the minimum height of this Skin.

layoutChildren

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

Description copied from class: SkinBase

Called during the layout pass of the scenegraph.

Overrides:

layoutChildren in class SkinBase<ScrollPane>

Parameters:

x - the x position

y - the y position

w - the width

h - the height

queryAccessibleAttribute

protected 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 SkinBase<ScrollPane>

Parameters:

attribute - the requested attribute

parameters - optional list of parameters

Returns:

the value for the requested attribute

See Also:

AccessibleAttribute, Node.queryAccessibleAttribute(javafx.scene.AccessibleAttribute, java.lang.Object...)