パッケージ javax.print.attribute.standard

パッケージ javax.print.attribute.standard には、特定の印刷属性のクラスが含まれています。

参照: 説明

クラスのサマリー

クラス	説明
Chromaticity	Chromaticity クラスは、モノクロまたはカラープリントを指定する列挙型の印刷属性クラスです。
ColorSupported	ColorSupported クラスは、デバイスがフルプロセスカラーとハイライトカラーを含む、あらゆる種類のカラープリントが可能かどうかを識別する列挙型の印刷属性クラスです。
Compression	Compression クラスは、印刷データの圧縮方法を指定する列挙型の印刷属性クラスです。
Copies	Copies クラスは、印刷する部数を指定する整数型の値の印刷属性クラスです。
CopiesSupported	クラス CopiesSupported は、Copies 属性のサポートされる値を与える印刷属性クラス (整数のセット) です。
DateTimeAtCompleted	DateTimeAtCompleted クラスは、Print Job が完了したか、または取消し、中断された日付と時刻を表示する日付と時刻属性の印刷属性クラスです。
DateTimeAtCreation	DateTimeAtCreation クラスは、Print Job が生成された日付と時刻を表示する日付と時刻属性の印刷属性クラスです。
DateTimeAtProcessing	DateTimeAtProcessing クラスは、Print Job が最初に処理を開始した日付と時刻を表示する日付と時刻属性の印刷属性クラスです。
Destination	Destination クラスは、スプールされたプリンタ形式のデータの代替出力先を示すために使用する URI 印刷属性クラスです。
DialogTypeSelection	クラス DialogTypeSelection は、印刷オプションの指定時に使用するユーザーダイアログのタイプを示す印刷属性クラス (列挙型) です。
DocumentName	DocumentName クラスは、ドキュメントの名前を指定するテキスト属性の印刷属性クラスです。
Fidelity	Fidelity クラスは、印刷要求属性を指定するクライアントに対して完全に忠実である必要があるかどうかを示す列挙型の印刷属性クラスです。
Finishings	Finishings クラスは、プリンタが装丁などの仕上処理を、ジョブの印刷ドキュメントのコピーごとに適用するかどうかを示す列挙型の印刷属性クラスです。
JobHoldUntil	JobHoldUntil クラスは、ジョブが印刷の候補となる正確な日付と時刻を指定する日付と時刻属性の印刷属性クラスです。
JobImpressions	JobImpressions クラスは、送信されるドキュメントの印刷データの数の合計数を指定する整数型の値の印刷属性クラスです。
JobImpressionsCompleted	JobImpressionsCompleted クラスは、今までにジョブが完了した印刷データの数を指定する整数型の値の印刷属性クラスです。
JobImpressionsSupported	クラス JobImpressionsSupported は、JobImpressions 属性のサポートされる値を与える印刷属性クラス (整数のセット) です。
JobKOctets	JobKOctets クラスは、K オクテット単位、つまりジョブの処理で要求される 1024 オクテット単位で、ドキュメントの合計サイズを指定する整数型の値の印刷属性クラスです。
JobKOctetsProcessed	JobKOctetsProcessed クラスは、K オクテット単位、つまり 1024 オクテット単位で、今までに処理された印刷データの合計オクテット数を指定する整数型の値の印刷属性クラスです。
JobKOctetsSupported	クラス JobKOctetsSupported は、JobKOctets 属性のサポートされる値を与える印刷属性クラス (整数のセット) です。
JobMediaSheets	JobMediaSheets クラスは、このジョブのために生成されるメディアシートの合計数を指定する整数型の値の印刷属性クラスです。
JobMediaSheetsCompleted	JobMediaSheetsCompleted クラスは、これらのシートが片面または両面に処理されているいないにかかわらず、今までにすべてのジョブに対してマーキングとスタッキングを完了したメディアシートの数を指定する整数型の値の印刷属性クラスです。
JobMediaSheetsSupported	クラス JobMediaSheetsSupported は、JobMediaSheets 属性のサポートされる値を与える印刷属性クラス (整数のセット) です。
JobMessageFromOperator	JobMessageFromOperator クラスは、オペレータ、システム管理者、またはインテリジェントプロセスからエンドユーザーに渡される、ジョブに対してとられた変更などの管理アクションの理由を示すメッセージを提供する、テキスト属性の印刷属性クラスです。
JobName	JobName クラスは、印刷ジョブの名前を指定するテキスト属性の印刷属性クラスです。
JobOriginatingUserName	JobOriginatingUserName は、印刷ジョブを開始したエンドユーザー名を格納するテキスト属性の印刷属性クラスです。
JobPriority	JobPriority は、印刷ジョブの優先順位を指定する、整数値の印刷属性クラスです。
JobPrioritySupported	JobPrioritySupported は、印刷サービスインスタンスが JobPriority 属性をサポートしているかどうかを指定し、サポートされている印刷順位レベル数を指定する、整数値の印刷属性クラスです。
JobSheets	JobSheets は、ジョブの開始時と終了時に印刷するシートがある場合に、そのうちのどれを使用するかを列挙して決定する印刷属性クラスです。
JobState	JobState は印刷ジョブの現在の状態を識別して列挙する印刷属性クラスです。
JobStateReason	JobStateReason はジョブの現在の状態についての追加情報、つまりジョブの JobState 属性をよりわかりやすくする情報を値の列挙として提供する印刷属性クラスです。
JobStateReasons	JobStateReasons はジョブの現在の状態についての追加情報、つまりジョブの JobState 属性をよりわかりやすくする情報を列挙値のセットとして提供する印刷属性クラスです。
Media	Media は印刷する媒体を指定する印刷属性クラスです。
MediaName	MediaName クラスは Media のサブクラスであり、印刷ジョブで使用する媒体名を列挙して指定する印刷属性クラスです。
MediaPrintableArea	MediaPrintableArea は媒体の印刷可能領域と印刷不可能領域を区別する印刷属性です。
MediaSize	MediaSize は縦長に置いた場合の媒体の寸法を 2 次元のサイズ値として示す印刷属性クラスです。X 次元が底辺の長さ、Y 次元が左辺の長さを表します。
MediaSize.Engineering	クラス MediaSize.Engineering には、技術規格媒体の MediaSize 値が含まれています。
MediaSize.ISO	クラス MediaSize.ISO には、ISO 媒体の MediaSize 値が含まれています。
MediaSize.JIS	クラス MediaSize.JIS には、JIS (日本工業規格) 媒体の MediaSize 値が含まれています。
MediaSize.NA	クラス MediaSize.NA には、北米規格媒体の MediaSize 値が含まれています。
MediaSize.Other	クラス MediaSize.Other には、その他の媒体の MediaSize 値が含まれています。
MediaSizeName	MediaSizeName クラスは Media のサブクラスです。
MediaTray	MediaTray クラスは Media のサブクラスです。
MultipleDocumentHandling	MultipleDocumentHandling は、仕上げ処理、および 1 つ以上の出力ストリームページの印刷データと用紙上での配置方法を制御する値を列挙して示す印刷属性クラスです。
NumberOfDocuments	NumberOfDocuments はプリンタがこのジョブに対して受信したドキュメントの数を示す整数値の印刷属性クラスです。ドキュメントの印刷データが実際にプリンタに届いているかどうかは考慮しません。
NumberOfInterveningJobs	NumberOfInterveningJobs は、完了予定時間の昇順、つまり現在スケジュールされている順序でジョブを並べた場合に、このジョブの前にあるジョブの数を整数値で示す印刷属性クラスです。
NumberUp	NumberUp は、選択された媒体の片面に印刷する出力ストリームのページ数を整数で表す印刷属性クラスです。
NumberUpSupported	クラス NumberUpSupported は、NumberUp 属性のサポートされる値を与える印刷属性クラス (整数のセット) です。
OrientationRequested	OrientationRequested は、印刷される出力ストリームページの方向を値の列挙で示す印刷属性クラスです。クライアントが指定する出力ストリームの方向は記述しません。
OutputDeviceAssigned	OutputDeviceAssigned は、サービスがこのジョブを割り当てた出力デバイスを識別する、テキスト属性の印刷属性クラスです。
PageRanges	PageRanges は、プリンタオブジェクトが印刷する各ドキュメントに使用する、出力ストリームの範囲を整数値のセットで表す印刷属性クラスです。
PagesPerMinute	PagesPerMinute は、このプリンタ (シンプレックスモノクロプリンタなど) が 1 分間に生成できるページ数をもっとも近い整数値で表す印刷属性クラスです。
PagesPerMinuteColor	PagesPerMinuteColor は、このプリンタ (シンプレックスカラープリンタなど) が 1 分間に生成できるカラーページ数をもっとも近い整数値で表す印刷属性クラスです。
PDLOverrideSupported	PDLOverrideSupported は、ドキュメントの印刷データに組み込まれた処理命令を、印刷データ外から属性として指定された処理命令でオーバーライドできるかどうかを列挙して示す印刷属性クラスです。
PresentationDirection	PresentationDirection は NumberUp 属性とともに使用され、複数の出力ストリームページを選択された媒体の片面にまとめて印刷する場合のレイアウトを列挙して示す印刷属性クラスです。
PrinterInfo	PrinterInfo はプリンタに関する説明的な情報を提供するテキスト属性の印刷属性クラスです。
PrinterIsAcceptingJobs	PrinterIsAcceptingJobs はプリンタが現在ジョブを受け入れ可能かどうかを値の列挙で示す印刷属性クラスです。
PrinterLocation	PrinterLocation は、デバイスの置かれている場所を識別するテキスト属性の印刷属性クラスです。
PrinterMakeAndModel	PrinterMakeAndModel はプリンタのメーカーとモデルについての情報を提供するテキスト属性の印刷属性クラスです。
PrinterMessageFromOperator	PrinterMessageFromOperator は、オペレータ、システム管理者、またはインテリジェントプロセスからエンドユーザーに渡される、プリンタ自体またはそのステータスについての情報メッセージを提供する、テキスト属性の印刷属性クラスです。プリンタが利用できない理由、利用できるようになる予定の時期などの情報が提供されます。
PrinterMoreInfo	PrinterMoreInfo は、このプリンタ固有の追加情報を取得するために使用される URI の印刷属性クラスです。
PrinterMoreInfoManufacturer	PrinterMoreInfoManufacturer は、この型のデバイスについての追加情報を取得するために使用する URI の印刷属性クラスです。
PrinterName	PrinterName は、プリンタ名を指定するテキスト属性の印刷属性クラスです。
PrinterResolution	PrinterResolution は、プリンタがサポートしているか、または印刷ジョブが使用する正確な解像度を指定する印刷属性クラスです。
PrinterState	PrinterState はプリンタの現在の状態を識別して列挙する印刷属性クラスです。
PrinterStateReason	PrinterStateReason はプリンタの現在の状態についての追加情報、つまりプリンタの PrinterState 属性をよりわかりやすくする情報を値の列挙として提供する印刷属性クラスです。
PrinterStateReasons	PrinterStateReasons はプリンタの現在の状態についての追加情報、つまりプリンタの PrinterState 属性をよりわかりやすくする情報を列挙値のセットとして提供する印刷属性クラスです。
PrinterURI	PrinterURI はプリンタの大域的に一意な名前を表す URI の印刷属性クラスです。
PrintQuality	PrintQuality はプリンタがジョブに対して使用する印刷品質を列挙して指定する印刷属性クラスです。
QueuedJobCount	QueuedJobCount は、JobState が PENDING、PENDING_HELD、PROCESSING、または PROCESSING_STOPPED のいずれかであるプリンタのジョブ数を整数値で示す印刷属性クラスです。
ReferenceUriSchemesSupported	ReferenceUriSchemesSupported は、URI 上の印刷データ取得にプリンタが使用できる、「http:」や「ftp:」などの URI スキームを列挙して示す印刷属性クラスです。
RequestingUserName	RequestingUserName は、印刷ジョブを送信したエンドユーザー名を指定するテキスト属性の印刷属性クラスです。
Severity	クラス Severity は、PrinterStateReason 属性の重要度を示す印刷属性クラス (列挙型) です。
SheetCollate	SheetCollate は、ドキュメントを 2 部以上印刷することが Copies 属性で指定されている場合、そのジョブの印刷ドキュメントを部単位で印刷するかどうかを列挙して指定する印刷属性クラスです。
Sides	Sides は、選択された媒体の各面への、出力ストリームページの配置方法、つまり印刷データの生成方法を値の列挙で指定する印刷属性クラスです。

