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

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

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

Переопределяет:

equals в классе Object

Параметры:

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

Возвращает:

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

См. также:

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

Возвращает:

значение хэша для этого объекта.

См. также:

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