Класс PageAttributes

public final class PageAttributes
extends Object
implements Cloneable

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

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

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

import java.awt.PageAttributes;

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

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

Конструкторы

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)

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

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

Возвращает:

строковое представление.