java.awt
类 PageAttributes

java.lang.Object
  java.awt.PageAttributes

所有已实现的接口：

Cloneable

public final class PageAttributes
extends Object
implements Cloneable

用来控制打印页面输出的属性集。

此类的实例控制颜色状态、纸张尺寸（介质类型）、打印方向、逻辑原点、打印质量，以及使用实例的每个页面的分辨率。属性名尽可能遵守 Internet Printing Protocol (IPP) 1.1。属性值要尽可能部分地遵守该协议。

要使用采用内部类类型的方法，需要将引用传递给内部类的常量字段之一。客户端代码无法创建内部类类型的新实例，因为这些类都不具有公共构造方法。例如，为了将颜色状态设置为单色，需要使用以下代码：

 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，第三个元素必须为 3 或 4。

抛出：

IllegalArgumentException - 如果违反了一个或多个上述条件。

clone

public Object clone()

创建并返回此 PageAttributes 的一个副本。

覆盖：

类 Object 中的 clone

返回：

新创建的副本。可以安全地将此 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 类的常数字段之一。

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 指定分辨率是以每英寸的点数为单位，还是以每厘米的点数为单位。3 表示以每英寸的点数为单位。4 表示以每厘米的点数为单位。

返回：

3 个元素的整数数组。第一、二个元素必须大于 0，第三个元素必须为 3 或 4。

setPrinterResolution

public void setPrinterResolution(int[] printerResolution)

指定使用这些属性的页面所需的打印分辨率。实际的分辨率取决于实现和目标打印机的限制。数组的索引 0 指定反向进纸的分辨率（通常为水平分辨率）。数组的索引 1 指定进纸的分辨率（通常为垂直分辨率）。数组的索引 2 指定分辨率是以每英寸的点数为单位，还是以每厘米的点数为单位。3 表示以每英寸的点数为单位。4 表示以每厘米的点数为单位。注意，1.1 打印实现 (Toolkit.getPrintJob) 要求进纸和反向进纸具有相同的分辨率。如果不指定此属性，则调用 setPrinterResolution(72)。

参数：

printerResolution - 3 个元素的整数数组。第一、二个元素必须大于 0，第三个元素必须为 3 或 4。

抛出：

IllegalArgumentException - 如果违反了一个或多个上述条件。

setPrinterResolution

public void setPrinterResolution(int printerResolution)

指定使用这些属性的页面所需的反向进纸和进纸的打印分辨率，分辨率以每英寸的点数为单位。相同的值同时用于这两种分辨率。实际的分辨率取决于实现和目标打印机的限制。如果不指定此属性，则默认指定 72。

参数：

printerResolution - 大于 0 的整数。

抛出：

IllegalArgumentException - 如果 printerResolution 小于或等于 0。

setPrinterResolutionToDefault

public void setPrinterResolutionToDefault()

将使用这些属性的页面的打印机分辨率设置为默认值。进纸和反向进纸的默认分辨率均为 72 dpi。

equals

public boolean equals(Object obj)

确定两个 PageAttributes 是否相等。

当且仅当两个 PageAttributes 的每个属性均相等时，它们才是相等的。当且仅当字段的引用指向相同的唯一枚举对象时，枚举类型的属性才是相等的。这意味着一个有别名的 media 等效于基础的唯一 media。当且仅当进纸分辨率、反向进纸分辨率和单位相等时，打印机分辨率才是相等的。

覆盖：

类 Object 中的 equals

参数：

obj - 将检查其相等性的对象。

返回：

根据以上标准，obj 是否等于此 PageAttribute。

另请参见：

Object.hashCode(), Hashtable

hashCode

public int hashCode()

返回此 PageAttributes 的哈希码值。

覆盖：

类 Object 中的 hashCode

返回：

哈希码。

另请参见：

Object.equals(java.lang.Object), Hashtable

toString

public String toString()

返回此 PageAttributes 的字符串表示形式。

覆盖：

类 Object 中的 toString

返回：

字符串表示形式。

版权所有 2007 Sun Microsystems, Inc. 保留所有权利。 请遵守许可证条款。另请参阅文档重新分发政策。