Класс Pagination

javafx.scene.control.Pagination

Все реализованные интерфейсы:: Styleable, EventTarget, Skinnable

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

Элемент управления Pagination используется для навигации по страницам единого содержимого, которое разделено на более мелкие части.

Стиль индикаторов страниц

Элемент управления можно настроить для отображения числовых индикаторов страниц или индикаторов в виде маркеров, установив класс стиля STYLE_CLASS_BULLET. Свойство maxPageIndicatorCountProperty можно использовать для изменения максимального количества индикаторов страниц. Значение свойства также можно изменить с помощью CSS, используя -fx-max-page-indicator-count. По умолчанию нумерация индикаторов страниц начинается с 1 (соответствующей индексу страницы 0).

Количество страниц

Свойство pageCountProperty управляет количеством страниц в этом элементе управления Pagination. Если количество страниц неизвестно, следует использовать INDETERMINATE в качестве количества страниц.

Фабрика страниц

pageFactoryProperty — это функция обратного вызова, которая вызывается при выборе страницы приложением или пользователем. Функция необходима для функциональности элемента управления Pagination. Функция обратного вызова должна загружать и возвращать содержимое выбранной страницы. null должно быть возвращено, если индекс выбранной страницы не существует.

Создание элемента управления Pagination:

Пример простого создания элемента управления Pagination с десятью страницами, на каждой из которых содержится текст.

 Pagination pagination = new Pagination(10, 0);
 pagination.setPageFactory(new Callback<Integer, Node>() {
     @Override
     public Node call(Integer pageIndex) {
         return new Label(pageIndex + 1 + ". Lorem ipsum dolor sit amet,\n"
                      + "consectetur adipiscing elit,\n"
                      + "sed do eiusmod tempor incididunt ut\n"
                      + "labore et dolore magna aliqua.");
     }
 });

или используя лямбды

 Pagination pagination = new Pagination(10, 0);
 pagination.setPageFactory(pageIndex ->
         new Label(pageIndex + 1 + ". Lorem ipsum dolor sit amet,\n"
                      + "consectetur adipiscing elit,\n"
                      + "sed do eiusmod tempor incididunt ut\n"
                      + "labore et dolore magna aliqua.");
 );

С:: JavaFX 2.2

Краткое описание свойств

Тип	Свойство	Описание
`final IntegerProperty`	`currentPageIndex`	Текущий индекс страницы для отображения в этом элементе управления Pagination.
`final IntegerProperty`	`maxPageIndicatorCount`	Максимальное количество индикаторов страниц для использования в этом элементе управления Pagination.
`final IntegerProperty`	`pageCount`	Количество страниц для этого элемента управления Pagination.
`final ObjectProperty<Callback<Integer,Node>>`	`pageFactory`	Функция обратного вызова pageFactory, которая вызывается при выборе страницы приложением или пользователем.

Свойства, объявленные в классе javafx.scene.control.Control

contextMenu, skin, tooltip

Свойства, объявленные в классе javafx.scene.layout.Region

background, border, cacheShape, centerShape, height, insets, maxHeight, maxWidth, minHeight, minWidth, opaqueInsets, padding, prefHeight, prefWidth, scaleShape, shape, snapToPixel, width

Свойства, объявленные в классе javafx.scene.Parent

needsLayout

Свойства, объявленные в классе javafx.scene.Node

accessibleHelp, accessibleRoleDescription, accessibleRole, accessibleText, blendMode, boundsInLocal, boundsInParent, cacheHint, cache, clip, cursor, depthTest, disabled, disable, effectiveNodeOrientation, effect, eventDispatcher, focused, focusTraversable, focusVisible, focusWithin, hover, id, inputMethodRequests, layoutBounds, layoutX, layoutY, localToParentTransform, localToSceneTransform, managed, mouseTransparent, nodeOrientation, 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, viewOrder, visible

Краткое описание полей

Модификатор и тип	Поле	Описание
`static final int`	`INDETERMINATE`	Значение для указания того, что количество страниц неопределенно.
`static final String`	`STYLE_CLASS_BULLET`	Класс стиля для изменения числовых индикаторов страниц на индикаторы в виде маркеров.

Поля, объявленные в классе javafx.scene.layout.Region

USE_COMPUTED_SIZE, USE_PREF_SIZE

Поля, объявленные в классе javafx.scene.Node

