javax.print.attribute.standard
クラス PageRanges

java.lang.Object
  javax.print.attribute.SetOfIntegerSyntax
      javax.print.attribute.standard.PageRanges

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

Serializable, Cloneable, Attribute, DocAttribute, PrintJobAttribute, PrintRequestAttribute

public final class PageRanges
extends SetOfIntegerSyntax
implements DocAttribute, PrintRequestAttribute, PrintJobAttribute

PageRanges は、プリンタオブジェクトが印刷する各ドキュメントに使用する、出力ストリームの範囲を整数値のセットで表す印刷属性クラスです。ドキュメントに存在しないものとされるページには何も印刷されません。属性は、たとえばある種のワードプロセッサアプリケーションのヘッダまたはフッタに設定される、アプリケーションでカウントされるページではなく、「出力ストリーム」のページに関連付けられます。

多くの場合、印刷される正確なページはデバイスドライバで生成されるため、この属性は不要です。ただし、すでに書式が設定されて保存されているドキュメントを印刷する時に、エンドユーザがそのドキュメントの一部のページだけを要求する場合があります。この場合にページ範囲として n-m が指定されると、n ページから m ページまでが印刷されます。

PageRanges 属性が印刷ジョブに指定されていない場合、ドキュメントのすべてのページが印刷されます。つまり、PageRanges 属性の既定値は {{1, Integer.MAX_VALUE}} になります。

複数ドキュメント印刷ジョブ (複数のドキュメントで構成される 1 つのジョブ) に対する PageRanges 属性の効果は、この値がすべてのドキュメントで同じに設定されているかどうか (または、異なるドキュメントで異なった値が設定されているかどうか) ということと、MultipleDocumentHandling 属性の (既定) 値によって決定されます。

• すべてのドキュメントに同じページ範囲が指定されている場合、MultipleDocumentHandling のすべての値が意味を持ち、プリンタの処理が、次のとおり MultipleDocumentHandling の値によって決まります。
  • SINGLE_DOCUMENT -- すべての入力ドキュメントが 1 つの出力ドキュメントとしてまとめられ、出力ドキュメントの指定されたページ範囲を印刷

  • SINGLE_DOCUMENT_NEW_SHEET -- すべての入力ドキュメントが 1 つの出力ドキュメントとしてまとめられ、各入力ドキュメントの最初の印刷データは必ず新しい用紙に印刷。出力ドキュメントの指定されたページ範囲を印刷

  • SEPARATE_DOCUMENTS_UNCOLLATED_COPIES -- 各入力ドキュメントの指定されたページ範囲を印刷

  • SEPARATE_DOCUMENTS_COLLATED_COPIES -- 各入力ドキュメントの指定されたページ範囲を印刷

  • SEPARATE_DOCUMENTS_UNCOLLATED_COPIES -- 各入力ドキュメント自体に指定されたページ範囲を印刷

  • SEPARATE_DOCUMENTS_COLLATED_COPIES -- 各入力ドキュメント自体に指定されたページ範囲を印刷

IPP 互換性: PageRanges 属性の標準配列形式は、IPP の page-ranges 属性の印刷範囲の各範囲の下限と上限にそれぞれ対応します。標準配列形式の説明は SetOfIntegerSyntax クラスを参照してください。getName() で返されるカテゴリ名は IPP 属性名に対応します。

関連項目:

直列化された形式

コンストラクタの概要

PageRanges(int member)
単独の整数で構成される新しいページ範囲属性を構築します。

PageRanges(int[][] members)
指定されたメンバを使用して、新しいページ範囲属性を構築します。

PageRanges(int lowerBound, int upperBound)
単独の整数範囲で構成される新しいページ範囲属性を構築します。

PageRanges(String members)
文字列形式で指定されたメンバを使用して、新しいページ範囲属性を構築します。

メソッドの概要

boolean	equals(Object object) このページ範囲属性がオブジェクトで渡されるものと同等かどうかを返します。
Class<? extends Attribute>	getCategory() この印刷属性値の「カテゴリ」として使用される印刷属性クラスを返します。
String	getName() 属性値がインスタンスとなるカテゴリの名前を返します。

クラス javax.print.attribute.SetOfIntegerSyntax から継承されたメソッド

contains, contains, getMembers, hashCode, next, toString

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

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

コンストラクタの詳細

PageRanges

public PageRanges(int[][] members)

指定されたメンバを使用して、新しいページ範囲属性を構築します。メンバは配列形式で指定されます。配列形式の説明は SetOfIntegerSyntax クラスを参照してください。

パラメータ:

members - 配列形式のセットメンバ

例外:

NullPointerException - 未確認の例外。members が null の場合、または members に null の要素が含まれる場合

IllegalArgumentException - 未確認の例外。members の要素として長さが 1 または 2 以外の配列が含まれる場合、members が長さゼロの配列である場合、またはセットに 1 よりも小さいメンバが含まれる場合

PageRanges

public PageRanges(String members)

文字列形式で指定されたメンバを使用して、新しいページ範囲属性を構築します。構文の説明は SetOfIntegerSyntax を参照してください。

パラメータ:

members - 文字列形式のセットメンバ

例外:

NullPointerException - 未確認の例外。members が null の場合、または members に null の要素が含まれる場合

IllegalArgumentException - 未確認の例外。members の構文が正しくない場合、構築された整数セットが長さゼロの配列の場合、整数セットに 1 より小さいメンバが含まれる場合

PageRanges

public PageRanges(int member)

単独の整数で構成される新しいページ範囲属性を構築します。1 ページだけが印刷されます。

パラメータ:

member - セットのメンバ

例外:

IllegalArgumentException - 未確認の例外。member が 1 より小さい場合

PageRanges

public PageRanges(int lowerBound,
                  int upperBound)

単独の整数範囲で構成される新しいページ範囲属性を構築します。この範囲のページだけが印刷されます。

パラメータ:

lowerBound - 範囲の下限

upperBound - 範囲の上限

例外:

IllegalArgumentException - 未確認の例外。null 範囲が指定されている場合、または 1 より小さい lowerBound で null でない範囲が指定されている場合

メソッドの詳細

equals

public boolean equals(Object object)

このページ範囲属性がオブジェクトで渡されるものと同等かどうかを返します。次の条件がすべて true の場合に同等と見なされます。

1. object が null ではない
2. object が PageRanges クラスのインスタンスである
3. このページ範囲属性のメンバと object のメンバが一致する

オーバーライド:

クラス SetOfIntegerSyntax 内の equals

パラメータ:

object - 比較対象のオブジェクト

戻り値:

object がこのページ範囲属性と同等の場合は true、そうでない場合は false

関連項目:

Object.hashCode(), Hashtable

getCategory

public final Class<? extends Attribute> getCategory()

この印刷属性値の「カテゴリ」として使用される印刷属性クラスを返します。

PageRanges クラスの場合、カテゴリは PageRanges クラス自身です。

定義:

インタフェース Attribute 内の getCategory

戻り値:

印刷属性クラス (カテゴリ)、java.lang.Class クラスのインスタンス

getName

public final String getName()

属性値がインスタンスとなるカテゴリの名前を返します。

PageRanges クラスの場合、カテゴリ名は page-ranges になります。

定義:

インタフェース Attribute 内の getName

戻り値:

属性カテゴリの名前