Класс JobAttributes
- Все реализованные интерфейсы:
Cloneable
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 метод. Поля значений по умолчанию не предоставляются.
- С:
- 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.
УстановитьПервуюСтраницу
public void setFromPage(int fromPage)
- Параметры:
-
fromPage- целое число, большее нуля и меньшее или равное toPage, большее или равное minPage и меньшее или равное maxPage. - Исключения:
-
IllegalArgumentException- если одно или несколько из вышеперечисленных условий нарушены.
МаксимальнаяСтраница
public int getMaxPage()
- Возвращает:
- целое число, большее нуля и большее или равное minPage.
УстановитьМаксимальнуюСтраницу
public void setMaxPage(int maxPage)
Integer.MAX_VALUE.- Параметры:
-
maxPage- целое число, большее нуля и большее или равное minPage - Исключения:
-
IllegalArgumentException- если одно или несколько из вышеперечисленных условий нарушены
МинимальнаяСтраница
public int getMinPage()
- Возвращает:
- целое число, большее нуля и меньшее или равное maxPage.
УстановитьМинимальнуюСтраницу
public void setMinPage(int minPage)
1.- Параметры:
-
minPage- целое число, большее нуля и меньшее или равное maxPage. - Исключения:
-
IllegalArgumentException- если одно или несколько из вышеперечисленных условий нарушены.
ОбработкаНесколькихДокументов
public JobAttributes.MultipleDocumentHandlingType getMultipleDocumentHandling()
- Возвращает:
- MultipleDocumentHandlingType.SEPARATE_DOCUMENTS_COLLATED_COPIES или MultipleDocumentHandlingType.SEPARATE_DOCUMENTS_UNCOLLATED_COPIES.
УстановитьОбработкуНесколькихДокументов
public void setMultipleDocumentHandling(JobAttributes.MultipleDocumentHandlingType multipleDocumentHandling)
- Параметры:
-
multipleDocumentHandling- MultipleDocumentHandlingType.SEPARATE_DOCUMENTS_COLLATED_COPIES или MultipleDocumentHandlingType.SEPARATE_DOCUMENTS_UNCOLLATED_COPIES. - Исключения:
-
IllegalArgumentException- если multipleDocumentHandling равно null.
УстановитьОбработкуНесколькихДокументовПоУмолчанию
public void setMultipleDocumentHandlingToDefault()
ПолучитьДиапазоныСтраниц
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.
УстановитьДиапазоныСтраниц
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- если одно или несколько из вышеперечисленных условий нарушены.
ПолучитьПринтер
public String getPrinter()
- Возвращает:
- имя принтера, которое может быть null.
УстановитьПринтер
public void setPrinter(String printer)
- Параметры:
-
printer- имя принтера, которое может быть null.
ПолучитьСтороны
public JobAttributes.SidesType getSides()
- Возвращает:
- SidesType.ONE_SIDED, SidesType.TWO_SIDED_LONG_EDGE или SidesType.TWO_SIDED_SHORT_EDGE.
УстановитьСтороны
public void setSides(JobAttributes.SidesType sides)
- Параметры:
-
sides- SidesType.ONE_SIDED, SidesType.TWO_SIDED_LONG_EDGE или SidesType.TWO_SIDED_SHORT_EDGE. - Исключения:
-
IllegalArgumentException- если sides равно null.
УстановитьСтороныПоУмолчанию
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://download.java.net/java/early_access/jdk24/docs/api/java.desktop/java/awt/JobAttributes.html