java.awt.print
クラス Book

java.lang.Object
  |
  +--java.awt.print.Book

すべての実装インタフェース:

Pageable

public class Book

extends Object

implements Pageable

Book クラスは、ドキュメントを表します。ドキュメント内のページには、ページ書式やページペインタが異なるページが含まれていてもかまいません。このクラスは、PrinterJob と情報をやり取りするために、Pageable インタフェースを使用します。

関連項目:

Pageable, PrinterJob

インタフェース java.awt.print.Pageable から継承したフィールド

UNKNOWN_NUMBER_OF_PAGES

コンストラクタの概要

Book()
新しい空の Book を作成します。

メソッドの概要

void	append(Printable painter, PageFormat page) この Book の末尾に 1 ページだけ追加します。
void	append(Printable painter, PageFormat page, int numPages) numPages で指定された数のページをこの Book の末尾に追加します。
int	getNumberOfPages() この Book に含まれるページ数を返します。
PageFormat	getPageFormat(int pageIndex) pageIndex で指定されたページの PageFormat を返します。
Printable	getPrintable(int pageIndex) pageIndex で指定されたページの描画処理に責任を持つ Printable のインスタンスを返します。
void	setPage(int pageIndex, Printable painter, PageFormat page) 指定されたページ番号の PageFormat および Painter を設定します。

クラス java.lang.Object から継承したメソッド

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

コンストラクタの詳細

Book

public Book()

新しい空の Book を作成します。

メソッドの詳細

getNumberOfPages

public int getNumberOfPages()

この Book に含まれるページ数を返します。

定義:

インタフェース Pageable 内の getNumberOfPages

戻り値:

この Book に含まれるページ数

getPageFormat

public PageFormat getPageFormat(int pageIndex)
                         throws IndexOutOfBoundsException

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

定義:

インタフェース Pageable 内の getPageFormat

パラメータ:

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

戻り値:

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

例外:

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

getPrintable

public Printable getPrintable(int pageIndex)
                       throws IndexOutOfBoundsException

pageIndex で指定されたページの描画処理に責任を持つ Printable のインスタンスを返します。

定義:

インタフェース Pageable 内の getPrintable

パラメータ:

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

戻り値:

ページを描画する Printable

例外:

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

setPage

public void setPage(int pageIndex,
                    Printable painter,
                    PageFormat page)
             throws IndexOutOfBoundsException

指定されたページ番号の PageFormat および Painter を設定します。

パラメータ:

pageIndex - ペインタおよび書式を変更するページのゼロから始まるインデックス

painter - ページを描画する Printable のインスタンス

page - ページのサイズと印刷方向

例外:

IndexOutOfBoundsException - 指定されたページがまだこの Book 内に存在しない場合

NullPointerException - painter または page 引数が null の場合

append

public void append(Printable painter,
                   PageFormat page)

この Book の末尾に 1 ページだけ追加します。

パラメータ:

painter - ページを描画する Printable のインスタンス

page - ページのサイズと印刷方向

例外:

NullPointerException - painter または page 引数が null の場合

append

public void append(Printable painter,
                   PageFormat page,
                   int numPages)

numPages で指定された数のページをこの Book の末尾に追加します。追加するページは、page で指定された書式に関連付けられます。

パラメータ:

painter - ページを描画する Printable のインスタンス

page - ページのサイズと印刷方向

numPages - この Book に追加するページの数

例外:

NullPointerException - painter 引数 または page 引数が null の場合