モジュール java.desktop
パッケージ javax.print.attribute.standard

クラスPageRanges

  • すべての実装されたインタフェース:
    Serializable, Cloneable, Attribute, DocAttribute, PrintJobAttribute, PrintRequestAttribute
    public final class PageRanges
extends SetOfIntegerSyntax
implements DocAttribute, PrintRequestAttribute, PrintJobAttribute
    クラスPageRangesは、印刷する各ドキュメントのコピーごとにPrinterオブジェクトが使用する印刷ストリーム・ページの範囲を識別する一連の整数である印刷属性クラスです。 ドキュメントに存在しないものとされるページには何も印刷されません。 属性は、アプリケーションでカウントされるページ(たとえばある種のワードプロセッサ・アプリケーションのヘッダーまたはフッターに設定されるページ番号)ではなく、出力ストリームのページに関連付けられます。

    多くの場合、印刷される正確なページはデバイス・ドライバで生成されるため、この属性は不要です。 ただし、すでに書式が設定されて保存されているドキュメントを印刷するときに、エンド・ユーザーがそのドキュメントの一部のページのみを要求する場合があります。 この場合、ページ範囲"n-m"が指定された場合、最初に印刷されるページはページnになります。 ドキュメントの後続のページのうち、ページm.を含むこのページまでのページがすべて印刷されます。

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

    マルチドック印刷ジョブ(複数のドキュメントを含むジョブ)に対する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)
      文字列形式で指定されたメンバーを使用して、新しいページ範囲属性を構築します。

    • コンストラクタの詳細

      • 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範囲が指定されている場合、またはnon-null範囲がlowerBoundが1未満で指定されている場合

    • メソッドの詳細

      • equals

        public boolean equals​(Object object)
        このページ範囲属性がオブジェクトで渡されるものと同等かどうかを返します。 次の条件がすべてtrueの場合に同等とみなされます。
        1. objectはnullではありません。
        2. objectは、クラスPageRangesのインスタンスです。
        3. このページ範囲属性のメンバーとobjectのメンバーが一致する。
        オーバーライド:
        equals、クラスSetOfIntegerSyntax
        パラメータ:
        object - 比較する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
        戻り値:
        属性カテゴリ名