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

public static final int UNKNOWN_NUMBER_OF_PAGES

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

メソッドの詳細

getNumberOfPages

public int getNumberOfPages()

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

戻り値:

この Pageable 内のページ数

getPageFormat

public PageFormat getPageFormat(int pageIndex)
                         throws IndexOutOfBoundsException

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

パラメータ:

pageIndex - PageFormat を要求するページのゼロから始まるインデックス

戻り値:

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

例外:

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

getPrintable

public Printable getPrintable(int pageIndex)
                       throws IndexOutOfBoundsException

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

パラメータ:

pageIndex - Printable を要求するページのゼロから始まるインデックス

戻り値:

ページを描画する Printable

例外:

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