BASELINE_OFFSET_SAME_AS_HEIGHT

Краткое описание конструкторов

Конструктор	Описание
`Pagination()`	Создаёт элемент управления Pagination с неопределённым количеством страниц и индексом страницы, равным нулю.
`Pagination(int pageCount)`	Создаёт новый элемент управления Pagination с указанным количеством страниц.
`Pagination(int pageCount, int pageIndex)`	Создаёт новый элемент управления Pagination с указанным количеством страниц и индексом страницы.

Краткое описание методов

Модификатор и тип	Метод	Описание
`final IntegerProperty`	`currentPageIndexProperty()`	Текущий индекс страницы для отображения в этом элементе управления Pagination.
`static List<CssMetaData<? extends Styleable,?>>`	`getClassCssMetaData()`	Возвращает связанный с этим классом `CssMetaData`, который может включать `CssMetaData` своих суперклассов.
`List<CssMetaData<? extends Styleable,?>>`	`getControlCssMetaData()`	Возвращает неизменяемый список стилизуемых свойств элемента управления.
`final int`	`getCurrentPageIndex()`	Возвращает текущий индекс страницы.
`final int`	`getMaxPageIndicatorCount()`	Возвращает максимальное количество индикаторов страниц.
`final int`	`getPageCount()`	Возвращает количество страниц.
`final Callback<Integer,Node>`	`getPageFactory()`	Возвращает функцию обратного вызова page factory.
`final IntegerProperty`	`maxPageIndicatorCountProperty()`	Максимальное количество индикаторов страниц для использования в этом элементе управления Pagination.
`final IntegerProperty`	`pageCountProperty()`	Количество страниц для этого элемента управления Pagination.
`final ObjectProperty<Callback<Integer,Node>>`	`pageFactoryProperty()`	Функция обратного вызова pageFactory, которая вызывается при выборе страницы приложением или пользователем.
`final void`	`setCurrentPageIndex(int value)`	Устанавливает текущий индекс страницы.
`final void`	`setMaxPageIndicatorCount(int value)`	Устанавливает максимальное количество индикаторов страниц.
`final void`	`setPageCount(int value)`	Устанавливает количество страниц.
`final void`	`setPageFactory(Callback<Integer,Node> value)`	Устанавливает функцию обратного вызова page factory.

Методы, объявленные в классе javafx.scene.control.Control

computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, contextMenuProperty, createDefaultSkin, getContextMenu, getCssMetaData, getInitialFocusTraversable, getSkin, getTooltip, isResizable, setContextMenu, setSkin, setTooltip, skinProperty, tooltipProperty

Методы, объявленные в классе javafx.scene.layout.Region

backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, computePrefHeight, computePrefWidth, getBackground, getBorder, getHeight, getInsets, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOpaqueInsets, getPadding, getPrefHeight, getPrefWidth, getShape, getUserAgentStylesheet, getWidth, heightProperty, insetsProperty, isCacheShape, isCenterShape, isScaleShape, isSnapToPixel, layoutInArea, layoutInArea, layoutInArea, layoutInArea, maxHeight, maxHeightProperty, maxWidth, maxWidthProperty, minHeight, minHeightProperty, minWidth, minWidthProperty, opaqueInsetsProperty, paddingProperty, positionInArea, positionInArea, prefHeight, prefHeightProperty, prefWidth, prefWidthProperty, resize, scaleShapeProperty, setBackground, setBorder, setCacheShape, setCenterShape, setHeight, setMaxHeight, setMaxSize, setMaxWidth, setMinHeight, setMinSize, setMinWidth, setOpaqueInsets, setPadding, setPrefHeight, setPrefSize, setPrefWidth, setScaleShape, setShape, setSnapToPixel, setWidth, shapeProperty, snappedBottomInset, snappedLeftInset, snappedRightInset, snappedTopInset, snapPosition, snapPositionX, snapPositionY, snapSize, snapSizeX, snapSizeY, snapSpace, snapSpaceX, snapSpaceY, snapToPixelProperty, widthProperty

Методы, объявленные в классе javafx.scene.Parent

getBaselineOffset, getChildren, getChildrenUnmodifiable, getManagedChildren, getStylesheets, isNeedsLayout, layout, layoutChildren, needsLayoutProperty, requestLayout, requestParentLayout, setNeedsLayout, updateBounds

