JavaTM 2 Platform
Standard Ed. 6

javax.print.attribute.standard
類別 MediaSize

java.lang.Object
  繼承者 javax.print.attribute.Size2DSyntax
      繼承者 javax.print.attribute.standard.MediaSize
所有已實作的介面:
Serializable, Cloneable, Attribute

public class MediaSize
extends Size2DSyntax
implements Attribute

MediaSize 是二維大小值形式的列印屬性類別,它指示縱向方向中的介質維度,其中 X 維度沿底邊計算,Y 維度沿左邊計算。因此,Y 維度必須大小或等於 X 維度。MediaSize 類別宣告了許多標準介質尺寸值,這些值被組織到 ISO、JIS、North American、engineering 和其他介質的巢狀類別中。

MediaSize 尚未用於指定介質。其當前職責是作為指定的介質的映射(參見 MediaSizeName)。客戶機可以使用映射方法 MediaSize.getMediaSizeForName(MediaSizeName) 來尋找此 API 中列舉的 MediaSizeName 實例的物理維度。此方法適用於需要此資訊來格式化列印和標記列印頁數的客戶機。

另請參見:
序列化表格

巢狀類別摘要
static class MediaSize.Engineering
          MediaSize.Engineering 類別包括 engineering 介質的 MediaSize 值。
static class MediaSize.ISO
          MediaSize.ISO 類別包括 ISO 介質的 MediaSize 值。
static class MediaSize.JIS
          MediaSize.JIS 類別包括 JIS (Japanese) 介質的 MediaSize 值。
static class MediaSize.NA
          MediaSize.NA 類別包括 North American 介質的 MediaSize 值。
static class MediaSize.Other
          MediaSize.Other 類別包括其他介質的 MediaSize 值。
 
欄位摘要
 
從類別 javax.print.attribute.Size2DSyntax 繼承的欄位
INCH, MM
 
建構子摘要
MediaSize(float x, float y, int units)
          從給定浮點值建構新 MediaSize 屬性。
MediaSize(float x, float y, int units, MediaSizeName media)
          從給定浮點值建構新 MediaSize 屬性。
MediaSize(int x, int y, int units)
          從給定整數值建構新 MediaSize 屬性。
MediaSize(int x, int y, int units, MediaSizeName media)
          從給定整數值建構新 MediaSize 屬性。
 
方法摘要
 boolean equals(Object object)
          返回此介質尺寸屬性是否等效於傳入的物件。
static MediaSizeName findMedia(float x, float y, int units)
          指定的維度用於從所有標準 MediaSize 實例中定位一個比對的 MediaSize 實例。
 Class<? extends Attribute> getCategory()
          獲取將被用作此列印屬性值的“類別別”的列印屬性類別。
static MediaSize getMediaSizeForName(MediaSizeName media)
          獲取指定的命名介質的 MediaSize。
 MediaSizeName getMediaSizeName()
          獲取此尺寸的介質名稱(如果有)。
 String getName()
          獲取類別別名稱,此屬性值為該類別別的實例。
 
從類別 javax.print.attribute.Size2DSyntax 繼承的方法
getSize, getX, getXMicrometers, getY, getYMicrometers, hashCode, toString, toString
 
從類別 java.lang.Object 繼承的方法
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

建構子詳細資訊

MediaSize

public MediaSize(float x,
                 float y,
                 int units)
從給定浮點值建構新 MediaSize 屬性。

參數:
x - X 維度。
y - Y 維度。
units - 單位轉換因子,例如 Size2DSyntax.INCHSize2DSyntax.MM
拋出:
IllegalArgumentException - (未檢查的異常)如果 x < 0 或 y < 0 或 units < 1 或 x > y,則拋出此異常。

MediaSize

public MediaSize(int x,
                 int y,
                 int units)
從給定整數值建構新 MediaSize 屬性。

參數:
x - X 維度。
y - Y 維度。
units - 單位轉換因子,例如 Size2DSyntax.INCHSize2DSyntax.MM
拋出:
IllegalArgumentException - (未檢查的異常)如果 x < 0 或 y < 0 或 units < 1 或 x > y,則拋出此異常。

