Класс 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. Если точного совпадения нет, используется ближайшее соответствие.

Ближайшее соответствие используется в свою очередь для поиска объекта 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)

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

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

Переопределяет:
equals в классе Size2DSyntax
Параметры:
object - 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.
https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/javax/print/attribute/standard/MediaSize.html

Spec-Zone .ru
спецификации, руководства, описания, API