javafx.scene.control

Class Pagination

java.lang.Object

javafx.scene.Node

javafx.scene.Parent

javafx.scene.control.Control

javafx.scene.control.Pagination

All Implemented Interfaces:

EventTarget, Skinnable

@DefaultProperty(value="pages")
public class Pagination
extends Control

A Pagination control is used for navigation between pages of a single content, which has been divided into smaller parts.

Styling the page indicators

The control can be customized to display numeric page indicators or bullet style indicators by setting the style class STYLE_CLASS_BULLET. The maxPageIndicatorCountProperty can be used to change the maximum number of page indicators. The property value can also be changed via CSS using -fx-max-page-indicator-count.

Page count

The pageCountProperty controls the number of pages this pagination control has. If the page count is not known INDETERMINATE should be used as the page count.

Page factory

The pageFactoryProperty is a callback function that is called when a page has been selected by the application or the user. The function is required for the functionality of the pagination control. The callback function should load and return the contents of the selected page. Null should be returned if the selected page index does not exist.

Creating a Pagination control:

A simple example of how to create a pagination control with ten pages and each page containing ten hyperlinks.

 Pagination pagination = new Pagination(10, 0);
   pagination.setPageFactory(new Callback<Integer, Node>() {
       public Node call(Integer pageIndex) {
           VBox box = new VBox(5);
           for (int i = 0; i < pageIndex + 10; i++) {
               Hyperlink link = new Hyperlink(myurls[i]);
               box.getChildren().add(link);
           }
           return box;
       }
   });
 

Since:

2.2

Property Summary

Properties

Type	Property and Description
IntegerProperty	currentPageIndex The current page index to display for this pagination control.
IntegerProperty	maxPageIndicatorCount The maximum number of page indicators to use for this pagination control.
IntegerProperty	pageCount The number of pages for this pagination control.
ObjectProperty<Callback<java.lang.Integer,Node>>	pageFactory The pageFactory callback function that is called when a page has been selected by the application or the user.

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

Modifier and Type	Field and Description
static int	INDETERMINATE Value for indicating that the page count is indeterminate.
static java.lang.String	STYLE_CLASS_BULLET The style class to change the numeric page indicators to bullet indicators.

Fields inherited from class javafx.scene.control.Control

USE_COMPUTED_SIZE, USE_PREF_SIZE

Constructor Summary

Constructors

Constructor and Description
Pagination() Constructs a Pagination control with an INDETERMINATE page count and a page index equal to zero.
Pagination(int pageCount) Constructs a new Pagination control with the specified page count.
Pagination(int pageCount, int pageIndex) Constructs a new Pagination control with the specified page count and page index.

Method Summary

Methods

Modifier and Type	Method and Description
IntegerProperty	currentPageIndexProperty() The current page index to display for this pagination control.
int	getCurrentPageIndex() Returns the current page index.
int	getMaxPageIndicatorCount() Returns the maximum number of page indicators.
int	getPageCount() Returns the number of pages.
Callback<java.lang.Integer,Node>	getPageFactory() Returns the page factory callback function.
IntegerProperty	maxPageIndicatorCountProperty() The maximum number of page indicators to use for this pagination control.
IntegerProperty	pageCountProperty() The number of pages for this pagination control.
ObjectProperty<Callback<java.lang.Integer,Node>>	pageFactoryProperty() The pageFactory callback function that is called when a page has been selected by the application or the user.
void	setCurrentPageIndex(int value) Sets the current page index.
void	setMaxPageIndicatorCount(int value) Sets the maximum number of page indicators.
void	setPageCount(int value) Sets the number of pages.
void	setPageFactory(Callback<java.lang.Integer,Node> value) Sets the page factory callback function.

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

maxPageIndicatorCount

public final IntegerProperty maxPageIndicatorCountProperty

The maximum number of page indicators to use for this pagination control. The maximum number of pages indicators will remain unchanged if the value is less than 1 or greater than the pageCount. The number of page indicators will be reduced to fit the control if the maxPageIndicatorCount cannot fit. The default is 10 page indicators.

See Also:

getMaxPageIndicatorCount(), setMaxPageIndicatorCount(int)

pageCount

public final IntegerProperty pageCountProperty