MediaSize

public MediaSize(float x,
                 float y,
                 int units,
                 MediaSizeName media)
從給定浮點值建構新 MediaSize 屬性。

參數:
x - X 維度。
y - Y 維度。
units - 單位轉換因子,例如 Size2DSyntax.INCHSize2DSyntax.MM
media - 與此 MediaSize 關聯的介質名稱
拋出:
IllegalArgumentException - (未檢查的異常)如果 x < 0 或 y < 0 或 units < 1 或 x > y,則拋出此異常。

MediaSize

public MediaSize(int x,
                 int y,
                 int units,
                 MediaSizeName media)
從給定整數值建構新 MediaSize 屬性。

參數:
x - X 維度。
y - Y 維度。
units - 單位轉換因子,例如 Size2DSyntax.INCHSize2DSyntax.MM
media - 與此 MediaSize 關聯的介質名稱
拋出:
IllegalArgumentException - (未檢查的異常)如果 x < 0 或 y < 0 或 units < 1 或 x > y,則拋出此異常。
方法詳細資訊

getMediaSizeName

public MediaSizeName getMediaSizeName()
獲取此尺寸的介質名稱(如果有)。

返回:
此介質尺寸的名稱,如果沒有與此尺寸關聯的名稱(匿名尺寸),則返回 null。

getMediaSizeForName

public static MediaSize getMediaSizeForName(MediaSizeName media)
獲取指定的命名介質的 MediaSize。

參數:
media - - 要尋找其尺寸的介質名稱
返回:
介質尺寸,如果此介質與任何尺寸均不關聯,則返回 null。

findMedia

public static MediaSizeName findMedia(float x,
                                      float y,
                                      int units)
指定的維度用於從所有標準 MediaSize 實例中定位一個比對的 MediaSize 實例。如果沒有精確比對,則使用最接近的比對。

然後依次使用 MediaSize 尋找 MediaSizeName 物件。如果最接近的比對 MediaSize 沒有對應的 Media 實例,則此方法可能返回 null。

此方法適用於只具有維度並且希望尋找對應於該維度的 Media 的客戶機。

參數:
x - - X 維度
y - - Y 維度。
units - 單位轉換因子,例如 Size2DSyntax.INCHSize2DSyntax.MM
返回:
與這些維度比對的 MediaSizeName 或 null。
拋出:
IllegalArgumentException - 如果 x <= 0、y <= 0 或 units < 1,則拋出此異常

equals

public boolean equals(Object object)
返回此介質尺寸屬性是否等效於傳入的物件。若要等效,以下所有條件都必須為 true:
  1. object 不為 null。
  2. object 為 MediaSize 類別的實例。
  3. 此介質大小屬性的 X 維度與 object 的 X 維度相等。
  4. 此介質大小屬性的 Y 維度與 object 的 Y 維度相等。

覆寫:
類別 Size2DSyntax 中的 equals
參數:
object - 要比較的 Object。
返回:
如果 object 等效於此介質尺寸屬性,則返回 true,否則返回 false。
另請參見:
Object.hashCode(), Hashtable

getCategory

public final Class<? extends Attribute> getCategory()
獲取將被用作此列印屬性值的“類別別”的列印屬性類別。

對於 MediaSize 類別和任何供應商定義的子類別,類別別為 MediaSize 類別本身。

指定者:
介面 Attribute 中的 getCategory
返回:
列印屬性類別(類別別),它是 java.lang.Class 類別的實例。

getName

public final String getName()
獲取類別別名稱,此屬性值為該類別別的實例。

對於 MediaSize 類別和任何供應商定義的子類別,類別別名稱為 "media-size"

指定者:
介面 Attribute 中的 getName
返回:
屬性類別別名稱。

JavaTM 2 Platform
Standard Ed. 6

提交錯誤或意見

版權所有 2008 Sun Microsystems, Inc. 保留所有權利。請遵守GNU General Public License, version 2 only