Класс MediaPrintableArea

java.lang.Object

javax.print.attribute.standard.MediaPrintableArea

Все реализованные интерфейсы:: Serializable, Attribute, DocAttribute, PrintJobAttribute, PrintRequestAttribute

public final class MediaPrintableArea extends Object implements DocAttribute, PrintRequestAttribute, PrintJobAttribute

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

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

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

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

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

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

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

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

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

См. также:

Сериализованная форма

Краткое описание полей

Модификатор и тип	Поле	Описание
`static final int`	`INCH`	Значение для указания единиц дюймов (дюйм).
`static final 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)`	Возвращает, эквивалентен ли этот атрибут отступов носителя переданному объекту.
`final Class<? extends Attribute>`	`getCategory()`	Возвращает класс атрибута печати, который следует использовать в качестве "категории" для этого значения атрибута печати.
`float`	`getHeight(int units)`	Получить `height` печатаемой области в указанных единицах.
`final 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)

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

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

Overrides:

equals в классе Object

Параметры:

object - объект для сравнения

Возвращает:

true, если object эквивалентен этому атрибуту области печати, false в противном случае

См. также:

getCategory

public final Class<? 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 - коэффициент преобразования единиц, например, INCH или MM; unitsName - строка с именем единиц, например, "in" или "mm". Если null, имя единиц не добавляется к результату
Возвращает:: строковое представление этого атрибута двумерных размеров
Исключения:: IllegalArgumentException - если units < 1

toString

public String toString()

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

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

hashCode

public int hashCode()

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

Overrides:

hashCode в классе Object

Возвращает:

хэш-код для этого объекта.

См. также:

© 1993, 2021, 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/17/docs/api/java.desktop/javax/print/attribute/standard/MediaPrintableArea.html