java.awt.print
クラス PrinterJob

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

public abstract class PrinterJob

extends Object

PrinterJob クラスは、印刷を制御する主要なクラスです。アプリケーションはこのクラスのメソッドを呼び出して、ジョブを設定し、必要に応じて印刷のダイアログを呼び出し、そのあとジョブのページを印刷します。

コンストラクタの概要

PrinterJob()
PrinterJob オブジェクトの作成には、static メソッドの getPrinterJob を使用してください。

メソッドの概要

abstract void	cancel() 実行中の印刷ジョブを取り消します。
PageFormat	defaultPage() 新しい PageFormat のインスタンスを生成し、デフォルトのサイズと印刷方向に設定します。
abstract PageFormat	defaultPage(PageFormat page) PageFormat 引数を複製し、その複製を変更してデフォルトのページサイズと印刷方向を記述します。
abstract int	getCopies() 印刷する部数を取得します。
abstract String	getJobName() 印刷するドキュメントの名前を取得します。
static PrinterJob	getPrinterJob() PrinterJob を作成して返します。
abstract String	getUserName() 印刷を行うユーザの名前を取得します。
abstract boolean	isCancelled() 印刷ジョブが実行中であり、次の機会に取り消される予定の場合は true、そうでない場合は false を返します。
abstract PageFormat	pageDialog(PageFormat page) PageFormat のインスタンスを変更するためのダイアログを表示します。
abstract void	print() ページのセットを印刷します。
abstract boolean	printDialog() ユーザに対して、印刷ジョブのプロパティを変更するためのダイアログを表示します。
abstract void	setCopies(int copies) 印刷する部数を設定します。
abstract void	setJobName(String jobName) 印刷するドキュメントの名前を設定します。
abstract void	setPageable(Pageable document) document に対して、ページ数や、Pageable のインスタンス (document) に保持されている各ページの PageFormat および Printable を問い合わせます。
abstract void	setPrintable(Printable painter) ページを描画するために painter を呼び出します。
abstract void	setPrintable(Printable painter, PageFormat format) 指定された format でページを描画するために painter を呼び出します。
abstract PageFormat	validatePage(PageFormat page) PageFormat 引数を、この PrinterJob オブジェクトの現在のプリンタで使用できるように変更します。

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

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

コンストラクタの詳細

PrinterJob

public PrinterJob()

PrinterJob オブジェクトの作成には、static メソッドの getPrinterJob を使用してください。

メソッドの詳細

getPrinterJob

public static PrinterJob getPrinterJob()

PrinterJob を作成して返します。

戻り値:

新しい PrinterJob

setPrintable

public abstract void setPrintable(Printable painter)

ページを描画するために painter を呼び出します。この PrinterJob によって印刷されるドキュメント内のページは、painter で指定された Printable オブジェクトによって描画されます。各ページの PageFormat は、デフォルトのページ書式になります。

パラメータ:

painter - ドキュメントの各ページを描画する Printable

setPrintable

public abstract void setPrintable(Printable painter,
                                  PageFormat format)

指定された format でページを描画するために painter を呼び出します。この PrinterJob によって印刷されるドキュメント内のページは、painter で指定された Printable オブジェクトによって描画されます。各ページの PageFormat は、format で指定されたページ書式になります。

パラメータ:

painter - ドキュメントの各ページを描画するために呼び出す Printable

format - 印刷される各ページのサイズと印刷方向

setPageable

public abstract void setPageable(Pageable document)
                          throws NullPointerException

document に対して、ページ数や、Pageable のインスタンス (document) に保持されている各ページの PageFormat および Printable を問い合わせます。

パラメータ:

document - 印刷されるページ。null を渡すことはできない

例外:

NullPointerException - 渡された Pageable が null である場合

関連項目:

PageFormat, Printable

printDialog

public abstract boolean printDialog()

ユーザに対して、印刷ジョブのプロパティを変更するためのダイアログを表示します。

戻り値:

ユーザがダイアログを取り消さない場合は true、そうでない場合は false

pageDialog

public abstract PageFormat pageDialog(PageFormat page)

PageFormat のインスタンスを変更するためのダイアログを表示します。引数 page は、ページ設定ダイアログのコントロールを初期化するために使用されます。ユーザがダイアログを取り消すと、このメソッドは元の page オブジェクトを変更しないで返します。ユーザがダイアログを了解すると、このメソッドは変更内容を示す新しい PageFormat を返します。どちらの場合にも、元の page オブジェクトは変更されません。

パラメータ:

page - 変更のためにユーザに表示されるデフォルトの PageFormat

戻り値:

ダイアログが取り消された場合は、元の page オブジェクト。ダイアログが了解された場合は、ユーザが示した書式を持つ新しい PageFormat オブジェクト

導入されたバージョン:

JDK1.2

defaultPage

public abstract PageFormat defaultPage(PageFormat page)

PageFormat 引数を複製し、その複製を変更してデフォルトのページサイズと印刷方向を記述します。

パラメータ:

page - 複製および変更される PageFormat

戻り値:

デフォルトの PageFormat を記述するために変更された page の複製

defaultPage

public PageFormat defaultPage()

新しい PageFormat のインスタンスを生成し、デフォルトのサイズと印刷方向に設定します。

戻り値:

デフォルトのサイズと印刷方向に設定された PageFormat

validatePage

public abstract PageFormat validatePage(PageFormat page)

PageFormat 引数を、この PrinterJob オブジェクトの現在のプリンタで使用できるように変更します。

パラメータ:

page - このページの記述は複製されて、その設定がこの PrinterJob で使用できるように変更される

戻り値:

PageFormat パラメータから複製され、この PrinterJob に合わせて変更された PageFormat

print

public abstract void print()
                    throws PrinterException

ページのセットを印刷します。

例外:

PrinterException - プリンタシステムのエラーが原因でジョブが停止した場合

関連項目:

Book, Pageable, Printable

setCopies

public abstract void setCopies(int copies)

印刷する部数を設定します。

パラメータ:

copies - 印刷する部数

getCopies

public abstract int getCopies()

印刷する部数を取得します。

戻り値:

印刷する部数

getUserName

public abstract String getUserName()

印刷を行うユーザの名前を取得します。

戻り値:

印刷を行うユーザの名前

setJobName

public abstract void setJobName(String jobName)

印刷するドキュメントの名前を設定します。ドキュメントの名前に null を指定することはできません。

パラメータ:

jobName - 印刷するドキュメントの名前

getJobName

public abstract String getJobName()

印刷するドキュメントの名前を取得します。

戻り値:

印刷するドキュメントの名前

cancel

public abstract void cancel()

実行中の印刷ジョブを取り消します。print が呼び出されている場合に、まだ復帰していない状態のときは、このメソッドはジョブを次の機会に取り消すように通知します。実行中の印刷ジョブがない場合には、何も行いません。

isCancelled

public abstract boolean isCancelled()

印刷ジョブが実行中であり、次の機会に取り消される予定の場合は true、そうでない場合は false を返します。

戻り値:

実行中のジョブが取り消される予定の場合は true、そうでない場合は false