java.lang.Object | ||
↳ | androidx.fragment.app.Fragment | |
↳ | com.pspdfkit.ui.PdfUiFragment |
Experimental API - Might change in the future.
This fragment provides the same UI as PdfActivity
. It can be used inside any view
hierarchy but use is limited to one instance per Activity, unless pdfFragmentTag(String)
is used to set a unique fragment tag for each
instance.
[Expand]
Inherited Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
[Expand]
Inherited Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
PdfUiFragment() |
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
PdfActivityConfiguration |
getConfiguration()
Returns the
PdfActivityConfiguration that was provided while launching this pdf UI. | ||||||||||
void | onActivityResult(int requestCode, int resultCode, Intent data) | ||||||||||
boolean |
onBackPressed()
Call this from your activity to properly close the UI when pressing back.
| ||||||||||
void | onCreateOptionsMenu(Menu menu, MenuInflater inflater) | ||||||||||
View | onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) | ||||||||||
void | onDestroy() | ||||||||||
boolean |
onDocumentClick()
Called when the user taps / clicks on the document, not the page itself but on the side (if
visible).
| ||||||||||
void |
onDocumentLoadFailed(Throwable exception)
Called if document loading has failed.
| ||||||||||
void |
onDocumentLoaded(PdfDocument document)
Called when document is successfully loaded and the document view has been laid out.
| ||||||||||
boolean |
onDocumentSave(PdfDocument document, DocumentSaveOptions saveOptions)
Called before document will be saved.
| ||||||||||
void |
onDocumentSaveCancelled(PdfDocument document)
Called if document saving has been cancelled.
| ||||||||||
void |
onDocumentSaveFailed(PdfDocument document, Throwable exception)
Called if document saving has failed.
| ||||||||||
void |
onDocumentSaved(PdfDocument document)
Called after the document has been saved.
| ||||||||||
void |
onDocumentZoomed(PdfDocument document, int pageIndex, float scaleFactor)
Called when a user zooms a document.
| ||||||||||
List<Integer> | onGenerateMenuItemIds(List<Integer> menuItems) | ||||||||||
int | onGetShowAsAction(int menuItemId, int defaultShowAsAction) | ||||||||||
boolean | onOptionsItemSelected(MenuItem item) | ||||||||||
void |
onPageChanged(PdfDocument document, int pageIndex)
Called when user scrolled to a new page.
| ||||||||||
boolean |
onPageClick(PdfDocument document, int pageIndex, MotionEvent event, PointF pagePosition, Annotation clickedAnnotation)
Called when user taps / clicks on the page.
| ||||||||||
void |
onPageUpdated(PdfDocument document, int pageIndex)
Called when content of page with pageIndex has changed (for example due to annotation or form
field being updated).
| ||||||||||
void | onPause() | ||||||||||
void | onPrepareOptionsMenu(Menu menu) | ||||||||||
void | onResume() | ||||||||||
void | onSaveInstanceState(Bundle outState) | ||||||||||
void |
onSetActivityTitle(PdfActivityConfiguration configuration, PdfDocument document)
Called when activity title must be set - before and after document was loaded.
| ||||||||||
void | onStart() | ||||||||||
void | onStop() | ||||||||||
void |
onUserInterfaceVisibilityChanged(boolean visible)
Called when user interface visibility have changed.
| ||||||||||
void |
setConfiguration(PdfActivityConfiguration configuration)
Replaces activity configuration.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() |
Returns the PdfActivityConfiguration
that was provided while launching this pdf UI.
Call this from your activity to properly close the UI when pressing back.
true
if the event was consumed and should not be
processed any further.
Called when the user taps / clicks on the document, not the page itself but on the side (if visible).
true
if tap is handled or false
if PSPDFKit should execute it's
default action.
Called if document loading has failed.
exception | Cause of the loading failure. |
---|
Called when document is successfully loaded and the document view has been laid out. This has to be called on the main thread.
document | Loaded document instance. |
---|
Called before document will be saved. This callback allows cancellation of the save process.
document | Instance of document to be saved. |
---|---|
saveOptions | Save options to be applied to the document. You may change parameters on this object to control how document is saved. |
true
if the document should be saved, false
if saving should be
cancelled.
Called if document saving has been cancelled.
document | Instance of document that was saved. |
---|
Called if document saving has failed.
exception | Cause of the saving failure if applicable. |
---|
Called after the document has been saved.
document | Instance of document that was saved. |
---|
Called when a user zooms a document.
document | Current document. |
---|---|
pageIndex | The number of the page that the was zoomed. |
scaleFactor | The current scale factor. |
Called when user scrolled to a new page.
document | Currently opened document. |
---|---|
pageIndex | Page number of new page. |
Called when user taps / clicks on the page.
document | Currently opened document. |
---|---|
pageIndex | Page number of the page being tapped. |
event | MotionEvent that triggered this page click. May be null if this
page click was triggered from keyboard or accessibility event. |
pagePosition | Tapped page position (in PDF page coordinates with origin on bottom
left). Coordinates passed here may exceed the page size (which is returned by getPageSize(int) ) and can also be negative. If the click was triggered by
the keyboard, pagePosition will be null . |
clickedAnnotation | Annotation that was tapped, or null if no annotation was
tapped. |
true
if tap was handled by this DocumentListener
and should not be
handled by PSPDFKit anymore. If returning false
PSPDFKit will continue executing
it's default action.
Called when content of page with pageIndex has changed (for example due to annotation or form field being updated). All views displaying this page need to refresh.
pageIndex | Page index of the updated page. Page index is 0-based. |
---|
Called when activity title must be set - before and after document was loaded.
configuration | Passed activity configuration instance. |
---|---|
document | Loaded document. If document hasn't been loaded yet, this parameter will be
null .
|
Called when user interface visibility have changed.
visible | true when UI interface is visible, false when it is hidden.
|
---|
Replaces activity configuration. This method restarts the pdf UI to apply new configuration.
Note: This is a no-op when configuration has not changed.
configuration | The configuration to restart pdf UI with. |
---|