Класс MediaPrintableArea

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.

Поля

INCH

public static final int INCH

Значение для указания единиц измерения дюймов (дюйм). Фактически, это коэффициент пересчета, необходимый для перевода дюймов в мкм (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)

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

Параметры:

units - Коэффициент перевода единиц, например, INCH или MM.

Возвращает:

Ширина области печати в указанных единицах.

Исключения:

IllegalArgumentException - (исключение, не обрабатываемое) Бросается, если units < 1.

getHeight

public float getHeight(int units)

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

Параметры:

units - Коэффициент перевода единиц, например, INCH или MM.

Возвращает:

Высота области печати в указанных единицах.

Исключения:

IllegalArgumentException - (исключение, не обрабатываемое) Бросается, если units < 1.

equals

public boolean equals(Object object)

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

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

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

equals в классе Object

Параметры:

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

Возвращает:

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

См. также:

Object.hashCode(), HashMap

getCategory

public final Class<? extends Attribute> getCategory()

Определено в:

getCategory в интерфейсе Attribute

Возвращает:

Класс атрибута печати (категория), экземпляр класса java.lang.Class.

getName

public final String getName()

Определено в:

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)