javax.print.attribute.standard
類別 MediaPrintableArea

java.lang.Object
  javax.print.attribute.standard.MediaPrintableArea

所有已實作的介面：

Serializable, Attribute, DocAttribute, PrintJobAttribute, PrintRequestAttribute

public final class MediaPrintableArea
extends Object
implements DocAttribute, PrintRequestAttribute, PrintJobAttribute

MediaPrintableArea 類別是列印屬性類別，用於區分介質的可列印區域和不可列印區域。

可列印區域被指定為介質總維度之內的矩形。

大多數印表機不能在介質的整個表面上列印，這是由於印表機的硬體限制。此類別可用於查詢所假定的列印作業的可接受值，以及請求要在列印作業中使用的可列印區域的限制之內的某個區域。

要查詢可列印區域，客戶機必須提供適合的上下文。如果不至少指定要使用的介質尺寸，則不能獲取有意義的可列印區域值。

此屬性不是根據與紙邊的距離描述的，部分是強調此屬性不是與特定介質無關的，但必須在其他屬性的選擇上下文中進行描述。此外，客戶機使用可列印區域更為方便。

硬體的最小頁邊距不僅是印表機的屬性，而且是介質尺寸、方向、介質型別和任何指定的 finishing 的函數。PrintService 提供了在適合的上下文中查詢支持的屬性值的方法：參見 PrintService.getSupportedAttributeValues()

矩形可列印區域定義如下：在縱向網要中，(x,y) 原點位於紙張左上角，與在請求上下文中所指定的方向無關。例如，縱向或橫向方向中 A4 紙的可列印區域中， height > width。

可列印區域屬性的值以整數值形式進行內部存儲，以 micrometers (µm) 為單位，其中 1 micrometer = 10^-6 meter = 1/1000 millimeter = 1/25400 inch。這使要表示的維度精確到 1/1000 毫米 (= 1 µm) 或 1/100 英吋 (= 254 µm)。如果小數 inch 以 2 的負數次方表示，則這允許將維度精確表示為 1/8 inch (= 3175 µm) 而不是 1/16 inch 的精度（因為 1/16 inch 不等於整數的 µm）。

IPP Compatibility: MediaPrintableArea 不是 IPP 屬性。

另請參見：

序列化表格

欄位摘要

static int	INCH 指示以 inch (in) 為單位的值。
static int	MM 指示以 millimeters (mm) 為單位的值。

建構子摘要

MediaPrintableArea(float x, float y, float w, float h, int units)
從浮點值建構 MediaPrintableArea 物件。

MediaPrintableArea(int x, int y, int w, int h, int units)
從整數值建構 MediaPrintableArea 物件。

方法摘要

boolean	equals(Object object) 返回此介質頁邊距屬性是否等效於傳入的物件。
Class<? extends Attribute>	getCategory() 獲取將被用作此列印屬性值的“類別別”的列印屬性類別。
float	getHeight(int units) 以指定單位獲取可列印區域的 height。
String	getName() 獲取類別別名稱，此屬性值為該類別別的實例。
float[]	getPrintableArea(int units) 以順序為 x, y, w, h 的 4 個值的陣列形式獲取可列印區域。
float	getWidth(int units) 以指定單位獲取可列印區域的 width。
float	getX(int units) 以指定的單位獲取可列印區域的原點的 x 位置。
float	getY(int units) 以指定單位獲取可列印區域的原點的 y 位置。
int	hashCode() 返回此屬性的雜湊碼值。
String	toString() 以 mm 為單位返回此矩形大小屬性的字元串版本。
String	toString(int units, String unitsName) 以給定單位返回此矩形大小屬性的字元串版本。

從類別 java.lang.Object 繼承的方法

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

欄位詳細資訊

INCH

public static final int INCH

指示以 inch (in) 為單位的值。它實際上是轉換因子，英吋乘以該轉換因子得到微米 (25400)。

另請參見：

常數欄位值

MM

public static final int MM

指示以 millimeters (mm) 為單位的值。它實際上是轉換因子，毫米乘以該轉換因子得到微米 (1000)。

另請參見：

常數欄位值

建構子詳細資訊

MediaPrintableArea

public MediaPrintableArea(float x,
                          float y,
                          float w,
                          float h,
                          int units)

從浮點值建構 MediaPrintableArea 物件。

參數：

x - 可列印的 x

y - 可列印的 y

w - 可列印的 width

h - 可列印的 height

