模块  java.desktop

Class MediaPrintableArea

  • 实现的所有接口
    SerializableAttributeDocAttributePrintJobAttributePrintRequestAttribute

    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/1000 mm(=1μm)或1/100英寸(=254μm)。 如果分数英寸以2的负幂表示,则允许尺寸精确表示精度为1/8英寸(= 3175微米)但不是1/16英寸(因为1/16英寸不等于整数Âμm)。

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

    另请参见:
    Serialized Form
    • 字段汇总

      字段  
      变量和类型 字段 描述
      static int INCH
      表示英寸(in)单位的值。
      static int MM
      表示毫米(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)
      返回此媒体边距属性是否等效于传入的对象。
      <? extends Attribute> getCategory()
      获取将用作此打印属性值的“类别”的打印属性类。
      float getHeight​(int units)
      获取指定单位的可打印区域的 height
      String getName()
      获取此属性值为实例的类别的名称。
      float[] getPrintableArea​(int units)
      将可打印区域作为4个值的数组,顺序为 x, y, w, h
      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)
      以给定单位返回此矩形大小属性的字符串版本。
    • 字段详细信息

      • INCH

        public static final int INCH
        表示英寸(in)单位的值。 它实际上是乘以英寸以产生Âμm(25400)的转换因子。
        另请参见:
        常数字段值
      • MM

        public static final int MM
        表示毫米(mm)单位的值。 它实际上是将mm乘以屈服μm(1000)的转换因子。
        另请参见:
        常数字段值
    • 构造方法详细信息

      • MediaPrintableArea

        public MediaPrintableArea​(float x,
                                  float y,
                                  float w,
                                  float h,
                                  int units)
        根据浮点值构造一个 MediaPrintableArea对象。
        参数
        x - 可打印x
        y - 可打印y
        w - 可打印宽度
        h - 可打印高度
        units - 表示值
        异常
        IllegalArgumentException - 如果 x < 0y < 0w <= 0h <= 0units < 1
      • MediaPrintableArea

        public MediaPrintableArea​(int x,
                                  int y,
                                  int w,
                                  int h,
                                  int units)
        从整数值构造 MediaPrintableArea对象。
        参数
        x - 可打印x
        y - 可打印的y
        w - 可打印宽度
        h - 可打印高度
        units - 表示值
        异常
        IllegalArgumentException - 如果 x < 0y < 0w <= 0h <= 0units < 1
    • 方法详细信息

      • getPrintableArea

        public float[] getPrintableArea​(int units)
        将可打印区域作为4个值的数组,顺序为x, y, w, h 返回的值以给定单位表示。
        参数
        units - 单位转换因子,例如 INCHMM
        结果
        可打印区域,以指定单位的数组 x, y, w, h
        异常
        IllegalArgumentException - 如果 units < 1
      • getX

        public float getX​(int units)
        获取指定单位的可打印区域原点的 x位置。
        参数
        units - 单位转换因子,例如 INCHMM
        结果
        x指定单位中可打印区域的原点位置
        异常
        IllegalArgumentException - 如果 units < 1
      • getY

        public float getY​(int units)
        获取指定单位的可打印区域原点的 y位置。
        参数
        units - 单位换算系数,例如 INCHMM
        结果
        y以指定单位表示可打印区域的原点
        异常
        IllegalArgumentException - 如果 units < 1
      • getWidth

        public float getWidth​(int units)
        以指定单位获取可打印区域的 width
        参数
        units - 单位转换因子,例如 INCHMM
        结果
        width指定单位的可打印区域
        异常
        IllegalArgumentException - 如果 units < 1
      • getHeight

        public float getHeight​(int units)
        获取指定单位的可打印区域的 height
        参数
        units - 单位换算系数,例如 INCHMM
        结果
        height指定单位的可打印区域
        异常
        IllegalArgumentException - 如果 units < 1
      • equals

        public boolean equals​(Object object)
        返回此媒体边距属性是否等效于传入的对象。 为了等效,所有以下条件必须为真:
        1. object不是null
        2. object是类MediaPrintableArea的实例。
        3. 原点和尺寸是相同的。
        重写:
        equalsObject
        参数
        object - Object来比较
        结果
        true如果 object等效于此媒体边距属性, false
        另请参见:
        Object.hashCode()HashMap
      • getCategory

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

        对于类MediaPrintableArea ,该类别是类MediaPrintableArea本身。

        Specified by:
        getCategory接口 Attribute
        结果
        打印属性类(类别),类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 - 单位转换因子,例如 INCHMM
        unitsName - 单位名称字符串,例如"in""mm" 如果是null ,则不会在结果中附加单位名称
        结果
        这个二维大小属性的字符串版本
        异常
        IllegalArgumentException - 如果 units < 1
      • toString

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