public
final
class
PrintDocumentInfo
extends Object
implements
Parcelable
| java.lang.Object | |
| ↳ | android.print.PrintDocumentInfo |
This class encapsulates information about a document for printing purposes. This meta-data is used by the platform and print services, components that interact with printers. For example, this class contains the number of pages contained in the document it describes and this number of pages is shown to the user allowing him/her to select the range to print. Also a print service may optimize the printing process based on the content type, such as document or photo.
Instances of this class are created by the printing application and
passed to the PrintDocumentAdapter.LayoutResultCallback.onLayoutFinished(
PrintDocumentInfo, boolean) callback after successfully laying out the
content which is performed in PrintDocumentAdapter.onLayout(PrintAttributes,
PrintAttributes, android.os.CancellationSignal,
PrintDocumentAdapter.LayoutResultCallback, android.os.Bundle).
An example usage looks like this:
Developers
. . .
public void onLayout(PrintAttributes oldAttributes, PrintAttributes newAttributes,
CancellationSignal cancellationSignal, LayoutResultCallback callback,
Bundle metadata) {
// Assume the app defined a LayoutResult class which contains
// the layout result data and that the content is a document.
LayoutResult result = doSomeLayoutWork();
PrintDocumentInfo info = new PrintDocumentInfo
.Builder("printed_file.pdf")
.setContentType(PrintDocumentInfo.CONTENT_TYPE_DOCUMENT)
.setPageCount(result.getPageCount())
.build();
callback.onLayoutFinished(info, result.getContentChanged());
}
. . .
Nested classes | |
|---|---|
class |
PrintDocumentInfo.Builder
Builder for creating a |
Constants | |
|---|---|
int |
CONTENT_TYPE_DOCUMENT
Content type: document. |
int |
CONTENT_TYPE_PHOTO
Content type: photo. |
int |
CONTENT_TYPE_UNKNOWN
Content type: unknown. |
int |
PAGE_COUNT_UNKNOWN
Constant for unknown page count. |
Inherited constants |
|---|
 From
interface
android.os.Parcelable
|
Fields | |
|---|---|
public
static
final
Creator<PrintDocumentInfo> |
CREATOR
|
Public methods | |
|---|---|
int
|
describeContents()
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
boolean
|
equals(Object obj)
Indicates whether some other object is "equal to" this one. |
int
|
getContentType()
Gets the content type. |
long
|
getDataSize()
Gets the document data size in bytes. |
String
|
getName()
Gets the document name. |
int
|
getPageCount()
Gets the total number of pages. |
int
|
hashCode()
Returns a hash code value for the object. |
String
|
toString()
Returns a string representation of the object. |
void
|
writeToParcel(Parcel parcel, int flags)
Flatten this object in to a Parcel. |
Inherited methods | |
|---|---|
From
class
java.lang.Object
| |
From
interface
android.os.Parcelable
| |
int CONTENT_TYPE_DOCUMENT
Content type: document.
A print service may use normal paper to print the content instead of dedicated photo paper. Also it may use a lower quality printing process as the content is not as sensitive to print quality variation as a photo is.
Constant Value: 0 (0x00000000)
int CONTENT_TYPE_PHOTO
Content type: photo.
A print service may use dedicated photo paper to print the content instead of normal paper. Also it may use a higher quality printing process as the content is more sensitive to print quality variation than a document.
Constant Value: 1 (0x00000001)
int CONTENT_TYPE_UNKNOWN
Content type: unknown.
Constant Value: -1 (0xffffffff)
int PAGE_COUNT_UNKNOWN
Constant for unknown page count.
Constant Value: -1 (0xffffffff)
int describeContents ()
Describe the kinds of special objects contained in this Parcelable
instance's marshaled representation. For example, if the object will
include a file descriptor in the output of writeToParcel(Parcel, int),
the return value of this method must include the
CONTENTS_FILE_DESCRIPTOR bit.
| Returns | |
|---|---|
int |
a bitmask indicating the set of special object types marshaled by this Parcelable object instance. |
boolean equals (Object obj)
Indicates whether some other object is "equal to" this one.
The equals method implements an equivalence relation
on non-null object references:
x, x.equals(x) should return
true.
x and y, x.equals(y)
should return true if and only if
y.equals(x) returns true.
x, y, and z, if
x.equals(y) returns true and
y.equals(z) returns true, then
x.equals(z) should return true.
x and y, multiple invocations of
x.equals(y) consistently return true
or consistently return false, provided no
information used in equals comparisons on the
objects is modified.
x,
x.equals(null) should return false.
The equals method for class Object implements
the most discriminating possible equivalence relation on objects;
that is, for any non-null reference values x and
y, this method returns true if and only
if x and y refer to the same object
(x == y has the value true).
Note that it is generally necessary to override the hashCode
method whenever this method is overridden, so as to maintain the
general contract for the hashCode method, which states
that equal objects must have equal hash codes.
| Parameters | |
|---|---|
obj |
Object:
the reference object with which to compare. |
| Returns | |
|---|---|
boolean |
true if this object is the same as the obj
argument; false otherwise. |
int getContentType ()
Gets the content type.
| Returns | |
|---|---|
int |
The content type. |
long getDataSize ()
Gets the document data size in bytes.
| Returns | |
|---|---|
long |
The data size. |
String getName ()
Gets the document name. This name may be shown to the user.
| Returns | |
|---|---|
String |
The document name. |
int getPageCount ()
Gets the total number of pages.
| Returns | |
|---|---|
int |
The number of pages. |
See also:
int hashCode ()
Returns a hash code value for the object. This method is
supported for the benefit of hash tables such as those provided by
HashMap.
The general contract of hashCode is:
hashCode method
must consistently return the same integer, provided no information
used in equals comparisons on the object is modified.
This integer need not remain consistent from one execution of an
application to another execution of the same application.
equals(Object)
method, then calling the hashCode method on each of
the two objects must produce the same integer result.
equals(java.lang.Object)
method, then calling the hashCode method on each of the
two objects must produce distinct integer results. However, the
programmer should be aware that producing distinct integer results
for unequal objects may improve the performance of hash tables.
As much as is reasonably practical, the hashCode method defined by
class Object does return distinct integers for distinct
objects. (This is typically implemented by converting the internal
address of the object into an integer, but this implementation
technique is not required by the
JavaTM programming language.)
| Returns | |
|---|---|
int |
a hash code value for this object. |
String toString ()
Returns a string representation of the object. In general, the
toString method returns a string that
"textually represents" this object. The result should
be a concise but informative representation that is easy for a
person to read.
It is recommended that all subclasses override this method.
The toString method for class Object
returns a string consisting of the name of the class of which the
object is an instance, the at-sign character `@', and
the unsigned hexadecimal representation of the hash code of the
object. In other words, this method returns a string equal to the
value of:
getClass().getName() + '@' + Integer.toHexString(hashCode())
| Returns | |
|---|---|
String |
a string representation of the object. |
void writeToParcel (Parcel parcel, int flags)
Flatten this object in to a Parcel.
| Parameters | |
|---|---|
parcel |
Parcel:
The Parcel in which the object should be written. |
flags |
int:
Additional flags about how the object should be written.
May be 0 or PARCELABLE_WRITE_RETURN_VALUE.
|