Класс JobAttributes

public final class JobAttributes
extends Object
implements Cloneable

Набор атрибутов, контролирующих печать задания.

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

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

import java.awt.JobAttributes;

 public class PureJavaPrintDialogExample {
     public void setPureJavaPrintDialog(JobAttributes jobAttributes) {
         jobAttributes.setDialog(JobAttributes.DialogType.COMMON);
     }
 }

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

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

JobAttributes

public JobAttributes()

Создаёт экземпляр JobAttributes с значениями по умолчанию для каждого атрибута. Диалоговое окно по умолчанию — DialogType.NATIVE. Минимальная страница по умолчанию — 1. Максимальная страница по умолчанию — Integer.MAX_VALUE. Пункт назначения по умолчанию — DestinationType.PRINTER. Выбор по умолчанию — DefaultSelectionType.ALL. Количество копий по умолчанию — 1. Обработка нескольких документов по умолчанию — MultipleDocumentHandlingType.SEPARATE_DOCUMENTS_UNCOLLATED_COPIES. Стороны по умолчанию — SidesType.ONE_SIDED. Имя файла по умолчанию — null.

JobAttributes

public JobAttributes(JobAttributes obj)

Создаёт экземпляр JobAttributes, являющийся копией переданного JobAttributes.

Параметры:

obj - копируемый JobAttributes

JobAttributes

public JobAttributes(int copies,
                     JobAttributes.DefaultSelectionType defaultSelection,
                     JobAttributes.DestinationType destination,
                     JobAttributes.DialogType dialog,
                     String fileName,
                     int maxPage,
                     int minPage,
                     JobAttributes.MultipleDocumentHandlingType multipleDocumentHandling,
                     int[][] pageRanges,
                     String printer,
                     JobAttributes.SidesType sides)

Создаёт экземпляр JobAttributes со значениями указанных атрибутов.

Параметры:

copies - целое число, большее 0

defaultSelection - DefaultSelectionType.ALL, DefaultSelectionType.RANGE, или DefaultSelectionType.SELECTION

destination - DesintationType.FILE или DesintationType.PRINTER

dialog - DialogType.COMMON, DialogType.NATIVE, или DialogType.NONE

fileName - возможное имя файла

maxPage - целое число, большее нуля и больше или равно minPage

minPage - целое число, большее нуля и меньше или равно maxPage

multipleDocumentHandling - MultipleDocumentHandlingType.SEPARATE_DOCUMENTS_COLLATED_COPIES или MultipleDocumentHandlingType.SEPARATE_DOCUMENTS_UNCOLLATED_COPIES

pageRanges - массив целочисленных массивов из двух элементов; массив интерпретируется как диапазон, охватывающий все страницы, включая и между указанными страницами; диапазоны должны быть в порядке возрастания и не должны перекрываться; указанные номера страниц не могут быть меньше minPage или больше maxPage; например:

(new int[][] { new int[] { 1, 3 }, new int[] { 5, 5 },
                         new int[] { 15, 19 } }),

указывает страницы 1, 2, 3, 5, 15, 16, 17, 18 и 19. Обратите внимание, что (new int[][] { new int[] { 1, 1 }, new int[] { 1, 2 } }) — недопустимый набор диапазонов страниц, поскольку эти диапазоны перекрываются.

printer - возможное имя принтера

sides - SidesType.ONE_SIDED, SidesType.TWO_SIDED_LONG_EDGE, или SidesType.TWO_SIDED_SHORT_EDGE

Исключения:

IllegalArgumentException - если одно или несколько из вышеперечисленных условий нарушены

Методы

clone

public Object clone()

Создаёт и возвращает копию этого JobAttributes.

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

clone в классе Object

Возвращает:

новую созданную копию; безопасно привести этот объект к типу JobAttributes

См. также:

Cloneable

set

public void set(JobAttributes obj)

Устанавливает все атрибуты этого JobAttributes в значения, совпадающие со значениями атрибутов obj.

Параметры:

obj - копируемые атрибуты JobAttributes

getCopies

public int getCopies()

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

Возвращает:

целое число, большее 0.

setCopies

public void setCopies(int copies)

Указывает количество копий, которые приложение должно отобразить для задач, использующих эти атрибуты. Отсутствие указания этого атрибута эквивалентно указанию 1.

Параметры:

copies - целое число, большее 0

Исключения:

IllegalArgumentException - если значение copies меньше или равно 0

setCopiesToDefault

public void setCopiesToDefault()

Устанавливает количество копий, которые приложение должно отобразить для задач, использующих эти атрибуты, по умолчанию. По умолчанию количество копий равно 1.

getDefaultSelection

public JobAttributes.DefaultSelectionType getDefaultSelection()

