| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public final class PageRanges extends SetOfIntegerSyntax implements DocAttribute, PrintRequestAttribute, PrintJobAttribute
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 {@link MultipleDocumentHandling MultipleDocumentHandling} attribute.
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 {@link
javax.print.attribute.SetOfIntegerSyntax SetOfIntegerSyntax} for an
explanation of canonical array form. The category name returned by
getName()
gives the IPP attribute name.
Constructor Summary | |
---|---|
PageRanges(int member) Construct a new page ranges attribute containing a single integer. |
|
PageRanges(int lowerBound, int upperBound) Construct a new page ranges attribute containing a single range of integers. |
|
PageRanges(int[][] members) Construct a new page ranges attribute with the given members. |
|
PageRanges(String members) Construct a new page ranges attribute with the given members in string form. |
Method Summary | |
---|---|
boolean |
Returns whether this page ranges attribute is equivalent to the passed in object. |
Class |
Get the printing attribute class which is to be used as the "category" for this printing attribute value. |
String |
getName() Get the name of the category of which this attribute value is an instance. |
Methods inherited from class javax.print.attribute.SetOfIntegerSyntax |
---|
contains, contains, equals, getMembers, hashCode, next, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public PageRanges(int member)
member
- Set member.public PageRanges(int lowerBound, int upperBound)
lowerBound
- Lower bound of the range.upperBound
- Upper bound of the range.public PageRanges(int[][] members)
members
- Set members in array form.public PageRanges(String members)
members
- Set members in string form.Method Detail |
---|
public boolean equals(Object object)
object
is not null.
object
is an instance of class PageRanges.
object
's members
are the same.
equals
in class SetOfIntegerSyntax
object
- Object to compare to.object
is equivalent to this page ranges
attribute, false otherwise.public final Class getCategory()
For class PageRanges, the category is class PageRanges itself.
public final String getName()
For class PageRanges, the category name is "page-ranges"
.
| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |