模块  java.desktop
软件包  javax.print.attribute.standard

Class 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实例的物理尺寸。 这对需要此信息格式化和分页打印的客户非常有用。

    另请参见：
    Serialized Form

    • 构造方法详细信息

      • 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)
        返回此媒体大小属性是否等效于传入的对象。 为了等效，所有以下条件必须为真：
        1. object不是null 。
        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
        结果
        打印属性类（类别），类java.lang.Class的实例

      • getName

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

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

        Specified by:
        getName ，界面 Attribute
        结果
        属性类别名称