Методы, объявленные в классе javafx.scene.Node

accessibleHelpProperty, accessibleRoleDescriptionProperty, accessibleRoleProperty, accessibleTextProperty, addEventFilter, addEventHandler, applyCss, autosize, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, buildEventDispatchChain, cacheHintProperty, cacheProperty, clipProperty, computeAreaInScreen, contains, contains, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, executeAccessibleAction, fireEvent, focusedProperty, focusTraversableProperty, focusVisibleProperty, focusWithinProperty, getAccessibleHelp, getAccessibleRole, getAccessibleRoleDescription, getAccessibleText, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClip, getContentBias, getCursor, getDepthTest, getEffect, getEffectiveNodeOrientation, getEventDispatcher, getId, getInitialCursor, getInputMethodRequests, getLayoutBounds, getLayoutX, getLayoutY, getLocalToParentTransform, getLocalToSceneTransform, getNodeOrientation, 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, getPseudoClassStates, getRotate, getRotationAxis, getScaleX, getScaleY, getScaleZ, getScene, getStyle, getStyleableParent, getStyleClass, getTransforms, getTranslateX, getTranslateY, getTranslateZ, getTypeSelector, getUserData, getViewOrder, hasProperties, hoverProperty, idProperty, inputMethodRequestsProperty, intersects, intersects, isCache, isDisable, isDisabled, isFocused, isFocusTraversable, isFocusVisible, isFocusWithin, isHover, isManaged, isMouseTransparent, isPickOnBounds, isPressed, isVisible, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParent, localToParent, localToParent, localToParent, localToParent, localToParentTransformProperty, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToSceneTransformProperty, localToScreen, localToScreen, localToScreen, localToScreen, localToScreen, lookup, lookupAll, managedProperty, mouseTransparentProperty, nodeOrientationProperty, notifyAccessibleAttributeChanged, 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, parentToLocal, parentToLocal, pickOnBoundsProperty, pressedProperty, pseudoClassStateChanged, queryAccessibleAttribute, relocate, removeEventFilter, removeEventHandler, requestFocus, requestFocusTraversal, resizeRelocate, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, screenToLocal, screenToLocal, screenToLocal, setAccessibleHelp, setAccessibleRole, setAccessibleRoleDescription, setAccessibleText, setBlendMode, setCache, setCacheHint, setClip, setCursor, setDepthTest, setDisable, setDisabled, setEffect, setEventDispatcher, setEventHandler, setFocused, setFocusTraversable, setHover, setId, setInputMethodRequests, setLayoutX, setLayoutY, setManaged, setMouseTransparent, setNodeOrientation, 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, setViewOrder, setVisible, snapshot, snapshot, startDragAndDrop, startFullDrag, styleProperty, toBack, toFront, toString, translateXProperty, translateYProperty, translateZProperty, usesMirroring, viewOrderProperty, visibleProperty

Методы, объявленные в классе java.lang.Object

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

Методы, объявленные в интерфейсе javafx.css.Styleable

getStyleableNode

Подробности свойства

maxPageIndicatorCount

public final IntegerProperty maxPageIndicatorCountProperty

Максимальное количество индикаторов страниц для использования в этом элементе управления постраничной навигацией. Максимальное количество индикаторов страниц останется неизменным, если значение меньше 1 или больше, чем pageCount. Количество индикаторов страниц будет уменьшено для размещения в элементе управления, если maxPageIndicatorCount не поместится. По умолчанию используется 10 индикаторов страниц.

См. также:

pageCount

public final IntegerProperty pageCountProperty

Количество страниц для этого элемента управления постраничной навигацией. Это значение должно быть больше или равно 1. INDETERMINATE следует использовать в качестве количества страниц, если общее количество страниц неизвестно. По умолчанию количество страниц является INDETERMINATE.

См. также:

currentPageIndex

public final IntegerProperty currentPageIndexProperty

Текущий индекс страницы для отображения в этом элементе управления постраничной навигацией. Первая страница будет текущей страницей, если значение меньше 0. Аналогично, последняя страница будет текущей страницей, если значение больше pageCount. По умолчанию 0 для первой страницы.

Поскольку индикаторы страниц устанавливают текущий индекс страницы, свойство currentPageIndex допускает только двустороннюю привязку. Метод bind генерирует исключение UnsupportedOperationException.

См. также:

