Module  javafx.controls
软件包  javafx.scene.control

Class Pagination

  • All Implemented Interfaces:
    Styleable ， EventTarget ， Skinnable 

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

    分页控件用于单个内容的页面之间的导航，该页面已分为较小的部分。

    对页面指标进行样式化

    可以通过设置样式类别STYLE_CLASS_BULLET来定制控件以显示数字页面指示符或项目符号样式指示符。 maxPageIndicatorCountProperty可用于更改页面指示器的最大数量。 属性值也可以使用-fx-max-page-indicator-count通过CSS更改。

    页数

    pageCountProperty控制此分页控件具有的页数。 如果页数未知INDETERMINATE应该用作页数。

    页面工厂

    pageFactoryProperty是当应用程序或用户选择页面时调用的回调函数。 该功能是分页控件功能所必需的。 回调函数应该加载并返回所选页面的内容。 如果所选页面索引不存在，则应返回空值。

    创建分页控件：

    一个简单的例子，如何创建一个分页控件与十页和每个页面包含十个超链接。 

       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; } });
    从以下版本开始：
    JavaFX 2.2

    • Property Detail

      • maxPageIndicatorCount

        public final IntegerProperty maxPageIndicatorCountProperty
        用于此分页控件的页面指示符的最大数量。 如果值小于1或大于pageCount ，则最大页面指标将保持不变。 如果maxPageIndicatorCount不适合，页面指标的数量将减少到适合控件。 默认为10页指示。
        另请参见：
        getMaxPageIndicatorCount() ， setMaxPageIndicatorCount(int)

      • currentPageIndex

        public final IntegerProperty currentPageIndexProperty
        要为此分页控件显示的当前页面索引。 如果值小于0，则第一页将是当前页面。同样，如果值大于pageCount ，最后一页将是当前页面。第一页的默认值为0。

        因为页面指标设置当前页面索引，所以currentPageIndex属性只允许双向绑定。 bind方法抛出UnsupportedOperationException异常。

        另请参见：
        getCurrentPageIndex() ， setCurrentPageIndex(int)

      • pageFactory

        public final ObjectProperty<Callback<Integer,Node>> pageFactoryProperty
        当应用程序或用户选择页面时调用的pageFactory回调函数。 此功能是分页控件功能所必需的。 回调函数应该加载并返回页面索引的内容。 如果页面索引不存在，则应返回空值。 当返回null时，currentPageIndex不会改变。 如果没有页面出厂设置，默认值为null。
        另请参见：
        getPageFactory() ， setPageFactory(Callback)

    • 构造方法详细信息

      • Pagination

        public Pagination​(int pageCount,
                  int pageIndex)
        使用指定的页数和页索引构造一个新的分页控件。
        参数
        pageCount - 分页控件的页数
        pageIndex - 第一页的索引。

      • Pagination

        public Pagination​(int pageCount)
        构造一个具有指定页数的新的分页控件。
        参数
        pageCount - 分页控件的页数

      • Pagination

        public Pagination​()
        构造分页控件，页面索引为 INDETERMINATE ，页面索引为零。

    • 方法详细信息

      • setMaxPageIndicatorCount

        public final void setMaxPageIndicatorCount​(int value)
        设置页面指示器的最大数量。
        参数
        value - 页面指标的数量。 默认值为10。

      • getMaxPageIndicatorCount

        public final int getMaxPageIndicatorCount​()
        返回页面指示符的最大数量。
        结果
        页面指标的最大数量

      • maxPageIndicatorCountProperty

        public final IntegerProperty maxPageIndicatorCountProperty​()
        用于此分页控件的页面指示符的最大数量。 如果值小于1或大于pageCount ，则最大页面指标将保持不变。 如果maxPageIndicatorCount不适合，页面指标的数量将减少到适合控件。 默认为10页指示。
        另请参见：
        getMaxPageIndicatorCount() ， setMaxPageIndicatorCount(int)

      • setPageCount

        public final void setPageCount​(int value)
        设置页数。
        参数
        value - 页数

      • getPageCount

        public final int getPageCount​()
        返回页数。
        结果
        页数

      • setCurrentPageIndex

        public final void setCurrentPageIndex​(int value)
        设置当前页面索引。
        参数
        value - 当前页索引。

      • getCurrentPageIndex

        public final int getCurrentPageIndex​()
        返回当前页面索引。
        结果
        当前页面索引

      • currentPageIndexProperty

        public final IntegerProperty currentPageIndexProperty​()
        要为此分页控件显示的当前页面索引。 如果值小于0，则第一页将是当前页面。同样，如果值大于pageCount ，则最后一页将是当前页面。第一页的默认值为0。

        因为页面指标设置当前页面索引，所以currentPageIndex属性只允许双向绑定。 bind方法抛出UnsupportedOperationException。

        另请参见：
        getCurrentPageIndex() ， setCurrentPageIndex(int)

      • 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时，currentPageIndex不会改变。 如果没有页面出厂设置，默认值为null。
        另请参见：
        getPageFactory() ， setPageFactory(Callback)

      • createDefaultSkin

        protected Skin<?> createDefaultSkin​()
        为此控件创建一个新的默认皮肤实例。 如果没有通过CSS -fx-skin提供皮肤或者在具有setSkin(...)的子类中显式设置，则调用此控件创建皮肤。
        重写：
        createDefaultSkin在 Control
        结果
        此控件的默认皮肤的新实例。 如果为null，则控件将没有皮肤，除非由css提供。

      • getClassCssMetaData

        public static List<CssMetaData<? extends Styleable,?>> getClassCssMetaData​()
        结果
        与此类相关联的CssMetaData可能包括其类的CssMetaData。
        从以下版本开始：
        JavaFX 8.0