Класс JobAttributes
- Все реализуемые интерфейсы:
Cloneable
public final class JobAttributes extends Object implements Cloneable
Экземпляры этого класса задают количество копий, выбор по умолчанию, назначение, диалоговое окно печати, имена файлов и принтеров, диапазоны страниц, обработку нескольких документов (включая сортировку копий) и размещение нескольких страниц на листе (например, двустороннюю печать) для каждого задания печати, использующего этот экземпляр. Имена атрибутов, где это возможно, соответствуют протоколу Internet Printing Protocol (IPP) 1.1. Значения атрибутов, где это возможно, частично соответствуют ему.
Чтобы использовать метод, принимающий тип внутреннего класса, передайте ссылку на одно из константных полей этого внутреннего класса. Клиентский код не может создавать экземпляры типов внутренних классов, поскольку ни у одного из этих классов нет открытого конструктора. Например, чтобы задать тип диалогового окна печати как кроссплатформенное диалоговое окно печати на чистой Java, используйте следующий код:
import java.awt.JobAttributes;
public class PureJavaPrintDialogExample {
public void setPureJavaPrintDialog(JobAttributes jobAttributes) {
jobAttributes.setDialog(JobAttributes.DialogType.COMMON);
}
}
Для каждого атрибута IPP, поддерживающего значение по умолчанию attributeName-default, имеется соответствующий метод setattributeNameToDefault. Поля со значениями по умолчанию не предоставляются.
- Начиная с версии:
- 1.3
Краткое описание вложенных классов
| Модификатор и тип | Класс | Описание |
|---|---|---|
static final class |
JobAttributes.DefaultSelectionType |
Типобезопасное перечисление возможных состояний выбора по умолчанию. |
static final class |
JobAttributes.DestinationType |
Типобезопасное перечисление возможных назначений задания печати. |
static final class |
JobAttributes.DialogType |
Типобезопасное перечисление возможных диалоговых окон для отображения пользователю. |
static final class |
JobAttributes.MultipleDocumentHandlingType |
Типобезопасное перечисление возможных состояний обработки нескольких копий. |
static final class |
JobAttributes.SidesType |
Типобезопасное перечисление возможных вариантов размещения нескольких страниц на листе. |
Краткое описание конструкторов
| Конструктор | Описание |
|---|---|
JobAttributes() |
Создает экземпляр JobAttributes со значениями по умолчанию для каждого атрибута. |
JobAttributes |
Создает экземпляр JobAttributes с указанными значениями для каждого атрибута. |
JobAttributes |
Создает экземпляр JobAttributes, являющийся копией переданного JobAttributes. |
Краткое описание методов
| Модификатор и тип | Метод | Описание |
|---|---|---|
Object |
clone() |
Создает и возвращает копию этого JobAttributes. |
boolean |
equals |
Определяет, равны ли друг другу два объекта JobAttributes. |
int |
getCopies() |
Возвращает количество копий, которое приложение должно напечатать для заданий, использующих эти атрибуты. |
JobAttributes.DefaultSelectionType |
getDefaultSelection() |
Задает, следует ли приложению печатать все страницы, диапазон, указанный возвращаемым значением getPageRanges, или текущее выделение для заданий, использующих эти атрибуты. |
JobAttributes.DestinationType |
getDestination() |
Задает, будет ли выводиться на принтер или в файл для заданий, использующих эти атрибуты. |
JobAttributes.DialogType |
getDialog() |
Возвращает сведения о том, должно ли для заданий, использующих эти атрибуты, отображаться диалоговое окно печати для изменения настроек печати и какой тип диалогового окна следует показывать. |
String |
getFileName() |
Задает имя выходного файла для заданий, использующих эти атрибуты. |
int |
getFromPage() |
Возвращает первую страницу, которую следует напечатать для заданий, использующих эти атрибуты, если печатается диапазон страниц. |
int |
getMaxPage() |
Задает максимальное значение, которое пользователь может указать в качестве последней страницы для печати для заданий, использующих эти атрибуты. |
int |
getMinPage() |
Задает минимальное значение, которое пользователь может указать в качестве первой страницы для печати для заданий, использующих эти атрибуты. |
JobAttributes.MultipleDocumentHandlingType |
getMultipleDocumentHandling() |
Задает способ обработки нескольких копий, включая сортировку, для заданий, использующих эти атрибуты. |
int[][] |
getPageRanges() |
Задает диапазоны страниц для печати для заданий, использующих эти атрибуты, если печатается диапазон страниц. |
String |
getPrinter() |
Возвращает принтер назначения для заданий, использующих эти атрибуты. |
JobAttributes.SidesType |
getSides() |
Возвращает способ размещения последовательных страниц на сторонах носителя для печати для заданий, использующих эти атрибуты. |
int |
getToPage() |
Возвращает последнюю страницу (включительно), которую следует напечатать для заданий, использующих эти атрибуты, если печатается диапазон страниц. |
int |
hashCode() |
Возвращает значение хеш-кода для этого объекта JobAttributes. |
void |
set |
Задает всем атрибутам этого JobAttributes те же значения, что и атрибутам obj. |
void |
setCopies |
Задает количество копий, которое приложение должно напечатать для заданий, использующих эти атрибуты. |
void |
setCopiesToDefault() |
Задает для количества копий, которое приложение должно напечатать для заданий, использующих эти атрибуты, значение по умолчанию. |
void |
setDefaultSelection |
Задает, следует ли приложению печатать все страницы, диапазон, указанный возвращаемым значением getPageRanges, или текущее выделение для заданий, использующих эти атрибуты. |
void |
setDestination |
Задает, будет ли выводиться на принтер или в файл для заданий, использующих эти атрибуты. |
void |
setDialog |
Задает, должно ли для заданий, использующих эти атрибуты, отображаться диалоговое окно печати для изменения настроек печати и какой тип диалогового окна следует показывать. |
void |
setFileName |
Задает имя выходного файла для заданий, использующих эти атрибуты. |
void |
setFromPage |
Задает первую страницу для печати для заданий, использующих эти атрибуты, если печатается диапазон страниц. |
void |
setMaxPage |
Задает максимальное значение, которое пользователь может указать в качестве последней страницы для печати для заданий, использующих эти атрибуты. |
void |
setMinPage |
Задает минимальное значение, которое пользователь может указать в качестве первой страницы для печати для заданий, использующих эти атрибуты. |
void |
setMultipleDocumentHandling |
Задает способ обработки нескольких копий, включая сортировку, для заданий, использующих эти атрибуты. |
void |
setMultipleDocumentHandlingToDefault() |
Задает для способа обработки нескольких копий, включая сортировку, для заданий, использующих эти атрибуты, значение по умолчанию. |
void |
setPageRanges |
Задает диапазоны страниц для печати для заданий, использующих эти атрибуты, если печатается диапазон страниц. |
void |
setPrinter |
Задает принтер назначения для заданий, использующих эти атрибуты. |
void |
setSides |
Задает способ размещения последовательных страниц на сторонах носителя для печати для заданий, использующих эти атрибуты. |
void |
setSidesToDefault() |
Задает для способа размещения последовательных страниц на сторонах носителя для печати для заданий, использующих эти атрибуты, значение по умолчанию. |
void |
setToPage |
Задает последнюю страницу (включительно), которую следует напечатать для заданий, использующих эти атрибуты, если печатается диапазон страниц. |
String |
toString() |
Возвращает строковое представление этого объекта JobAttributes. |
Методы, объявленные в классе Object
finalize, getClass, notify, notifyAll, wait, wait, wait | Модификатор и тип | Метод | Описание |
|---|---|---|
protected void |
finalize() |
Устарело, будет удалено: этот элемент API может быть удален в будущей версии. Финализация устарела и будет удалена в одном из будущих выпусков. |
final Class |
getClass() |
Возвращает класс времени выполнения этого Object. |
final void |
notify() |
Пробуждает один поток, ожидающий на мониторе этого объекта. |
final void |
notifyAll() |
Пробуждает все потоки, ожидающие на мониторе этого объекта. |
final void |
wait() |
Переводит текущий поток в состояние ожидания до его пробуждения, обычно посредством вызова notify или прерывания. |
final void |
wait |
Переводит текущий поток в состояние ожидания до его пробуждения, обычно посредством вызова notify или прерывания, либо до истечения заданного промежутка реального времени. |
final void |
wait |
Переводит текущий поток в состояние ожидания до его пробуждения, обычно посредством вызова notify или прерывания, либо до истечения заданного промежутка реального времени. |
Подробное описание конструкторов
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—DestinationType.FILEилиDestinationType.PRINTER -
dialog—DialogType.COMMON,DialogType.NATIVEилиDialogType.NONE -
fileName— возможно,nullимя файла -
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— возможно,nullимя принтера -
sides—SidesType.ONE_SIDED,SidesType.TWO_SIDED_LONG_EDGEилиSidesType.TWO_SIDED_SHORT_EDGE - Исключения:
-
IllegalArgumentException— если нарушено одно или несколько перечисленных выше условий
Подробное описание методов
clone
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()
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()
- Возвращает:
- DestinationType.FILE или DestinationType.PRINTER
setDestination
public void setDestination(JobAttributes.DestinationType destination)
- Параметры:
-
destination— DestinationType.FILE или DestinationType.PRINTER. - Исключения:
-
IllegalArgumentException— если destination равно null.
getDialog
public JobAttributes.DialogType getDialog()
- Возвращает:
-
DialogType.COMMON,DialogType.NATIVEилиDialogType.NONE
setDialog
public void setDialog(JobAttributes.DialogType dialog)
- Параметры:
-
dialog— DialogType.COMMON, DialogType.NATIVE или DialogType.NONE. - Исключения:
-
IllegalArgumentException— если dialog равно null.
getFileName
public String getFileName()
- Возвращает:
- возможно,
nullимя файла
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)
- Параметры:
-
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)
- Параметры:
-
multipleDocumentHandling— MultipleDocumentHandlingType.SEPARATE_DOCUMENTS_COLLATED_COPIES или MultipleDocumentHandlingType.SEPARATE_DOCUMENTS_UNCOLLATED_COPIES. - Исключения:
-
IllegalArgumentException— если multipleDocumentHandling равно null.
setMultipleDocumentHandlingToDefault
public void setMultipleDocumentHandlingToDefault()
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)
- Параметры:
-
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, SidesType.TWO_SIDED_LONG_EDGE или SidesType.TWO_SIDED_SHORT_EDGE.
setSides
public void setSides(JobAttributes.SidesType sides)
- Параметры:
-
sides— SidesType.ONE_SIDED, SidesType.TWO_SIDED_LONG_EDGE или SidesType.TWO_SIDED_SHORT_EDGE. - Исключения:
-
IllegalArgumentException— если sides равно null.
setSidesToDefault
public void setSidesToDefault()
getToPage
public int getToPage()
getDefaultSelection не равно DefaultSelectionType.RANGE. По возможности приложению следует отдавать приоритет возвращаемому значению getPageRanges перед возвращаемым значением этого метода.- Возвращает:
- целое число больше нуля, большее или равное toPage и minPage, а также меньшее или равное maxPage.
setToPage
public void setToPage(int toPage)
- Параметры:
-
toPage— целое число больше нуля, большее или равное fromPage и minPage, а также меньшее или равное maxPage. - Исключения:
-
IllegalArgumentException— если нарушено одно или несколько перечисленных выше условий.
equals
public boolean equals(Object obj)
Два объекта JobAttributes равны тогда и только тогда, когда равны все их атрибуты. Атрибуты перечислимого типа равны тогда и только тогда, когда их поля ссылаются на один и тот же уникальный объект перечисления. Наборы диапазонов страниц равны тогда и только тогда, когда они имеют одинаковую длину, каждый диапазон задает одни и те же страницы и диапазоны расположены в одинаковом порядке.
hashCode
toString
© 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.