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

巢狀類別摘要

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) 確定兩個 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) 指定使用這些屬性的頁面所需的反向進紙和進紙的列印分辨率，分辨率以每英吋的點數為單位。
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，第三個元素必須為 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

返回：

字元串表示形式。