units - 用於表示值的單位。

拋出：

IllegalArgumentException - 如果 x < 0 或 y < 0 或 w <= 0 或 h <= 0 或 units < 1，則拋出此異常。

MediaPrintableArea

public MediaPrintableArea(int x,
                          int y,
                          int w,
                          int h,
                          int units)

從整數值建構 MediaPrintableArea 物件。

參數：

x - 可列印的 x

y - 可列印的 y

w - 可列印的 width

h - 可列印的 height

units - 用於表示值的單位。

拋出：

IllegalArgumentException - 如果 x < 0 或 y < 0 或 w <= 0 或 h <= 0 或 units < 1，則拋出此異常。

方法詳細資訊

getPrintableArea

public float[] getPrintableArea(int units)

以順序為 x, y, w, h 的 4 個值的陣列形式獲取可列印區域。返回的值以給定單位為單位。

參數：

units - 單位轉換因子，例如，INCH 或 MM。

返回：

以指定的單位返回 x, y, w, h 陣列形式的可列印區域。

拋出：

IllegalArgumentException - （未經檢查的異常）如果 units < 1，則拋出該異常。

getX

public float getX(int units)

以指定的單位獲取可列印區域的原點的 x 位置。

參數：

units - 單位轉換因子，例如，INCH 或 MM。

返回：

以指定單位返回可列印區域的原點的 x 位置。

拋出：

IllegalArgumentException - （未經檢查的異常）如果 units < 1，則拋出該異常。

getY

public float getY(int units)

以指定單位獲取可列印區域的原點的 y 位置。

參數：

units - 單位轉換因子，例如，INCH 或 MM。

返回：

以指定單位返回可列印區域的原點的 y 位置。

拋出：

IllegalArgumentException - （未經檢查的異常）如果 units < 1，則拋出該異常。

getWidth

public float getWidth(int units)

以指定單位獲取可列印區域的 width。

參數：

units - 單位轉換因子，例如，INCH 或 MM。

返回：

以指定單位返回可列印區域的 width。

拋出：

IllegalArgumentException - （未經檢查的異常）如果 units < 1，則拋出該異常。

getHeight

public float getHeight(int units)

以指定單位獲取可列印區域的 height。

參數：

units - 單位轉換因子，例如 INCH 或 MM。

返回：

以指定單位返回可列印區域的 height。

拋出：

IllegalArgumentException - （未經檢查的異常）如果 units < 1，則拋出該異常。

equals

public boolean equals(Object object)

返回此介質頁邊距屬性是否等效於傳入的物件。若要等效，以下所有條件都必須為 true：

1. object 不為 null。
2. object 為 MediaPrintableArea 類別的實例。
3. 原點和維度是相同的。

覆寫：

類別 Object 中的 equals

參數：

object - 要比較的 Object。

返回：

如果 object 等效於此介質頁邊距屬性，則返回 true，否則返回 false。

另請參見：

Object.hashCode(), Hashtable

getCategory

public final Class<? extends Attribute> getCategory()

獲取將被用作此列印屬性值的“類別別”的列印屬性類別。

對於 MediaPrintableArea 類別，類別別為 MediaPrintableArea 類別本身。

指定者：

介面 Attribute 中的 getCategory

返回：

列印屬性類別（類別別），它是 java.lang.Class 類別的實例。

getName

public final String getName()

獲取類別別名稱，此屬性值為該類別別的實例。

對於 MediaPrintableArea 類別，類別別名稱為 "media-printable-area"。

這不是 IPP V1.1 屬性。

指定者：

介面 Attribute 中的 getName

返回：

屬性類別別名稱。

toString

public String toString(int units,
                       String unitsName)

以給定單位返回此矩形大小屬性的字元串版本。

參數：

units - 單位轉換因子，例如 INCH 或 MM。

unitsName - 單位名稱字元串，例如 "in" 或 "mm"。如果為 null，則沒有任何單位名稱附加到該結果。

返回：

此二維大小屬性的字元串版本。

拋出：

IllegalArgumentException - （未經檢查的異常）如果 units < 1，則拋出該異常。

toString

public String toString()

以 mm 為單位返回此矩形大小屬性的字元串版本。

覆寫：

類別 Object 中的 toString

返回：

該物件的字元串表示形式。

hashCode

public int hashCode()

返回此屬性的雜湊碼值。

覆寫：

類別 Object 中的 hashCode

返回：

此物件的一個雜湊碼值。

另請參見：

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