モジュール java.desktop
パッケージ java.awt

クラスPageAttributes

java.lang.Object
java.awt.PageAttributes
すべての実装されたインタフェース:
Cloneable
public final class PageAttributes
extends Object
implements Cloneable
印刷したページの出力を制御する属性セットです。

このクラスのインスタンスは、色の状態、用紙サイズ(メディアの種類)、用紙方向、論理的な原点、印刷品質、およびインスタンスを使用する各ページの解像度を制御します。 属性名は、可能な場合Internet Printing Protocol (IPP) 1.1に準拠しています。 属性値は可能な場合、部分的に準拠しています。

内部クラス型をとるメソッドを使用するには、その内部クラスの定数フィールドに対する参照を渡します。 クライアント・コードは、このクラスがpublicコンストラクタを持たないため、内部クラス型の新規インスタンスを作成できません。 色の状態をモノクロに設定するには、次のコードを使用します。 

 import java.awt.PageAttributes;

 public class MonochromeExample {
     public void setMonochrome(PageAttributes pageAttributes) {
         pageAttributes.setColor(PageAttributes.ColorType.MONOCHROME);
     }
 }

attributeNameのデフォルト値をサポートするどのIPP属性にも、対応するsetattributeNameToDefaultメソッドがあります。 デフォルト値のフィールドは提供されていません。

