モジュール java.desktop
パッケージ 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)
      文字列形式で指定されたメンバーを使用して、新しいページ範囲属性を構築します。

    • コンストラクタの詳細

      • 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
        戻り値:
        属性カテゴリの名前