java.lang.Object | |
↳ | com.pspdfkit.document.PdfDocumentLoader |
Provides methods to obtain PdfDocument
instances.
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
static PdfDocument |
openDocument(Context context, Uri documentUri)
Opens a PDF document from a Uri.
| ||||||||||
static PdfDocument |
openDocument(Context context, DocumentSource source)
Opens a PDF document from a Uri.
| ||||||||||
static PdfDocument |
openDocument(Context context, DocumentSource source, boolean multithreadedRenderingEnabled)
Opens a PDF document from a Uri.
| ||||||||||
static PdfDocument |
openDocument(Context context, Uri documentUri, String password)
Opens a PDF document from a Uri.
| ||||||||||
static Single<PdfDocument> |
openDocumentAsync(Context context, DocumentSource source)
Opens a PDF document from a
DocumentSource . | ||||||||||
static Single<PdfDocument> |
openDocumentAsync(Context context, Uri documentUri)
Opens a PDF document from an Uri.
| ||||||||||
static Single<PdfDocument> |
openDocumentAsync(Context context, DocumentSource source, boolean multithreadedRenderingEnabled)
Opens a PDF document from an Uri.
| ||||||||||
static Single<PdfDocument> |
openDocumentAsync(Context context, Uri documentUri, String password)
Opens a PDF document from an Uri.
| ||||||||||
static PdfDocument |
openDocuments(Context context, List<DocumentSource> sources, boolean multithreadedRenderingEnabled)
Opens multiple PDF document from a list of sources.
| ||||||||||
static PdfDocument |
openDocuments(Context context, List<DocumentSource> sources)
Opens multiple PDF document from a list of sources.
| ||||||||||
static Single<PdfDocument> |
openDocumentsAsync(Context context, List<DocumentSource> sources, boolean multithreadedRenderingEnabled)
Opens multiple PDF document from a list Uris.
| ||||||||||
static Single<PdfDocument> |
openDocumentsAsync(Context context, List<DocumentSource> sources)
Opens multiple PDF document from a list Uris.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
Opens a PDF document from a Uri. Note that currently only local files are supported and
passing remote or non-file Uris will throw an IOException
.
Note that this method blocks until the document is loaded and should not be invoked on main thread.
context | Application context. |
---|---|
documentUri | Uri pointing to the PDF document. |
PdfDocument
instance if the opening succeeded.IOException | If file was not opened correctly. |
---|---|
InvalidPasswordException | If opening the document failed due to password protection.
To specify a password for opening the file, use the openDocument(Context, Uri, String) method instead. |
PSPDFKitNotInitializedException | If PSPDFKit was not initialized with initialize(Context, String) call.
|
Opens a PDF document from a Uri. Note that currently only local files are supported and
passing remote or Uris will throw an IOException
.
Note that this method blocks until the document is loaded and should not be invoked on main thread.
context | Application context. |
---|---|
source | DocumentSource describing the source and password of this document. |
PdfDocument
instance if opening succeeded.IOException | If file was not opened correctly. |
---|---|
PSPDFKitNotInitializedException | If PSPDFKit was not initialized with initialize(Context, String) call. |
InvalidPasswordException | If no password or a wrong password was provided for opening the document. |
InvalidSignatureException | If the provided contentSignature does not match the
opened document.
|
Opens a PDF document from a Uri. Note that currently only local files are supported and
passing remote or Uris will throw an IOException
.
Note that this method blocks until the document is loaded and should not be invoked on main thread.
context | Application context. |
---|---|
source | DocumentSource describing the source and password of this document. |
multithreadedRenderingEnabled | Whether the multithreaded rendering should be enabled when rendering document pages. |
PdfDocument
instance if opening succeeded.IOException | If file was not opened correctly. |
---|---|
PSPDFKitNotInitializedException | If PSPDFKit was not initialized with initialize(Context, String) call. |
InvalidPasswordException | If no password or a wrong password was provided for opening the document. |
InvalidSignatureException | If the provided contentSignature does not match the
opened document.
|
Opens a PDF document from a Uri. Note that currently only local files are supported and
passing remote or non-file Uris will throw an IOException
.
Note that this method blocks until the document is loaded and should not be invoked on main thread.
context | Application context. |
---|---|
documentUri | Uri pointing to the PDF document. |
password | PDF document password, may be null . |
PdfDocument
instance if the opening succeeded.IOException | If file was not opened correctly. |
---|---|
InvalidPasswordException | If no password or a wrong password was provided for opening the document. |
PSPDFKitNotInitializedException | If PSPDFKit was not initialized with initialize(Context, String) call.
|
Opens a PDF document from a DocumentSource
. The returned Single may fail with
a InvalidPasswordException
when trying to open a password protected document.
context | Application context |
---|---|
source | DocumentSource of the document. |
PSPDFKitNotInitializedException | if PSPDFKit was not initialized with initialize(Context, String) call.
|
---|
Opens a PDF document from an Uri. Note that currently only local files are supported and
passing remote or non-file Uris will return a IOException
. If the document
being opened is password protected, the returned Single will fail with an InvalidPasswordException
. To open password protected documents use openDocumentAsync(Context, Uri, String)
instead.
context | Application context |
---|---|
documentUri | Uri pointing to the PDF document. |
PSPDFKitNotInitializedException | if PSPDFKit was not initialized with initialize(Context, String) call.
|
---|
Opens a PDF document from an Uri. Note that currently only local files are supported and
passing remote or non-file Uris will return a IOException
.
context | Application context |
---|---|
source | DocumentSource of the document. |
multithreadedRenderingEnabled | Whether the multithreaded rendering should be enabled when rendering document pages. |
PSPDFKitNotInitializedException | if PSPDFKit was not initialized with initialize(Context, String) call.
|
---|
Opens a PDF document from an Uri. Note that currently only local files are supported and
passing remote or non-file Uris will return a IOException
. The returned
Single may fail with a InvalidPasswordException
if no password or a wrong
password was provided for opening the document.
context | Application context |
---|---|
documentUri | Uri pointing to the PDF document. |
password | PDF document password, may be null . |
PSPDFKitNotInitializedException | if PSPDFKit was not initialized with initialize(Context, String) call.
|
---|
Opens multiple PDF document from a list of sources. The documents will be displayed as a
single continuous document. Note that currently only local files are supported and passing
remote or Uris will throw an IOException
.
Note that this method blocks until the document is loaded and should not be invoked on main thread.
context | Application context. |
---|---|
sources | List of DocumentSource s describing the sources and passwords of the
documents. |
multithreadedRenderingEnabled | Whether the multithreaded rendering should be enabled when rendering document pages. |
PdfDocument
instance if the opening succeeded.IOException | If file was not opened correctly. |
---|---|
InvalidPasswordException | If no passwords or a wrong passwords were provided for opening the documents. |
PSPDFKitNotInitializedException | If PSPDFKit was not initialized with initialize(Context, String) call.
|
Opens multiple PDF document from a list of sources. The documents will be displayed as a
single continuous document. Note that currently only local files are supported and passing
remote or Uris will throw an IOException
.
Note that this method blocks until the document is loaded and should not be invoked on main thread.
context | Application context. |
---|---|
sources | List of DocumentSource s describing the sources and passwords of the
documents. |
PdfDocument
instance if the opening succeeded.IOException | If file was not opened correctly. |
---|---|
InvalidPasswordException | If no passwords or a wrong passwords were provided for opening the documents. |
PSPDFKitNotInitializedException | If PSPDFKit was not initialized with initialize(Context, String) call.
|
Opens multiple PDF document from a list Uris. The documents will be displayed as a single
continuous document. Note that currently only local files are supported and passing remote or
non-file Uris will throw an IOException
. The returned Single will
fail with an InvalidPasswordException
when trying to open a password protected
document with no or a wrong password. To specify a password, create the DocumentSource
instances using one of the constructors taking a password.
context | Application context. |
---|---|
sources | List of DocumentSource s for this document. |
multithreadedRenderingEnabled | Whether the multithreaded rendering should be enabled when rendering document pages. |
PSPDFKitNotInitializedException | If PSPDFKit was not initialized with initialize(Context, String) call.
|
---|
Opens multiple PDF document from a list Uris. The documents will be displayed as a single
continuous document. Note that currently only local files are supported and passing remote or
non-file Uris will throw an IOException
. The returned Single will
fail with an InvalidPasswordException
when trying to open a password protected
document with no or a wrong password. To specify a password, create the DocumentSource
instances using one of the constructors taking a password.
context | Application context. |
---|---|
sources | List of DocumentSource s for this document. |
PSPDFKitNotInitializedException | If PSPDFKit was not initialized with initialize(Context, String) call.
|
---|