Module java.desktop

Class 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、北美、工程和其他媒体的嵌套类。

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

参见:
  • Constructor Details

    • MediaSize

      public MediaSize(float x, float y, int units)
      从给定的浮点值构造一个新的媒体尺寸属性。
      参数:
      x - X维度
      y - Y维度
      units - 单位转换因子,例如Size2DSyntax.INCHSize2DSyntax.MM
      抛出:
      IllegalArgumentException - 如果x < 0y < 0units < 1x > y
    • MediaSize

      public MediaSize(int x, int y, int units)
      从给定的整数值构造一个新的媒体尺寸属性。
      参数:
      x - X维度
      y - Y维度
      units - 单位转换因子,例如Size2DSyntax.INCHSize2DSyntax.MM
      抛出:
      IllegalArgumentException - 如果x < 0y < 0units < 1x > y
    • MediaSize

      public MediaSize(float x, float y, int units, MediaSizeName media)
      从给定的浮点值构造一个新的媒体尺寸属性。
      参数:
      x - X维度
      y - Y维度
      units - 单位转换因子,例如Size2DSyntax.INCHSize2DSyntax.MM
      media - 与此MediaSize关联的媒体名称
      抛出:
      IllegalArgumentException - 如果x < 0y < 0units < 1x > y
    • MediaSize

      public MediaSize(int x, int y, int units, MediaSizeName media)
      从给定的整数值构造一个新的媒体尺寸属性。
      参数:
      x - X维度
      y - Y维度
      units - 单位转换因子,例如Size2DSyntax.INCHSize2DSyntax.MM
      media - 与此MediaSize关联的媒体名称
      抛出:
      IllegalArgumentException - 如果x < 0y < 0units < 1x > y
  • Method Details

    • 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来定位MediaSizeName对象。如果最接近的匹配的MediaSize没有对应的Media实例,则此方法可能返回null

      此方法对于仅具有尺寸并希望找到与尺寸对应的Media的客户端很有用。

      参数:
      x - X维度
      y - Y维度
      units - 单位转换因子,例如Size2DSyntax.INCHSize2DSyntax.MM
      返回:
      匹配这些尺寸的MediaSizeName,或null
      抛出:
      IllegalArgumentException - 如果x <= 0y <= 0units < 1
    • equals

      public boolean equals(Object object)
      返回此媒体尺寸属性是否等同于传入的对象。要等同,必须满足以下所有条件:
      1. object不是null
      2. objectMediaSize类的实例。
      3. 此媒体尺寸属性的X维度等于objectX维度。
      4. 此媒体尺寸属性的Y维度等于objectY维度。
      覆盖:
      equals 在类 Size2DSyntax
      参数:
      object - 要比较的Object
      返回:
      如果object等同于此媒体尺寸属性,则返回true,否则返回false
      参见:
    • getCategory

      public final Class<? extends Attribute> getCategory()
      获取用作此打印属性值的“类别”的打印属性类。

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

      指定者:
      getCategory 在接口 Attribute
      返回:
      打印属性类(类别),是java.lang.Class类的实例
    • getName

      public final String getName()
      获取此属性值是其实例的类别的名称。

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

      指定者:
      getName 在接口 Attribute
      返回:
      属性类别名称