Указывает, для задач, использующих эти атрибуты, должно ли приложение печатать все страницы, диапазон, указанный возвращаемым значением getPageRanges, или текущий выделенный фрагмент. Этот атрибут обновляется до значения, выбранного пользователем.

Возвращает:

DefaultSelectionType.ALL, DefaultSelectionType.RANGE или DefaultSelectionType.SELECTION

setDefaultSelection

public void setDefaultSelection(JobAttributes.DefaultSelectionType defaultSelection)

Указывает, для задач, использующих эти атрибуты, должно ли приложение печатать все страницы, диапазон, указанный возвращаемым значением getPageRanges, или текущий выделенный фрагмент. Отсутствие указания этого атрибута эквивалентно указанию DefaultSelectionType.ALL.

Параметры:

defaultSelection - DefaultSelectionType.ALL, DefaultSelectionType.RANGE или DefaultSelectionType.SELECTION.

Исключения:

IllegalArgumentException - если defaultSelection — null

getDestination

public JobAttributes.DestinationType getDestination()

Указывает, будет ли вывод направлен на принтер или в файл для задач, использующих эти атрибуты. Этот атрибут обновляется до значения, выбранного пользователем.

Возвращает:

DesintationType.FILE или DesintationType.PRINTER

setDestination

public void setDestination(JobAttributes.DestinationType destination)

Указывает, будет ли вывод направлен на принтер или в файл для задач, использующих эти атрибуты. Отсутствие указания этого атрибута эквивалентно указанию DesintationType.PRINTER.

Параметры:

destination - DesintationType.FILE или DesintationType.PRINTER.

Исключения:

IllegalArgumentException - если destination равно null.

getDialog

public JobAttributes.DialogType getDialog()

Возвращает, для задач, использующих эти атрибуты, следует ли пользователю видеть диалоговое окно печати для изменения параметров печати и какой тип диалогового окна печати следует отобразить. DialogType.COMMON обозначает кроссплатформенное, чисто Java-диалоговое окно печати. DialogType.NATIVE обозначает собственное диалоговое окно печати платформы. Если платформа не поддерживает собственное диалоговое окно печати, отображается чисто Java-диалоговое окно печати. DialogType.NONE указывает отсутствие диалогового окна печати (т. е. печать в фоновом режиме). Этот атрибут не может быть изменён и не ограничен реализацией или целевым принтером.

Возвращает:

DialogType.COMMON, DialogType.NATIVE, или DialogType.NONE

setDialog

public void setDialog(JobAttributes.DialogType dialog)

Указывает, для задач, использующих эти атрибуты, следует ли пользователю видеть диалоговое окно печати для изменения параметров печати и какой тип диалогового окна печати следует отобразить. DialogType.COMMON обозначает кроссплатформенное, чисто Java-диалоговое окно печати. DialogType.NATIVE обозначает собственное диалоговое окно печати платформы. Если платформа не поддерживает собственное диалоговое окно печати, отображается чисто Java-диалоговое окно печати. DialogType.NONE указывает отсутствие диалогового окна печати (т. е. печать в фоновом режиме). Отсутствие указания этого атрибута эквивалентно указанию DialogType.NATIVE.

Параметры:

dialog - DialogType.COMMON, DialogType.NATIVE или DialogType.NONE.

Исключения:

IllegalArgumentException - если dialog равно null.

getFileName

public String getFileName()

Указывает имя файла для выходного файла для задач, использующих эти атрибуты. Этот атрибут обновляется до значения, выбранного пользователем.

Возвращает:

возможное имя файла

setFileName

public void setFileName(String fileName)

Указывает имя файла для выходного файла для задач, использующих эти атрибуты. По умолчанию зависит от платформы и реализации.

Параметры:

fileName - возможное имя файла (null допускается).

getFromPage

public int getFromPage()

Возвращает для задач, использующих эти атрибуты, первую страницу для печати, если необходимо печатать диапазон страниц. Этот атрибут обновляется до значения, выбранного пользователем. Приложение должно игнорировать этот атрибут при выводе, если возвращаемое значение метода getDefaultSelection равно DefaultSelectionType.RANGE. Приложение должно учитывать возвращаемое значение метода getPageRanges вместо значения данного метода, если это возможно.

Возвращает:

целое число, большее нуля и меньше или равно toPage, больше или равно minPage и меньше или равно maxPage.

setFromPage

public void setFromPage(int fromPage)

Указывает для задач, использующих эти атрибуты, первую страницу для печати, если необходимо печатать диапазон страниц. Если этот атрибут не указан, используются значения из атрибута pageRanges. Если pageRanges и любой из fromPage или toPage указаны, pageRanges имеет приоритет. Отсутствие pageRanges, fromPage или toPage эквивалентно вызову setPageRanges(new int[][] { new int[] { minPage } });

Параметры:

fromPage - целое число, большее нуля и меньше или равно toPage, больше или равно minPage и меньше или равно maxPage.

