Top Description Inners Fields Constructors Methods
javafx.scene.control.skin

public Class PaginationSkin

extends SkinBase<Pagination>
Class Inheritance
Static Imports
com.sun.javafx.scene.control.skin.resources.ControlResources.getString

Default skin implementation for the Pagination control.
Since
9
See Also
Pagination

Nested and Inner Type Summary

Modifier and TypeClass and Description
pack-priv class
private static class

Field Summary

Modifier and TypeField and Description
private boolean
private final DoubleProperty
arrowButtonGap

The size of the gap between number buttons and arrow buttons

private BooleanProperty
private final PaginationBehavior
private EventHandler<ActionEvent>
private Rectangle
private int
private int
private StackPane
private static final Boolean
private static final Side
private static final Boolean
private static final Boolean
private int
private static final Duration
private int
private volatile boolean
private static final Interpolator
private double
private long
private int
private boolean
private StackPane
private int
private ObjectProperty<Side>
private BooleanProperty
private int
private boolean
private double
private long
private static final double
private EventHandler<ActionEvent>
private Timeline
private int
private BooleanProperty
private static final double
private int
private boolean
private double

Constructor Summary

AccessConstructor and Description
public
PaginationSkin(final Pagination
The control that this skin should be installed onto.
control
)

Creates a new PaginationSkin 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 TypeMethod and Description
private void
animateClamping(boolean rightToLeft)

private void
private final DoubleProperty
private final BooleanProperty
protected double
computeMinHeight(double width, double topInset, double rightInset, double bottomInset, double leftInset)

Overrides javafx.scene.control.SkinBase.computeMinHeight.

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)

Overrides javafx.scene.control.SkinBase.computeMinWidth.

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)

Overrides javafx.scene.control.SkinBase.computePrefHeight.

Calculates the preferred height of this SkinBase.

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

Overrides javafx.scene.control.SkinBase.computePrefWidth.

Calculates the preferred width of this SkinBase.

private boolean
createPage(StackPane pane, int index)

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
public static List<CssMetaData<? extends Styleable, ?>>

Returns:

the CssMetaData associated with this class, which may include the CssMetaData of its superclasses
getClassCssMetaData
()

Hides javafx.scene.control.SkinBase.getClassCssMetaData.

Returns the CssMetaData associated with this class, which may include the CssMetaData of its superclasses.

public List<CssMetaData<? extends Styleable, ?>>
getCssMetaData()

Overrides javafx.scene.control.SkinBase.getCssMetaData.

This method should delegate to Node#getClassCssMetaData() so that a Node's CssMetaData can be accessed without the need for reflection.

private int
private int
private int
private final Side
private void
public void
install()

Overrides default javafx.scene.control.Skin.install.

Called once when Skin is set.

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

Overrides javafx.scene.control.SkinBase.layoutChildren.

Called during the layout pass of the scenegraph.

private final ObjectProperty<Side>
private final BooleanProperty
protected Object
queryAccessibleAttribute(AccessibleAttribute attribute, Object... parameters)

Overrides javafx.scene.control.SkinBase.queryAccessibleAttribute.

This method is called by the assistive technology to request the value for an attribute.

private void
resetIndexes(boolean usePageIndex)

private void
private void
private void
private final void
setArrowButtonGap(double value)

private final void
setArrowsVisible(boolean value)

private final void
private final void
private final void
setTooltipVisible(boolean value)

private void
private final BooleanProperty
Inherited from javafx.scene.control.SkinBase:
computeBaselineOffsetcomputeMaxHeightcomputeMaxWidthconsumeMouseEventsexecuteAccessibleActiongetChildrengetNodegetSkinnablelayoutInArealayoutInArealayoutInAreapositionInAreapositionInAreapseudoClassStateChangedregisterChangeListenerregisterInvalidationListenerregisterListChangeListenersnappedBottomInsetsnappedLeftInsetsnappedRightInsetsnappedTopInsetsnapPositionsnapPositionXsnapPositionYsnapSizesnapSizeXsnapSizeYsnapSpacesnapSpaceXsnapSpaceYunregisterChangeListenersunregisterInvalidationListenersunregisterListChangeListeners

Field Detail

animateback to summary
private boolean animate
arrowButtonGapback to summary
private final DoubleProperty arrowButtonGap

The size of the gap between number buttons and arrow buttons

