javax.print

インタフェースDocPrintJob

既知のすべてのサブインタフェース:

CancelablePrintJob, MultiDocPrintJob

public interface DocPrintJob

このインタフェースは、ジョブ属性セットを保持する指定されたドキュメントを印刷可能な印刷ジョブを表します。このインタフェースを実装するオブジェクトは、印刷サービスから取得できます。

メソッドのサマリー

修飾子と型	メソッドと説明
void	addPrintJobAttributeListener(PrintJobAttributeListener listener, PrintJobAttributeSet attributes) 指定された属性の変更用のリスナーを登録します。
void	addPrintJobListener(PrintJobListener listener) この印刷ジョブ時に発生するイベントのリスナーを登録します。
PrintJobAttributeSet	getAttributes() このPrint Jobの印刷属性セットを取得します。
PrintService	getPrintService() この印刷ジョブ・オブジェクトがバインドされているPrintServiceオブジェクトを判定します。
void	print(Doc doc, PrintRequestAttributeSet attributes) ドキュメントを指定されたジョブ属性で印刷します。
void	removePrintJobAttributeListener(PrintJobAttributeListener listener) この印刷ジョブから属性リスナーを削除します。
void	removePrintJobListener(PrintJobListener listener) この印刷ジョブからリスナーを削除します。

メソッドの詳細

getPrintService

PrintService getPrintService()

この印刷ジョブ・オブジェクトがバインドされているPrintServiceオブジェクトを判定します。

戻り値:

PrintServiceオブジェクト。

getAttributes

PrintJobAttributeSet getAttributes()

このPrint Jobの印刷属性セットを取得します。返される属性セット・オブジェクトは変更できません。返される属性セット・オブジェクトは、このPrint Jobの属性セットのgetAttributes()メソッド呼出し時の「スナップショット」です。つまり、このPrint Jobの属性セットの内容が将来変更されても、返される属性セット・オブジェクトの内容は更新されません。属性値の変更を検出するには、getAttributes()を再度呼び出して、新規属性セットを以前の属性セットと比較します。もう1つの方法として、印刷ジョブ・イベントのリスナーを登録することもできます。戻り値は、空のセットでもかまいませんが、nullにはできません。

戻り値:

印刷ジョブ属性

addPrintJobListener

void addPrintJobListener(PrintJobListener listener)

この印刷ジョブ時に発生するイベントのリスナーを登録します。listenerがnullの場合、例外はスローされず、何も処理は行われません。リスナーが登録済みの場合、再度登録されます。

パラメータ:

listener - リスナー・インタフェースを実装するオブジェクト

関連項目:

removePrintJobListener(javax.print.event.PrintJobListener)

removePrintJobListener

void removePrintJobListener(PrintJobListener listener)

この印刷ジョブからリスナーを削除します。引数で指定されたリスナーが以前にこのコンポーネントに追加されたことがない場合、このメソッドは何も実行せず、例外もスローしません。listenerがnullの場合、例外はスローされず、何も処理は行われません。リスナーが複数回登録されている場合、登録の1つだけが削除されます。

パラメータ:

listener - リスナー・インタフェースを実装するオブジェクト

関連項目:

addPrintJobListener(javax.print.event.PrintJobListener)

addPrintJobAttributeListener

void addPrintJobAttributeListener(PrintJobAttributeListener listener,
                                  PrintJobAttributeSet attributes)

指定された属性の変更用のリスナーを登録します。listenerがnullの場合、例外はスローされず、何も処理は行われません。このジョブが報告する属性更新を判別するため、クライアントはgetAttributes()を呼び出して、リスナーに報告するような重要なサブセットを識別できます。特定のジョブ属性の変更の更新を期待するクライアントは、それが該当するセットであることを確認する必要があります。ただし、属性の更新は、変更が行われ、ジョブがそれを検出した場合のみ実行されます。更新は、ジョブによるバッチ処理の対象になる場合もあります。印刷ジョブの処理で発生するオーバーヘッドを最小限に抑えるため、変更が行われる可能性の高い属性のサブセットのみで待機を行うことをお薦めします。指定されたセットが空の場合、属性の更新はリスナーに報告されません。属性セットがnullの場合、ジョブがサポートするすべての動的属性で待機することを意味します。このため、ジョブが属性の更新を1つも報告できない場合、更新通知は一切行われません。リスナーが登録済みの場合、再度登録されます。

パラメータ:

listener - リスナー・インタフェースを実装するオブジェクト

attributes - ジョブによって決定された待機対象の属性、または変更可能なすべての属性を意味するnull。

関連項目:

removePrintJobAttributeListener(javax.print.event.PrintJobAttributeListener)

removePrintJobAttributeListener

void removePrintJobAttributeListener(PrintJobAttributeListener listener)

この印刷ジョブから属性リスナーを削除します。引数で指定されたリスナーが以前にこのコンポーネントに追加されたことがない場合、このメソッドは何も実行せず、例外もスローしません。リスナーがnullの場合、例外はスローされず、アクションは実行されません。リスナーが複数回登録されている場合(それが異なる属性セットに対してであっても)、どのリスナーが削除されるかは保証されません。

パラメータ:

listener - リスナー・インタフェースを実装するオブジェクト

関連項目:

addPrintJobAttributeListener(javax.print.event.PrintJobAttributeListener, javax.print.attribute.PrintJobAttributeSet)

print

void print(Doc doc,
           PrintRequestAttributeSet attributes)
    throws PrintException

ドキュメントを指定されたジョブ属性で印刷します。このメソッドは、指定された印刷ジョブで一度だけ呼び出す必要があります。このメソッドを再度呼び出しても、新規ジョブがプリンタにスプールされることはありません。サービス実装は、サービス割り込みおよび復元のポリシーを定義します。印刷メソッドの復帰時に、異なるスレッドで印刷が非同期に発生したなどの理由で、印刷が完了していない場合があります。成功または失敗を監視するアプリケーション・クライアントは、PrintJobListenerを登録する必要があります。

印刷サービスの実装者は、クライアントdocから取得したすべての印刷データ・ストリーム(ReaderまたはInputStream実装)を閉じる必要があります。堅牢なクライアントの中には、これを検証するものもあります。DocFlavorを出力できない場合、常に例外が生成されます。

パラメータ:

doc - 印刷するドキュメント。このPrintJobがサポートするフレーバでなければならない。

attributes - この印刷ジョブに適用するジョブ属性。このパラメータがnullの場合、デフォルト属性が使用される。

例外:

PrintException - この例外によって、原因をより正確に記述するインタフェースが実装されることもある

• FlavorException。ドキュメントにこの印刷ジョブでサポートされないフレーバが含まれている場合
• AttributeException。この印刷ジョブに有効でない属性が1つ以上ある場合