am adade10a: Merge "KLP API Review: PrintDocumentAdapter documentation" into klp-dev
* commit 'adade10a5186636daaea50e90fddb50c3707d5ed': KLP API Review: PrintDocumentAdapter documentation
This commit is contained in:
@@ -55,7 +55,7 @@ import java.util.List;
|
|||||||
* The APIs defined in this class are designed to enable doing part or all
|
* 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
|
* 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
|
* does not depend on the UI state, i.e. on what is shown on the screen, then
|
||||||
* you can off load the entire work on a dedicated thread, thus making your
|
* you can offload the entire work on a dedicated thread, thus making your
|
||||||
* application interactive while the print work is being performed.
|
* application interactive while the print work is being performed.
|
||||||
* </p>
|
* </p>
|
||||||
* <p>
|
* <p>
|
||||||
@@ -99,6 +99,7 @@ public abstract class PrintDocumentAdapter {
|
|||||||
* the last argument <code>true</code> or <code>false</code> depending on
|
* the last argument <code>true</code> or <code>false</code> depending on
|
||||||
* whether the layout changed the content or not, respectively; and {@link
|
* whether the layout changed the content or not, respectively; and {@link
|
||||||
* LayoutResultCallback#onLayoutFailed(CharSequence)}, if an error occurred.
|
* LayoutResultCallback#onLayoutFailed(CharSequence)}, if an error occurred.
|
||||||
|
* Note that you must call one of the methods of the given callback.
|
||||||
* </p>
|
* </p>
|
||||||
* <p>
|
* <p>
|
||||||
* When doing a layout you may satisfy some of the constraints in the print
|
* When doing a layout you may satisfy some of the constraints in the print
|
||||||
@@ -147,13 +148,14 @@ public abstract class PrintDocumentAdapter {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Called when specific pages of the content should be written in the
|
* Called when specific pages of the content should be written in the
|
||||||
* from of a PDF file to the given file descriptor. This method is invoked
|
* form of a PDF file to the given file descriptor. This method is invoked
|
||||||
* on the main thread.
|
* on the main thread.
|
||||||
*<p>
|
*<p>
|
||||||
* After you are done writing, you should close the file descriptor and
|
* After you are done writing, you should close the file descriptor and
|
||||||
* invoke {@link WriteResultCallback #onWriteFinished(List)}, if writing
|
* invoke {@link WriteResultCallback #onWriteFinished(PageRange[]), if writing
|
||||||
* completed successfully; or {@link WriteResultCallback#onWriteFailed(
|
* completed successfully; or {@link WriteResultCallback#onWriteFailed(
|
||||||
* CharSequence)}, if an error occurred.
|
* CharSequence)}, if an error occurred. Note that you must call one of
|
||||||
|
* the methods of the given callback.
|
||||||
* </p>
|
* </p>
|
||||||
* <p>
|
* <p>
|
||||||
* <strong>Note:</strong> If the printed content is large, it is a good
|
* <strong>Note:</strong> If the printed content is large, it is a good
|
||||||
|
|||||||
@@ -36,10 +36,11 @@ import java.io.InputStream;
|
|||||||
import java.io.OutputStream;
|
import java.io.OutputStream;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Adapter for printing files. This class could be useful if you
|
* Adapter for printing PDF files. This class could be useful if you
|
||||||
* want to print a file and intercept when the system is ready
|
* want to print a file and intercept when the system is ready
|
||||||
* spooling the data, so you can deleted the file if it is a
|
* spooling the data, so you can delete the file if it is a
|
||||||
* temporary one.
|
* temporary one. To achieve this one must override {@link #onFinish()}
|
||||||
|
* and delete the file yourself.
|
||||||
*/
|
*/
|
||||||
public class PrintFileDocumentAdapter extends PrintDocumentAdapter {
|
public class PrintFileDocumentAdapter extends PrintDocumentAdapter {
|
||||||
|
|
||||||
@@ -57,7 +58,7 @@ public class PrintFileDocumentAdapter extends PrintDocumentAdapter {
|
|||||||
* Constructor.
|
* Constructor.
|
||||||
*
|
*
|
||||||
* @param context Context for accessing resources.
|
* @param context Context for accessing resources.
|
||||||
* @param file The file to print.
|
* @param file The PDF file to print.
|
||||||
* @param documentInfo The information about the printed file.
|
* @param documentInfo The information about the printed file.
|
||||||
*/
|
*/
|
||||||
public PrintFileDocumentAdapter(Context context, File file,
|
public PrintFileDocumentAdapter(Context context, File file,
|
||||||
|
|||||||
Reference in New Issue
Block a user