Класс PageAttributes

java.lang.Object

java.awt.PageAttributes

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

public final class PageAttributes extends Object implements Cloneable

Набор атрибутов, управляющих выводом печатной страницы.

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

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

import java.awt.PageAttributes;

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

Каждому атрибуту IPP, для которого поддерживается значение по умолчанию attributeName-default, соответствует метод 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.

Методы, объявленные в классе Object

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

Модификатор и тип	Метод	Описание
`protected void`	`finalize()`	Устарело, подлежит удалению: этот элемент API будет удален в будущей версии. Финализация устарела и будет удалена в одном из следующих выпусков.
`final Class<?>`	`getClass()`	Возвращает класс времени выполнения этого `Object`.
`final void`	`notify()`	Пробуждает один поток, ожидающий на мониторе этого объекта.
`final void`	`notifyAll()`	Пробуждает все потоки, ожидающие на мониторе этого объекта.
`final void`	`wait()`	Заставляет текущий поток ожидать пробуждения, обычно в результате уведомления или прерывания.
`final void`	`wait(long timeoutMillis)`	Заставляет текущий поток ожидать пробуждения, обычно в результате уведомления или прерывания, либо истечения заданного промежутка реального времени.
`final void`	`wait(long timeoutMillis, int nanos)`	Заставляет текущий поток ожидать пробуждения, обычно в результате уведомления или прерывания, либо истечения заданного промежутка реального времени.

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

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.

См. также:

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 — если color равен 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).

Параметры:: printerResolution — целочисленный массив из 3 элементов. Первый элемент должен быть больше 0. Второй элемент также должен быть больше 0. Третий элемент должен быть равен 3 или 4.
Исключения:: IllegalArgumentException — если нарушено одно или несколько из перечисленных выше условий.

setPrinterResolution

public void setPrinterResolution(int printerResolution)

Задает желаемое разрешение печати в направлениях поперечной подачи и подачи в точках на дюйм для страниц с этими атрибутами. Для обоих разрешений используется одно и то же значение. Фактические разрешения определяются ограничениями реализации и целевого принтера. Если свойство не задано, это равносильно указанию 72.

Параметры:: printerResolution — целое число больше 0.
Исключения:: IllegalArgumentException — если printerResolution меньше или равно 0.

setPrinterResolutionToDefault

public void setPrinterResolutionToDefault()

Задает для страниц с этими атрибутами разрешение принтера по умолчанию. По умолчанию для разрешения в направлениях подачи и поперечной подачи используется значение 72 dpi.

equals

public boolean equals(Object obj)

Определяет, равны ли друг другу два объекта PageAttributes.

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

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

equals в классе Object

Параметры:

obj — объект, равенство которого будет проверяться.

Возвращает:

сведения о том, равен ли obj этому PageAttribute согласно приведенным выше критериям.

См. также:

hashCode

public int hashCode()

Возвращает значение хеш-кода для этого PageAttributes.

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

hashCode в классе Object

Возвращает:

хеш-код.

См. также:

toString

public String toString()

Возвращает строковое представление этого PageAttributes.

Переопределяет:: toString в классе Object
Возвращает:: строковое представление.

© 1993, 2025, 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.