Spec-Zone.ru › OpenJDK 17

Класс PageAttributes

java.lang.Object
java.awt.PageAttributes
Все реализованные интерфейсы:
Cloneable
public final class PageAttributes extends Object implements Cloneable
Набор атрибутов, контролирующих вывод напечатанной страницы.

Экземпляры этого класса управляют состоянием цвета, размером бумаги (типом носителя), ориентацией, логическим началом, качеством печати и разрешением каждой страницы, использующей экземпляр. Имена атрибутов соответствуют протоколу печати по Интернету (IPP) 1.1, где это возможно. Значения атрибутов частично соответствуют стандарту, где это возможно.

Чтобы использовать метод, принимающий внутренний класс, передайте ссылку на одно из постоянных полей внутреннего класса. Код клиента не может создавать новые экземпляры типов внутренних классов, потому что ни один из этих классов не имеет публичного конструктора. Например, чтобы установить состояние цвета на монохромное, используйте следующий код: 

 import java.awt.PageAttributes;

 public class MonochromeExample {
     public void setMonochrome(PageAttributes pageAttributes) {
         pageAttributes.setColor(PageAttributes.ColorType.MONOCHROME);
     }
 }

Каждый атрибут IPP, который поддерживает значение по умолчанию attributeName, имеет соответствующий setattributeNameToDefault метод. Поля значений по умолчанию не предоставляются.

С:
1.3

Краткое описание вложенных классов

Модификатор и тип Класс Описание
static final class  PageAttributes.ColorType
Безопасная для типа перечисление возможных состояний цвета.
static final class  PageAttributes.MediaType
Безопасная для типа перечисление возможных размеров бумаги.
static final class  PageAttributes.OrientationRequestedType
Безопасная для типа перечисление возможных ориентаций.
static final class  PageAttributes.OriginType
Безопасная для типа перечисление возможных начальных точек.
static final class  PageAttributes.PrintQualityType
Безопасная для типа перечисление возможных качеств печати.

Краткое описание конструкторов

Конструктор Описание
PageAttributes()
Создает экземпляр PageAttributes со значениями по умолчанию для каждого атрибута.
PageAttributes(PageAttributes obj)
Создает экземпляр PageAttributes, являющийся копией предоставленного PageAttributes.
PageAttributes(PageAttributes.ColorType color, PageAttributes.MediaType media, PageAttributes.OrientationRequestedType orientationRequested, PageAttributes.OriginType origin, PageAttributes.PrintQualityType printQuality, int[] printerResolution)
Создает экземпляр PageAttributes со значениями, указанными для каждого атрибута.

Краткое описание методов

Модификатор и тип Метод Описание
Object clone()
Создает и возвращает копию PageAttributes.
boolean equals(Object obj)
Определяет, равны ли два PageAttributes.
PageAttributes.ColorType getColor()
Возвращает, будут ли страницы, использующие эти атрибуты, отображаться в цвете или монохромно.
PageAttributes.MediaType getMedia()
Возвращает размер бумаги для страниц, использующих эти атрибуты.
PageAttributes.OrientationRequestedType getOrientationRequested()
Возвращает ориентацию печати для страниц, использующих эти атрибуты.
PageAttributes.OriginType getOrigin()
Возвращает, будет ли рисование в координатах (0, 0) на страницах, использующих эти атрибуты, происходить в верхнем левом углу физической страницы или в верхнем левом углу области печати.
int[] getPrinterResolution()
Возвращает разрешение печати для страниц, использующих эти атрибуты.
PageAttributes.PrintQualityType getPrintQuality()
Возвращает качество печати для страниц, использующих эти атрибуты.
int hashCode()
Возвращает хэш-код для этого PageAttributes.
void set(PageAttributes obj)
Устанавливает все атрибуты этого PageAttributes в те же значения, что и атрибуты obj.
void setColor(PageAttributes.ColorType color)
Указывает, будут ли страницы, использующие эти атрибуты, отображаться в цвете или монохромно.
void setMedia(PageAttributes.MediaType media)
Указывает желаемый размер бумаги для страниц, использующих эти атрибуты.
void setMediaToDefault()
Устанавливает размер бумаги для страниц, использующих эти атрибуты, на размер по умолчанию для локального языка по умолчанию.
void setOrientationRequested(int orientationRequested)
Указывает ориентацию печати для страниц, использующих эти атрибуты.
void setOrientationRequested(PageAttributes.OrientationRequestedType orientationRequested)
Указывает ориентацию печати для страниц, использующих эти атрибуты.
void setOrientationRequestedToDefault()
Устанавливает ориентацию печати для страниц, использующих эти атрибуты, на значение по умолчанию.
void setOrigin(PageAttributes.OriginType origin)
Указывает, будет ли рисование в координатах (0, 0) на страницах, использующих эти атрибуты, происходить в верхнем левом углу физической страницы или в верхнем левом углу области печати.
void setPrinterResolution(int printerResolution)
Указывает желаемые разрешения печати по ходу и подачи в точках на дюйм для страниц, использующих эти атрибуты.
void setPrinterResolution(int[] printerResolution)
Указывает желаемое разрешение печати для страниц, использующих эти атрибуты.
void setPrinterResolutionToDefault()
Устанавливает разрешение принтера для страниц, использующих эти атрибуты, на значение по умолчанию.
void setPrintQuality(int printQuality)
Указывает качество печати для страниц, использующих эти атрибуты.
void setPrintQuality(PageAttributes.PrintQualityType printQuality)
Указывает качество печати для страниц, использующих эти атрибуты.
void setPrintQualityToDefault()
Устанавливает качество печати для страниц, использующих эти атрибуты, на значение по умолчанию.
String toString()
Возвращает строковое представление PageAttributes.

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

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

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