パッケージ javax.print.attribute.standard の説明

パッケージ javax.print.attribute.standard には、特定の印刷属性のクラスが含まれています。親パッケージの javax.print.attribute は、Java Print Service の属性の型とそれらが属性セットに収集される方法を記述するクラスとインタフェースを提供します。

属性は印刷サービスが提供可能な印刷機能を表します。印刷サービスがすべての属性をサポートする保証はありません。サポートされる属性の値についても、そのすべてをサポートする保証はありません。

API 側では特定の属性のサポートを必須としますが、それ以外はオプションであり、サポートするかどうかはサービス側で選択できます。受け入れ可能な値は属性によって異なり、特定の属性に対して特定の値が必須になります。それ以外の属性値は属性自体と同様にオプションであり、サポートするかどうかはサービス側で選択できます。これらのサポート条件は各属性クラスのドキュメントに記述されます。

javax.print.attribute.standard パッケージは、印刷ドメインで広く使用される標準印刷属性と標準印刷属性値を含みます。印刷サービスのベンダーは、標準の属性に加えて、ベンダー固有の印刷属性を提供でき、またたとえば、サブクラスで標準印刷属性にベンダー固有の値を追加し、拡張できます。クライアント側でこのような追加属性や拡張属性を使用可能にするためには、ベンダーは新しい属性クラスを公開する必要があります。

