java.awt.print

インタフェース Pageable

既知のすべての実装クラス:

Book

public interface Pageable

Pageable を実装したクラスは、印刷されるページのセットを表します。Pageable オブジェクトは、セット内のページの総数のほかに、指定されたページの PageFormat および Printable を返します。

関連項目:

PageFormat、Printable

フィールドのサマリー

フィールド

修飾子と型	フィールドと説明
static int	UNKNOWN_NUMBER_OF_PAGES この定数は、Pageable を実装したクラスがセット内のページ数を認識しないときに、getNumberOfPages メソッドから返されます。

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
int	getNumberOfPages() セット内のページ数を返します。
PageFormat	getPageFormat(int pageIndex) pageIndex で指定されたページの PageFormat を返します。
Printable	getPrintable(int pageIndex) pageIndex で指定されたページの描画処理に対応する Printable のインスタンスを返します。

フィールドの詳細

UNKNOWN_NUMBER_OF_PAGES

static final int UNKNOWN_NUMBER_OF_PAGES

この定数は、Pageable を実装したクラスがセット内のページ数を認識しないときに、getNumberOfPages メソッドから返されます。

関連項目:

定数フィールド値

メソッドの詳細

getNumberOfPages

int getNumberOfPages()

セット内のページ数を返します。高度な印刷機能を有効にするには、Pageable を実装したクラスが定数 UNKNOWN_NUMBER_OF_PAGES ではなく、実際のページ数を返すようにしてください。

戻り値:

この Pageable 内のページ数。

getPageFormat

PageFormat getPageFormat(int pageIndex)
                         throws IndexOutOfBoundsException

pageIndex で指定されたページの PageFormat を返します。

パラメータ:

pageIndex - PageFormat が要求されているページのゼロから始まるインデックス

戻り値:

サイズおよび印刷方向を記述する PageFormat。

例外:

IndexOutOfBoundsException - Pageable に要求されたページが含まれていない場合。

getPrintable

Printable getPrintable(int pageIndex)
                       throws IndexOutOfBoundsException

pageIndex で指定されたページの描画処理に対応する Printable のインスタンスを返します。

パラメータ:

pageIndex - Printable が要求されているページのゼロから始まるインデックス

戻り値:

ページを描画する Printable。

例外:

IndexOutOfBoundsException - Pageable に要求されたページが含まれていない場合。