Java™ Platform
Standard Ed. 6

javax.print.attribute.standard
Class NumberUp

java.lang.Object
  extended by javax.print.attribute.IntegerSyntax
      extended by 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.

IPP Compatibility: The integer value gives the IPP integer value. The category name returned by getName() gives the IPP attribute name.

See Also:
Serialized Form

Constructor Summary
NumberUp(int value)
          Construct a new number up attribute with the given integer value.
 
Method Summary
 boolean equals(Object object)
          Returns whether this number up attribute is equivalent to the passed in object.
 Class<? extends Attribute> getCategory()
          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.IntegerSyntax
getValue, hashCode, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

NumberUp

public NumberUp(int value)
Construct a new number up attribute with the given integer value.

Parameters:
value - Integer value.
Throws:
IllegalArgumentException - (Unchecked exception) Thrown if value is less than 1.
Method Detail

equals

public boolean equals(Object object)
Returns whether this number up attribute is equivalent to the passed in object. To be equivalent, all of the following conditions must be true:
  1. object is not null.
  2. object is an instance of class NumberUp.
  3. This number up attribute's value and object's value are equal.

Overrides:
equals in class IntegerSyntax
Parameters:
object - Object to compare to.
Returns:
True if object is equivalent to this number up attribute, false otherwise.
See Also:
Object.hashCode(), Hashtable

getCategory

public final Class<? extends Attribute> 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 class NumberUp itself.

Specified by:
getCategory in interface Attribute
Returns:
Printing attribute class (category), an instance of class java.lang.Class.

getName

public final String getName()
Get the name of the category of which this attribute value is an instance.

For class NumberUp, the category name is "number-up".

Specified by:
getName in interface Attribute
Returns:
Attribute category name.

Java™ Platform
Standard Ed. 6

Submit a bug or feature
For further API reference and developer documentation, see Java SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.

Copyright © 1993, 2011, Oracle and/or its affiliates. All rights reserved.

Scripting on this page tracks web page traffic, but does not change the content in any way.