Класс 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 class  PageAttributes.ColorType

Безопасное для типов перечисление возможных состояний цвета.
static class  PageAttributes.MediaType

Безопасное для типов перечисление возможных размеров бумаги.
static class  PageAttributes.OrientationRequestedType

Безопасное для типов перечисление возможных ориентаций.
static class  PageAttributes.OriginType

Безопасное для типов перечисление возможных начальных положений.
static 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.

Overrides:
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 - объект, чёё равенство проверяется.
Возвращает:
равен ли obj этому PageAttribute в соответствии с вышеуказанными критериями.
См. также:
Object.hashCode(), HashMap

hashCode

public int hashCode()

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

Переопределяет:
hashCode в классе Object
Возвращает:
код хэша.
См. также:
Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)

toString

public String toString()

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

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

© 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/java/awt/PageAttributes.html

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