pageFactory

public final ObjectProperty<Callback<Integer,Node>> pageFactoryProperty

Обратный вызов pageFactory, который вызывается, когда приложение или пользователь выбирают страницу. Эта функция необходима для функционирования элемента управления постраничной навигацией. Обратный вызов должен загрузить и вернуть содержимое индекса страницы. Возвращает null, если индекс страницы не существует. Текущий индекс страницы не изменится, когда возвращается null. По умолчанию null, если фабрика страниц не задана.

См. также:

Подробности поля

STYLE_CLASS_BULLET

public static final String STYLE_CLASS_BULLET

Класс стиля для изменения числовых индикаторов страниц на индикаторы-пули.

См. также:

INDETERMINATE

public static final int INDETERMINATE

Значение для указания того, что количество страниц неопределённо.

См. также:

Подробности конструктора

Pagination

public Pagination(int pageCount, int pageIndex)

Создает новый элемент управления постраничной навигацией со значением указанного количества страниц и индекса страницы.

Параметры:: pageCount - количество страниц для элемента управления постраничной навигацией; pageIndex - индекс первой страницы.

Pagination

public Pagination(int pageCount)

Создаёт новый элемент управления Pagination со значением указанного количества страниц.

Параметры:: pageCount - количество страниц для элемента управления Pagination

Pagination

public Pagination()

Создает элемент управления Pagination с неопределенным количеством страниц и индексом страницы, равным нулю.

Подробности метода

setMaxPageIndicatorCount

public final void setMaxPageIndicatorCount(int value)

Устанавливает максимальное количество индикаторов страниц.

Параметры:: value - количество индикаторов страниц. По умолчанию 10.

getMaxPageIndicatorCount

public final int getMaxPageIndicatorCount()

Возвращает максимальное количество индикаторов страниц.

Возвращает:: максимальное количество индикаторов страниц

maxPageIndicatorCountProperty

public final IntegerProperty maxPageIndicatorCountProperty()

Возвращает:

максимальное количество индикаторов страниц для использования в этом элементе управления постраничной навигацией

См. также:

setPageCount

public final void setPageCount(int value)

Устанавливает количество страниц.

Параметры:: value - количество страниц

getPageCount

public final int getPageCount()

Возвращает количество страниц.

Возвращает:: количество страниц

pageCountProperty

public final IntegerProperty pageCountProperty()

Возвращает:

количество страниц для этого элемента управления постраничной навигацией

См. также:

setCurrentPageIndex

public final void setCurrentPageIndex(int value)

Устанавливает текущий индекс страницы.

Параметры:: value - текущий индекс страницы.

getCurrentPageIndex

public final int getCurrentPageIndex()

Возвращает текущий индекс страницы.

Возвращает:: текущий индекс страницы

currentPageIndexProperty

public final IntegerProperty currentPageIndexProperty()

Возвращает:

свойство текущего индекса страницы

См. также:

setPageFactory

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

Устанавливает обратный вызов фабрики страниц.

Параметры:: value - обратный вызов фабрики страниц

getPageFactory

public final Callback<Integer,Node> getPageFactory()

Возвращает обратный вызов фабрики страниц.

Возвращает:: обратный вызов фабрики страниц

pageFactoryProperty

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

Функция обратного вызова pageFactory, которая вызывается, когда приложение или пользователь выбрали страницу. Эта функция необходима для работы элемента управления постраничной навигацией. Функция обратного вызова должна загрузить и вернуть содержимое страницы по индексу. Если индекс страницы не существует, должно быть возвращено значение Null. Текущий индекс страницы не изменится, если возвращено значение Null. По умолчанию значение равно Null, если фабрика страниц не задана.

Возвращает:

свойство page factory

См. также:

getClassCssMetaData

public static List<CssMetaData<? extends Styleable,?>> getClassCssMetaData()

Получает CssMetaData, связанные с этим классом, что может включать CssMetaData его суперклассов.

Возвращает:: CssMetaData
С:: JavaFX 8.0

getControlCssMetaData

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

Получает неизменяемый список стилизуемых свойств элемента управления CSS.

Переопределяет:: getControlCssMetaData в классе Control
Возвращает:: неизменяемый список стилизуемых свойств элемента управления CSS
С:: JavaFX 8.0

© 2008, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from JavaFX API Documentation.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Java, JavaFX and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.