PageAttributes

public PageAttributes()
Создаёт экземпляр PageAttributes со значениями по умолчанию для каждого атрибута.

PageAttributes

public PageAttributes(PageAttributes obj)
Создаёт экземпляр PageAttributes, являющийся копией переданного PageAttributes.
Параметры:
obj - копируемый PageAttributes.

PageAttributes

public PageAttributes(PageAttributes.ColorType color, PageAttributes.MediaType media, PageAttributes.OrientationRequestedType orientationRequested, PageAttributes.OriginType origin, PageAttributes.PrintQualityType printQuality, int[] printerResolution)
Создаёт экземпляр PageAttributes со значениями каждого атрибута, указанными в списке параметров.
Параметры:
color - ColorType.COLOR или ColorType.MONOCHROME.
media - одно из константных полей класса MediaType.
orientationRequested - OrientationRequestedType.PORTRAIT или OrientationRequestedType.LANDSCAPE.
origin - OriginType.PHYSICAL или OriginType.PRINTABLE
printQuality - PrintQualityType.DRAFT, PrintQualityType.NORMAL или PrintQualityType.HIGH
printerResolution - целочисленный массив из 3 элементов. Первый элемент должен быть больше 0. Второй элемент должен быть больше 0. Третий элемент должен быть либо 3 или 4.
Исключения:
IllegalArgumentException - если одно или несколько из вышеперечисленных условий нарушены.

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

clone

public Object clone()
Создаёт и возвращает копию текущего PageAttributes.
Переопределяет:
clone в классе Object
Возвращает:
новую созданную копию. Безопасно приводить этот объект к типу PageAttributes.
См. также:
  • Cloneable

set

public void set(PageAttributes obj)
Устанавливает все атрибуты текущего PageAttributes в такие же значения, как атрибуты obj.
Параметры:
obj - копируемый PageAttributes.

getColor

public PageAttributes.ColorType getColor()
Возвращает, будут ли страницы, использующие эти атрибуты, отображаться в цвете или в монохроме. Этот атрибут обновляется до значения, выбранного пользователем.
Возвращает:
ColorType.COLOR или ColorType.MONOCHROME.

setColor

public void setColor(PageAttributes.ColorType color)
Определяет, будут ли страницы, использующие эти атрибуты, отображаться в цвете или в монохроме. Если этот атрибут не указан, то используется значение ColorType.MONOCHROME.
Параметры:
color - ColorType.COLOR или ColorType.MONOCHROME.
Исключения:
IllegalArgumentException - если цвет равен null.

getMedia

public PageAttributes.MediaType getMedia()
Возвращает размер бумаги для страниц, использующих эти атрибуты. Этот атрибут обновляется до значения, выбранного пользователем.
Возвращает:
одно из константных полей класса MediaType.

setMedia

