Класс 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 предоставляет нижнюю и верхнюю границы для каждого диапазона страниц, которые необходимо включить в атрибут IPP «page-ranges». Смотрите класс SetOfIntegerSyntax для объяснения канонической формы массива. Имя категории, возвращаемое getName() , дает имя атрибута IPP.

См. также:

Сериализованная форма

Краткое описание конструкторов

Конструктор	Описание
`PageRanges(int member)`	Создает новый атрибут диапазонов страниц, содержащий одно целое число.
`PageRanges(int[][] members)`	Создает новый атрибут диапазонов страниц с заданными членами.
`PageRanges(int lowerBound, int upperBound)`	Создает новый атрибут диапазонов страниц, содержащий один диапазон целых чисел.
`PageRanges(String members)`	Создает новый атрибут диапазонов страниц с заданными членами в строковой форме.

Краткое описание методов

Модификатор и тип	Метод	Описание
`boolean`	`equals(Object object)`	Возвращает, эквивалентен ли этот атрибут диапазонов страниц переданному объекту.
`final Class<? extends Attribute>`	`getCategory()`	Получает класс атрибута печати, который должен использоваться в качестве «категории» для этого значения атрибута печати.
`final 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 - если указан диапазон null или если указан диапазон non-null с lowerBound меньше 1

Подробное описание методов

equals

public boolean equals(Object object)

Возвращает, эквивалентен ли данный атрибут диапазонов страниц переданному объекту. Для эквивалентности должны выполняться все следующие условия:

object не равен null.
object является экземпляром класса PageRanges.
Члены данного атрибута диапазонов страниц и члены object совпадают.

Переопределяет:

equals в классе SetOfIntegerSyntax

Параметры:

object - объект для сравнения

Возвращает:

true если object эквивалентен данному атрибуту диапазонов страниц, false в противном случае

См. также:

getCategory

public final Class<? extends Attribute> getCategory()

Получить класс атрибута печати, который должен использоваться в качестве "категории" для данного значения атрибута печати.

Для класса PageRanges, категорией является сам класс PageRanges.

Установлено в:: getCategory в интерфейсе Attribute
Возвращает:: класс атрибута печати (категория), экземпляр класса java.lang.Class

getName

public final String getName()

Получить имя категории, экземпляром которой является данное значение атрибута.

Для класса PageRanges, именем категории является "page-ranges".

Установлено в:: getName в интерфейсе Attribute
Возвращает:: имя категории атрибута

© 1993, 2021, 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/17/docs/api/java.desktop/javax/print/attribute/standard/PageRanges.html