導入されたバージョン:
1.3

  • コンストラクタの詳細

    • PageAttributes

      public PageAttributes()
      各属性にデフォルトの値を持つPageAttributesインスタンスを生成します。

    • PageAttributes

      public PageAttributes​(PageAttributes obj)
      指定されたPageAttributesのコピーであるPageAttributesインスタンスを生成します。
      パラメータ:
      obj - コピーするPageAttributes。

    • PageAttributes

      public PageAttributes​(PageAttributes.ColorType color, PageAttributes.MediaType media, PageAttributes.OrientationRequestedType orientationRequested, PageAttributes.OriginType origin, PageAttributes.PrintQualityType printQuality, int[] printerResolution)
      各属性に指定された値を持つPageAttributesインスタンスを生成します。
      パラメータ:
      color - ColorType.COLORまたはColorType.MONOCHROME。
      media - MediaTypeクラスのいずれかの定数フィールド。
      orientationRequested - OrientationRequestedType.PORTRAITまたはOrientationRequestedType.LANDSCAPE。
      origin - OriginType.PHYSICALまたはOriginType.PRINTABLE
      printQuality - PrintQualityType.DRAFT、PrintQualityType.NORMAL、またはPrintQualityType.HIGH
      printerResolution - 3要素の整数配列。 最初の要素は、0より大きいことが必要です。 2番目の要素は、0より大きいことが必要です。 3番目の要素は、3または4のどちらかである必要があります。
      例外:
      IllegalArgumentException - 上の条件の1つ以上に違反した場合。

  • メソッドの詳細

    • clone

      public Object clone()
      PageAttributesのコピーを作成して、返します。
      オーバーライド:
      clone、クラス: Object
      戻り値:
      新しく作成されたコピー。 このObjectをPageAttributesにキャストすると安全である
      関連項目:
      Cloneable

    • set

      public void set​(PageAttributes obj)
      PageAttributesのすべての属性をobjの属性と同じ値に設定します。
      パラメータ:
      obj - コピーするPageAttributes。

    • getColor

      public PageAttributes.ColorType getColor()
      これらの属性を使用するページをカラーで描画するかモノクロで描画するかを返します。 この属性は、ユーザーが選択した値に更新されます。
      戻り値:
      ColorType.COLORまたはColorType.MONOCHROME

    • setColor

      public void setColor​(PageAttributes.ColorType color)
      これらの属性を使用するページをカラーで描画するかモノクロで描画するかを指定します。 指定しない場合はColorType.MONOCHROMEとなります。
      パラメータ:
      color - ColorType.COLORまたはColorType.MONOCHROME。
      例外:
      IllegalArgumentException - colorがnullの場合。

    • getMedia

      public PageAttributes.MediaType getMedia()
      これらの属性を使用するページの用紙サイズを返します。 この属性は、ユーザーが選択した値に更新されます。
      戻り値:
      MediaTypeクラスの1つの定数フィールド

    • setMedia

      public void setMedia​(PageAttributes.MediaType media)
      これらの属性を使用するページの用紙サイズを指定します。 実際の用紙サイズは、出力先プリンタの制限で決まります。 完全に一致しない場合は近似値が選択されます。 この属性を指定しない場合、デフォルトのロケールに対してデフォルトのサイズが指定されます。 米国およびカナダのロケールのデフォルト・サイズはMediaType.NA_LETTERです。 その他すべてのロケールでのデフォルト・サイズはMediaType.ISO_A4です。
      パラメータ:
      media - MediaTypeクラスのいずれかの定数フィールド。
      例外:
      IllegalArgumentException - mediaがnullの場合。

    • setMediaToDefault

      public void setMediaToDefault()
      これらの属性を使用するページの用紙サイズをデフォルト・ロケールのデフォルト・サイズに指定します。 米国およびカナダのロケールのデフォルト・サイズはMediaType.NA_LETTERです。 その他すべてのロケールでのデフォルト・サイズはMediaType.ISO_A4です。

    • getOrientationRequested

      public PageAttributes.OrientationRequestedType getOrientationRequested()
      これらの属性を使用するページの用紙方向を返します。 この属性は、ユーザーが選択した値に更新されます。
      戻り値:
      OrientationRequestedType.PORTRAITまたはOrientationRequestedType.LANDSCAPE。

    • setOrientationRequested

      public void setOrientationRequested​(PageAttributes.OrientationRequestedType orientationRequested)
      これらの属性を使用するページの用紙方向を指定します。 プロパティで指定しない場合はOrientationRequestedType.PORTRAITとなります。
      パラメータ:
      orientationRequested - OrientationRequestedType.PORTRAITまたはOrientationRequestedType.LANDSCAPE。
      例外:
      IllegalArgumentException - orientationRequestedがnullの場合。

    • setOrientationRequested

      public void setOrientationRequested​(int orientationRequested)
      これらの属性を使用するページの用紙方向を指定します。 3を指定すると縦方向、 4を指定すると横方向になります。 ほかの値を指定するとIllegalArgumentExceptionがスローされます。 プロパティで指定しない場合は、setOrientationRequested(OrientationRequestedType.PORTRAIT)が呼び出されます。
      パラメータ:
      orientationRequested - 3または4
      例外:
      IllegalArgumentException - orientationRequestedが3または4でない場合

    • setOrientationRequestedToDefault

      public void setOrientationRequestedToDefault()
      これらの属性を使用するページの用紙方向をデフォルトに設定します。 デフォルトでは縦方向になります。

    • getOrigin

      public PageAttributes.OriginType getOrigin()
      これらの属性を使用するページの(0, 0)描画を物理ページの左上隅にするか、印刷範囲の左上隅にするかを返します。 これらの位置は同じではありません。 この属性は、実装や出力先プリンタによる変更や制限を受けることはありません。
      戻り値:
      OriginType.PHYSICALまたはOriginType.PRINTABLE

    • setOrigin

      public void setOrigin​(PageAttributes.OriginType origin)
      これらの属性を使用するページの(0, 0)描画を物理ページの左上隅にするか、印刷範囲の左上隅にするかを指定します。 これらの位置は同じではありません。 プロパティで指定しない場合はOriginType.PHYSICALとなります。
      パラメータ:
      origin - OriginType.PHYSICALまたはOriginType.PRINTABLE
      例外:
      IllegalArgumentException - originがnullの場合。

    • getPrintQuality

      public PageAttributes.PrintQualityType getPrintQuality()
      これらの属性を使用するページの印刷品質を返します。 この属性は、ユーザーが選択した値に更新されます。
      戻り値:
      PrintQualityType.DRAFT、PrintQualityType.NORMAL、またはPrintQualityType.HIGH

    • setPrintQuality

      public void setPrintQuality​(PageAttributes.PrintQualityType printQuality)
      これらの属性を使用するページの印刷品質を指定します。 プロパティで指定しない場合はPrintQualityType.NORMALとなります。
      パラメータ:
      printQuality - PrintQualityType.DRAFT、PrintQualityType.NORMAL、またはPrintQualityType.HIGH
      例外:
      IllegalArgumentException - printQualityがnullの場合。

    • setPrintQuality

      public void setPrintQuality​(int printQuality)
      これらの属性を使用するページの印刷品質を指定します。 3を指定するとドラフト、 4を指定すると通常、 5を指定すると高品質になります。 ほかの値を指定するとIllegalArgumentExceptionがスローされます。 プロパティで指定しない場合は、setPrintQuality(PrintQualityType.NORMAL)が呼び出されます。
      パラメータ:
      printQuality - 3、4、または5
      例外:
      IllegalArgumentException - printQualityが3、4、または5でない場合

    • setPrintQualityToDefault

      public void setPrintQualityToDefault()
      これらの属性を使用するページの印刷品質をデフォルトに設定します。 デフォルトでは通常品質となります。

    • getPrinterResolution

      public int[] getPrinterResolution()
      これらの属性を使用するページの印刷解像度を返します。 配列のインデックス0は、横送り方向の解像度を指定します(通常は水平方向の解像度)。 配列のインデックス1は、送り方向の解像度を指定します(通常は垂直方向の解像度)。 配列のインデックス2は、解像度が1インチ当たりのドット数または1センチ当たりのドット数のどちらであるかを指定します。3は、1インチ当たりのドット数を示します。4は、1センチ当たりのドット数を示します。
      戻り値:
      3要素の整数型配列。 最初の要素は、0より大きいことが必要です。 2番目の要素は、0より大きいことが必要です。 3番目の要素は、3または4のどちらかである必要があります。

    • setPrinterResolution

      public void setPrinterResolution​(int[] printerResolution)
      これらの属性を使用するページの印刷解像度を指定します。 実際の解像度は、実装や出力先プリンタの制限により決まります。 配列のインデックス0は、横送り方向の解像度を指定します(通常は水平方向の解像度)。 配列のインデックス1は、送り方向の解像度を指定します(通常は垂直方向の解像度)。 配列のインデックス2は、解像度が1インチ当たりのドット数または1センチ当たりのドット数のどちらであるかを指定します。3は、1インチ当たりのドット数を示します。4は、1センチ当たりのドット数を示します。 1.1印刷実装(Toolkit.getPrintJob)では、送り方向の解像度と前後送りの解像度は同じである必要があります。 プロパティで指定しない場合は、setPrinterResolution(72)が呼び出されます。
      パラメータ:
      printerResolution - 3要素の整数配列。 最初の要素は、0より大きいことが必要です。 2番目の要素は、0より大きいことが必要です。 3番目の要素は、3または4のどちらかである必要があります。
      例外:
      IllegalArgumentException - 上の条件の1つ以上に違反した場合。

    • setPrinterResolution

      public void setPrinterResolution​(int printerResolution)
      これらの属性を使用するページの前後送りまたは送りの印刷解像度を1インチ当たりのドット数で指定します。 両方の解像度には同じ値が使用されます。 実際の解像度は、実装や出力先プリンタの制限により決まります。 プロパティで指定しない場合は、72が指定されます。
      パラメータ:
      printerResolution - 0より大きい整数。
      例外:
      IllegalArgumentException - printerResolutionが0以下の場合。

    • setPrinterResolutionToDefault

      public void setPrinterResolutionToDefault()
      これらの属性を使用するページのプリンタ解像度をデフォルトに設定します。 デフォルトは、送りおよび前後送りの解像度いずれも72 dpiです。

    • equals

      public boolean equals​(Object obj)
      2つのPageAttributesが同じであるかどうかを判定します。

      お互いの属性がすべて同じである場合にだけ、2つのPageAttributesは等しくなります。 フィールドが一意の同じ列挙オブジェクトを参照している場合にだけ、列挙型の属性が等しくなります。 つまり、別名のメディアは、元になる一意のメディアと同じであるということです。 送り解像度、前後送り解像度および単位が同じである場合にだけ、プリンタの解像度が等しくなります。

      オーバーライド:
      equals 、クラス:  Object
      パラメータ:
      obj - 同じであるかどうかがチェックされるオブジェクト。
      戻り値:
      上記の基準により、objがこのPageAttributeと等しいかどうか
      関連項目:
      Object.hashCode()、HashMap

    • hashCode

      public int hashCode()
      このPageAttributesのハッシュ・コード値を返します。
      オーバーライド:
      hashCode 、クラス:  Object
      戻り値:
      ハッシュ・コード
      関連項目:
      Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)

    • toString

      public String toString()
      このPageAttributesの文字列表現を返します。
      オーバーライド:
      toString 、クラス:  Object
      戻り値:
      文字列表現。