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