Added in API level 19

PrintDocumentInfo

class PrintDocumentInfo : Parcelable
kotlin.Any
   ↳ 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 them 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 PrintDocumentInfo, boolean) callback after successfully laying out the content which is performed in 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

Builder for creating a PrintDocumentInfo.
Constants
static Int

Content type: document.
static Int

Content type: photo.
static Int

Content type: unknown.
static Int

Constant for unknown page count.
Inherited constants
Public methods
Int

Boolean
equals(other: Any?)

Indicates whether some other object is "equal to" this one.
Int

Gets the content type.
Long

Gets the document data size in bytes.
String

Gets the document name.
Int

Gets the total number of pages.
Int

String

Unit
writeToParcel(parcel: Parcel, flags: Int)
Properties
static Parcelable.Creator<PrintDocumentInfo!>

Constants

CONTENT_TYPE_DOCUMENT

Added in API level 19
static val CONTENT_TYPE_DOCUMENT: Int

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. 

Value: 0

CONTENT_TYPE_PHOTO

Added in API level 19
static val CONTENT_TYPE_PHOTO: Int

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. 

Value: 1

CONTENT_TYPE_UNKNOWN

Added in API level 19
static val CONTENT_TYPE_UNKNOWN: Int

Content type: unknown.

Value: -1

PAGE_COUNT_UNKNOWN

Added in API level 19
static val PAGE_COUNT_UNKNOWN: Int

Constant for unknown page count.

Value: -1

Public methods

describeContents

Added in API level 19
fun describeContents(): Int
Return
Int a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR

equals

Added in API level 19
fun equals(other: Any?): Boolean

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values 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.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
obj This value may be null.
Return
Boolean true if this object is the same as the obj argument; false otherwise.

getContentType

Added in API level 19
fun getContentType(): Int

Gets the content type.

Return
Int The content type.

getDataSize

Added in API level 19
fun getDataSize(): Long

Gets the document data size in bytes.

Return
Long The data size. Value is 0 or greater

getName

Added in API level 19
fun getName(): String

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

Return
String The document name. This value cannot be null.

getPageCount

Added in API level 19
fun getPageCount(): Int

Gets the total number of pages.

Return
Int The number of pages. Value is -1 or greater

hashCode

Added in API level 19
fun hashCode(): Int
Return
Int a hash code value for this object.

toString

Added in API level 19
fun toString(): String
Return
String a string representation of the object.

writeToParcel

Added in API level 19
fun writeToParcel(
    parcel: Parcel, 
    flags: Int
): Unit
Parameters
dest The Parcel in which the object should be written. This value cannot be null.
flags Int: Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Properties

CREATOR

Added in API level 19
static val CREATOR: Parcelable.Creator<PrintDocumentInfo!>