Класс 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 final class`	`MediaSize.Engineering`	Класс `MediaSize.Engineering` включает значения `MediaSize` для инженерных носителей.
`static final class`	`MediaSize.ISO`	Класс `MediaSize.ISO` включает значения `MediaSize` для носителей ISO.
`static final class`	`MediaSize.JIS`	Класс `MediaSize.JIS` включает значения `MediaSize` для носителей JIS (японских).
`static final class`	`MediaSize.NA`	Класс `MediaSize.NA` включает значения `MediaSize` для североамериканских носителей.
`static final 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`.
`final Class<? extends Attribute>`	`getCategory()`	Получение класса атрибута печати, который будет использоваться в качестве «категории» для этого значения атрибута печати.
`static MediaSize`	`getMediaSizeForName(MediaSizeName media)`	Получение `MediaSize` для указанного именованного носителя.
`MediaSizeName`	`getMediaSizeName()`	Получение имени носителя, если оно есть, для этого размера.
`final 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. Если точного совпадения нет, используется ближайшее совпадение.

Ближайшее совпадение в свою очередь используется для поиска объекта 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 этого атрибута размера носителя равен размеру по object объекта.
Размер по Y этого атрибута размера носителя равен размеру по object объекта.

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

equals в классе Size2DSyntax

Параметры:

object - Object для сравнения

Возвращает:

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

См. также:

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, 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/MediaSize.html