arrowsVisibleback to summary
private BooleanProperty arrowsVisible
behaviorback to summary
private final PaginationBehavior behavior
clampAnimationEndEventHandlerback to summary
private EventHandler<ActionEvent> clampAnimationEndEventHandler
clipRectback to summary
private Rectangle clipRect
currentAnimatedIndexback to summary
private int currentAnimatedIndex
currentIndexback to summary
private int currentIndex
currentStackPaneback to summary
private StackPane currentStackPane
DEFAULT_ARROW_VISIBLEback to summary
private static final Boolean DEFAULT_ARROW_VISIBLE
DEFAULT_PAGE_INFORMATION_ALIGNMENTback to summary
private static final Side DEFAULT_PAGE_INFORMATION_ALIGNMENT
DEFAULT_PAGE_INFORMATION_VISIBLEback to summary
private static final Boolean DEFAULT_PAGE_INFORMATION_VISIBLE
DEFAULT_TOOLTIP_VISIBLEback to summary
private static final Boolean DEFAULT_TOOLTIP_VISIBLE
directionback to summary
private int direction
DURATIONback to summary
private static final Duration DURATION
fromIndexback to summary
private int fromIndex
hasPendingAnimationback to summary
private volatile boolean hasPendingAnimation
interpolatorback to summary
private static final Interpolator interpolator
lastTouchPosback to summary
private double lastTouchPos
lastTouchTimeback to summary
private long lastTouchTime
maxPageIndicatorCountback to summary
private int maxPageIndicatorCount
nextPageReachedback to summary
private boolean nextPageReached
nextStackPaneback to summary
private StackPane nextStackPane
pageCountback to summary
private int pageCount
pageInformationAlignmentback to summary
private ObjectProperty<Side> pageInformationAlignment
pageInformationVisibleback to summary
private BooleanProperty pageInformationVisible
previousIndexback to summary
private int previousIndex
setInitialDirectionback to summary
private boolean setInitialDirection
startTouchPosback to summary
private double startTouchPos
startTouchTimeback to summary
private long startTouchTime
SWIPE_THRESHOLDback to summary
private static final double SWIPE_THRESHOLD
swipeAnimationEndEventHandlerback to summary
private EventHandler<ActionEvent> swipeAnimationEndEventHandler
timelineback to summary
private Timeline timeline
toIndexback to summary
private int toIndex
tooltipVisibleback to summary
private BooleanProperty tooltipVisible
TOUCH_THRESHOLDback to summary
private static final double TOUCH_THRESHOLD
touchEventIdback to summary
private int touchEventId
touchThresholdBrokenback to summary
private boolean touchThresholdBroken
touchVelocityback to summary
private double touchVelocity

Constructor Detail

PaginationSkinback to summary
public PaginationSkin(final Pagination control)

Creates a new PaginationSkin 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:Pagination

The control that this skin should be installed onto.

Method Detail

animateClampingback to summary
private void animateClamping(boolean rightToLeft)
animateSwitchPageback to summary
private void animateSwitchPage()
arrowButtonGapPropertyback to summary
private final DoubleProperty arrowButtonGapProperty()
arrowsVisiblePropertyback to summary
private final BooleanProperty arrowsVisibleProperty()
computeMinHeightback 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.

Annotations
@Override
computeMinWidthback 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.

Annotations
@Override
computePrefHeightback 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.

Annotations
@Override
computePrefWidthback 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.

Annotations
@Override
createPageback to summary
private boolean createPage(StackPane pane, int index)
disposeback 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
getArrowButtonGapback to summary
private final double getArrowButtonGap()
getClassCssMetaDataback to summary
public static List<CssMetaData<? extends Styleable, ?>> getClassCssMetaData()

Hides javafx.scene.control.SkinBase.getClassCssMetaData.

Returns the CssMetaData associated with this class, which may include the CssMetaData of its superclasses.

Returns:List<CssMetaData<? extends Styleable, ?>>

the CssMetaData associated with this class, which may include the CssMetaData of its superclasses

getCssMetaDataback to summary
public List<CssMetaData<? extends Styleable, ?>> getCssMetaData()

Overrides javafx.scene.control.SkinBase.getCssMetaData.

Doc from javafx.scene.control.SkinBase.getCssMetaData.

This method should delegate to Node#getClassCssMetaData() so that a Node's CssMetaData can be accessed without the need for reflection.

Annotations
@Override
getCurrentPageIndexback to summary
private int getCurrentPageIndex()
getMaxPageIndicatorCountback to summary
private int getMaxPageIndicatorCount()
getPageCountback to summary
private int getPageCount()
getPageInformationAlignmentback to summary
private final Side getPageInformationAlignment()
initializeSwipeAndTouchHandlersback to summary
private void initializeSwipeAndTouchHandlers()
installback to summary
public void install()

Overrides default javafx.scene.control.Skin.install.

Doc from javafx.scene.control.Skin.install.

Called once when Skin is set. This method is called after the previous skin, if any, has been uninstalled via its dispose() method. The skin can now safely make changes to its associated control, like registering listeners, adding child nodes, and modifying properties and event handlers.

Application code must not call this method.

The default implementation of this method does nothing.

Annotations
@Override
isArrowsVisibleback to summary
private final boolean isArrowsVisible()
isPageInformationVisibleback to summary
private final boolean isPageInformationVisible()
isTooltipVisibleback to summary
private final boolean isTooltipVisible()
layoutChildrenback 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.

