Класс 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, существует соответствующий метод 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

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

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

Возвращает:

созданную копию. Этот объект 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 точки на дюйм для разрешения как в направлении подачи бумаги, так и в поперечном направлении.

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.
https://docs.oracle.com/en/java/javase/25/docs/api/java.desktop/java/awt/PageAttributes.html