Pagination

java.lang.Object
- Region
- - javafx.scene.control.Control
  - - javafx.scene.control.Pagination

All Implemented Interfaces:

Skinnable
```
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:

JavaFX 2.2

Property Summary

All Methods Instance Methods Concrete Methods
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.
`<any>`	`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
contextMenuProperty, skinClassNameProperty, skinProperty, tooltipProperty

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

private static class Pagination.StyleableProperties

Nested Classes
Modifier and Type	Class and Description
`private static class`	`Pagination.StyleableProperties`

Field Summary

Fields
Modifier and Type	Field and Description
`private IntegerProperty`	`currentPageIndex`
`private static int`	`DEFAULT_MAX_PAGE_INDICATOR_COUNT`
`private static java.lang.String`	`DEFAULT_STYLE_CLASS` * Stylesheet Handling * *
`static int`	`INDETERMINATE` Value for indicating that the page count is indeterminate.
`private IntegerProperty`	`maxPageIndicatorCount`
`private int`	`oldMaxPageIndicatorCount` * Properties * *
`private int`	`oldPageCount`
`private IntegerProperty`	`pageCount`
`private <any>`	`pageFactory`
`static java.lang.String`	`STYLE_CLASS_BULLET` The style class to change the numeric page indicators to bullet indicators.

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

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected Skin<?>`	`createDefaultSkin()` Create a new instance of the default skin for this control.
`IntegerProperty`	`currentPageIndexProperty()` The current page index to display for this pagination control.
`static java.util.List<<any>>`	`getClassCssMetaData()`
`java.util.List<<any>>`	`getControlCssMetaData()`
`int`	`getCurrentPageIndex()` Returns the current page index.
`int`	`getMaxPageIndicatorCount()` Returns the maximum number of page indicators.
`int`	`getPageCount()` Returns the number of pages.
`<any>`	`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.
`<any>`	`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(<any> value)` Sets the page factory callback function.

Methods inherited from class javafx.scene.control.Control
computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, contextMenuProperty, executeAccessibleAction, getBaselineOffset, getContextMenu, getControlChildren, getCssMetaData, getInitialFocusTraversable, getSkin, getTooltip, isResizable, layoutChildren, loadSkinClass, queryAccessibleAttribute, setContextMenu, setSkin, setTooltip, skinClassNameProperty, skinProperty, tooltipProperty

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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.
    Because the page indicators set the current page index, the currentPageIndex property permits only bidirectional binding. The bind method throws an UnsupportedOperationException.
    
    See Also:
    
    getCurrentPageIndex(), setCurrentPageIndex(int)
  - pageFactory
```
public final <any> 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()
- Field Detail
  - DEFAULT_MAX_PAGE_INDICATOR_COUNT
```
private static final int DEFAULT_MAX_PAGE_INDICATOR_COUNT
```
    See Also:
    
    Constant Field Values
  - 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
  - oldMaxPageIndicatorCount
```
private int oldMaxPageIndicatorCount
```
    * Properties * *
  - maxPageIndicatorCount
```
private IntegerProperty maxPageIndicatorCount
```
  - oldPageCount
```
private int oldPageCount
```
  - pageCount
```
private IntegerProperty pageCount
```
  - currentPageIndex
```
private final IntegerProperty currentPageIndex
```
  - pageFactory
```
private <any> pageFactory
```
  - DEFAULT_STYLE_CLASS
```
private static final java.lang.String DEFAULT_STYLE_CLASS
```
    * Stylesheet Handling * *
    
    See Also:
    
    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.
    
    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.
    
    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.
    
    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.
    Because the page indicators set the current page index, the currentPageIndex property permits only bidirectional binding. The bind method throws an UnsupportedOperationException.
    
    See Also:
    
    getCurrentPageIndex(), setCurrentPageIndex(int)
  - setPageFactory
```
public final void setPageFactory(<any> value)
```
    Sets the page factory callback function.
    
    Parameters:
    
    value - the page factory callback function
  - getPageFactory
```
public final <any> getPageFactory()
```
    Returns the page factory callback function.
    
    Returns:
    
    the page factory callback function
  - pageFactoryProperty
```
public final <any> 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()
  - 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<<any>> getClassCssMetaData()
```
    Returns:
    
    The CssMetaData associated with this class, which may include the CssMetaData of its superclasses.
    
    Since:
    
    JavaFX 8.0
  - getControlCssMetaData
```
public java.util.List<<any>> getControlCssMetaData()
```
    Overrides:
    
    getControlCssMetaData in class Control
    
    Returns:
    
    unmodifiable list of the controls css styleable properties
    
    Since:
    
    JavaFX 8.0

Class Pagination

Styling the page indicators

Page count

Page factory

Creating a Pagination control:

Property Summary

Properties inherited from class javafx.scene.control.Control

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class javafx.scene.control.Control

Methods inherited from class java.lang.Object

Property Detail

maxPageIndicatorCount

pageCount

currentPageIndex

pageFactory

Field Detail

DEFAULT_MAX_PAGE_INDICATOR_COUNT

STYLE_CLASS_BULLET

INDETERMINATE

oldMaxPageIndicatorCount

maxPageIndicatorCount

oldPageCount

pageCount

currentPageIndex

pageFactory

DEFAULT_STYLE_CLASS

Constructor Detail

Pagination

Pagination

Pagination

Method Detail

setMaxPageIndicatorCount

getMaxPageIndicatorCount

maxPageIndicatorCountProperty

setPageCount

getPageCount

pageCountProperty

setCurrentPageIndex

getCurrentPageIndex

currentPageIndexProperty

setPageFactory

getPageFactory

pageFactoryProperty

createDefaultSkin

getClassCssMetaData

getControlCssMetaData