Added in API level 19

Summary: Nested Classes | Constants | Ctors | Methods | Inherited Methods

PrintDocumentAdapter

---

Kotlin |Java

public abstract class PrintDocumentAdapter
extends Object

java.lang.Object
↳	android.print.PrintDocumentAdapter

---

Base class that provides the content of a document to be printed.

Lifecycle

• Initially, you will receive a call to onStart(). This callback can be used to allocate resources.
• Next, you will get one or more calls to onLayout(android.print.PrintAttributes, android.print.PrintAttributes, android.os.CancellationSignal, android.print.PrintDocumentAdapter.LayoutResultCallback, android.os.Bundle) to inform you that the print attributes (page size, density, etc) changed giving you an opportunity to layout the content to match the new constraints.
• After every call to onLayout(android.print.PrintAttributes, android.print.PrintAttributes, android.os.CancellationSignal, android.print.PrintDocumentAdapter.LayoutResultCallback, android.os.Bundle), you may get a call to onWrite(android.print.PageRange[], android.os.ParcelFileDescriptor, android.os.CancellationSignal, android.print.PrintDocumentAdapter.WriteResultCallback) asking you to write a PDF file with the content for specific pages.
• Finally, you will receive a call to onFinish(). You can use this callback to release resources allocated in onStart().

The onStart() callback is always the first call you will receive and is useful for doing one time setup or resource allocation before printing. You will not receive a subsequent call here.

The onLayout(android.print.PrintAttributes, android.print.PrintAttributes, android.os.CancellationSignal, android.print.PrintDocumentAdapter.LayoutResultCallback, android.os.Bundle) callback requires that you layout the content based on the current PrintAttributes. The execution of this method is not considered completed until you invoke one of the methods on the passed in callback instance. Hence, you will not receive a subsequent call to any other method of this class until the execution of this method is complete by invoking one of the callback methods.

The onWrite(android.print.PageRange[], android.os.ParcelFileDescriptor, android.os.CancellationSignal, android.print.PrintDocumentAdapter.WriteResultCallback) requires that you render and write the content of some pages to the provided destination. The execution of this method is not considered complete until you invoke one of the methods on the passed in callback instance. Hence, you will not receive a subsequent call to any other method of this class until the execution of this method is complete by invoking one of the callback methods. You will never receive a sequence of one or more calls to this method without a previous call to onLayout(android.print.PrintAttributes, android.print.PrintAttributes, android.os.CancellationSignal, android.print.PrintDocumentAdapter.LayoutResultCallback, android.os.Bundle).

The onFinish() callback is always the last call you will receive and is useful for doing one time cleanup or resource deallocation after printing. You will not receive a subsequent call here.

Implementation

The APIs defined in this class are designed to enable doing part or all of the work on an arbitrary thread. For example, if the printed content does not depend on the UI state, i.e. on what is shown on the screen, then you can offload the entire work on a dedicated thread, thus making your application interactive while the print work is being performed. Note that while your activity is covered by the system print UI and a user cannot interact with it, doing the printing work on the main application thread may affect the performance of your other application components as they are also executed on that thread.

You can also do work on different threads, for example if you print UI content, you can handle onStart() and onLayout(android.print.PrintAttributes, android.print.PrintAttributes, android.os.CancellationSignal, android.print.PrintDocumentAdapter.LayoutResultCallback, android.os.Bundle) on the UI thread (assuming onStart initializes resources needed for layout). This will ensure that the UI does not change while you are laying out the printed content. Then you can handle onWrite(android.print.PageRange[], android.os.ParcelFileDescriptor, android.os.CancellationSignal, android.print.PrintDocumentAdapter.WriteResultCallback) and onFinish() on another thread. This will ensure that the main thread is busy for a minimal amount of time. Also this assumes that you will generate the printed content in onLayout(android.print.PrintAttributes, android.print.PrintAttributes, android.os.CancellationSignal, android.print.PrintDocumentAdapter.LayoutResultCallback, android.os.Bundle) which is not mandatory. If you use multiple threads, you are responsible for proper synchronization.

Summary

Nested classes
class	PrintDocumentAdapter.LayoutResultCallback Base class for implementing a callback for the result of PrintDocumentAdapter.onLayout(android.print.PrintAttributes, android.print.PrintAttributes, android.os.CancellationSignal, android.print.PrintDocumentAdapter.LayoutResultCallback, android.os.Bundle).
class	PrintDocumentAdapter.WriteResultCallback Base class for implementing a callback for the result of PrintDocumentAdapter.onWrite(android.print.PageRange[], android.os.ParcelFileDescriptor, android.os.CancellationSignal, android.print.PrintDocumentAdapter.WriteResultCallback).

Constants
String	EXTRA_PRINT_PREVIEW Extra: mapped to a boolean value that is true if the current layout is for a print preview, false otherwise.

Public constructors
PrintDocumentAdapter()

Public methods
void	onFinish() Called when printing finishes.
abstract void	onLayout(PrintAttributes oldAttributes, PrintAttributes newAttributes, CancellationSignal cancellationSignal, PrintDocumentAdapter.LayoutResultCallback callback, Bundle extras) Called when the print attributes (page size, density, etc) changed giving you a chance to layout the content such that it matches the new constraints.
void	onStart() Called when printing starts.
abstract void	onWrite(PageRange[] pages, ParcelFileDescriptor destination, CancellationSignal cancellationSignal, PrintDocumentAdapter.WriteResultCallback callback) Called when specific pages of the content should be written in the form of a PDF file to the given file descriptor.

Inherited methods

