当前页面: 在线文档首页 > JavaTM 2 Platform Standard Edition 5.0 API 规范中文版

MediaSize (Java 2 Platform SE 5.0) - JavaTM 2 Platform Standard Edition 5.0 API 规范中文版

概述  软件包   类  使用  树  已过时  索引  帮助		JavaTM 2 Platform Standard Ed. 5.0
上一个类   下一个类	框架    无框架
摘要： 嵌套 | 字段 | 构造方法 | 方法	详细信息： 字段 | 构造方法 | 方法

---

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(float x, float y, int units, MediaSizeName media)           从给定浮点值构造新介质尺寸属性。
MediaSize(int x, int y, int units)           从给定整数值构造新介质尺寸属性。
MediaSize(int x, int y, int units, MediaSizeName media)           从给定整数值构造新介质尺寸属性。

 

方法摘要
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)

从给定浮点值构造新介质尺寸属性。

参数：

x - X 维度。

y - Y 维度。

units - 单位转换因子，例如 Size2DSyntax.INCH 或 Size2DSyntax.MM。

抛出：

IllegalArgumentException - （未检查的异常）如果 x < 0 或 y < 0 或 units < 1 或 x > y，则抛出此异常。

---

MediaSize

public MediaSize(int x,
                 int y,
                 int units)

从给定整数值构造新介质尺寸属性。

参数：

x - X 维度。

y - Y 维度。

units - 单位转换因子，例如 Size2DSyntax.INCH 或 Size2DSyntax.MM。

抛出：

IllegalArgumentException - （未检查的异常）如果 x < 0 或 y < 0 或 units < 1 或 x > y，则抛出此异常。

---

MediaSize

public MediaSize(float x,
                 float y,
                 int units,
                 MediaSizeName media)

从给定浮点值构造新介质尺寸属性。

参数：

x - X 维度。

y - Y 维度。

units - 单位转换因子，例如 Size2DSyntax.INCH 或 Size2DSyntax.MM。

media - 与此 MediaSize 关联的介质名称

抛出：

IllegalArgumentException - （未检查的异常）如果 x < 0 或 y < 0 或 units < 1 或 x > y，则抛出此异常。

---

MediaSize

public MediaSize(int x,
                 int y,
                 int units,
                 MediaSizeName media)

从给定整数值构造新介质尺寸属性。

参数：

x - X 维度。

y - Y 维度。

units - 单位转换因子，例如 Size2DSyntax.INCH 或 Size2DSyntax.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.INCH 或 Size2DSyntax.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. 5.0
上一个类   下一个类	框架    无框架
摘要： 嵌套 | 字段 | 构造方法 | 方法	详细信息： 字段 | 构造方法 | 方法

---

提交错误或意见
有关更多的 API 参考资料和开发人员文档，请参阅 Java 2 SDK SE 开发人员文档。该文档包含更详细的、面向开发人员的描述，以及总体概述、术语定义、使用技巧和工作代码示例。

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