Класс MediaSize

java.lang.Object
- javax.print.attribute.Size2DSyntax
- - javax.print.attribute.standard.MediaSize

Все реализуемые интерфейсы:: Serializable, Cloneable, Attribute

public class MediaSize
extends Size2DSyntax
implements Attribute

Класс MediaSize — это класс печати с двумерным размером, который указывает размеры носителя в портретном ориентировании, причём размер X проходит по нижнему краю, а размер Y — по левому. Таким образом, размер Y должен быть больше или равен размеру X. Класс MediaSize объявляет множество стандартных значений размеров носителя, организованных во вложенные классы для ISO, JIS, североамериканских, инженерных и других носителей.

MediaSize пока не используется для задания носителя. Его текущая роль — как отображение для именованных носителей (см. MediaSizeName). Клиенты могут использовать метод отображения MediaSize.getMediaSizeForName(MediaSizeName) для поиска физических размеров экземпляров MediaSizeName, перечисленных в этом API. Это полезно для клиентов, которым нужна эта информация для форматирования и компоновки печати.

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

Вложенные классы

Модификатор и тип	Класс и описание
`static class`	`MediaSize.Engineering` Класс MediaSize.Engineering содержит значения `MediaSize` для инженерных носителей.
`static class`	`MediaSize.ISO` Класс MediaSize.ISO содержит значения `MediaSize` для носителей ISO.
`static class`	`MediaSize.JIS` Класс MediaSize.JIS содержит значения `MediaSize` для носителей JIS (японских).
`static class`	`MediaSize.NA` Класс MediaSize.NA содержит значения `MediaSize` для североамериканских носителей.
`static class`	`MediaSize.Other` Класс MediaSize.Other содержит значения `MediaSize` для различных носителей.

Поля

Поля, унаследованные от класса javax.print.attribute.Size2DSyntax

INCH, MM

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

Конструктор и описание
`MediaSize(float x, float y, int units)` Создаёт новый атрибут размера носителя из заданных значений с плавающей точкой.
`MediaSize(float x, float y, int units, MediaSizeName media)` Создаёт новый атрибут размера носителя из заданных значений с плавающей точкой.
`MediaSize(int x, int y, int units)` Создаёт новый атрибут размера носителя из заданных целочисленных значений.
`MediaSize(int x, int y, int units, MediaSizeName media)` Создаёт новый атрибут размера носителя из заданных целочисленных значений.

Методы

Модификатор и тип	Метод и описание
`boolean`	`equals(Object object)` Возвращает, эквивалентен ли этот атрибут размера носителя переданному объекту.
`static MediaSizeName`	`findMedia(float x, float y, int units)` Заданные размеры используются для поиска соответствующего экземпляра MediaSize среди всех стандартных экземпляров MediaSize.
`Class<? extends Attribute>`	`getCategory()` Получение класса атрибута печати, который должен использоваться в качестве "категории" для этого значения атрибута печати.
`static MediaSize`	`getMediaSizeForName(MediaSizeName media)` Получение MediaSize для указанного именованного носителя.
`MediaSizeName`	`getMediaSizeName()` Получение имени носителя, если оно есть, для этого размера.
`String`	`getName()` Получение имени категории, экземпляром которой является это значение атрибута.

Методы, унаследованные от класса javax.print.attribute.Size2DSyntax

getSize, getX, getXMicrometers, getY, getYMicrometers, hashCode, toString, toString

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

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

Подробное описание конструкторов

MediaSize

public MediaSize(float x,
                 float y,
                 int units)

Создаёт новый атрибут размера носителя из заданных значений с плавающей точкой.

Параметры:: x - Размер по оси X.; y - Размер по оси Y.; units - Коэффициент преобразования единиц, например, Size2DSyntax.INCH или Size2DSyntax.MM.
Исключения:: IllegalArgumentException - (исключение без проверки) Выбрасывается, если x < 0 или y < 0 или units < 1 или x > y.

MediaSize

public MediaSize(int x,
                 int y,
                 int units)

Создаёт новый атрибут размера носителя из заданных целочисленных значений.

Параметры:: x - Размер по оси X.; y - Размер по оси Y.; units - Коэффициент преобразования единиц, например, Size2DSyntax.INCH или Size2DSyntax.MM.
Исключения:: IllegalArgumentException - (исключение без проверки) Выбрасывается, если x < 0 или y < 0 или units < 1 или x > y.

MediaSize

public MediaSize(float x,
                 float y,
                 int units,
                 MediaSizeName media)

Создаёт новый атрибут размера носителя из заданных значений с плавающей точкой.

Параметры:: x - Размер по оси X.; y - Размер по оси Y.; units - Коэффициент преобразования единиц, например, Size2DSyntax.INCH или Size2DSyntax.MM.; media - имя носителя, которое следует связать с этим MediaSize
Исключения:: IllegalArgumentException - (исключение без проверки) Выбрасывается, если x < 0 или y < 0 или units < 1 или x > y.

MediaSize

public MediaSize(int x,
                 int y,
                 int units,
                 MediaSizeName media)

Создаёт новый атрибут размера носителя из заданных целочисленных значений.

Параметры:: x - Размер по оси X.; y - Размер по оси Y.; units - Коэффициент преобразования единиц, например, Size2DSyntax.INCH или Size2DSyntax.MM.; media - имя носителя, которое следует связать с этим MediaSize
Исключения:: IllegalArgumentException - (исключение без проверки) Выбрасывается, если x < 0 или y < 0 или units < 1 или x > y.

Подробное описание методов

getMediaSizeName

public MediaSizeName getMediaSizeName()

Получение имени носителя, если оно есть, для этого размера.

Возвращает:: имя для этого размера носителя или null, если с этим размером не было связано никакого имени (анонимный размер).

getMediaSizeForName

public static MediaSize getMediaSizeForName(MediaSizeName media)

Получение MediaSize для указанного именованного носителя.

Параметры:: media - - имя носителя, размер которого требуется получить
Возвращает:: размер носителя или null, если этому носителю не был сопоставлен ни один размер.

findMedia

public static MediaSizeName findMedia(float x,
                                      float y,
                                      int units)

Заданные размеры используются для поиска соответствующего экземпляра MediaSize среди всех стандартных экземпляров MediaSize. Если точного совпадения нет, используется наиболее близкое совпадение.

MediaSize в свою очередь используется для поиска объекта MediaSizeName. Этот метод может вернуть null, если у наиболее близко соответствующего MediaSize нет соответствующего экземпляра Media.

Этот метод полезен для клиентов, у которых есть только размеры и которые хотят найти Media, соответствующий этим размерам.

Параметры:: x - - Размер по оси X; y - - Размер по оси Y.; units - Коэффициент преобразования единиц, например, Size2DSyntax.INCH или Size2DSyntax.MM
Возвращает:: MediaSizeName, соответствующий этим размерам, или null.
Исключения:: IllegalArgumentException - если x <= 0, y <= 0, или units < 1.

equals

public boolean equals(Object object)

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

object не равно null.
object является экземпляром класса MediaSize.
Размер по оси X этого атрибута размера носителя равен размеру по оси X object.
Размер по оси Y этого атрибута размера носителя равен размеру по оси Y object.

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

getCategory

public final Class<? extends Attribute> getCategory()

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

Для класса MediaSize и любых подклассов, определённых поставщиком, категорией является сам класс MediaSize.

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

getName

public final String getName()

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

Для класса MediaSize и любых подклассов, определённых поставщиком, имя категории — "media-size".

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

© 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.