java.awt.print
インタフェース Printable

public interface Printable

Printable インタフェースは、ページを描画する印刷システムによって呼び出される、現在のページペインタの print メソッドによって実装されます。Pageable を作成する場合は、PageFormat のインスタンスと、このインタフェースを実装するインスタンスのペアを使用して各ページを記述します。Printable を実装するインスタンスは、ページのグラフィックを印刷するために呼び出されます。

関連項目:

Pageable, PageFormat, PrinterJob

フィールドの概要

static int	NO_SUCH_PAGE pageIndex が大き過ぎるため要求されたページが存在しないことを通知するために print メソッドによって返されます。
static int	PAGE_EXISTS 描画された要求ページを通知するために print(Graphics, PageFormat, int) メソッドによって返されます。

メソッドの概要

int	print(Graphics graphics, PageFormat pageFormat, int pageIndex) 指定されたインデックスにあるページを、指定された書式で、指定された Graphics コンテキストに印刷します。

フィールドの詳細

PAGE_EXISTS

public static final int PAGE_EXISTS

描画された要求ページを通知するために print(Graphics, PageFormat, int) メソッドによって返されます。

NO_SUCH_PAGE

public static final int NO_SUCH_PAGE

pageIndex が大き過ぎるため要求されたページが存在しないことを通知するために print メソッドによって返されます。

メソッドの詳細

print

public int print(Graphics graphics,
                 PageFormat pageFormat,
                 int pageIndex)
          throws PrinterException

指定されたインデックスにあるページを、指定された書式で、指定された Graphics コンテキストに印刷します。PrinterJob は Printable インタフェースを呼び出して、graphics で指定されたコンテキストにページが描画されるように要求します。描画されるページの書式は、pageFormat で指定します。pageIndex では、描画されるページのゼロから始まるインデックスを指定します。指定されたページが存在しない場合、このメソッドは NO_SUCH_PAGE を返します。存在する場合は、PAGE_EXISTS が返されます。Graphics クラスまたはサブクラスは、PrinterGraphics インタフェースを実装して追加情報を提供します。Printable オブジェクトが印刷を中断した場合は、PrinterException がスローされます。

パラメータ:

graphics - ページが描画されるコンテキスト

pageFormat - 描画されるページのサイズと印刷方向

pageIndex - 描画されるページのゼロから始まるインデックス

戻り値:

ページの描画に成功した場合は PAGE_EXISTS、pageIndex で指定されたページが存在しない場合は NO_SUCH_PAGE

例外:

PrinterException - 印刷が中断された場合