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
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
|
/*
* Copyright (C) 2013 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package android.print;
import android.os.Parcel;
import android.os.Parcelable;
import android.print.PrintAttributes.Margins;
import android.print.PrintAttributes.MediaSize;
import android.text.TextUtils;
/**
* This class encapsulates information about a printed document.
*/
public final class PrintDocumentInfo implements Parcelable {
/**
* Constant for an unknown media size.
*/
public static final MediaSize MEDIA_SIZE_UNKNOWN = new MediaSize("Unknown", "Unknown", 1, 1);
/**
* Constant for unknown page count..
*/
public static final int PAGE_COUNT_UNKNOWN = -1;
/**
* Content type: unknown.
*/
public static final int CONTENT_TYPE_UNKNOWN = -1;
/**
* Content type: document.
*/
public static final int CONTENT_TYPE_DOCUMENT = 0;
/**
* Content type: photo.
*/
public static final int CONTENT_TYPE_PHOTO = 1;
private String mName;
private int mPageCount;
private int mContentType;
private int mOrientation;
private int mFittingMode;
private int mColorMode;
private Margins mMargins;
private MediaSize mMediaSize;
private long mDataSize;
/**
* Creates a new instance.
*/
private PrintDocumentInfo() {
/* do nothing */
}
/**
* Creates a new instance.
*
* @param Prototype from which to clone.
*/
private PrintDocumentInfo(PrintDocumentInfo prototype) {
mName = prototype.mName;
mPageCount = prototype.mPageCount;
mContentType = prototype.mContentType;
mOrientation = prototype.mOrientation;
mFittingMode = prototype.mFittingMode;
mColorMode = prototype.mColorMode;
mMargins = prototype.mMargins;
mMediaSize = prototype.mMediaSize;
mDataSize = prototype.mDataSize;
}
/**
* Creates a new instance.
*
* @param parcel Data from which to initialize.
*/
private PrintDocumentInfo(Parcel parcel) {
mName = parcel.readString();
mPageCount = parcel.readInt();
mContentType = parcel.readInt();
mOrientation = parcel.readInt();
mFittingMode = parcel.readInt();
mColorMode = parcel.readInt();
mMargins = Margins.createFromParcel(parcel);
mMediaSize = MediaSize.createFromParcel(parcel);
mDataSize = parcel.readLong();
}
/**
* Gets the document name.
*
* @return The document name.
*/
public String getName() {
return mName;
}
/**
* Gets the total number of pages.
*
* @return The number of pages.
*
* @see #PAGE_COUNT_UNKNOWN
*/
public int getPageCount() {
return mPageCount;
}
/**
* Gets the content type.
*
* @return The content type.
*
* @see #CONTENT_TYPE_UNKNOWN
* @see #CONTENT_TYPE_DOCUMENT
* @see #CONTENT_TYPE_PHOTO
*/
public int getContentType() {
return mContentType;
}
/**
* Gets the document orientation.
*
* @return The orientation.
*
* @see PrintAttributes#ORIENTATION_PORTRAIT PrintAttributes.ORIENTATION_PORTRAIT
* @see PrintAttributes#ORIENTATION_LANDSCAPE PrintAttributes.ORIENTATION_LANDSCAPE
*/
public int getOrientation() {
return mOrientation;
}
/**
* Gets the document fitting mode.
*
* @return The fitting mode.
*
* @see PrintAttributes#FITTING_MODE_NONE PrintAttributes.FITTING_MODE_NONE
* @see PrintAttributes#FITTING_MODE_SCALE_TO_FILL PrintAttributes.FITTING_MODE_SCALE_TO_FILL
* @see PrintAttributes#FITTING_MODE_SCALE_TO_FIT PrintAttributes.FITTING_MODE_SCALE_TO_FIT
*/
public int getFittingMode() {
return mFittingMode;
}
/**
* Gets document color mode.
*
* @return The color mode.
*
* @see PrintAttributes#COLOR_MODE_COLOR PrintAttributes.COLOR_MODE_COLOR
* @see PrintAttributes#COLOR_MODE_MONOCHROME PrintAttributes.COLOR_MODE_MONOCHROME
*/
public int getColorMode() {
return mColorMode;
}
/**
* Gets the document margins.
*
* @return The margins.
*/
public Margins getMargins() {
return mMargins;
}
/**
* Gets the media size.
*
* @return The media size.
*/
public MediaSize getMediaSize() {
return mMediaSize;
}
/**
* Gets the document data size in bytes.
*
* @return The data size.
*/
public long getDataSize() {
return mDataSize;
}
/**
* Sets the document data size in bytes.
*
* @param dataSize The data size.
*
* @hide
*/
public void setDataSize(long dataSize) {
mDataSize = dataSize;
}
@Override
public int describeContents() {
return 0;
}
@Override
public void writeToParcel(Parcel parcel, int flags) {
parcel.writeString(mName);
parcel.writeInt(mPageCount);
parcel.writeInt(mContentType);
parcel.writeInt(mOrientation);
parcel.writeInt(mFittingMode);
parcel.writeInt(mColorMode);
mMargins.writeToParcel(parcel);
mMediaSize.writeToParcel(parcel);
parcel.writeLong(mDataSize);
}
@Override
public int hashCode() {
final int prime = 31;
int result = 1;
result = prime * result + ((mName != null) ? mName.hashCode() : 0);
result = prime * result + mContentType;
result = prime * result + mPageCount;
result = prime * result + mOrientation;
result = prime * result + mFittingMode;
result = prime * result + mColorMode;
result = prime * result + (mMargins != null ? mMargins.hashCode() : 0);
result = prime * result + (mMediaSize != null ? mMediaSize.hashCode() : 0);
result = prime * result + (int) mDataSize;
result = prime * result + (int) mDataSize >> 32;
return result;
}
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (getClass() != obj.getClass()) {
return false;
}
PrintDocumentInfo other = (PrintDocumentInfo) obj;
if (!TextUtils.equals(mName, other.mName)) {
return false;
}
if (mContentType != other.mContentType) {
return false;
}
if (mPageCount != other.mPageCount) {
return false;
}
if (mOrientation != other.mOrientation) {
return false;
}
if (mFittingMode != other.mFittingMode) {
return false;
}
if (mColorMode != other.mColorMode) {
return false;
}
if (mMargins == null) {
if (other.mMargins != null) {
return false;
}
} else if (!mMargins.equals(other.mMargins)) {
return false;
}
if (mMediaSize == null) {
if (other.mMediaSize != null) {
return false;
}
} else if (!mMediaSize.equals(other.mMediaSize)) {
return false;
}
if (mDataSize != other.mDataSize) {
return false;
}
return true;
}
@Override
public String toString() {
StringBuilder builder = new StringBuilder();
builder.append("PrintDocumentInfo{");
builder.append("name=").append(mName);
builder.append(", pageCount=").append(mPageCount);
builder.append(", contentType=").append(contentTyepToString(mContentType));
builder.append(", orientation=").append(PrintAttributes.orientationToString(mOrientation));
builder.append(", fittingMode=").append(PrintAttributes.fittingModeToString(mFittingMode));
builder.append(", colorMode=").append(PrintAttributes.colorModeToString(mColorMode));
builder.append(", margins=").append(mMargins);
builder.append(", mediaSize=").append(mMediaSize);
builder.append(", size=").append(mDataSize);
builder.append("}");
return builder.toString();
}
private String contentTyepToString(int contentType) {
switch (contentType) {
case CONTENT_TYPE_DOCUMENT: {
return "CONTENT_TYPE_DOCUMENT";
}
case CONTENT_TYPE_PHOTO: {
return "CONTENT_TYPE_PHOTO";
}
default: {
return "CONTENT_TYPE_UNKNOWN";
}
}
}
/**
* Builder for creating an {@link PrintDocumentInfo}.
*/
public static final class Builder {
private final PrintDocumentInfo mPrototype;
/**
* Constructor.
* <p>
* The values of the relevant properties are initialized from the
* provided print attributes. For example, the orientation is set
* to be the same as the orientation returned by calling {@link
* PrintAttributes#getOrientation() PrintAttributes.getOrientation()}.
* </p>
*
* @param name The document name. Cannot be empty.
* @param attributes Print attributes. Cannot be null.
*
* @throws IllegalArgumentException If the name is empty.
*/
public Builder(String name, PrintAttributes attributes) {
if (TextUtils.isEmpty(name)) {
throw new IllegalArgumentException("name cannot be empty");
}
if (attributes == null) {
throw new IllegalArgumentException("attributes cannot be null");
}
mPrototype = new PrintDocumentInfo();
mPrototype.mName = name;
mPrototype.mOrientation = attributes.getOrientation();
mPrototype.mFittingMode = attributes.getFittingMode();
mPrototype.mColorMode = attributes.getColorMode();
mPrototype.mMargins = attributes.getMargins();
mPrototype.mMediaSize = attributes.getMediaSize();
}
/**
* Constructor.
* <p>
* The values of the relevant properties are initialized with default
* values. Please refer to the documentation of the individual setters
* for information about the default values.
* </p>
*
* @param name The document name. Cannot be empty.
*/
public Builder(String name) {
if (TextUtils.isEmpty(name)) {
throw new IllegalArgumentException("name cannot be empty");
}
mPrototype = new PrintDocumentInfo();
mPrototype.mName = name;
mPrototype.mOrientation = PrintAttributes.ORIENTATION_PORTRAIT;
mPrototype.mFittingMode = PrintAttributes.FITTING_MODE_NONE;
mPrototype.mColorMode = PrintAttributes.COLOR_MODE_COLOR;
mPrototype.mMargins = Margins.NO_MARGINS;
mPrototype.mMediaSize = MEDIA_SIZE_UNKNOWN;
}
/**
* Sets the total number of pages.
* <p>
* <strong>Default: </strong> {@link #PAGE_COUNT_UNKNOWN}
* </p>
*
* @param pageCount The number of pages. Must be greater than
* or equal to zero or {@link PrintDocumentInfo#PAGE_COUNT_UNKNOWN}.
*/
public Builder setPageCount(int pageCount) {
if (pageCount < 0 && pageCount != PAGE_COUNT_UNKNOWN) {
throw new IllegalArgumentException("pageCount"
+ " must be greater than or euqal to zero or"
+ " DocumentInfo#PAGE_COUNT_UNKNOWN");
}
mPrototype.mPageCount = pageCount;
return this;
}
/**
* Sets the content type.
* <p>
* <strong>Default: </strong> {@link #CONTENT_TYPE_UNKNOWN}
* </p>
*
* @param type The content type.
*
* @see #CONTENT_TYPE_UNKNOWN
* @see #CONTENT_TYPE_DOCUMENT
* @see #CONTENT_TYPE_PHOTO
*/
public Builder setContentType(int type) {
mPrototype.mContentType = type;
return this;
}
/**
* Sets the orientation.
* <p>
* <strong>Default: </strong> {@link PrintAttributes#ORIENTATION_PORTRAIT
* PrintAttributes.ORIENTATION_PORTRAIT}
* </p>
*
* @param orientation The orientation.
*
* @see PrintAttributes#ORIENTATION_PORTRAIT PrintAttributes.ORIENTATION_PORTRAIT
* @see PrintAttributes#ORIENTATION_LANDSCAPE PrintAttributes.ORIENTATION_LANDSCAPE
*/
public Builder setOrientation(int orientation) {
PrintAttributes.enforceValidOrientation(orientation);
mPrototype.mOrientation = orientation;
return this;
}
/**
* Sets the content fitting mode.
* <p>
* <strong>Default: </strong> {@link PrintAttributes#FITTING_MODE_NONE
* PrintAttributes.FITTING_MODE_NONE}
* </p>
*
* @param fittingMode The fitting mode.
*
* @see PrintAttributes#FITTING_MODE_NONE PrintAttributes.FITTING_MODE_NONE
* @see PrintAttributes#FITTING_MODE_SCALE_TO_FILL PrintAttributes.FITTING_MODE_SCALE_TO_FILL
* @see PrintAttributes#FITTING_MODE_SCALE_TO_FIT PrintAttributes.FITTING_MODE_SCALE_TO_FIT
*/
public Builder setFittingMode(int fittingMode) {
PrintAttributes.enforceValidFittingMode(fittingMode);
mPrototype.mFittingMode = fittingMode;
return this;
}
/**
* Sets the content color mode.
* <p>
* <strong>Default: </strong> {@link PrintAttributes#COLOR_MODE_COLOR
* PrintAttributes.COLOR_MODE_COLOR}
* </p>
*
* @param colorMode The color mode.
*
* @see PrintAttributes#COLOR_MODE_COLOR PrintAttributes.COLOR_MODE_COLOR
* @see PrintAttributes#COLOR_MODE_MONOCHROME PrintAttributes.COLOR_MODE_MONOCHROME
*/
public Builder setColorMode(int colorMode) {
PrintAttributes.enforceValidColorMode(colorMode);
mPrototype.mColorMode = colorMode;
return this;
}
/**
* Sets the document margins.
* <p>
* <strong>Default: </strong> {@link PrintAttributes.Margins#NO_MARGINS Margins.NO_MARGINS}
* </p>
*
* @param margins The margins. Cannot be null.
*/
public Builder setMargins(Margins margins) {
if (margins == null) {
throw new IllegalArgumentException("margins cannot be null");
}
mPrototype.mMargins = margins;
return this;
}
/**
* Sets the document media size.
* <p>
* <strong>Default: </strong>#MEDIA_SIZE_UNKNOWN
* </p>
*
* @param mediaSize The media size. Cannot be null.
*
* @see #MEDIA_SIZE_UNKNOWN
*/
public Builder setMediaSize(MediaSize mediaSize) {
if (mediaSize == null) {
throw new IllegalArgumentException("media size cannot be null");
}
mPrototype.mMediaSize = mediaSize;
return this;
}
/**
* Creates a new {@link PrintDocumentInfo} instance.
*
* @return The new instance.
*/
public PrintDocumentInfo create() {
return new PrintDocumentInfo(mPrototype);
}
}
public static final Parcelable.Creator<PrintDocumentInfo> CREATOR =
new Creator<PrintDocumentInfo>() {
@Override
public PrintDocumentInfo createFromParcel(Parcel parcel) {
return new PrintDocumentInfo(parcel);
}
@Override
public PrintDocumentInfo[] newArray(int size) {
return new PrintDocumentInfo[size];
}
};
}
|