Класс PageRanges

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

public PageRanges(int[][] members)

Создать новый атрибут диапазонов страниц с заданными элементами. Элементы задаются в «массивовой форме»; см. класс SetOfIntegerSyntax для объяснения массивовой формы.

Параметры:

members - элементы набора в массивовой форме

Исключение:

NullPointerException - если members равен null или любой элемент members равен null

IllegalArgumentException - если любой элемент members не является массивом длины один или два. Также если 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)

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

1. object не равен null.
2. object является экземпляром класса PageRanges.
3. Элементы данного атрибута диапазона страниц и элементы 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".

Указано в:

getName в интерфейсе Attribute

Возвращает:

имя категории атрибута