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}} になります。

multidoc 印刷ジョブ (複数のドキュメントを持つジョブ) に対する 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 が長さ 0 の場合、またはセットのいずれかのメンバーが 1 より小さい場合にもスローされる。

PageRanges

public PageRanges(String members)

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

パラメータ:

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

例外:

NullPointerException - 非チェック例外。members が null の場合、または members のいずれかの要素が null の場合にスローされる。

IllegalArgumentException - 非チェック例外。members が正しい構文に従わない場合にスローされる。また、構築された整数セットが長さ 0 の配列の場合、またはセットのいずれかのメンバーが 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 のメンバーが一致する。

オーバーライド:

equals、クラス: SetOfIntegerSyntax

パラメータ:

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

戻り値:

object がこのページ範囲属性と一致する場合は true、そうでない場合は false。

関連項目:

Object.hashCode()、HashMap

getCategory

public final Class<? extends Attribute> getCategory()

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

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

定義:

getCategory、インタフェース: Attribute

戻り値:

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

getName

public final String getName()

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

PageRanges クラスの場合、カテゴリ名は "page-ranges" です。

定義:

getName、インタフェース: Attribute

戻り値:

属性カテゴリの名前