javax.print.attribute.standard

Class MediaSize

java.lang.Object

javax.print.attribute.Size2DSyntax

javax.print.attribute.standard.MediaSize

All Implemented Interfaces:

Serializable ， Cloneable ， Attribute

public class MediaSize
extends Size2DSyntax
implements Attribute

MediaSize类是一种二维尺寸值的打印属性类，它以纵向方向指示介质的尺寸，X尺寸沿着底边缘运行，Y尺寸沿着左边缘运行。 因此，Y尺寸必须大于或等于X尺寸。 MediaSize类将许多标准介质尺寸值声明为ISO，JIS，北美，工程和其他介质的嵌套类。

MediaSize尚未用于指定媒体。 它当前的作用是作为命名媒体的映射（见MediaSizeName ）。 客户端可以使用映射方法MediaSize.getMediaSizeForName(MediaSizeName)查找此API中枚举的MediaSizeName实例的物理尺寸。 这对于需要此信息来格式化和分页打印的客户端是有用的。

另请参见：

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MediaSize.Engineering Class MediaSize.Engineering包括工程媒体的MediaSize值。
static class	MediaSize.ISO MediaSize.ISO类包含ISO媒体的MediaSize值。
static class	MediaSize.JIS Class MediaSize.JIS包括JIS（日本）媒体的MediaSize值。
static class	MediaSize.NA MediaSize.NA类包括北美媒体的MediaSize值。
static class	MediaSize.Other Class MediaSize.Other包括杂项媒体的MediaSize值。

Field Summary

Fields inherited from class javax.print.attribute.Size2DSyntax

INCH, MM

构造方法摘要

构造方法

Constructor and Description
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) 从给定的整数值构造一个新的媒体大小属性。

方法摘要

Modifier and Type	Method and Description
boolean	equals(Object object) 返回此media size属性是否等同于传入的对象。
static MediaSizeName	findMedia(float x, float y, int units) 指定的维度用于从所有标准MediaSize实例中定位匹配的MediaSize实例。
类<? extends Attribute>	getCategory() 获取要用作此打印属性值的“类别”的打印属性类。
static MediaSize	getMediaSizeForName(MediaSizeName media) 获取指定的指定介质的MediaSize。
MediaSizeName	getMediaSizeName() 获取此尺寸的媒体名称（如果有）。
String	getName() 获取此属性值是一个实例的类别的名称。

Methods inherited from class javax.print.attribute.Size2DSyntax

getSize, getX, getXMicrometers, getY, getYMicrometers, hashCode, toString, toString

Methods inherited from class 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。

该方法对于仅具有维度并且希望找到与尺寸对应的媒体的客户端是有用的。

参数

x - - X尺寸

y - - Y维。

units - 单位换算系数，例如 Size2DSyntax.INCH或 Size2DSyntax.MM

结果

MediaSizeName与这些维度相匹配，或为null。

异常

IllegalArgumentException -如果 x <= 0 ， y <= 0 ，或 units < 1 。

equals

public boolean equals(Object object)

返回此media size属性是否等同于传入的对象。 要相等的，所有以下条件必须为真：

1. object不为空。
2. object是MediaSize类的一个实例。
3. 此介质尺寸属性的X尺寸等于object的X尺寸。
4. 此介质尺寸属性的Y尺寸等于object的Y尺寸。

重写：

equals在 Size2DSyntax

参数

object - 要比较的对象。

结果

如果 object等效于此媒体大小属性，则为True， object为false。

另请参见：

Object.hashCode() ， HashMap

getCategory

public final 类<? extends Attribute> getCategory()

获取要用作此打印属性值的“类别”的打印属性类。

对于MediaSize类和任何供应商定义的子类，该类别是MediaSize本身。

Specified by:

getCategory在界面 Attribute

结果

打印属性类（category），类为java.lang.Class的一个实例。

getName

public final String getName()

获取此属性值是一个实例的类别的名称。

对于MediaSize类和任何供应商定义的子类，类别名称为"media-size" 。

Specified by:

getName在接口 Attribute

结果

属性类别名称。