Исключения:

IllegalArgumentException - если одно или несколько из вышеперечисленных условий нарушены.

getMaxPage

public int getMaxPage()

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

Возвращает:

целое число, большее нуля и больше или равно minPage.

setMaxPage

public void setMaxPage(int maxPage)

Указывает максимальное значение, которое пользователь может указать в качестве последней страницы для печати для задач, использующих эти атрибуты. Отсутствие указания этого атрибута эквивалентно указанию Integer.MAX_VALUE.

Параметры:

maxPage - целое число, большее нуля и больше или равно minPage

Исключения:

IllegalArgumentException - если одно или несколько из вышеперечисленных условий нарушены

getMinPage

public int getMinPage()

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

Возвращает:

целое число больше нуля и меньше или равно maxPage.

setMinPage

public void setMinPage(int minPage)

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

Параметры:

minPage - целое число больше нуля и меньше или равно maxPage.

Исключение:

IllegalArgumentException - если одно или несколько из вышеперечисленных условий нарушены.

getMultipleDocumentHandling

public JobAttributes.MultipleDocumentHandlingType getMultipleDocumentHandling()

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

Возвращает:

MultipleDocumentHandlingType.SEPARATE_DOCUMENTS_COLLATED_COPIES или MultipleDocumentHandlingType.SEPARATE_DOCUMENTS_UNCOLLATED_COPIES.

setMultipleDocumentHandling

public void setMultipleDocumentHandling(JobAttributes.MultipleDocumentHandlingType multipleDocumentHandling)

Определяет обработку нескольких копий, включая совмещение, для заданий, использующих эти атрибуты. Если этот атрибут не указан, он эквивалентен MultipleDocumentHandlingType.SEPARATE_DOCUMENTS_UNCOLLATED_COPIES.

Параметры:

multipleDocumentHandling - MultipleDocumentHandlingType.SEPARATE_DOCUMENTS_COLLATED_COPIES или MultipleDocumentHandlingType.SEPARATE_DOCUMENTS_UNCOLLATED_COPIES.

Исключение:

IllegalArgumentException - если multipleDocumentHandling равно null.

setMultipleDocumentHandlingToDefault

public void setMultipleDocumentHandlingToDefault()

Устанавливает обработку нескольких копий, включая совмещение, для заданий, использующих эти атрибуты, по умолчанию. Обработка по умолчанию - MultipleDocumentHandlingType.SEPARATE_DOCUMENTS_UNCOLLATED_COPIES.

getPageRanges

public int[][] getPageRanges()

Определяет диапазоны страниц для печати заданий, использующих эти атрибуты, если необходимо напечатать диапазон страниц. Все номера диапазонов включительно. Этот атрибут обновляется до значения, выбранного пользователем. Приложение должно игнорировать этот атрибут при выводе, если значение метода getDefaultSelection равно DefaultSelectionType.RANGE.

Возвращает:

массив целых массивов по 2 элемента. Массив интерпретируется как диапазон, охватывающий все страницы, включая и между указанными страницами. Диапазоны должны быть в порядке возрастания и не должны перекрываться. Указанные номера страниц не должны быть меньше minPage и больше maxPage. Например: (new int[][] { new int[] { 1, 3 }, new int[] { 5, 5 }, new int[] { 15, 19 } }), определяет страницы 1, 2, 3, 5, 15, 16, 17, 18 и 19.

setPageRanges

public void setPageRanges(int[][] pageRanges)

Определяет диапазоны страниц для печати заданий, использующих эти атрибуты, если необходимо напечатать диапазон страниц. Все номера диапазонов включительно. Если этот атрибут не указан, используются значения из атрибутов fromPage и toPages. Если pageRanges и хотя бы один из fromPage или toPage указаны, pageRanges имеет приоритет. Отсутствие pageRanges, fromPage или toPage эквивалентно вызову setPageRanges(new int[][] { new int[] { minPage, minPage } });

Параметры:

pageRanges - массив целых массивов по 2 элемента. Массив интерпретируется как диапазон, охватывающий все страницы, включая и между указанными страницами. Диапазоны должны быть в порядке возрастания и не должны перекрываться. Указанные номера страниц не должны быть меньше minPage и больше maxPage. Например: (new int[][] { new int[] { 1, 3 }, new int[] { 5, 5 }, new int[] { 15, 19 } }), определяет страницы 1, 2, 3, 5, 15, 16, 17, 18 и 19. Обратите внимание, что (new int[][] { new int[] { 1, 1 }, new int[] { 1, 2 } }), является недопустимым набором диапазонов страниц, потому что два диапазона перекрываются.

Исключение:

IllegalArgumentException - если одно или несколько из вышеперечисленных условий нарушены.

getPrinter

public String getPrinter()

