PageRanges JDK 1.6)

Description

publicfinal class PageRanges

Class PageRanges is a printing attribute class, a set of integers, that identifies the range(s) of print-stream pages that the Printer object uses for each copy of each document which are to be printed. Nothing is printed for any pages identified that do not exist in the document(s). The attribute is associated with print-stream pages, not application-numbered pages (for example, the page numbers found in the headers and or footers for certain word processing applications).

In most cases, the exact pages to be printed will be generated by a device driver and this attribute would not be required. However, when printing an archived document which has already been formatted, the end user may elect to print just a subset of the pages contained in the document. In this case, if a page range of "n-m" is specified, the first page to be printed will be page n. All subsequent pages of the document will be printed through and including page m.

If a PageRanges attribute is not specified for a print job, all pages of the document will be printed. In other words, the default value for the PageRanges attribute is always {{1, Integer.MAX_VALUE}}.

The effect of a PageRanges attribute on a multidoc print job (a job with multiple documents) depends on whether all the docs have the same page ranges specified or whether different docs have different page ranges specified, and on the (perhaps defaulted) value of the MultipleDocumentHandling attribute.

If all the docs have the same page ranges specified, then any value of MultipleDocumentHandling makes sense, and the printer's processing depends on the MultipleDocumentHandling value:
- SINGLE_DOCUMENT -- All the input docs will be combined together into one output document. The specified page ranges of that output document will be printed.
- SINGLE_DOCUMENT_NEW_SHEET -- All the input docs will be combined together into one output document, and the first impression of each input doc will always start on a new media sheet. The specified page ranges of that output document will be printed.
- SEPARATE_DOCUMENTS_UNCOLLATED_COPIES -- For each separate input doc, the specified page ranges will be printed.
- SEPARATE_DOCUMENTS_COLLATED_COPIES -- For each separate input doc, the specified page ranges will be printed.
- SEPARATE_DOCUMENTS_UNCOLLATED_COPIES -- For each separate input doc, its own specified page ranges will be printed..
- SEPARATE_DOCUMENTS_COLLATED_COPIES -- For each separate input doc, its own specified page ranges will be printed..

IPP Compatibility: The PageRanges attribute's canonical array form gives the lower and upper bound for each range of pages to be included in and IPP "page-ranges" attribute. See class SetOfIntegerSyntax for an explanation of canonical array form. The category name returned by getName() gives the IPP attribute name.

See also:

Constructors

public PageRanges (int member)

Construct a new page ranges attribute containing a single integer.

Construct a new page ranges attribute containing a single integer. That
is, only the one page is to be printed.
Parameters:
- member - Set member.
Throws:
- IllegalArgumentException - (Unchecked exception) Thrown if member is less than 1.

public PageRanges (int[][] members)

Construct a new page ranges attribute with the given members.

Construct a new page ranges attribute with the given members. The
members are specified in "array form;" see class SetOfIntegerSyntax for an
explanation of array form.
Parameters:
- members - Set members in array form.
Throws:
- NullPointerException - (unchecked exception) Thrown if members is null or any element of members is null.
- IllegalArgumentException - (unchecked exception) Thrown if any element of members is not a length-one or length-two array. Also thrown if members is a zero-length array or if any member of the set is less than 1.

public PageRanges (int lowerBound, int upperBound)

Construct a new page ranges attribute containing a single range of integers.

Construct a new page ranges attribute containing a single range of
integers. That is, only those pages in the one range are to be printed.
Parameters:
- lowerBound - Lower bound of the range.
- upperBound - Upper bound of the range.
Throws:
- IllegalArgumentException - (Unchecked exception) Thrown if a null range is specified or if a non-null range is specified with lowerBound less than 1.

public PageRanges (String members)

Construct a new page ranges attribute with the given members in string form.

Construct a new page ranges attribute with the given members in
string form.
See class SetOfIntegerSyntax
for explanation of the syntax.
Parameters:
- members - Set members in string form.
Throws:
- NullPointerException - (unchecked exception) Thrown if members is null or any element of members is null.
- IllegalArgumentException - (Unchecked exception) Thrown if members does not obey the proper syntax. Also thrown if the constructed set-of-integer is a zero-length array or if any member of the set is less than 1.

Methods

Hide/Show inherited methods

public boolean contains (int x) [Inherited From SetOfIntegerSyntax]

Determine if this set-of-integer attribute contains the given value.

Determine if this set-of-integer attribute contains the given value.
Returns: True if this set-of-integer attribute contains the value x, false otherwise.
Parameters:
- x - Integer value.

public boolean contains (IntegerSyntax attribute) [Inherited From SetOfIntegerSyntax]

Determine if this set-of-integer attribute contains the given integer attribute's value.

Determine if this set-of-integer attribute contains the given integer
attribute's value.
Returns: True if this set-of-integer attribute contains theAttribute's value, false otherwise.
Parameters:
- attribute - Integer attribute.

public boolean equals (Object object) [Overrides SetOfIntegerSyntax]

Returns whether this page ranges attribute is equivalent to the passed in object.

Returns whether this page ranges attribute is equivalent to the passed
in object. To be equivalent, all of the following conditions must be
true:

object is not null.
object is an instance of class PageRanges.
This page ranges attribute's members and object's members
are the same.

Returns: True if object is equivalent to this page ranges attribute, false otherwise.
Parameters:
- object - Object to compare to.

publicfinal Class<Attribute> getCategory ()

Get the printing attribute class which is to be used as the "category" for this printing attribute value.

public int getMembers () [Inherited From SetOfIntegerSyntax]

Obtain this set-of-integer attribute's members in canonical array form.

publicfinal String getName ()

Get the name of the category of which this attribute value is an instance.

public int hashCode () [Inherited From SetOfIntegerSyntax]

Returns a hash code value for this set-of-integer attribute.

public int next (int x) [Inherited From SetOfIntegerSyntax]

Determine the smallest integer in this set-of-integer attribute that is greater than the given value.

Determine the smallest integer in this set-of-integer attribute that is
greater than the given value. If there are no integers in this
set-of-integer attribute greater than the given value, -1 is
returned. (Since a set-of-integer attribute can only contain nonnegative
values, -1 will never appear in the set.) You can use the
next() method to iterate through the integer values in a
set-of-integer attribute in ascending order, like this:


     SetOfIntegerSyntax attribute = . . .;
     int i = -1;
     while ((i = attribute.next (i)) != -1)
         {
         foo (i);
         }

Returns: The smallest integer in this set-of-integer attribute that is greater than x, or -1 if no integer in this set-of-integer attribute is greater than x.
Parameters:
- x - Integer value.

public String toString () [Inherited From SetOfIntegerSyntax]

Returns a string value corresponding to this set-of-integer attribute.

Returns a string value corresponding to this set-of-integer attribute.
The string value is a zero-length string if this set is empty. Otherwise,
the string value is a comma-separated list of the ranges in the canonical
array form, where each range is represented as "i" if
the lower bound equals the upper bound or
"i-j" otherwise.