モジュール javafx.controls
パッケージ javafx.scene.control

クラスPagination

  • すべての実装されたインタフェース:
    Styleable, EventTarget, Skinnable
    @DefaultProperty("pages")
public class Pagination
extends Control

    Paginationコントロールは、1つのコンテンツを小さい部分に分割した複数のページ間の移動に使用されます。

    ページ・インジケータのスタイル設定

    コントロールは、スタイル・クラスSTYLE_CLASS_BULLETを設定することで、数値ページ・インジケータまたは箇条書きスタイル・インジケータを表示するようにカスタマイズできます。 maxPageIndicatorCountPropertyを使用すると、ページ・インジケータの最大数を変更できます。 プロパティ値は、-fx-max-page-indicator-countを使用してCSS経由で変更することもできます。

    ページ数

    pageCountPropertyでは、このページ区切りコントロールが保持するページ数を制御します。 ページ数がわからない場合は、INDETERMINATEをページ数として使用する必要があります。

    ページ・ファクトリ

    pageFactoryPropertyは、アプリケーションまたはユーザーがページを選択した場合に呼び出されるコールバック関数です。 ページ区切りコントロールの機能には、この関数が必要です。 コールバック関数は、選択されたページのコンテンツをロードして返します。 選択したページ・インデックスが存在しない場合、nullが返されます。

    ページ区切りコントロールの作成:

    ページ数が10ページで、各ページに10個のハイパーリンクが含まれているページ区切りコントロールを作成する方法の簡単な例。 

     
   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

    • プロパティの詳細

      • maxPageIndicatorCount

        public final IntegerProperty maxPageIndicatorCountProperty
        このページ区切りコントロールに使用するページ・インジケータの最大数。 この値が1未満かpageCountよりも大きい場合、ページ・インジケータの最大数は変更されません。 maxPageIndicatorCountが適合しない場合、ページ・インジケータの数はコントロールに合うように削減されます。 デフォルトは10ページ・インジケータです。
        関連項目:
        getMaxPageIndicatorCount()、setMaxPageIndicatorCount(int)

      • pageCount

        public final IntegerProperty pageCountProperty
        このページ区切りコントロールのページ数。 この値は1以上でなければなりません。 総ページ数が不明な場合は、INDETERMINATEをページ数として使用する必要があります。 デフォルトは、INDETERMINATEページ数です。
        関連項目:
        getPageCount()、setPageCount(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が返されます。 nullが返された場合、currentPageIndexは変更されません。 ページ・ファクトリ設定がない場合、デフォルトはnullです。
        関連項目:
        getPageFactory()、setPageFactory(Callback)

    • フィールドの詳細

      • STYLE_CLASS_BULLET

        public static final String STYLE_CLASS_BULLET
        数値ページ・インジケータを箇条書きインジケータに変更するスタイル・クラス。
        関連項目:
        定数フィールド値

    • コンストラクタの詳細

      • 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()
        ページ数を返します。
        戻り値:
        ページ数

      • pageCountProperty

        public final IntegerProperty pageCountProperty()
        このページ区切りコントロールのページ数。 この値は1以上でなければなりません。 総ページ数が不明な場合は、INDETERMINATEをページ数として使用する必要があります。 デフォルトは、INDETERMINATEページ数です。
        関連項目:
        getPageCount()、setPageCount(int)

      • 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が返されます。 nullが返された場合、currentPageIndexは変更されません。 ページ・ファクトリ設定がない場合、デフォルトはnullです。
        関連項目:
        getPageFactory()、setPageFactory(Callback)

      • getClassCssMetaData

        public static List<CssMetaData<? extends Styleable,?>> getClassCssMetaData()
        戻り値:
        このクラスに関連付けられたCssMetaData。スーパークラスのCssMetaDataを含むことがあります。
        導入されたバージョン:
        JavaFX 8.0

      • getControlCssMetaData

        public List<CssMetaData<? extends Styleable,?>> getControlCssMetaData()
        オーバーライド:
        getControlCssMetaData 、クラス: Control
        戻り値:
        コントロールのCSSでスタイル設定可能なプロパティの変更不可能なリスト
        導入されたバージョン:
        JavaFX 8.0