Please note that the contents of this offline web site may be out of date. To access the most recent documentation visit the online version .
Note that links that point to online resources are green in color and will open in a new window.
We would love it if you could give us feedback about this material by filling this form (You have to be online to fill it)
Android APIs
public final class

PrintDocumentInfo

extends Object
implements Parcelable
java.lang.Object
   ↳ android.print.PrintDocumentInfo

Class Overview

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: 

        . . .

 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());
   }

   . . .

Summary

Nested Classes
class PrintDocumentInfo.Builder Builder for creating a PrintDocumentInfo . 
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.
[Expand]
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's marshalled representation.
boolean equals ( Object obj)
Compares this instance with the specified object and indicates if they are equal.
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 an integer hash code for this object.
String toString ()
Returns a string containing a concise, human-readable description of this object.
void writeToParcel ( Parcel parcel, int flags)
Flatten this object in to a Parcel.
[Expand]
Inherited Methods
From class java.lang.Object
From interface android.os.Parcelable

Constants

public static final int CONTENT_TYPE_DOCUMENT

Added in API level 19

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)

public static final int CONTENT_TYPE_PHOTO

Added in API level 19

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)

public static final int CONTENT_TYPE_UNKNOWN

Added in API level 19

Content type: unknown.

Constant Value: -1 (0xffffffff)

public static final int PAGE_COUNT_UNKNOWN

Added in API level 19

Constant for unknown page count.

Constant Value: -1 (0xffffffff)

Fields

public static final Creator < PrintDocumentInfo > CREATOR

Added in API level 19

Public Methods

public int describeContents ()

Describe the kinds of special objects contained in this Parcelable's marshalled representation.

Returns
  • a bitmask indicating the set of special object types marshalled by the Parcelable.

public boolean equals ( Object obj)

Compares this instance with the specified object and indicates if they are equal. In order to be equal, o must represent the same object as this instance using a class-specific comparison. The general contract is that this comparison should be reflexive, symmetric, and transitive. Also, no object reference other than null is equal to null.

The default implementation returns true only if this == o . See Writing a correct equals method if you intend implementing your own equals method.

The general contract for the equals and hashCode() methods is that if equals returns true for any two objects, then hashCode() must return the same value for these objects. This means that subclasses of Object usually override either both methods or neither of them.

Parameters
obj the object to compare this instance with.
Returns
  • true if the specified object is equal to this Object ; false otherwise.

public int getContentType ()

Gets the content type.

Returns
  • The content type.
See Also

public long getDataSize ()

Gets the document data size in bytes.

Returns
  • The data size.

public String getName ()

Gets the document name. This name may be shown to the user.

Returns
  • The document name.

public int getPageCount ()

Gets the total number of pages.

Returns
  • The number of pages.
See Also

public int hashCode ()

Returns an integer hash code for this object. By contract, any two objects for which equals(Object) returns true must return the same hash code value. This means that subclasses of Object usually override both methods or neither method.

Note that hash values must not change over time unless information used in equals comparisons also changes.

See Writing a correct hashCode method if you intend implementing your own hashCode method.

Returns
  • this object's hash code.

public String toString ()

Returns a string containing a concise, human-readable description of this object. Subclasses are encouraged to override this method and provide an implementation that takes into account the object's type and data. The default implementation is equivalent to the following expression: 

          getClass().getName() + '@' + Integer.toHexString(hashCode())

See Writing a useful toString method if you intend implementing your own toString method.

Returns
  • a printable representation of this object.

public void writeToParcel ( Parcel parcel, int flags)

Flatten this object in to a Parcel.

Parameters
parcel The Parcel in which the object should be written.
flags Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE .