API Overview API Index Package Overview Direct link to this page
JDK 1.6
  javax.print.attribute.standard. NumberUp View Javadoc
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174

/*
 * @(#)NumberUp.java	1.8 05/11/17
 *
 * Copyright 2006 Sun Microsystems, Inc. All rights reserved.
 * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
 */
package javax.print.attribute.standard;

import javax.print.attribute.Attribute;
import javax.print.attribute.IntegerSyntax;
import javax.print.attribute.DocAttribute;
import javax.print.attribute.PrintRequestAttribute;
import javax.print.attribute.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 <I>n,</I>
 * the printer must place <I>n</I> 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. 
 * <P>
 * 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 {@link 
 * MultipleDocumentHandling MultipleDocumentHandling} attribute. 
 * <UL>
 * <LI>
 * If all the docs have the same number up value <I>n</I> specified, then any 
 * value of {@link MultipleDocumentHandling MultipleDocumentHandling} makes 
 * sense, and the printer's processing depends on the {@link 
 * MultipleDocumentHandling MultipleDocumentHandling} value: 
 * <UL>
 * <LI>
 * SINGLE_DOCUMENT -- All the input docs will be combined together into one 
 * output document. Each media impression will consist of <I>n</I>m
 *  print-stream pages from the output document. 
 * <P>
 * <LI>
 * SINGLE_DOCUMENT_NEW_SHEET -- All the input docs will be combined together 
 * into one output document. Each media impression will consist of <I>n</I> 
 * 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 <I>n</I> print-stream pages
 *  on it. 
 * <P>
 * <LI>
 * SEPARATE_DOCUMENTS_UNCOLLATED_COPIES -- The input docs will remain separate. 
 * Each media impression will consist of <I>n</I> 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 <I>n</I> print-stream pages on 
 * it. 
 * <P>
 * <LI>
 * SEPARATE_DOCUMENTS_COLLATED_COPIES -- The input docs will remain separate. 
 * Each media impression will consist of <I>n</I> 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 <I>n</I> print-stream pages
 * on it. 
 * </UL> 
 * <UL>
 * <LI>
 * SINGLE_DOCUMENT -- All the input docs will be combined together into one 
 * output document. Each media impression will consist of <I>n<SUB>i</SUB></I> 
 * print-stream pages from the output document, where <I>i</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. 
 * <P>
 * <LI>
 * SINGLE_DOCUMENT_NEW_SHEET -- All the input docs will be combined together 
 * into one output document. Each media impression will consist of <I>n</I> 
 * 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 <I>n</I> print-stream pages
 * on it. 
 * <P>
 * <LI>
 * SEPARATE_DOCUMENTS_UNCOLLATED_COPIES -- The input docs will remain separate. 
 * For input doc <I>i,</I> each media impression will consist of 
 * <I>n<SUB>i</SUB></I> 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 <I>n<SUB>i</SUB></I> print-stream pages on it. 
 * <P>
 * <LI>
 * SEPARATE_DOCUMENTS_COLLATED_COPIES -- The input docs will remain separate. 
 * For input doc <I>i,</I> each media impression will consist of 
 * <I>n<SUB>i</SUB></I> 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 <I>n<SUB>i</SUB></I> print-stream pages on it. 
 * </UL> 
 * </UL>
 * <B>IPP Compatibility:</B> The integer value gives the IPP integer value.  
 * The category name returned by <CODE>getName()</CODE> gives the IPP  
 * attribute name. 
 * <P>
 *
 * @author  Alan Kaminsky
 */
public final class NumberUp extends IntegerSyntax
    implements DocAttribute, PrintRequestAttribute, PrintJobAttribute {

    private static final long serialVersionUID = -3040436486786527811L;


    /**
     * Construct a new number up attribute with the given integer value. 
     *
     * @param  value  Integer value.
     *
     * @exception  IllegalArgumentException
     *   (Unchecked exception) Thrown if <CODE>value</CODE> is less than 1.
     */
    public NumberUp(int value) {
	super (value, 1, Integer.MAX_VALUE);
    }

    /**
     * Returns whether this number up attribute is equivalent to the passed in 
     * object. To be equivalent, all of the following conditions must be true: 
     * <OL TYPE=1>
     * <LI>
     * <CODE>object</CODE> is not null.
     * <LI>
     * <CODE>object</CODE> is an instance of class NumberUp.
     * <LI>
     * This number up attribute's value and <CODE>object</CODE>'s value are 
     * equal. 
     * </OL>
     *
     * @param  object  Object to compare to.
     *
     * @return  True if <CODE>object</CODE> is equivalent to this number up
     *          attribute, false otherwise. 
     */
    public boolean equals(Object object) {
	return (super.equals(object) && object instanceof NumberUp);
    }

    /**
     * Get the printing attribute class which is to be used as the "category" 
     * for this printing attribute value.
     * <P>
     * For class NumberUp, the category is class NumberUp itself. 
     *
     * @return  Printing attribute class (category), an instance of class
     *          {@link java.lang.Class java.lang.Class}.
     */
    public final Class<? extends Attribute> getCategory() {
	return NumberUp.class;
    }

    /**
     * Get the name of the category of which this attribute value is an 
     * instance. 
     * <P>
     * For class NumberUp, the category name is <CODE>"number-up"</CODE>. 
     *
     * @return  Attribute category name.
     */
    public final String getName() {
	return "number-up";
    }

}

Generated By: JavaOnTracks Doclet 0.1.4     ©Thibaut Colar