Возвращает целевой принтер для заданий, использующих эти атрибуты. Этот атрибут обновляется до значения, выбранного пользователем.

Возвращает:

возможно null имя принтера.

setPrinter

public void setPrinter(String printer)

Устанавливает целевой принтер для заданий, использующих эти атрибуты. Значение по умолчанию зависит от платформы и определяется реализацией.

Параметры:

printer - возможно null имя принтера.

getSides

public JobAttributes.SidesType getSides()

Возвращает, как последовательные страницы должны быть наложены на стороны носителя печати для заданий, использующих эти атрибуты. SidesType.ONE_SIDED накладывает каждую последующую страницу на ту же сторону последовательных листов носителя. Это наложение иногда называется simplex. SidesType.TWO_SIDED_LONG_EDGE накладывает каждую последующую пару страниц на лицевую и оборотную стороны последовательных листов носителя, так что ориентация каждой пары страниц на носителе была бы правильной для читателя, как если бы для переплета на длинном крае. Это наложение иногда называется duplex. SidesType.TWO_SIDED_SHORT_EDGE накладывает каждую последующую пару страниц на лицевую и оборотную стороны последовательных листов носителя, так что ориентация каждой пары страниц на носителе была бы правильной для читателя, как если бы для переплета на коротком крае. Это наложение иногда называется tumble. Этот атрибут обновляется до значения, выбранного пользователем.

Возвращает:

SidesType.ONE_SIDED, SidesType.TWO_SIDED_LONG_EDGE или SidesType.TWO_SIDED_SHORT_EDGE.

setSides

public void setSides(JobAttributes.SidesType sides)

Определяет, как последовательные страницы должны быть наложены на стороны носителя печати для заданий, использующих эти атрибуты. SidesType.ONE_SIDED накладывает каждую последующую страницу на ту же сторону последовательных листов носителя. Это наложение иногда называется simplex. SidesType.TWO_SIDED_LONG_EDGE накладывает каждую последующую пару страниц на лицевую и оборотную стороны последовательных листов носителя, так что ориентация каждой пары страниц на носителе была бы правильной для читателя, как если бы для переплета на длинном крае. Это наложение иногда называется duplex. SidesType.TWO_SIDED_SHORT_EDGE накладывает каждую последующую пару страниц на лицевую и оборотную стороны последовательных листов носителя, так что ориентация каждой пары страниц на носителе была бы правильной для читателя, как если бы для переплета на коротком крае. Это наложение иногда называется tumble. Отсутствие указания этого атрибута эквивалентно указанию SidesType.ONE_SIDED.

Параметры:

sides - SidesType.ONE_SIDED, SidesType.TWO_SIDED_LONG_EDGE или SidesType.TWO_SIDED_SHORT_EDGE.

Исключение:

IllegalArgumentException - если sides равно null.

setSidesToDefault

public void setSidesToDefault()

Устанавливает способ наложения последовательных страниц на стороны носителя печати для заданий, использующих эти атрибуты, по умолчанию. Наложение по умолчанию - SidesType.ONE_SIDED.

getToPage

public int getToPage()

Возвращает последнюю страницу (включительно) для печати заданий, использующих эти атрибуты, если необходимо напечатать диапазон страниц. Этот атрибут обновляется до значения, выбранного пользователем. Приложение должно игнорировать этот атрибут при выводе, если значение метода getDefaultSelection равно DefaultSelectionType.RANGE. Приложение должно учитывать значение, возвращаемое getPageRanges, в приоритете по сравнению с возвращаемым значением этого метода, если возможно.

Возвращает:

целое число больше нуля и больше или равно toPage, больше или равно minPage и меньше или равно maxPage.

setToPage

public void setToPage(int toPage)

Определяет последнюю страницу (включительно) для печати заданий, использующих эти атрибуты, если необходимо напечатать диапазон страниц. Если этот атрибут не указан, используются значения из атрибута pageRanges. Если pageRanges и хотя бы один из fromPage или toPage указаны, pageRanges имеет приоритет. Отсутствие pageRanges, fromPage или toPage эквивалентно вызову setPageRanges(new int[][] { new int[] { minPage } });

Параметры:

toPage - целое число больше нуля, больше или равно fromPage, больше или равно minPage и меньше или равно maxPage.

Исключение:

IllegalArgumentException - если одно или несколько из вышеперечисленных условий нарушены.

equals

public boolean equals(Object obj)

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

equals в классе Object

Параметры:

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

Возвращает:

является ли obj равным этому JobAttribute в соответствии с вышеуказанными критериями.

См. также:

Object.hashCode(), HashMap

hashCode

public int hashCode()

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

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

hashCode в классе Object

Возвращает:

хэш-код.

См. также:

Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)

toString

public String toString()

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

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

toString в классе Object

Возвращает:

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