標準属性クラスの多くは、javax.print.attribute パッケージの抽象構文クラスの 1 つを拡張したものです。これらの抽象構文クラスは、それぞれ異なる型を表します。たとえば EnumSyntax クラスは、型保証された列挙を表します。抽象構文クラスは属性値のラッパーを提供します。

属性クラスが EnumSyntax を拡張し、属性の値が IPP 互換の場合、属性の toString メソッドは属性値の IPP 文字列表現を返します。たとえば JobState 属性には「processing-stopped」のような値が返されます。ただし EnumSyntax クラスは拡張可能であるため、ベンダー独自の属性値を定義できます。属性が EnumSyntax クラスを使用し、これらのベンダー定義の値の 1 つに設定される場合、toString メソッドは値の IPP 文字列表現を返しません。

印刷クライアントアプリケーションは、通常 javax.print.attribute.standard パッケージのすべての印刷属性クラスを使用する必要はなく、アプリケーション関連のものだけを使用します。

javax.print.attribute.standard パッケージの属性クラスは、2000 年 9 月に制定された、インターネット RFC ドキュメント「RFC 2911 Internet Printing Protocol/1.1: Model and Semantics」で定義されている Internet Printing Protocol (IPP) 属性に基づいています。詳細は、RFC 2911 を参照してください。各属性クラスの説明は主に上記のドキュメントからの引用です。これらのドキュメントの作者にこの場を借りて感謝いたします。