From class java.lang.Object Object clone() Creates and returns a copy of this object. boolean equals(Object obj) Indicates whether some other object is "equal to" this one. void finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. final Class<?> getClass() Returns the runtime class of this Object. int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait(long timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait() Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Constants

EXTRA_PRINT_PREVIEW

Added in API level 19

public static final String EXTRA_PRINT_PREVIEW

Extra: mapped to a boolean value that is true if the current layout is for a print preview, false otherwise. This extra is provided in the Bundle argument of the onLayout(android.print.PrintAttributes, android.print.PrintAttributes, android.os.CancellationSignal, android.print.PrintDocumentAdapter.LayoutResultCallback, android.os.Bundle) callback.

See also:

• onLayout(PrintAttributes, PrintAttributes, CancellationSignal, LayoutResultCallback, Bundle)

Constant Value: "EXTRA_PRINT_PREVIEW"

Public constructors

PrintDocumentAdapter

public PrintDocumentAdapter ()

Public methods

onFinish

Added in API level 19

public void onFinish ()

Called when printing finishes. You can use this callback to release resources acquired in onStart(). This method is invoked on the main thread.

onLayout

Added in API level 19

public abstract void onLayout (PrintAttributes oldAttributes, 
                PrintAttributes newAttributes, 
                CancellationSignal cancellationSignal, 
                PrintDocumentAdapter.LayoutResultCallback callback, 
                Bundle extras)

Called when the print attributes (page size, density, etc) changed giving you a chance to layout the content such that it matches the new constraints. This method is invoked on the main thread.

After you are done laying out, you must invoke: PrintDocumentAdapter.LayoutResultCallback.onLayoutFinished(android.print.PrintDocumentInfo, boolean) with the last argument true or false depending on whether the layout changed the content or not, respectively; or PrintDocumentAdapter.LayoutResultCallback.onLayoutFailed(java.lang.CharSequence), if an error occurred; or LayoutResultCallback#onLayoutCancelled() if layout was cancelled in a response to a cancellation request via the passed in CancellationSignal. Note that you must call one of the methods of the given callback for this method to be considered complete which is you will not receive any calls to this adapter until the current layout operation is complete by invoking a method on the callback instance. The callback methods can be invoked from an arbitrary thread.

One of the arguments passed to this method is a CancellationSignal which is used to propagate requests from the system to your application for canceling the current layout operation. For example, a cancellation may be requested if the user changes a print option that may affect layout while you are performing a layout operation. In such a case the system will make an attempt to cancel the current layout as another one will have to be performed. Typically, you should register a cancellation callback in the cancellation signal. The cancellation callback will not be made on the main thread and can be registered as follows:

 cancellationSignal.setOnCancelListener(new OnCancelListener() {
     @Override
     public void onCancel() {
         // Cancel layout
     }
 });
 

Note: If the content is large and a layout will be performed, it is a good practice to schedule the work on a dedicated thread and register an observer in the provided CancellationSignal upon invocation of which you should stop the layout.

Parameters
oldAttributes	PrintAttributes: The old print attributes.
newAttributes	PrintAttributes: The new print attributes.
cancellationSignal	CancellationSignal: Signal for observing cancel layout requests.
callback	PrintDocumentAdapter.LayoutResultCallback: Callback to inform the system for the layout result.
extras	Bundle: Additional information about how to layout the content.

See also:

• PrintDocumentAdapter.LayoutResultCallback
• CancellationSignal
• EXTRA_PRINT_PREVIEW

onStart

Added in API level 19

public void onStart ()

Called when printing starts. You can use this callback to allocate resources. This method is invoked on the main thread.

onWrite

Added in API level 19

public abstract void onWrite (PageRange[] pages, 
                ParcelFileDescriptor destination, 
                CancellationSignal cancellationSignal, 
                PrintDocumentAdapter.WriteResultCallback callback)

Called when specific pages of the content should be written in the form of a PDF file to the given file descriptor. This method is invoked on the main thread.

After you are done writing, you should close the file descriptor and invoke WriteResultCallback#onWriteFinished(PageRange[]), if writing completed successfully; or WriteResultCallback#onWriteFailed( CharSequence), if an error occurred; or WriteResultCallback#onWriteCancelled(), if writing was cancelled in a response to a cancellation request via the passed in CancellationSignal. Note that you must call one of the methods of the given callback for this method to be considered complete which is you will not receive any calls to this adapter until the current write operation is complete by invoking a method on the callback instance. The callback methods can be invoked from an arbitrary thread.

One of the arguments passed to this method is a CancellationSignal which is used to propagate requests from the system to your application for canceling the current write operation. For example, a cancellation may be requested if the user changes a print option that may affect layout while you are performing a write operation. In such a case the system will make an attempt to cancel the current write as a layout will have to be performed which then may be followed by a write. Typically, you should register a cancellation callback in the cancellation signal. The cancellation callback will not be made on the main thread and can be registered as follows:

 cancellationSignal.setOnCancelListener(new OnCancelListener() {
     @Override
     public void onCancel() {
         // Cancel write
     }
 });
 

Note: If the printed content is large, it is a good practice to schedule writing it on a dedicated thread and register an observer in the provided CancellationSignal upon invocation of which you should stop writing.

Parameters
pages	PageRange: The pages whose content to print - non-overlapping in ascending order.
destination	ParcelFileDescriptor: The destination file descriptor to which to write.
cancellationSignal	CancellationSignal: Signal for observing cancel writing requests.
callback	PrintDocumentAdapter.WriteResultCallback: Callback to inform the system for the write result.

See also:

• PrintDocumentAdapter.WriteResultCallback
• CancellationSignal