Класс 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- возможно, имя файла -
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 - См. также:
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()
- Возвращает:
- возможное имя файла
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)
- Parameters:
-
fromPage- целое число больше нуля и меньше или равно toPage, больше или равно minPage и меньше или равно maxPage. - Throws:
-
IllegalArgumentException- если одно или несколько из вышеперечисленных условий нарушены.
getMaxPage
public int getMaxPage()
- Returns:
- целое число больше нуля и больше или равно minPage.
setMaxPage
public void setMaxPage(int maxPage)
Integer.MAX_VALUE. - Parameters:
-
maxPage- целое число больше нуля и больше или равно minPage - Throws:
-
IllegalArgumentException- если одно или несколько из вышеперечисленных условий нарушены
getMinPage
public int getMinPage()
- Returns:
- целое число больше нуля и меньше или равно maxPage.
setMinPage
public void setMinPage(int minPage)
1. - Parameters:
-
minPage- целое число больше нуля и меньше или равно maxPage. - Throws:
-
IllegalArgumentException- если одно или несколько из вышеперечисленных условий нарушены.
getMultipleDocumentHandling
public JobAttributes.MultipleDocumentHandlingType getMultipleDocumentHandling()
- Returns:
- MultipleDocumentHandlingType.SEPARATE_DOCUMENTS_COLLATED_COPIES или MultipleDocumentHandlingType.SEPARATE_DOCUMENTS_UNCOLLATED_COPIES.
setMultipleDocumentHandling
public void setMultipleDocumentHandling(JobAttributes.MultipleDocumentHandlingType multipleDocumentHandling)
- Parameters:
-
multipleDocumentHandling- MultipleDocumentHandlingType.SEPARATE_DOCUMENTS_COLLATED_COPIES или MultipleDocumentHandlingType.SEPARATE_DOCUMENTS_UNCOLLATED_COPIES. - Throws:
-
IllegalArgumentException- если multipleDocumentHandling равно null.
setMultipleDocumentHandlingToDefault
public void setMultipleDocumentHandlingToDefault()
getPageRanges
public int[][] getPageRanges()
getDefaultSelection — DefaultSelectionType.RANGE.- Returns:
- массив целочисленных массивов по 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)
- Parameters:
-
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 } }), - недопустимый набор диапазонов страниц, так как диапазоны перекрываются. - Throws:
-
IllegalArgumentException- если одно или несколько из вышеперечисленных условий нарушены.
getPrinter
public String getPrinter()
- Returns:
- возможно null имя принтера.
setPrinter
public void setPrinter(String printer)
- Parameters:
-
printer- возможно null имя принтера.
getSides
public JobAttributes.SidesType getSides()
- Returns:
- SidesType.ONE_SIDED, SidesType.TWO_SIDED_LONG_EDGE или SidesType.TWO_SIDED_SHORT_EDGE.
setSides
public void setSides(JobAttributes.SidesType sides)
- Parameters:
-
sides- SidesType.ONE_SIDED, SidesType.TWO_SIDED_LONG_EDGE или SidesType.TWO_SIDED_SHORT_EDGE. - Throws:
-
IllegalArgumentException- если sides равно null.
setSidesToDefault
public void setSidesToDefault()
getToPage
public int getToPage()
getDefaultSelection равно DefaultSelectionType.RANGE. Приложение должно отдавать предпочтение возвращаемому значению метода getPageRanges, если это возможно.- Returns:
- целое число больше нуля и больше или равно toPage, больше или равно minPage и меньше или равно maxPage.
setToPage
public void setToPage(int toPage)
- Parameters:
-
toPage- целое число больше нуля и больше или равно fromPage и больше или равно minPage и меньше или равно maxPage. - Throws:
-
IllegalArgumentException- если одно или несколько из вышеперечисленных условий нарушены.
equals
public boolean equals(Object obj)
Два JobAttributes равны тогда и только тогда, когда равны каждый из их атрибутов. Атрибуты перечислимого типа равны, если и только если поля ссылаются на один и тот же уникальный объект перечисления. Набор диапазонов страниц равен, если и только если наборы имеют одинаковую длину, каждый диапазон перечисляет те же страницы и диапазоны расположены в том же порядке.
- Overrides:
-
equalsв классеObject - Parameters:
-
obj- объект, равенство которого будет проверено. - Returns:
- равен ли obj этому JobAttribute в соответствии с вышеуказанными критериями.
- See Also:
hashCode
public int hashCode()
- Overrides:
-
hashCodeв классеObject - Returns:
- хэш-код.
- See Also:
toString
public String toString()
- Overrides:
-
toStringв классеObject - Returns:
- строковое представление.
© 1993, 2023, 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/21/docs/api/java.desktop/java/awt/JobAttributes.html