属性の構成

印刷属性には、ドキュメント属性、印刷要求属性、印刷ジョブ属性、印刷サービス属性、サポート値属性の 5 種類があります。

ドキュメント属性

ドキュメント属性は個々のドキュメント、およびそのドキュメントに適用される印刷ジョブ設定を指定します。ドキュメント属性クラスは DocAttribute インタフェースを実装します。ドキュメント属性は DocAttributeSet で使用できます。

印刷要求属性

印刷要求属性は、印刷ジョブ全体、およびそのジョブのすべてのドキュメントに適用される設定を指定します。印刷要求属性クラスは PrintRequestAttribute インタフェースを実装します。印刷要求属性は PrintRequestAttributeSet で使用できます。

ドキュメント属性ではあっても印刷要求属性ではない属性があり、このような属性はドキュメントレベルだけで指定できます。逆に印刷要求属性ではあってもドキュメント属性ではない属性もあり、このような属性は印刷要求レベルだけで指定できます。どちらでも指定できる属性もあります。

属性をドキュメントレベルで指定すると、属性はそのドキュメントだけに適用されます。印刷要求レベルで指定すると、ジョブ全体、そのジョブに含まれるすべてのドキュメントに適用されます。両方に指定されている場合、ドキュメントレベルの属性が印刷要求レベルで同じカテゴリに指定された属性をオーバーライドします。

