Android/frameworks_base
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

am adade10a: Merge "KLP API Review: PrintDocumentAdapter documentation" into klp-dev

Browse Source 
* commit 'adade10a5186636daaea50e90fddb50c3707d5ed':
  KLP API Review: PrintDocumentAdapter documentation
This commit is contained in:
Svetoslav Ganov
2013-09-04 19:30:10 -07:00
committed by Android Git Automerger
parent 61cbaa432d adade10a51
commit cf2a44e413
2 changed files with 11 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
core/java/android/print/PrintDocumentAdapter.java
View File

@@ -55,7 +55,7 @@ import java.util.List;
* 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 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.
* </p>
* <p>
@@ -99,6 +99,7 @@ public abstract class PrintDocumentAdapter {
* the last argument <code>true</code> or <code>false</code> depending on
* whether the layout changed the content or not, respectively; and {@link
* LayoutResultCallback#onLayoutFailed(CharSequence)}, if an error occurred.
* Note that you must call one of the methods of the given callback.
* </p>
* <p>
* 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
* 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.
*<p>
* 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(
* 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>
* <strong>Note:</strong> If the printed content is large, it is a good

9
core/java/android/print/PrintFileDocumentAdapter.java
View File

@@ -36,10 +36,11 @@ import java.io.InputStream;
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
* spooling the data, so you can deleted the file if it is a
* temporary one.
* spooling the data, so you can delete the file if it is a
* temporary one. To achieve this one must override {@link #onFinish()}
* and delete the file yourself.
*/
public class PrintFileDocumentAdapter extends PrintDocumentAdapter {
@@ -57,7 +58,7 @@ public class PrintFileDocumentAdapter extends PrintDocumentAdapter {
* Constructor.
*
* @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.
*/
public PrintFileDocumentAdapter(Context context, File file,