Spec-Zone.ru › OpenJDK 24

Класс 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).
Параметры:
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 равны тогда и только тогда, когда равны все их атрибуты. Атрибуты перечислимого типа равны тогда и только тогда, когда поля ссылаются на один и тот же уникальный объект перечисления. Это означает, что псевдоним среды равен своей основной уникальной среде. Разрешения принтера равны тогда и только тогда, когда разрешение подачи, разрешение поперечного перемещения и единицы измерения равны.

Overrides:
equals в классе Object
Параметры:
obj - объект, равенство которого необходимо проверить.
Возвращает:
true, если obj равен этому PageAttribute в соответствии с вышеуказанными критериями.
См. также:
  • Object.hashCode()
  • HashMap

hashCode

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

toString

public String toString()
Возвращает строковое представление этого PageAttributes.
Overrides:
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://download.java.net/java/early_access/jdk24/docs/api/java.desktop/java/awt/PageAttributes.html

Spec-Zone.ru

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