印刷ジョブ属性

印刷ジョブ属性は印刷ジョブのステータスを通知します。印刷ジョブ属性クラスは PrintJobAttribute インタフェースを実装します。印刷ジョブ属性は PrintJobAttributeSet で使用できます。

印刷要求属性および印刷ジョブ属性のどちらとしても指定可能な属性があります。このような属性を印刷要求に追加すると、それ以降の印刷ジョブの特性を指定できます。これらの属性は印刷ジョブの属性セットにも指定されます。印刷ジョブ属性ではあっても印刷要求属性ではない属性は、印刷サービス自体によって印刷ジョブの属性セットに追加されます。

印刷サービス属性

印刷サービス属性は印刷サービスのステータスを通知します。印刷サービス属性クラスは PrintServiceAttribute インタフェースを実装します。印刷サービス属性は PrintServiceAttributeSet で使用できます。

サポート値属性

サポート値属性は、印刷サービスがサポートしている、別の属性に対する正当な値を示します。サポート値属性クラスは SupportedValuesAttribute インタフェースを実装します。ただし、サポート値属性は属性セットには表示されないため、これに対する制限された AttributeSet サブインタフェースはありません。

属性テーブル

次の表はすべての印刷属性のリストです。Attribute インタフェースに加えて、各属性クラスが実装するタグ機能インタフェースも記載され、API での各属性の使用方法を示しています。印刷サービスが、各ドキュメント属性と印刷要求属性の属性カテゴリに対してサポートしている値を示す、サポート値属性クラスがある場合は、SupportedValuesAttribute 列に表示されます。

属性クラス	ドキュメント 属性	印刷 要求 属性	印刷 ジョブ 属性	印刷 サービス 属性	SupportedValuesAttribute
Compression	X
DocumentName	X
Chromaticity	X	X	X
Copies		X	X		CopiesSupported
Finishings	X	X	X
JobHoldUntil		X	X
JobImpressions		X	X		JobImpressionsSupported
JobKOctets		X	X		JobKOctetsSupported
JobMediaSheets		X	X		JobMediaSheetsSupported
JobName		X	X
JobPriority		X	X		JobPrioritySupported
JobSheets		X	X
Media	X	X	X
MediaSize
MultipleDocumentHandling		X	X
NumberUp	X	X	X		NumberUpSupported
OrientationRequested	X	X	X
PageRanges	X	X	X
PresentationDirection	X	X	X
PrinterResolution	X	X	X
PrintQuality	X	X	X
RequestingUserName		X	X
SheetCollate	X	X	X
Sides	X	X	X
DateTimeAtCompleted			X
DateTimeAtCreation			X
DateTimeAtProcessing			X
JobImpressionsCompleted			X
JobKOctetsProcessed			X
JobMediaSheetsCompleted			X
JobMessageFromOperator			X
JobOriginatingUserName			X
JobState			X
JobStateReasons ゼロ以上が含まれる			X
-- JobStateReason
NumberOfDocuments			X
NumberOfInterveningJobs			X
OutputDeviceAssigned			X
ColorSupported				X
PagesPerMinute				X
PagesPerMinuteColor				X
PDLOverrideSupported				X
PrinterIsAcceptingJobs				X
PrinterInfo				X
PrinterLocation				X
PrinterMessageFromOperator				X
PrinterMakeAndModel				X
PrinterMoreInfo				X
PrinterMoreInfoManufacturer				X
PrinterName				X
PrinterState				X
PrinterStateReasons ゼロ以上が含まれる				X
-- PrinterStateReason
-- Severity
QueuedJobCount				X
ReferenceUriSchemesSupported

注: javax.print API では、メソッドへの null 参照パラメータ指定は、ドキュメントに意味が明記されている場合を除いては不正であることに注意してください。これに反する使用は無効なコーディングであり、すぐにまたはあとで実行時の例外が生ずる結果になります。IllegalArgumentException および NullPointerException は、このような場合の典型的で許容できる実行時の例外の事例です。

導入されたバージョン:

1.4