Класс PageRanges
- java.lang.Object
-
- javax.print.attribute.SetOfIntegerSyntax
-
- javax.print.attribute.standard.PageRanges
- Все реализованные интерфейсы:
- Serializable, Cloneable, Attribute, DocAttribute, PrintJobAttribute, PrintRequestAttribute
public final class PageRanges extends SetOfIntegerSyntax implements DocAttribute, PrintRequestAttribute, PrintJobAttribute
Класс PageRanges — это класс атрибутов печати, набор целых чисел, который определяет диапазон(ы) страниц потока печати, которые использует объект Printer для каждой копии каждого документа, который должен быть напечатан. Ничего не печатается для страниц, которые не идентифицированы в документе(ах).
Атрибут связан со страницами потока печати, а не с номерами страниц, присвоенными приложением (например, номерами страниц, которые отображаются в заголовках и/или подвалах некоторых приложений для обработки текстовых документов).
В большинстве случаев точные страницы для печати будут генерироваться драйвером устройства, и этот атрибут не потребуется. Однако при печати архивированного документа, который уже отформатирован, конечный пользователь может выбрать печать только подмножества страниц, содержащихся в документе. В этом случае, если указан диапазон страниц "n-m", первой напечатанной страницей будет страница n. Все последующие страницы документа будут напечатаны до и включая страницу m.
Если для задания печати не указан атрибут PageRanges, будут напечатаны все страницы документа. Другими словами, значение по умолчанию для атрибута PageRanges всегда {{1, Integer.MAX_VALUE}}.
Влияние атрибута PageRanges на задание печати с несколькими документами (задание с несколькими документами) зависит от того, указаны ли для всех документов одни и те же диапазоны страниц или разные документы имеют разные диапазоны страниц, а также от (возможно, значения по умолчанию) атрибута MultipleDocumentHandling.
- Если для всех документов указаны одинаковые диапазоны страниц, то любое значение
MultipleDocumentHandlingимеет смысл, и обработка принтера зависит от значенияMultipleDocumentHandling:- SINGLE_DOCUMENT — Все входные документы будут объединены в один выходной документ. Будут напечатаны указанные диапазоны страниц этого выходного документа.
- SINGLE_DOCUMENT_NEW_SHEET — Все входные документы будут объединены в один выходной документ, и первый отпечаток каждого входного документа всегда будет начинаться на новом листе носителя. Будут напечатаны указанные диапазоны страниц этого выходного документа.
- SEPARATE_DOCUMENTS_UNCOLLATED_COPIES — Для каждого отдельного входного документа будут напечатаны указанные диапазоны страниц.
- SEPARATE_DOCUMENTS_COLLATED_COPIES — Для каждого отдельного входного документа будут напечатаны указанные диапазоны страниц.
- SEPARATE_DOCUMENTS_UNCOLLATED_COPIES — Для каждого отдельного входного документа будут напечатаны его собственные указанные диапазоны страниц.
- SEPARATE_DOCUMENTS_COLLATED_COPIES — Для каждого отдельного входного документа будут напечатаны его собственные указанные диапазоны страниц.
Совместимость с IPP: Каноническая форма массива атрибута PageRanges задаёт нижнюю и верхнюю границы для каждого диапазона страниц, которые должны быть включены в атрибут "page-ranges" IPP. Смотрите класс SetOfIntegerSyntax для объяснения канонической формы массива. Имя категории, возвращаемое getName() задаёт имя атрибута IPP.
- См. также:
- Сериализованная форма
Конструкторы
| Конструктор и описание |
|---|
PageRanges(int member) Создаёт новый атрибут диапазонов страниц, содержащий одно целое число. |
PageRanges(int[][] members) Создаёт новый атрибут диапазонов страниц с заданными элементами. |
PageRanges(int lowerBound,
int upperBound) Создаёт новый атрибут диапазонов страниц, содержащий один диапазон целых чисел. |
PageRanges(String members) Создаёт новый атрибут диапазонов страниц с заданными элементами в строковой форме. |
Методы
| Модификатор и тип | Метод и описание |
|---|---|
boolean |
equals(Object object) Возвращает, эквивалентен ли этот атрибут диапазонов страниц переданному объекту. |
Class<? extends Attribute> |
getCategory() Получает класс атрибута печати, который будет использоваться в качестве «категории» для этого значения атрибута печати. |
String |
getName() Получает имя категории, экземпляром которой является это значение атрибута. |
Методы, унаследованные от класса javax.print.attribute.SetOfIntegerSyntax
contains, contains, getMembers, hashCode, next, toString Методы, унаследованные от класса java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait Конструкторы
PageRanges
public PageRanges(int[][] members)
Создаёт новый атрибут диапазонов страниц с заданными элементами. Элементы задаются в «массиве»; см. класс SetOfIntegerSyntax для объяснения формы массива.
- Параметры:
-
members- Элементы набора в форме массива. - Исключения:
-
NullPointerException- (исключение времени выполнения) Бросается, еслиmembersравно null или любой элементmembersравен null. -
IllegalArgumentException- (исключение времени выполнения) Бросается, если любой элементmembersне является массивом длины 1 или длины 2. Также бросается, еслиmembers— массив нулевой длины или если любой элемент набора меньше 1.
PageRanges
public PageRanges(String members)
Создаёт новый атрибут диапазонов страниц с заданными элементами в строковой форме. См. класс SetOfIntegerSyntax для объяснения синтаксиса.
- Параметры:
-
members- Элементы набора в строковой форме. - Исключения:
-
NullPointerException- (исключение времени выполнения) Бросается, еслиmembersравно null или любой элементmembersравен null. -
IllegalArgumentException- (Исключение времени выполнения) Бросается, еслиmembersне соответствует правильному синтаксису. Также бросается, если созданный набор целых чисел является массивом нулевой длины или если любой элемент набора меньше 1.
PageRanges
public PageRanges(int member)
Создаёт новый атрибут диапазонов страниц, содержащий одно целое число. То есть должна быть напечатана только одна страница.
- Параметры:
-
member- Элемент набора. - Исключения:
-
IllegalArgumentException- (Исключение времени выполнения) Бросается, еслиmemberменьше 1.
PageRanges
public PageRanges(int lowerBound,
int upperBound) Создаёт новый атрибут диапазонов страниц, содержащий один диапазон целых чисел. То есть должны быть напечатаны только страницы в этом диапазоне.
- Параметры:
-
lowerBound- Нижняя граница диапазона. -
upperBound- Верхняя граница диапазона. - Исключения:
-
IllegalArgumentException- (Исключение времени выполнения) Бросается, если указан нулевой диапазон или если указан ненулевой диапазон сlowerBoundменьше 1.
Методы
equals
public boolean equals(Object object)
Возвращает, эквивалентен ли этот атрибут диапазонов страниц переданному объекту. Для эквивалентности должны выполняться все следующие условия:
-
objectне равно null. -
objectявляется экземпляром класса PageRanges. - Элементы этого атрибута диапазонов страниц и элементы
objectодинаковы.
- Переопределяет:
-
equalsв классеSetOfIntegerSyntax - Параметры:
-
object- Объект для сравнения. - Возвращает:
- True, если
objectэквивалентен этому атрибуту диапазонов страниц, false в противном случае. - См. также:
-
Object.hashCode(),HashMap
getCategory
public final Class<? extends Attribute> getCategory()
Получает класс атрибута печати, который должен использоваться как «категория» для этого значения атрибута печати.
Для класса PageRanges категорией является сам класс PageRanges.
- Определено в:
-
getCategoryв интерфейсеAttribute - Возвращает:
- Класс атрибута печати (категория), экземпляр класса
java.lang.Class.
getName
public final String getName()
Получает имя категории, экземпляром которой является это значение атрибута.
Для класса PageRanges имя категории — "page-ranges".
© 1993, 2020, 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.