java.lang.Object
javax.print.attribute.IntegerSyntax
javax.print.attribute.standard.NumberUp
- All Implemented Interfaces:
Serializable,Cloneable,Attribute,DocAttribute,PrintJobAttribute,PrintRequestAttribute
public final class NumberUp
extends IntegerSyntax
implements DocAttribute, PrintRequestAttribute, PrintJobAttribute
Class
NumberUp is an integer valued printing attribute class that
specifies the number of print-stream pages to impose upon a single side of an
instance of a selected medium. That is, if the NumberUp value is n,
the printer must place n print-stream pages on a single side of an
instance of the selected medium. To accomplish this, the printer may add some
sort of translation, scaling, or rotation. This attribute primarily controls
the translation, scaling and rotation of print-stream pages.
The effect of a NumberUp attribute on a multidoc print job (a job
with multiple documents) depends on whether all the docs have the same number
up values specified or whether different docs have different number up values
specified, and on the (perhaps defaulted) value of the
MultipleDocumentHandling attribute.
- If all the docs have the same number up value n specified, then
any value of
MultipleDocumentHandlingmakes sense, and the printer's processing depends on theMultipleDocumentHandlingvalue:SINGLE_DOCUMENT-- All the input docs will be combined together into one output document. Each media impression will consist of nm print-stream pages from the output document.SINGLE_DOCUMENT_NEW_SHEET-- All the input docs will be combined together into one output document. Each media impression will consist of n print-stream pages from the output document. However, the first impression of each input doc will always start on a new media sheet; this means the last impression of an input doc may have fewer than n print-stream pages on it.SEPARATE_DOCUMENTS_UNCOLLATED_COPIES-- The input docs will remain separate. Each media impression will consist of n print-stream pages from the input doc. Since the input docs are separate, the first impression of each input doc will always start on a new media sheet; this means the last impression of an input doc may have fewer than n print-stream pages on it.SEPARATE_DOCUMENTS_COLLATED_COPIES-- The input docs will remain separate. Each media impression will consist of n print-stream pages from the input doc. Since the input docs are separate, the first impression of each input doc will always start on a new media sheet; this means the last impression of an input doc may have fewer than n print-stream pages on it.
SINGLE_DOCUMENT-- All the input docs will be combined together into one output document. Each media impression will consist of ni print-stream pages from the output document, where i is the number of the input doc corresponding to that point in the output document. When the next input doc has a different number up value from the previous input doc, the first print-stream page of the next input doc goes at the start of the next media impression, possibly leaving fewer than the full number of print-stream pages on the previous media impression.SINGLE_DOCUMENT_NEW_SHEET-- All the input docs will be combined together into one output document. Each media impression will consist of n print-stream pages from the output document. However, the first impression of each input doc will always start on a new media sheet; this means the last impression of an input doc may have fewer than n print-stream pages on it.SEPARATE_DOCUMENTS_UNCOLLATED_COPIES-- The input docs will remain separate. For input doc i, each media impression will consist of ni print-stream pages from the input doc. Since the input docs are separate, the first impression of each input doc will always start on a new media sheet; this means the last impression of an input doc may have fewer than ni print-stream pages on it.SEPARATE_DOCUMENTS_COLLATED_COPIES-- The input docs will remain separate. For input doc i, each media impression will consist of ni print-stream pages from the input doc. Since the input docs are separate, the first impression of each input doc will always start on a new media sheet; this means the last impression of an input doc may have fewer than ni print-stream pages on it.
getName() gives the IPP attribute name.- See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionNumberUp(int value) Construct a new number up attribute with the given integer value. -
Method Summary
Modifier and TypeMethodDescriptionbooleanReturns whether this number up attribute is equivalent to the passed in object.Get the printing attribute class which is to be used as the "category" for this printing attribute value.final StringgetName()Get the name of the category of which this attribute value is an instance.Methods declared in class javax.print.attribute.IntegerSyntax
getValue, hashCode, toString
-
Constructor Details
-
NumberUp
public NumberUp(int value) Construct a new number up attribute with the given integer value.- Parameters:
value- Integer value- Throws:
IllegalArgumentException- ifvalue < 1
-
-
Method Details
-
equals
Returns whether this number up attribute is equivalent to the passed in object. To be equivalent, all of the following conditions must be true:objectis notnull.objectis an instance of classNumberUp.- This number up attribute's value and
object's value are equal.
- Overrides:
equalsin classIntegerSyntax- Parameters:
object-Objectto compare to- Returns:
trueifobjectis equivalent to this number up attribute,falseotherwise- See Also:
-
getCategory
Get the printing attribute class which is to be used as the "category" for this printing attribute value.For class
NumberUp, the category is classNumberUpitself.- Specified by:
getCategoryin interfaceAttribute- Returns:
- printing attribute class (category), an instance of class
java.lang.Class
-
getName
Get the name of the category of which this attribute value is an instance.For class
NumberUp, the category name is"number-up".
-