public void setMedia(PageAttributes.MediaType media)
Устанавливает желаемый размер бумаги для страниц, использующих эти атрибуты. Фактический размер бумаги будет определяться ограничениями целевого принтера. Если точное совпадение не найдено, реализация выберет максимально близкое соответствие. Если этот атрибут не указан, используется значение по умолчанию для текущей локали. Значение по умолчанию для США и Канады — MediaType.NA_LETTER. Значение по умолчанию для всех других локалей — MediaType.ISO_A4.
Параметры:
media - одно из константных полей класса MediaType.
Исключения:
IllegalArgumentException - если media равно null.

setMediaToDefault

public void setMediaToDefault()
Устанавливает размер бумаги для страниц, использующих эти атрибуты, в значение по умолчанию для текущей локали. Значение по умолчанию для США и Канады — MediaType.NA_LETTER. Значение по умолчанию для всех других локалей — MediaType.ISO_A4.

getOrientationRequested

public PageAttributes.OrientationRequestedType getOrientationRequested()
Возвращает ориентацию печати для страниц, использующих эти атрибуты. Этот атрибут обновляется до значения, выбранного пользователем.
Возвращает:
OrientationRequestedType.PORTRAIT или OrientationRequestedType.LANDSCAPE.

setOrientationRequested

public void setOrientationRequested(PageAttributes.OrientationRequestedType orientationRequested)
Устанавливает ориентацию печати для страниц, использующих эти атрибуты. Если свойство не указано, то используется значение OrientationRequestedType.PORTRAIT.
Параметры:
orientationRequested - OrientationRequestedType.PORTRAIT или OrientationRequestedType.LANDSCAPE.
Исключения:
IllegalArgumentException - если orientationRequested равно null.

setOrientationRequested

public void setOrientationRequested(int orientationRequested)
Устанавливает ориентацию печати для страниц, использующих эти атрибуты. Значение 3 обозначает портретную ориентацию. Значение 4 обозначает альбомную ориентацию. Любое другое значение вызовет IllegalArgumentException. Если свойство не указано, вызывается setOrientationRequested(OrientationRequestedType.PORTRAIT).
Параметры:
orientationRequested - 3 или 4
Исключения:
IllegalArgumentException - если orientationRequested не равно 3 или 4

setOrientationRequestedToDefault

public void setOrientationRequestedToDefault()
Устанавливает ориентацию печати для страниц, использующих эти атрибуты, в значение по умолчанию. Значение по умолчанию — портретная ориентация.

getOrigin

public PageAttributes.OriginType getOrigin()
Возвращает, соответствует ли (0, 0) на страницах, использующих эти атрибуты, верхнему левому углу физической страницы или верхнему левому углу области печати. (Обратите внимание, что эти места могут совпадать.) Этот атрибут не может быть изменён и не зависит от ограничений реализации или целевого принтера.
Возвращает:
OriginType.PHYSICAL или OriginType.PRINTABLE

setOrigin

public void setOrigin(PageAttributes.OriginType origin)
Устанавливает, соответствует ли (0, 0) на страницах, использующих эти атрибуты, верхнему левому углу физической страницы или верхнему левому углу области печати. (Обратите внимание, что эти места могут совпадать.) Если свойство не указано, то используется значение OriginType.PHYSICAL.
Параметры:
origin - OriginType.PHYSICAL или OriginType.PRINTABLE
Исключения:
IllegalArgumentException - если origin равно null.

getPrintQuality

public PageAttributes.PrintQualityType getPrintQuality()
Возвращает качество печати для страниц, использующих эти атрибуты. Этот атрибут обновляется до значения, выбранного пользователем.
Возвращает:
PrintQualityType.DRAFT, PrintQualityType.NORMAL или PrintQualityType.HIGH

setPrintQuality

public void setPrintQuality(PageAttributes.PrintQualityType printQuality)
Устанавливает качество печати для страниц, использующих эти атрибуты. Если свойство не указано, то используется PrintQualityType.NORMAL.
Параметры:
printQuality - PrintQualityType.DRAFT, PrintQualityType.NORMAL или PrintQualityType.HIGH
Исключения:
IllegalArgumentException - если printQuality равно null.

setPrintQuality

