Класс MediaPrintableArea

Все реализованные интерфейсы:
Serializable, Attribute, DocAttribute, PrintJobAttribute, PrintRequestAttribute 
public final class MediaPrintableArea
extends Object
implements DocAttribute, PrintRequestAttribute, PrintJobAttribute

Класс MediaPrintableArea — это атрибут печати, используемый для различения печатаемых и непечатаемых областей носителя.

Печатаемая область задаётся как прямоугольник в пределах общих размеров носителя.

Большинство принтеров не могут печатать на всей поверхности носителя из-за ограничений аппаратного обеспечения принтера. Этот класс можно использовать для запроса допустимых значений для предполагаемой работы по печати и для запроса области в пределах ограничений печатаемой области для использования в работе по печати.

Для запроса печатаемой области клиент должен предоставить подходящий контекст. Без указания по меньшей мере размера используемого носителя невозможно получить осмысленное значение для печатаемой области.

Атрибут не описывается в терминах расстояния от края бумаги, частично для того, чтобы подчеркнуть, что этот атрибут не является независимым от конкретного носителя, а должен быть описан в контексте выбора других атрибутов. Кроме того, обычно для клиента удобнее использовать печатаемую область.

Минимальные отступы оборудования зависят не только от принтера, но и от размера носителя, ориентации, типа носителя и любых указанных отделочных работ. PrintService предоставляет метод для запроса поддерживаемых значений атрибута в соответствующем контексте: см. PrintService.getSupportedAttributeValues()

Прямоугольная печатаемая область определяется следующим образом: начало координат (x, y) расположено в левом верхнем углу бумаги в портретном режиме, независимо от ориентации, указанной в запрашиваемом контексте. Например, печатаемая область для бумаги формата A4 в портретном или альбомном режиме будет иметь высоту > ширины.

Значения атрибута печатаемой области хранятся внутри в виде целых чисел в единицах микрон (мкм), где 1 микрон = 10-6 метра = 1/1000 миллиметра = 1/25400 дюйма. Это позволяет точно представлять размеры с точностью до 1/1000 мм (= 1 мкм) или 1/100 дюйма (= 254 мкм). Если дробные дюймы выражены в отрицательных степенях двойки, это позволяет точно представлять размеры с точностью до 1/8 дюйма (= 3175 мкм), но не 1/16 дюйма (потому что 1/16 дюйма не равно целому числу мкм).

Совместимость с IPP: MediaPrintableArea не является атрибутом IPP.

См. также:
Сериализованная форма

Поля

Модификатор и тип Поле Описание
static int INCH

Значение для указания единиц дюймов (дюйм).
static int 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)

Возвращает, эквивалентен ли данный атрибут полей для печати переданному объекту.
Class<? 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()

Возвращает строковое представление атрибута прямоугольного размера в мм.
String toString​(int units, String unitsName)

Возвращает строковое представление атрибута прямоугольного размера в заданных единицах.

Методы, объявленные в классе java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Поля

INCH

public static final int INCH

Значение для указания единиц дюймов (in). На самом деле это коэффициент пересчета, на который нужно умножить дюймы для получения мкм (25400).

См. также:
Значения постоянных полей

MM

public static final int MM

Значение для указания единиц миллиметров (мм). На самом деле это коэффициент пересчета, на который нужно умножить мм для получения мкм (1000).

См. также:
Значения постоянных полей

Конструкторы

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)

Получить область печати в виде массива из 4 значений в порядке x, y, w, h. Возвращаемые значения находятся в заданных единицах.

Параметры:
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
Возвращает:
y положение начала области печати в заданных единицах
Исключения:
IllegalArgumentException - если units < 1

getWidth

public float getWidth(int units)

Получить width области печати в заданных единицах.

Параметры:
units - коэффициент преобразования единиц, например, INCH или MM
Возвращает:
width области печати в заданных единицах
Исключения:
IllegalArgumentException - если units < 1

getHeight

public float getHeight(int units)

Получить height области печати в заданных единицах.

Параметры:
units - коэффициент преобразования единиц, например, INCH или MM
Возвращает:
height области печати в заданных единицах
Исключения:
IllegalArgumentException - если units < 1

equals

public boolean equals(Object object)

Возвращает, эквивалентен ли этот атрибут отступов печати переданному объекту. Для эквивалентности должны выполняться все следующие условия:

  1. object не равен null.
  2. object является экземпляром класса MediaPrintableArea.
  3. Начальная точка и размеры одинаковы.

Переопределяет:
equals в классе Object
Параметры:
object - Object для сравнения
Возвращает:
true если object эквивалентен этому атрибуту отступов печати, false в противном случае
См. также:
Object.hashCode(), HashMap

getCategory

public final Class<? extends Attribute> getCategory()

Получить класс атрибута печати, который будет использоваться в качестве "категории" для этого значения атрибута печати.

Для класса MediaPrintableArea, категория — сам класс MediaPrintableArea.

Определено в:
getCategory в интерфейсе Attribute
Возвращает:
класс атрибута печати (категория), экземпляр класса java.lang.Class

getName

public final String getName()

Получить имя категории, экземпляром которой является это значение атрибута.

Для класса MediaPrintableArea, имя категории — "media-printable-area".

Это не атрибут IPP V1.1.

Определено в:
getName в интерфейсе Attribute
Возвращает:
имя категории атрибута

toString

public String toString(int units,
                       String unitsName)

Возвращает строковое представление этого атрибута прямоугольного размера в заданных единицах.

Параметры:
units - коэффициент преобразования единиц, например, INCH или MM
unitsName - строка с именем единиц, например, "in" или "mm". Если null, имя единиц к результату не добавляется
Возвращает:
строковое представление этого атрибута двумерного размера
Исключения:
IllegalArgumentException - если units < 1

toString

public String toString()

Возвращает строковое представление этого атрибута прямоугольного размера в мм.

Переопределяет:
toString в классе Object
Возвращает:
строковое представление объекта.

hashCode

public int hashCode()

Возвращает значение хэша для этого атрибута.

Переопределяет:
hashCode в классе Object
Возвращает:
значение хэша для этого объекта.
См. также:
Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)

© 1993, 2020, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/javax/print/attribute/standard/MediaPrintableArea.html

Spec-Zone .ru
спецификации, руководства, описания, API