Класс 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) располагается в верхнем левом углу бумаги в книжной ориентации независимо от ориентации, указанной в контексте запроса. Например, область печати для бумаги A4 в книжной или альбомной ориентации будет иметь высоту больше ширины.

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

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

См. также:

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

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

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

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

Подробное описание полей

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 < 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, 2025, 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/25/docs/api/java.desktop/javax/print/attribute/standard/MediaPrintableArea.html