PageAttributes (Java Platform SE 7)

java.lang.Object
- java.awt.PageAttributes

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

Cloneable
```
public final class PageAttributes
extends Object
implements Cloneable
```
印刷したページの出力を制御する属性セットです。
このクラスのインスタンスは、色の状態、用紙サイズ (メディアの種類)、用紙方向、論理的な原点、印刷品質、およびインスタンスを使用する各ページの解像度を制御します。属性名は、可能な場合 Internet Printing Protocol (IPP) 1.1 に準拠しています。属性値は可能な場合、部分的に 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

ネストされたクラスのサマリー

ネストされたクラス
修飾子と型	クラスと説明
`static class`	`PageAttributes.ColorType` 使用可能なカラー状態の型保証された列挙
`static class`	`PageAttributes.MediaType` 使用可能な用紙サイズの型保証された列挙です。
`static class`	`PageAttributes.OrientationRequestedType` 使用可能な用紙方向の型保証された列挙です。
`static class`	`PageAttributes.OriginType` 使用可能な原点の型保証された列挙です。
`static class`	`PageAttributes.PrintQualityType` 使用可能な印刷品質の型保証された列挙です。

コンストラクタのサマリー

コンストラクタ
コンストラクタと説明
`PageAttributes()` 各属性にデフォルトの値を持つ PageAttributes インスタンスを生成します。
`PageAttributes(PageAttributes.ColorType color, PageAttributes.MediaType media, PageAttributes.OrientationRequestedType orientationRequested, PageAttributes.OriginType origin, PageAttributes.PrintQualityType printQuality, int[] printerResolution)` 各属性に指定された値を持つ PageAttributes インスタンスを生成します。
`PageAttributes(PageAttributes obj)` 指定された PageAttributes のコピーである PageAttributes インスタンスを生成します。

メソッドのサマリー

メソッド
修飾子と型	メソッドと説明
`Object`	`clone()` PageAttributes のコピーを作成して、返します。
`boolean`	`equals(Object obj)` 2 つの PageAttributes が同じであるかどうかを判定します。
`PageAttributes.ColorType`	`getColor()` これらの属性を使用するページをカラーで描画するかモノクロで描画するかを返します。
`PageAttributes.MediaType`	`getMedia()` これらの属性を使用するページの用紙サイズを返します。
`PageAttributes.OrientationRequestedType`	`getOrientationRequested()` これらの属性を使用するページの用紙方向を返します。
`PageAttributes.OriginType`	`getOrigin()` これらの属性を使用するページの (0, 0) 描画を物理ページの左上隅にするか、印刷範囲の左上隅にするかを返します。
`int[]`	`getPrinterResolution()` これらの属性を使用するページの印刷解像度を返します。
`PageAttributes.PrintQualityType`	`getPrintQuality()` これらの属性を使用するページの印刷品質を返します。
`int`	`hashCode()` この PageAttributes のハッシュコード値を返します。
`void`	`set(PageAttributes obj)` PageAttributes のすべての属性を obj の属性と同じ値に設定します。
`void`	`setColor(PageAttributes.ColorType color)` これらの属性を使用するページをカラーで描画するかモノクロで描画するかを指定します。
`void`	`setMedia(PageAttributes.MediaType media)` これらの属性を使用するページの用紙サイズを指定します。
`void`	`setMediaToDefault()` これらの属性を使用するページの用紙サイズをデフォルトロケールのデフォルトサイズに指定します。
`void`	`setOrientationRequested(int orientationRequested)` これらの属性を使用するページの用紙方向を指定します。
`void`	`setOrientationRequested(PageAttributes.OrientationRequestedType orientationRequested)` これらの属性を使用するページの用紙方向を指定します。
`void`	`setOrientationRequestedToDefault()` これらの属性を使用するページの用紙方向をデフォルトに設定します。
`void`	`setOrigin(PageAttributes.OriginType origin)` これらの属性を使用するページの (0, 0) 描画を物理ページの左上隅にするか、印刷範囲の左上隅にするかを指定します。
`void`	`setPrinterResolution(int printerResolution)` これらの属性を使用するページの前後送りまたは送りの印刷解像度を 1 インチ当たりのドット数で指定します。
`void`	`setPrinterResolution(int[] printerResolution)` これらの属性を使用するページの印刷解像度を指定します。
`void`	`setPrinterResolutionToDefault()` これらの属性を使用するページのプリンタ解像度をデフォルトに設定します。
`void`	`setPrintQuality(int printQuality)` これらの属性を使用するページの印刷品質を指定します。
`void`	`setPrintQuality(PageAttributes.PrintQualityType printQuality)` これらの属性を使用するページの印刷品質を指定します。
`void`	`setPrintQualityToDefault()` これらの属性を使用するページの印刷品質をデフォルトに設定します。
`String`	`toString()` この PageAttributes の文字列表現を返します。

クラス java.lang.Object から継承されたメソッド
finalize, getClass, notify, notifyAll, wait, wait, wait

- コンストラクタの詳細
  - 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
    
    戻り値:
    文字列表現。

バグまたは機能を送信
詳細な API リファレンスおよび開発者ドキュメントについては、Java SE のドキュメントを参照してください。そのドキュメントには、概念的な概要、用語の定義、回避方法、有効なコード例などの、開発者を対象にしたより詳細な説明が含まれています。
Copyright © 1993, 2013, Oracle and/or its affiliates. All rights reserved.

クラス PageAttributes

ネストされたクラスのサマリー

コンストラクタのサマリー

メソッドのサマリー

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

コンストラクタの詳細

PageAttributes

PageAttributes

PageAttributes

メソッドの詳細

clone

set

getColor

setColor

getMedia

setMedia

setMediaToDefault

getOrientationRequested

setOrientationRequested

setOrientationRequested

setOrientationRequestedToDefault

getOrigin

setOrigin

getPrintQuality

setPrintQuality

setPrintQuality

setPrintQualityToDefault

getPrinterResolution

setPrinterResolution

setPrinterResolution

setPrinterResolutionToDefault

equals

hashCode

toString