Annotations
@Override
pageInformationAlignmentPropertyback to summary
private final ObjectProperty<Side> pageInformationAlignmentProperty()
pageInformationVisiblePropertyback to summary
private final BooleanProperty pageInformationVisibleProperty()
queryAccessibleAttributeback 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.

Annotations
@Override
resetIndexesback to summary
private void resetIndexes(boolean usePageIndex)
resetIndiciesAndNavback to summary
private void resetIndiciesAndNav()
selectNextback to summary
private void selectNext()
selectPreviousback to summary
private void selectPrevious()
setArrowButtonGapback to summary
private final void setArrowButtonGap(double value)
setArrowsVisibleback to summary
private final void setArrowsVisible(boolean value)
setPageInformationAlignmentback to summary
private final void setPageInformationAlignment(Side value)
setPageInformationVisibleback to summary
private final void setPageInformationVisible(boolean value)
setTooltipVisibleback to summary
private final void setTooltipVisible(boolean value)
swapPanesback to summary
private void swapPanes()
tooltipVisiblePropertyback to summary
private final BooleanProperty tooltipVisibleProperty()
javafx.scene.control.skin back to summary

pack-priv Class PaginationSkin.IndicatorButton

extends ToggleButton
Class Inheritance

Field Summary

Modifier and TypeField and Description
private int

Constructor Summary

AccessConstructor and Description
public
IndicatorButton(int pageNumber)

Method Summary

Modifier and TypeMethod and Description
public void
executeAccessibleAction(AccessibleAction action, Object... parameters)

Overrides javafx.scene.control.ButtonBase.executeAccessibleAction.

This method is called by the assistive technology to request the action indicated by the argument should be executed.

public void
fire()

Overrides javafx.scene.control.ToggleButton.fire.

Invoked when a user gesture indicates that an event for this ButtonBase should occur.

public int
public Object
queryAccessibleAttribute(AccessibleAttribute attribute, Object... parameters)

Overrides javafx.scene.control.ToggleButton.queryAccessibleAttribute.

This method is called by the assistive technology to request the value for an attribute.

private void
private void
setTooltipVisible(boolean b)

Inherited from javafx.scene.control.ToggleButton:
createDefaultSkingetInitialAlignmentgetToggleGroupisSelectedselectedPropertysetSelectedsetToggleGrouptoggleGroupProperty

Field Detail

pageNumberback to summary
private int pageNumber

Constructor Detail

IndicatorButtonback to summary
public IndicatorButton(int pageNumber)

Method Detail

executeAccessibleActionback to summary
public void executeAccessibleAction(AccessibleAction action, Object... parameters)

Overrides javafx.scene.control.ButtonBase.executeAccessibleAction.

Doc from javafx.scene.control.ButtonBase.executeAccessibleAction.

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

Annotations
@Override
fireback to summary
public void fire()

Overrides javafx.scene.control.ToggleButton.fire.

Doc from javafx.scene.control.ToggleButton.fire.

Invoked when a user gesture indicates that an event for this ButtonBase should occur.

If invoked, this method will be executed regardless of the status of arm.

Annotations
@Override
getPageNumberback to summary
public int getPageNumber()
queryAccessibleAttributeback to summary
public Object queryAccessibleAttribute(AccessibleAttribute attribute, Object... parameters)

Overrides javafx.scene.control.ToggleButton.queryAccessibleAttribute.

Doc from javafx.scene.control.ToggleButton.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.

Annotations
@Override
setBulletIndicatorTypeback to summary
private void setBulletIndicatorType(boolean on)
setTooltipVisibleback to summary
private void setTooltipVisible(boolean b)
javafx.scene.control.skin back to summary

private Class PaginationSkin.StyleableProperties

extends Object
Class Inheritance

Field Summary

Modifier and TypeField and Description
private static final CssMetaData<Pagination, Number>
private static final CssMetaData<Pagination, Boolean>
private static final CssMetaData<Pagination, Side>
private static final CssMetaData<Pagination, Boolean>
private static final List<CssMetaData<? extends Styleable, ?>>
private static final CssMetaData<Pagination, Boolean>

Constructor Summary

AccessConstructor and Description
private

Method Summary

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

ARROW_BUTTON_GAPback to summary
private static final CssMetaData<Pagination, Number> ARROW_BUTTON_GAP
ARROWS_VISIBLEback to summary
private static final CssMetaData<Pagination, Boolean> ARROWS_VISIBLE
PAGE_INFORMATION_ALIGNMENTback to summary
private static final CssMetaData<Pagination, Side> PAGE_INFORMATION_ALIGNMENT
PAGE_INFORMATION_VISIBLEback to summary
private static final CssMetaData<Pagination, Boolean> PAGE_INFORMATION_VISIBLE
STYLEABLESback to summary
private static final List<CssMetaData<? extends Styleable, ?>> STYLEABLES
TOOLTIP_VISIBLEback to summary
private static final CssMetaData<Pagination, Boolean> TOOLTIP_VISIBLE

Constructor Detail

StyleablePropertiesback to summary
private StyleableProperties()