public void setPrintQuality(int printQuality)
Устанавливает качество печати для страниц, использующих эти атрибуты. Значение 3 обозначает черновой вариант. Значение 4 обозначает нормальное качество. Значение 5 обозначает высокое качество. Любое другое значение вызовет IllegalArgumentException. Если свойство не указано, вызывается setPrintQuality(PrintQualityType.NORMAL).
Параметры:
printQuality - 3, 4, или 5
Исключения:
IllegalArgumentException - если printQuality не равно 3, 4, или 5

setPrintQualityToDefault

public void setPrintQualityToDefault()
Устанавливает качество печати для страниц, использующих эти атрибуты, в значение по умолчанию. Значение по умолчанию — нормальное качество.

getPrinterResolution

public int[] getPrinterResolution()
Возвращает разрешение печати для страниц, использующих эти атрибуты. Индекс 0 массива указывает разрешение по поперечному направлению (обычно горизонтальное разрешение). Индекс 1 массива указывает разрешение по направлению подачи (обычно вертикальное разрешение). Индекс 2 массива указывает, выражаются ли разрешения в точках на дюйм или точках на сантиметр. 3 обозначает точки на дюйм. 4 обозначает точки на сантиметр.
Возвращает:
целочисленный массив из 3 элементов. Первый элемент должен быть больше 0. Второй элемент должен быть больше 0. Третий элемент должен быть либо 3 или 4.

setPrinterResolution

public void setPrinterResolution(int[] printerResolution)
Устанавливает желаемое разрешение печати для страниц, использующих эти атрибуты. Фактическое разрешение будет определяться ограничениями реализации и целевого принтера. Индекс 0 массива задаёт разрешение по поперечной подаче (обычно горизонтальное разрешение). Индекс 1 массива задаёт разрешение по направлению подачи (обычно вертикальное разрешение). Индекс 2 массива указывает, заданы ли разрешения в точках на дюйм или точках на сантиметр. 3 обозначает точки на дюйм. 4 обозначает точки на сантиметр. Обратите внимание, что в реализации печати 1.1 (Toolkit.getPrintJob) требуется, чтобы разрешения подачи и поперечной подачи были одинаковыми. Отсутствие указания свойства эквивалентно вызову setPrinterResolution(72).
Parameters:
printerResolution - целочисленный массив из 3 элементов. Первый элемент должен быть больше 0. Второй элемент должен быть больше 0. Третий элемент должен быть либо 3 , либо 4.
Throws:
IllegalArgumentException - если одно или несколько из вышеперечисленных условий нарушены.

setPrinterResolution

public void setPrinterResolution(int printerResolution)
Устанавливает желаемое разрешение печати по поперечной подаче и подаче в точках на дюйм для страниц, использующих эти атрибуты. Одно и то же значение используется для обоих разрешений. Фактические разрешения будут определяться ограничениями реализации и целевого принтера. Отсутствие указания свойства эквивалентно указанию 72.
Parameters:
printerResolution - целое число, большее 0.
Throws:
IllegalArgumentException - если printerResolution меньше или равно 0.

setPrinterResolutionToDefault

public void setPrinterResolutionToDefault()
Устанавливает разрешение принтера для страниц, использующих эти атрибуты, по умолчанию. По умолчанию используется 72 dpi для разрешений подачи и поперечной подачи.

equals

public boolean equals(Object obj)
Определяет, равны ли два объекта PageAttributes друг другу.

Два объекта PageAttributes равны тогда и только тогда, когда равны все их атрибуты. Атрибуты перечисления равны тогда и только тогда, когда поля ссылаются на один и тот же уникальный объект перечисления. Это означает, что алиасированный носитель равен своему основному уникальному носителю. Разрешения принтера равны тогда и только тогда, когда разрешение подачи, разрешение поперечной подачи и единицы измерения равны.

Overrides:
equals в классе Object
Parameters:
obj - объект, равенство которого будет проверено.
Returns:
равен ли obj этому PageAttribute в соответствии с вышеуказанными критериями.
See Also:
  • Object.hashCode()
  • HashMap

hashCode

public int hashCode()
Возвращает значение хэш-кода для этого PageAttributes.
Overrides:
hashCode в классе Object
Returns:
хэш-код.
See Also:
  • Object.equals(java.lang.Object)
  • System.identityHashCode(java.lang.Object)

toString

public String toString()
Возвращает строковое представление этого PageAttributes.
Overrides:
toString в классе Object
Returns:
строковое представление.

© 1993, 2021, 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/17/docs/api/java.desktop/java/awt/PageAttributes.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API