The number of pages for this pagination control. This value must be greater than or equal to 1. INDETERMINATE should be used as the page count if the total number of pages is unknown. The default is an INDETERMINATE number of pages.

See Also:

getPageCount(), setPageCount(int)

currentPageIndex

public final IntegerProperty currentPageIndexProperty

The current page index to display for this pagination control. The first page will be the current page if the value is less than 0. Similarly the last page will be the current page if the value is greater than the pageCount The default is 0 for the first page.

See Also:

getCurrentPageIndex(), setCurrentPageIndex(int)

pageFactory

public final ObjectProperty<Callback<java.lang.Integer,Node>> pageFactoryProperty

The pageFactory callback function that is called when a page has been selected by the application or the user. This function is required for the functionality of the pagination control. The callback function should load and return the contents the page index. Null should be returned if the page index does not exist. The currentPageIndex will not change when null is returned. The default is null if there is no page factory set.

See Also:

getPageFactory(), setPageFactory(Callback)

Field Detail

STYLE_CLASS_BULLET

public static final java.lang.String STYLE_CLASS_BULLET

The style class to change the numeric page indicators to bullet indicators.

See Also:

Constant Field Values

INDETERMINATE

public static final int INDETERMINATE

Value for indicating that the page count is indeterminate.

See Also:

setPageCount(int), Constant Field Values

Constructor Detail

Pagination

public Pagination(int pageCount,
          int pageIndex)

Constructs a new Pagination control with the specified page count and page index.

Parameters:

pageCount - the number of pages for the pagination control

pageIndex - the index of the first page.

Pagination

public Pagination(int pageCount)

Constructs a new Pagination control with the specified page count.

Parameters:

pageCount - the number of pages for the pagination control

Pagination

public Pagination()

Constructs a Pagination control with an INDETERMINATE page count and a page index equal to zero.

Method Detail

setMaxPageIndicatorCount

public final void setMaxPageIndicatorCount(int value)

Sets the maximum number of page indicators.

Parameters:

value - the number of page indicators. The default is 10.

getMaxPageIndicatorCount

public final int getMaxPageIndicatorCount()

Returns the maximum number of page indicators.

maxPageIndicatorCountProperty

public final IntegerProperty maxPageIndicatorCountProperty()

The maximum number of page indicators to use for this pagination control. The maximum number of pages indicators will remain unchanged if the value is less than 1 or greater than the pageCount. The number of page indicators will be reduced to fit the control if the maxPageIndicatorCount cannot fit. The default is 10 page indicators.

See Also:

getMaxPageIndicatorCount(), setMaxPageIndicatorCount(int)

setPageCount

public final void setPageCount(int value)

Sets the number of pages.

Parameters:

value - the number of pages

getPageCount

public final int getPageCount()

Returns the number of pages.

pageCountProperty

public final IntegerProperty pageCountProperty()

The number of pages for this pagination control. This value must be greater than or equal to 1. INDETERMINATE should be used as the page count if the total number of pages is unknown. The default is an INDETERMINATE number of pages.

See Also:

getPageCount(), setPageCount(int)

setCurrentPageIndex

public final void setCurrentPageIndex(int value)

Sets the current page index.

Parameters:

value - the current page index.

getCurrentPageIndex

public final int getCurrentPageIndex()

Returns the current page index.

currentPageIndexProperty

public final IntegerProperty currentPageIndexProperty()

The current page index to display for this pagination control. The first page will be the current page if the value is less than 0. Similarly the last page will be the current page if the value is greater than the pageCount The default is 0 for the first page.

See Also:

getCurrentPageIndex(), setCurrentPageIndex(int)

setPageFactory

public final void setPageFactory(Callback<java.lang.Integer,Node> value)

Sets the page factory callback function.

getPageFactory

public final Callback<java.lang.Integer,Node> getPageFactory()

Returns the page factory callback function.

pageFactoryProperty

public final ObjectProperty<Callback<java.lang.Integer,Node>> pageFactoryProperty()

The pageFactory callback function that is called when a page has been selected by the application or the user. This function is required for the functionality of the pagination control. The callback function should load and return the contents the page index. Null should be returned if the page index does not exist. The currentPageIndex will not change when null is returned. The default is null if there is no page factory set.

See Also:

getPageFactory(), setPageFactory(Callback)