Module  java.desktop
软件包  javax.print.attribute.standard

Class MediaPrintableArea

  • All Implemented Interfaces:
    Serializable ， Attribute ， DocAttribute ， PrintJobAttribute ， PrintRequestAttribute 

    public final class MediaPrintableArea
extends Object
implements DocAttribute, PrintRequestAttribute, PrintJobAttribute
    MediaPrintableArea类是用于区分可打印区域和不可打印区域的打印属性。

    可打印区域在介质的总体尺寸内被指定为矩形。

    由于打印机硬件限制，大多数打印机无法在介质的整个表面上进行打印。 该类可用于查询假定的打印作业的可接受值，并请求在可打印区域的限制内的区域用于打印作业。

    要查询可打印区域，客户端必须提供合适的上下文。 至少没有指定使用的介质的尺寸，可以获得可印刷区域的有意义的值。

    该属性没有以与纸张边缘的距离来描述，部分是为了强调该属性不是独立于特定媒体，而是必须在选择其他属性的上下文中进行描述。 此外，客户端通常更方便地使用可打印区域。

    硬件的最小边距不仅仅是打印机的属性，而是可能是介质尺寸，方向，介质类型和任何指定的功能的函数。 PrintService提供了在适当的上下文中查询属性的支持值的方法：参见PrintService.getSupportedAttributeValues()

    矩形可打印区域由此定义：（x，y）原点位于纸张的左上角，而不管请求上下文中指定的方向如何。 例如，纵向或横向A4纸的可打印区域的高度>宽度。

    可打印区域属性的值作为整数以微米（μm）为单位存储，其中1微米= 10 -6米= 1/1000毫米= 1/25400英寸。 这允许尺寸精确地表示为1/1000mm（=1μm）或1/100英寸（=254μm）的精度。 如果分数英寸以两个负功率表示，则允许尺寸精确地表示为1/8英寸（=3175μm）但不是1/16英寸的精度（因为1/16英寸不等于整数Âμm）。

    IPP兼容性： MediaPrintableArea不是IPP属性。

    另请参见：
    Serialized Form

    • Field Summary

      Fields  
      Modifier and Type Field 描述
      static int INCH
      值表示英寸单位（英寸）。
      static int MM
      值表示毫米（mm）单位。

    • 构造方法摘要

      构造方法  
      Constructor 描述
      MediaPrintableArea​(float x, float y, float w, float h, int units)
      从浮点值构造一个MediaPrintableArea对象。
      MediaPrintableArea​(int x, int y, int w, int h, int units)
      从整数值构造MediaPrintableArea对象。

    • 方法摘要

      所有方法  接口方法  具体的方法 
      Modifier and Type 方法 描述
      boolean equals​(Object object)
      返回此介质边距属性是否等同于传入的对象。
      Class<? extends Attribute> getCategory​()
      获取要用作此打印属性值的“类别”的打印属性类。
      float getHeight​(int units)
      X- 2004545 X-
      String getName​()
      获取此属性值是一个实例的类别的名称。
      float[] getPrintableArea​(int units)
      将可打印区域按照x，y，w，h的顺序排列为4个数组。
      float getWidth​(int units)
      以指定单位获取可打印区域的宽度。
      float getX​(int units)
      以指定单位获取可打印区域的原点的x位置。
      float getY​(int units)
      以指定单位获取可打印区域的原点的y位置。
      int hashCode​()
      返回此属性的哈希码值。
      String toString​()
      返回以mm为单位的矩形大小属性的字符串版本。
      String toString​(int units, String unitsName)
      返回给定单位的此矩形大小属性的字符串版本。

    • 字段详细信息

      • INCH

        public static final int INCH
        值表示英寸单位（英寸）。 实际上是通过乘以英寸产生Âμm（25400）的转换因子。
        另请参见：
        Constant Field Values

      • MM

        public static final int MM
        值表示毫米（mm）单位。 实际上是乘以mm的转换因子，得到Âμm（1000）。
        另请参见：
        Constant Field Values

    • 构造方法详细信息

      • MediaPrintableArea

        public MediaPrintableArea​(float x,
                          float y,
                          float w,
                          float h,
                          int units)
        从浮点值构造一个MediaPrintableArea对象。
        参数
        x - 可打印x
        y - 可打印y
        w - 可打印宽度
        h - 可打印高度
        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 - 可打印宽度
        h - 可打印的高度
        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 。
        结果
        可指定单位的可打印区域的原点位置。
        异常
        IllegalArgumentException - （未经检查的异常）抛出，如果 units < 1 。

      • getWidth

        public float getWidth​(int units)
        以指定单位获取可打印区域的宽度。
        参数
        units - 单位换算系数，例如 INCH或 MM 。
        结果
        可打印区域的宽度为指定单位。
        异常
        IllegalArgumentException - （未经检查的异常）抛出 units < 1 。

      • getHeight

        public float getHeight​(int units)
        X- 2004545 X-
        参数
        units - 单位换算系数，例如 INCH或 MM 。
        结果
        可打印区域的高度在指定单位。
        异常
        IllegalArgumentException - （未经检查的异常）抛出 units < 1 。

      • equals

        public boolean equals​(Object object)
        返回此介质边距属性是否等同于传入的对象。 要相等的，所有以下条件必须为真：
        1. object不为空。
        2. object是MediaPrintableArea类的一个实例。
        3. 原点和尺寸是一样的。
        重写：
        equals Object
        参数
        object - 要比较的对象。
        结果
        如果 object等效于此媒体边距属性， object true，否则为false。
        另请参见：
        Object.hashCode() ， HashMap

      • getCategory

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

        对于MediaPrintableArea类，该类别是MediaPrintableArea类。

        Specified by:
        getCategory在接口 Attribute
        结果
        打印属性类（category），一个java.lang.Class类的实例。

      • getName

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

        对于MediaPrintableArea类，类别名称为"media-printable-area" 。

        这不是IPP V1.1属性。

        Specified by:
        getName在接口 Attribute
        结果
        属性类别名称。

      • toString

        public String toString​(int units,
                       String unitsName)
        返回给定单位的此矩形大小属性的字符串版本。
        参数
        units - 单位换算系数，例如 INCH或 MM 。
        unitsName - 单位名称字符串，例如"in"或"mm" 。 如果为空，则不会在结果附加单位名称。
        结果
        这个二维大小属性的字符串版本。
        异常
        IllegalArgumentException - （未经检查的异常）抛出 units < 1 。

      • toString

        public String toString​()
        返回以mm为单位的矩形大小属性的字符串版本。
        重写：
        toString在 Object
        结果
        对象的字符串表示形式。