Класс 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, предусмотрен соответствующий метод 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. |
Подробное описание конструкторов
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.
https://docs.oracle.com/en/java/javase/25/docs/api/java.desktop/java/awt/JobAttributes.html