java.lang.Object | ||
↳ | Fragment | |
↳ | com.pdftron.pdf.controls.PdfViewCtrlTabBaseFragment |
Known Direct Subclasses |
Known Indirect Subclasses |
The PdfViewCtrlTabBaseFragment is the base class for other viewer classes.
Nested Classes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
class | PdfViewCtrlTabBaseFragment.FloatingNavTheme | ||||||||||
interface | PdfViewCtrlTabBaseFragment.PageStackListener | ||||||||||
interface | PdfViewCtrlTabBaseFragment.PasswordProtectedListener | ||||||||||
class | PdfViewCtrlTabBaseFragment.SaveFolderWrapper | Wraps either a File or an ExternalFileInfo in order to make saving easier. | |||||||||
interface | PdfViewCtrlTabBaseFragment.TabListener | Callback interface to be invoked when an interaction is needed. |
Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
int | ANIMATE_DURATION_HIDE | ||||||||||
int | ANIMATE_DURATION_SHOW | ||||||||||
String | BUNDLE_TAB_ANNOTATION_MANAGER_EDIT_MODE | ||||||||||
String | BUNDLE_TAB_ANNOTATION_MANAGER_UNDO_MODE | ||||||||||
String | BUNDLE_TAB_CONFIG | ||||||||||
String | BUNDLE_TAB_CONTENT_LAYOUT | ||||||||||
String | BUNDLE_TAB_CUSTOM_HEADERS | ||||||||||
String | BUNDLE_TAB_FILE_EXTENSION | ||||||||||
String | BUNDLE_TAB_INITIAL_PAGE | ||||||||||
String | BUNDLE_TAB_ITEM_SOURCE | ||||||||||
String | BUNDLE_TAB_PASSWORD | ||||||||||
String | BUNDLE_TAB_PDFVIEWCTRL_ID | ||||||||||
String | BUNDLE_TAB_TAG | ||||||||||
String | BUNDLE_TAB_TITLE |
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
PdfViewCtrlTabBaseFragment() |
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
void |
addPageStackListener(PdfViewCtrlTabBaseFragment.PageStackListener listener)
Adds
PdfViewCtrlTabBaseFragment.PageStackListener listener. | ||||||||||
void |
addPasswordProtectedDocumentListener(PdfViewCtrlTabBaseFragment.PasswordProtectedListener listener)
Adds a
PdfViewCtrlTabBaseFragment.PasswordProtectedListener listener. | ||||||||||
void |
addQuickMenuListener(ToolManager.QuickMenuListener listener)
Adds
ToolManager.QuickMenuListener listener. | ||||||||||
void | animatePageIndicator(boolean show) | ||||||||||
void |
annotationsCouldNotBeAdded(String errorMessage)
The overloaded implementation of
annotationsCouldNotBeAdded(String) . | ||||||||||
void | applyCutout(int top, int bottom) | ||||||||||
void |
attachFileSelected(PointF targetPoint)
Called when a location has been selected for adding the file attachment.
| ||||||||||
boolean |
canDocBeSaved()
Checks whether the document can be saved.
| ||||||||||
void |
cancelFindText()
Cancels finding text.
| ||||||||||
void |
clearPageBackAndForwardStacks()
Clears the stacks of page backward/forward.
| ||||||||||
void |
closeNavigationList()
Closes the navigation list if it was opened as side sheet
| ||||||||||
void |
closeRedactionSearchList()
Closes the redaction search dialog if it was opened as side sheet
| ||||||||||
void |
closeSideSheet(String tag)
Closes the side sheet
| ||||||||||
static Bundle |
createBasicPdfViewCtrlTabBundle(String tag, String title, String fileExtension, String password, int itemSource, ViewerConfig config)
Returns the bundle having information needed to create a tab fragment.
| ||||||||||
static Bundle |
createBasicPdfViewCtrlTabBundle(String tag, String title, String fileExtension, String password, int itemSource, int initialPage, ViewerConfig config)
Returns the bundle having information needed to create a tab fragment.
| ||||||||||
static Bundle |
createBasicPdfViewCtrlTabBundle(String tag, String title, String fileExtension, String password, int itemSource)
Returns the bundle having information needed to create a tab fragment.
| ||||||||||
static Bundle |
createBasicPdfViewCtrlTabBundle(Context context, Uri fileUri, String title, String password, ViewerConfig config)
Returns the bundle having information needed to create a tab fragment.
| ||||||||||
static Bundle |
createBasicPdfViewCtrlTabBundle(Context context, Uri fileUri, String password, ViewerConfig config)
Returns the bundle having information needed to create a tab fragment.
| ||||||||||
static Bundle |
createBasicPdfViewCtrlTabBundle(Context context, Uri fileUri, String password)
Returns the bundle having information needed to create a tab fragment.
| ||||||||||
boolean | doesSaveDocNeedNewTab() | ||||||||||
void |
exitSearchMode()
Exits the search mode.
| ||||||||||
void |
fileAttachmentSelected(FileAttachment attachment)
Called when a file attachment has been selected.
| ||||||||||
void |
fileCreated(String filePath, ToolManager.AdvancedAnnotationListener.AnnotAction action)
Called when an annotation needs to perform an action with a file created
| ||||||||||
void |
forceSave()
Saves the changes to the document forcefully
| ||||||||||
void |
freeTextInlineEditingStarted()
Called when free text inline editing has started.
| ||||||||||
void |
freehandStylusUsedFirstTime()
Called when free hand stylus has been used for the firs time.
| ||||||||||
int |
getBookmarkDialogCurrentTab()
Returns which tab in bookmark dialog is selected.
| ||||||||||
|
getBookmarks()
Returns the live data containing bookmarks in the document.
| ||||||||||
BookmarksDialogFragment | getBookmarksNavigationList() | ||||||||||
FileInfo |
getCurrentFileInfo()
Returns the current file info.
| ||||||||||
long | getCurrentFileSize() | ||||||||||
PageBackButtonInfo |
getCurrentPageInfo()
Returns the current page info.
| ||||||||||
File | getExportDirectory() | ||||||||||
ExternalFileInfo | getExportUriDirectory() | ||||||||||
File |
getFile()
Returns the file.
| ||||||||||
String | getFileName(boolean needsCopy, String suffix) | ||||||||||
String |
getFilePath()
Returns the path of the document
| ||||||||||
boolean |
getHasWarnedAboutCanNotEditDuringConversion()
Checks whether a warning about can not edit during conversion has been shown.
| ||||||||||
PDFViewCtrl |
getPDFViewCtrl()
Returns the
PDFViewCtrl associated with this tab. | ||||||||||
|
getPageChange()
Returns the live data containing the current page state.
| ||||||||||
Transition | getPageNumberIndicatorTransition() | ||||||||||
PDFDoc |
getPdfDoc()
Returns the PDF document
| ||||||||||
ReflowControl |
getReflowControl()
Returns the
ReflowControl associated with this tab. | ||||||||||
int |
getReflowTextSize()
Returns the reflow text size.
| ||||||||||
int |
getTabErrorCode()
Returns the error code, if any.
| ||||||||||
int |
getTabSource()
Returns the item source of the tab.
| ||||||||||
String |
getTabTag()
Returns the tab tag.
| ||||||||||
String |
getTabTitle()
Returns the filename of the tab
| ||||||||||
String |
getTabTitleWithExtension()
Returns the filename of the tab
| ||||||||||
ToolManager |
getToolManager()
Returns
ToolManager associated with this tab. | ||||||||||
Uri |
getUriFile()
Returns the URI file
| ||||||||||
void |
gotoNextSearch()
Goes to the next text in search.
| ||||||||||
void |
gotoPreviousSearch()
Goes to the previous text in search.
| ||||||||||
boolean |
handleKeyShortcut(int keyCode, KeyEvent event)
Handles CTRL-based key when triggered.
| ||||||||||
boolean |
handleKeyUp(int keyCode, KeyEvent event)
Handles key when pressed up.
| ||||||||||
void |
handleOnlineShare()
Handles sharing.
| ||||||||||
void | handlePrintAnnotationSummary() | ||||||||||
void | handleSaveAsCopy() | ||||||||||
void | handleSaveCroppedCopy() | ||||||||||
void | handleSaveFlattenedCopy() | ||||||||||
void | handleSaveOptimizedCopy(OptimizeParams params) | ||||||||||
void | handleSavePasswordCopy() | ||||||||||
boolean |
handleSpecialFile()
Handles if the file is special case.
| ||||||||||
void | handleViewFileAttachments() | ||||||||||
void | handleViewSelectedFileAttachment(File localFolder, ExternalFileInfo extFolder) | ||||||||||
void | handleViewSelectedFileAttachment(File localFolder, ExternalFileInfo extFolder, Uri destFileUri) | ||||||||||
boolean | hasUserCropBox() | ||||||||||
void |
hideBackAndForwardButtons()
Hides backward/forward buttons.
| ||||||||||
void | hidePageNumberIndicator() | ||||||||||
void |
highlightFullTextSearchResult(TextSearchResult result)
Highlights the results of full text search.
| ||||||||||
void |
highlightSearchResults()
Starts the TextHighlighter tool.
| ||||||||||
void |
imageSignatureSelected(PointF targetPoint, int targetPage, Long widget)
Called when a location or widget has been selected for adding the image signature
Only one of the param should be valid
| ||||||||||
void |
imageStamperSelected(PointF targetPoint)
Called when a location has been selected for adding the image stamp.
| ||||||||||
abstract boolean | isAnnotationMode() | ||||||||||
boolean |
isContinuousPageMode()
Checks if the tab is in continuous page mode.
| ||||||||||
boolean | isConvertibleFormat() | ||||||||||
boolean |
isDocModifiedAfterOpening()
Checks whether the document modified after opening.
| ||||||||||
boolean |
isDocumentReady()
Checks if the document is ready.
| ||||||||||
boolean | isExportDirectoryContentUri() | ||||||||||
boolean |
isNavigationListShowing()
Gets whether the navigation side sheet is visible
| ||||||||||
boolean | isNonContinuousVerticalPageMode() | ||||||||||
boolean |
isNotPdf()
Checks whether the document is not PDF.
| ||||||||||
boolean | isNotPdfUri() | ||||||||||
boolean |
isOpenFileFailed()
Checks if opening file failed.
| ||||||||||
boolean | isPasswordProtected() | ||||||||||
boolean |
isReflowMode()
Checks if the tab is in reflow mode.
| ||||||||||
boolean |
isRtlMode()
Checks whether right-to-left mode is enabled
| ||||||||||
boolean |
isSearchMode()
Checks whether it is in search mode.
| ||||||||||
boolean |
isSinglePageMode()
Checks if the tab is in single page mode.
| ||||||||||
boolean |
isTabReadOnly()
Checks if the tab is ready only.
| ||||||||||
boolean | isWebViewConvertibleFormat() | ||||||||||
void |
localFileWriteAccessCheck()
Handles if local file doesn't have write access.
| ||||||||||
boolean | newFileSelectedFromTool(String filePath, int pageNumber) | ||||||||||
void | onActionGoBack() | ||||||||||
void |
onActivityResult(int requestCode, int resultCode, Intent data)
Handles the activity result
| ||||||||||
void | onAddNewPage(Page page) | ||||||||||
void | onAddNewPages(Page[] pages) | ||||||||||
void |
onAddProgressIndicator()
Handles when a blank page without content is added to the document
as a placeholder.
| ||||||||||
void |
onAllAnnotationsRemoved()
The overloaded implementation of
onAllAnnotationsRemoved() . | ||||||||||
void |
onAnnotationAction()
The overloaded implementation of
onAnnotationAction() . | ||||||||||
void |
onAnnotationSelected(Annot annot, int pageNum)
Called when an annotation has been selected.
| ||||||||||
void |
onAnnotationUnselected()
Called when an annotation has been unselected.
| ||||||||||
void |
onAnnotationsAdded(Map<Annot, Integer> annots)
The overloaded implementation of
onAnnotationsAdded(Map) . | ||||||||||
void |
onAnnotationsModified(Map<Annot, Integer> annots, Bundle extra)
The overloaded implementation of
onAnnotationsModified(Map, Bundle)
| ||||||||||
void |
onAnnotationsPreModify(Map<Annot, Integer> annots)
The overloaded implementation of
onAnnotationsPreModify(Map) . | ||||||||||
void |
onAnnotationsPreRemove(Map<Annot, Integer> annots)
The overloaded implementation of
onAnnotationsPreRemove(Map) . | ||||||||||
void |
onAnnotationsRemoved(Map<Annot, Integer> annots)
The overloaded implementation of
onAnnotationsRemoved(Map) . | ||||||||||
void |
onAnnotationsRemovedOnPage(int pageNum)
The overloaded implementation of
onAnnotationsRemovedOnPage(int) . | ||||||||||
void |
onBookmarkModified(List<UserBookmarkItem> bookmarkItems)
Called when PDF bookmarks have been modified.
| ||||||||||
void |
onChangePointerIcon(PointerIcon pointerIcon)
The overloaded implementation of
onChangePointerIcon(PointerIcon) . | ||||||||||
void |
onConfigurationChanged(Configuration newConfig)
The overloaded implementation of Fragment#onConfigurationChanged(Configuration).
| ||||||||||
void |
onConversionEvent(PDFViewCtrl.ConversionState state, int totalPagesConverted)
Handles an update during document conversion.
| ||||||||||
void |
onCreate(Bundle savedInstanceState)
The overloaded implementation of Fragment#onCreate(Bundle).
| ||||||||||
View |
onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState)
The overloaded implementation of Fragment#onCreateView(LayoutInflater, ViewGroup, Bundle).
| ||||||||||
void | onDeleteCurrentPage() | ||||||||||
void |
onDestroy()
The overloaded implementation of Fragment#onDestroy().
| ||||||||||
void |
onDestroyView()
The overloaded implementation of Fragment#onDestroyView().
| ||||||||||
void |
onDocPagesModified()
Handles when document pages are modified.
| ||||||||||
void |
onDocumentLoaded()
Handles terminating document load.
| ||||||||||
boolean |
onDoubleTap(MotionEvent e)
The overloaded implementation of
onDoubleTap(MotionEvent) . | ||||||||||
boolean |
onDown(MotionEvent e)
Propagates
onDown(MotionEvent)
| ||||||||||
void |
onDownloadEvent(PDFViewCtrl.DownloadState state, int page_num, int page_downloaded, int page_count, String message)
Handles an update during download.
| ||||||||||
boolean |
onEnterFullscreenMode()
Called before the containing host fragment enters
fullscreen mode (system status bar and navigation bar will be hidden).
| ||||||||||
boolean |
onExitFullscreenMode()
Called before the containing host fragment exits
fullscreen mode (system status bar and/or navigation bar will be shown).
| ||||||||||
void |
onExportAnnotations(PDFDoc outputDoc)
Called when document annotations have been exported.
| ||||||||||
void | onFullSaveRequired() | ||||||||||
void |
onGenericMotionEvent(MotionEvent event)
Handles generic motion events.
| ||||||||||
void |
onHiddenChanged(boolean hidden)
The overloaded implementation of Fragment#onHiddenChanged(boolean).
| ||||||||||
abstract boolean |
onHideToolbars()
Called when the androidx.appcompat.widget.Toolbar toolbar of the containing
host fragment will be hidden.
| ||||||||||
boolean |
onInterceptAnnotationHandling(Annot annot, Bundle extra, ToolManager.ToolMode toolMode)
Intercept tool's response to user actions (such as clicking on links,
clicking on form widget, or about to change annotation properties etc.)
If handled, tool will stop default logic.
| ||||||||||
boolean |
onInterceptDialog(AlertDialog dialog)
Intercept handling of dialog
| ||||||||||
boolean |
onKeyUp(int keyCode, KeyEvent event)
Propagates
onKeyUp(int, KeyEvent) to the tools. | ||||||||||
boolean |
onLongPress(MotionEvent e)
The overloaded implementation of
onLongPress(MotionEvent) . | ||||||||||
void |
onLowMemory()
The overloaded implementation of Fragment#onLowMemory().
| ||||||||||
boolean |
onMove(MotionEvent e1, MotionEvent e2, float x_dist, float y_dist)
The overloaded implementation of
onMove(MotionEvent, MotionEvent, float, float) . | ||||||||||
void |
onPageChange(int old_page, int cur_page, PDFViewCtrl.PageChangeState state)
Handles changes the page number.
| ||||||||||
void |
onPageLabelsChanged()
Called when page labels have been changed
| ||||||||||
void |
onPageMoved(int from, int to)
The overloaded implementation of
onPageMoved(int, int) . | ||||||||||
void |
onPagesAdded(List<Integer> pageList)
The overloaded implementation of
onPagesAdded(List) . | ||||||||||
void |
onPagesCropped()
The overloaded implementation of
onPagesCropped() . | ||||||||||
void |
onPagesDeleted(List<Integer> pageList)
The overloaded implementation of
onPagesDeleted(List) . | ||||||||||
void |
onPagesMoved(List<Integer> pagesMoved, int to, int currentPage)
Called when pages have been moved.
| ||||||||||
void |
onPagesRotated(List<Integer> pageList)
The overloaded implementation of
onPagesRotated(List) . | ||||||||||
void |
onPause()
The overloaded implementation of Fragment#onPause().
| ||||||||||
void | onPdfTextChanged() | ||||||||||
void | onPortfolioDialogFragmentFileClicked(int fileType, PortfolioDialogFragment dialog, String fileName) | ||||||||||
void |
onPositionProgressIndicatorPage(Rect position)
Handles when the position of the blank page without content moves.
| ||||||||||
void |
onProgressIndicatorPageVisibilityChanged(boolean isVisible)
Handles when the blank page without content enters or leaves the screen.
| ||||||||||
boolean |
onQuickMenuClicked(QuickMenuItem menuItem)
The overloaded implementation of
onQuickMenuClicked(QuickMenuItem) . | ||||||||||
void |
onQuickMenuDismissed()
The overloaded implementation of
onQuickMenuDismissed() . | ||||||||||
void |
onQuickMenuShown()
The overloaded implementation of
onQuickMenuShown() . | ||||||||||
void |
onReflowSingleTapUp(MotionEvent event)
The overloaded implementation of
onReflowSingleTapUp(MotionEvent) . | ||||||||||
void |
onRemoveContentPendingIndicator()
Handles when the content on the page the user was previously trying to access is
accessible.
| ||||||||||
void |
onRemoveProgressIndicator()
Handles when a blank page without content is removed from the document.
| ||||||||||
void |
onRenderingFinished()
Handles when
PDFViewCtrl finishes rendering. | ||||||||||
void |
onRenderingStarted()
Handles when
PDFViewCtrl starts rendering. | ||||||||||
void |
onResume()
The overloaded implementation of Fragment#onResume().
| ||||||||||
void | onSaveFileAttachmentSelected(FileAttachment fileAttachment, Intent intent) | ||||||||||
void | onSaveInstanceState(Bundle outState) | ||||||||||
boolean |
onScale(float x, float y)
The overloaded implementation of
onScale(float, float) . | ||||||||||
boolean |
onScaleBegin(float x, float y)
The overloaded implementation of
onScaleBegin(float, float) . | ||||||||||
boolean |
onScaleEnd(float x, float y)
The overloaded implementation of
onScaleEnd(float, float) . | ||||||||||
void |
onScrollChanged(int l, int t, int oldl, int oldt)
The overloaded implementation of
onScrollChanged(int, int, int, int) . | ||||||||||
void |
onShowContentPendingIndicator()
Handles when it user is trying to access the next page of the PDFViewCtrl but there is no
room for the visual progress indicator in the viewer.
| ||||||||||
boolean |
onShowQuickMenu(QuickMenu quickMenu, Annot annot)
Called when quick menu is about to show.
| ||||||||||
boolean |
onShowToolbar()
Called when the androidx.appcompat.widget.Toolbar toolbar of the containing
host fragment will be shown.
| ||||||||||
boolean |
onSingleTapConfirmed(MotionEvent e)
The overloaded implementation of
onSingleTapConfirmed(MotionEvent) . | ||||||||||
void |
onStop()
The overloaded implementation of Fragment#onStop().
| ||||||||||
void |
onThumbnailsViewDialogDismiss(int pageNum, boolean docPagesModified)
Handles when thumbnails view dialog is dismissed.
| ||||||||||
boolean |
onUp(MotionEvent e, PDFViewCtrl.PriorEventMode priorEventMode)
The overloaded implementation of
onUp(MotionEvent, PDFViewCtrl.PriorEventMode) . | ||||||||||
void |
onViewCreated(View view, Bundle savedInstanceState)
The overloaded implementation of Fragment#onViewCreated(View, Bundle).
| ||||||||||
void | openNavigationList(BookmarksDialogFragment bookmarksDialogFragment, int marginTop, int marginBottom) | ||||||||||
void |
openNavigationList(BookmarksDialogFragment bookmarksDialogFragment)
Opens the navigation list as a side sheet
| ||||||||||
void |
openRedactionSearchList(SearchRedactionDialogFragment searchRedactionDialogFragment)
Opens the redaction search dialog as a side sheet
| ||||||||||
void | openRedactionSearchList(SearchRedactionDialogFragment searchRedactionDialogFragment, int marginTop, int marginBottom) | ||||||||||
void |
openSideSheet(DialogFragment dialogFragment, String tag, int marginTop, int marginBottom)
Opens a dialog fragment as side sheet
| ||||||||||
void |
queryTextSubmit(String text)
Submits the query text.
| ||||||||||
void |
redo()
Redo the last undo operation.
| ||||||||||
void |
refreshPageCount()
Refreshes the number of pages.
| ||||||||||
void |
removeFromRecentList()
Removes the current file from the recent list.
| ||||||||||
void |
removePageStackListener(PdfViewCtrlTabBaseFragment.PageStackListener listener)
Removes
PdfViewCtrlTabBaseFragment.PageStackListener listener. | ||||||||||
void |
removePasswordProtectedDocumentListener(PdfViewCtrlTabBaseFragment.PasswordProtectedListener listener)
Removes the
PdfViewCtrlTabBaseFragment.PasswordProtectedListener . | ||||||||||
void |
removeQuickMenuListener(ToolManager.QuickMenuListener listener)
Removes
ToolManager.QuickMenuListener listener. | ||||||||||
void | resetAutoSavingTimer() | ||||||||||
void |
resetFullTextResults()
Resets full text results.
| ||||||||||
void |
save(boolean close, boolean forceSave, boolean skipSpecialFileCheck, boolean upload)
Saves the changes to the document.
| ||||||||||
void |
save(boolean close, boolean forceSave, boolean skipSpecialFileCheck)
Saves the changes to the document.
| ||||||||||
void |
saveExternalFile(boolean close, boolean forceSave)
Saves external document file.
| ||||||||||
void |
saveLocalFile(boolean close, boolean forceSave)
Saves local document file.
| ||||||||||
void |
setBookmarkDialogCurrentTab(int index)
Sets the which tab in bookmarks dialog should be selected.
| ||||||||||
void |
setCanAddToTabInfo(boolean enabled)
Sets if the file an be added to tab info.
| ||||||||||
void |
setColorModeChanged()
Specifies that color mode has been changed.
| ||||||||||
void |
setCurrentPageHelper(int nextPageNum, boolean setPDFViewCtrl)
Helper to set the current page.
| ||||||||||
static void | setDebug(boolean debug) | ||||||||||
void |
setHasWarnedAboutCanNotEditDuringConversion()
Specifies that the warning about can not edit during conversion has been shown.
| ||||||||||
void |
setReflowMode(boolean isReflowMode)
Sets the reflow mode.
| ||||||||||
void |
setRtlMode(boolean isRtlMode)
Sets right-to-left mode
| ||||||||||
void |
setSavedAndClosedShown()
Confirms that document saved toast has been shown.
| ||||||||||
void |
setSavingEnabled(boolean enabled)
Set enable or disable auto-saving annotations.
| ||||||||||
void |
setSearchMatchCase(boolean matchCase)
Sets the search rule for match case.
| ||||||||||
void |
setSearchMode(boolean enabled)
Sets search mode
| ||||||||||
void |
setSearchNavButtonsVisible(boolean visible)
Sets the visibility of search navigation buttons.
| ||||||||||
void |
setSearchQuery(String text)
Specifies the search query.
| ||||||||||
void |
setSearchSettings(boolean matchCase, boolean wholeWord)
Sets the search rules for match case and whole word.
| ||||||||||
void |
setSearchWholeWord(boolean wholeWord)
Sets the search rule for whole word.
| ||||||||||
void |
setStateEnabled(boolean enabled)
set enable or disable saving state of document from outside
| ||||||||||
void |
setTabListener(PdfViewCtrlTabBaseFragment.TabListener listener)
Sets the
PdfViewCtrlTabBaseFragment.TabListener listener. | ||||||||||
abstract void |
setThumbSliderVisible(boolean visible, boolean animateThumbSlider)
Sets the visibility of thumbnail slider.
| ||||||||||
void |
showBackAndForwardButtons()
Shows backward/forward buttons.
| ||||||||||
void | showReadOnlyAlert(DialogFragment dialogToDismiss) | ||||||||||
void | stopAutoSavingTimer() | ||||||||||
boolean |
toggleReflow()
Toggles the reflow mode.
| ||||||||||
boolean |
toggleRtlMode()
Toggles right-to-left mode.
| ||||||||||
void |
toolChanged(ToolManager.Tool newTool, ToolManager.Tool oldTool)
Event called when the tool changes.
| ||||||||||
void |
undo()
Undo the last modification.
| ||||||||||
void |
updateColorMode()
Updates the color mode.
| ||||||||||
void |
updateCurrentPageInfo()
Updates the current page info.
| ||||||||||
void | updateNavigationListLayout(int marginTop, int marginBottom, boolean animated) | ||||||||||
void |
updatePrintAnnotationsMode(boolean enabled)
Updates annotation mode in print.
| ||||||||||
void |
updatePrintDocumentMode(boolean enabled)
Updates documentation mode in print.
| ||||||||||
void |
updatePrintSummaryMode(boolean enabled)
Updates summery mode in print.
| ||||||||||
void |
updateRecentList()
Updates the recent list.
| ||||||||||
void |
updateViewMode(PDFViewCtrl.PagePresentationMode pagePresentationMode)
Updates the view mode.
| ||||||||||
void |
userCropDialogDismiss()
Dismisses the user crop dialog.
| ||||||||||
void |
zoomInOutReflow(boolean flagZoomIn)
Zooms in/out reflow mode.
|
Adds PdfViewCtrlTabBaseFragment.PageStackListener
listener.
listener | The listener |
---|
Adds a PdfViewCtrlTabBaseFragment.PasswordProtectedListener
listener.
listener | The listener to add to this viewer |
---|
Adds ToolManager.QuickMenuListener
listener.
listener | The listener |
---|
The overloaded implementation of annotationsCouldNotBeAdded(String)
.
errorMessage | The error message |
---|
Called when a location has been selected for adding the file attachment.
targetPoint | The target location to add the file attachment |
---|
Checks whether the document can be saved.
Cancels finding text.
Clears the stacks of page backward/forward.
Closes the navigation list if it was opened as side sheet
Closes the redaction search dialog if it was opened as side sheet
Closes the side sheet
tag | the dialog fragment tag |
---|
Returns the bundle having information needed to create a tab fragment.
tag | The tab tag |
---|---|
title | The title of tab |
fileExtension | The extension of the document |
password | The password of the document |
itemSource | The source of the document FileInfo |
config | The configuration of the Fragment ViewerConfig |
Returns the bundle having information needed to create a tab fragment.
tag | The tab tag |
---|---|
title | The title of tab |
fileExtension | The extension of the document |
password | The password of the document |
itemSource | The source of the document FileInfo |
initialPage | The page to scroll to when the document is first opened, unused if less than 1 |
config | The configuration of the Fragment ViewerConfig |
Returns the bundle having information needed to create a tab fragment.
tag | The tab tag |
---|---|
title | The title of tab |
fileExtension | The extension of the document |
password | The password of the document |
itemSource | The source of the document FileInfo |
Returns the bundle having information needed to create a tab fragment.
context | The context |
---|---|
fileUri | The uri of the document |
title | The title of tab |
password | The password of the document |
config | The configuration of the Fragment ViewerConfig |
Returns the bundle having information needed to create a tab fragment.
context | The context |
---|---|
fileUri | The uri of the document |
password | The password of the document |
config | The configuration of the Fragment ViewerConfig |
Returns the bundle having information needed to create a tab fragment.
context | The context |
---|---|
fileUri | The uri of the document |
password | The password of the document |
Exits the search mode.
Called when a file attachment has been selected.
attachment | The file attachment |
---|
Called when an annotation needs to perform an action with a file created
filePath | location of the file associated with annotation |
---|---|
action | the specific action associated with the file |
Saves the changes to the document forcefully
Called when free text inline editing has started.
Called when free hand stylus has been used for the firs time.
Returns which tab in bookmark dialog is selected.
Returns the live data containing bookmarks in the document.
Returns the current page info.
Returns the file.
Returns the path of the document
Checks whether a warning about can not edit during conversion has been shown.
Returns the PDFViewCtrl
associated with this tab.
Returns the live data containing the current page state.
Returns the PDF document
Returns the reflow text size.
Returns the error code, if any.
See PdfDocManager
Returns the item source of the tab.
Returns the tab tag.
Returns the filename of the tab
Returns the filename of the tab
Returns ToolManager
associated with this tab.
Returns the URI file
Goes to the next text in search.
Goes to the previous text in search.
Handles CTRL-based key when triggered.
keyCode | The key code |
---|---|
event | The key event |
Handles key when pressed up.
keyCode | The key code |
---|---|
event | The key event |
Handles sharing.
Handles if the file is special case.
Hides backward/forward buttons.
Highlights the results of full text search.
result | The TextSearchResult
|
---|
Starts the TextHighlighter tool.
Called when a location or widget has been selected for adding the image signature Only one of the param should be valid
targetPoint | the target location in page point |
---|---|
targetPage | the target page |
widget | the target widget |
Called when a location has been selected for adding the image stamp.
targetPoint | The target location to add the image stamp |
---|
Checks if the tab is in continuous page mode.
Checks whether the document modified after opening.
Checks if the document is ready.
Gets whether the navigation side sheet is visible
Checks whether the document is not PDF.
Checks if opening file failed.
Checks if the tab is in reflow mode.
Checks whether right-to-left mode is enabled
Checks whether it is in search mode.
Checks if the tab is in single page mode.
Checks if the tab is ready only.
Handles if local file doesn't have write access.
Handles the activity result
Handles when a blank page without content is added to the document as a placeholder.
Called when an annotation has been selected.
annot | The selected annotation |
---|---|
pageNum | The page number where the annotation is on |
Called when an annotation has been unselected.
The overloaded implementation of onAnnotationsAdded(Map)
.
annots | The list of annotations (a pair of annotation and the page number where the annotation is on) |
---|
The overloaded implementation of onAnnotationsModified(Map, Bundle)
annots | The list of annotations (a pair of annotation and the page number where the annotation is on) |
---|
The overloaded implementation of onAnnotationsPreModify(Map)
.
annots | The list of annotations (a pair of annotation and the page number where the annotation is on) |
---|
The overloaded implementation of onAnnotationsPreRemove(Map)
.
annots | The list of annotations (a pair of annotation and the page number where the annotation is on) |
---|
The overloaded implementation of onAnnotationsRemoved(Map)
.
annots | The list of annotations (a pair of annotation and the page number where the annotation is on) |
---|
The overloaded implementation of onAnnotationsRemovedOnPage(int)
.
pageNum | The page number where the annotations are on |
---|
Called when PDF bookmarks have been modified.
bookmarkItems | the new bookmarks after modification |
---|
The overloaded implementation of onChangePointerIcon(PointerIcon)
.
pointerIcon | The pointer icon |
---|
The overloaded implementation of Fragment#onConfigurationChanged(Configuration).
Handles an update during document conversion.
state | - the state of update. |
---|---|
totalPagesConverted | The total number of pages converted so far. Only relevant for the @link #CONVERSION_PROGRESS state. Note that pages can be processed in batches, and so the number might not |
The overloaded implementation of Fragment#onCreate(Bundle).
The overloaded implementation of Fragment#onCreateView(LayoutInflater, ViewGroup, Bundle).
The overloaded implementation of Fragment#onDestroy().
The overloaded implementation of Fragment#onDestroyView().
Handles when document pages are modified.
Handles terminating document load.
The overloaded implementation of onDoubleTap(MotionEvent)
.
Handles an update during download.
state | the state of the update. |
---|---|
page_num | the number of the page that was just downloaded. Meaningful
if type is PAGE . |
page_downloaded | the total number of pages that have been downloaded |
page_count | the page count of the associated document |
message | error message in case the download has failed |
Called before the containing host fragment enters fullscreen mode (system status bar and navigation bar will be hidden).
true
if fullscreen mode can be entered, false
otherwise.
Called before the containing host fragment exits fullscreen mode (system status bar and/or navigation bar will be shown).
true
if fullscreen mode can be exited, false
otherwise.
Called when document annotations have been exported.
outputDoc | The PDFDoc containing the exported annotations |
---|
Handles generic motion events.
event | The generic motion event being processed. |
---|
The overloaded implementation of Fragment#onHiddenChanged(boolean).
Called when the androidx.appcompat.widget.Toolbar toolbar of the containing host fragment will be hidden.
true
if the toolbar can be hidden, false
otherwise.
Intercept tool's response to user actions (such as clicking on links, clicking on form widget, or about to change annotation properties etc.) If handled, tool will stop default logic.
annot | annotation |
---|---|
extra | extra information |
toolMode | tool mode that handles annotation |
Intercept handling of dialog
dialog | the dialog about to show up |
---|
Propagates onKeyUp(int, KeyEvent)
to the tools.
The overloaded implementation of onLongPress(MotionEvent)
.
The overloaded implementation of Fragment#onLowMemory().
The overloaded implementation of onMove(MotionEvent, MotionEvent, float, float)
.
Handles changes the page number.
old_page | the old page number |
---|---|
cur_page | the current (new) page number |
state | in non-continuous page presentation modes and when the built-in page sliding is in process, this flag is used to indicate the state of page change. |
Called when page labels have been changed
The overloaded implementation of onPageMoved(int, int)
.
from | The page number on which the page moved from |
---|---|
to | The page number on which the page moved to |
The overloaded implementation of onPagesAdded(List)
.
pageList | The list of pages added to the document |
---|
The overloaded implementation of onPagesDeleted(List)
.
pageList | The list of pages deleted from the document |
---|
Called when pages have been moved.
pagesMoved | The page numbers which the pages moved from |
---|---|
to | The page number on which the page moved to |
currentPage | The current page the viewer is on |
The overloaded implementation of onPagesRotated(List)
.
pageList | The list of rotated pages |
---|
The overloaded implementation of Fragment#onPause().
Handles when the position of the blank page without content moves.
position | position |
---|
Handles when the blank page without content enters or leaves the screen.
isVisible | whether visible or not |
---|
The overloaded implementation of onQuickMenuClicked(QuickMenuItem)
.
menuItem | The quick menu item |
---|
The overloaded implementation of onReflowSingleTapUp(MotionEvent)
.
event | The motion event |
---|
Handles when the content on the page the user was previously trying to access is accessible.
Handles when a blank page without content is removed from the document.
The overloaded implementation of Fragment#onResume().
The overloaded implementation of onScaleBegin(float, float)
.
The overloaded implementation of onScaleEnd(float, float)
.
The overloaded implementation of onScrollChanged(int, int, int, int)
.
Handles when it user is trying to access the next page of the PDFViewCtrl but there is no room for the visual progress indicator in the viewer. For example in single page mode.
Called when quick menu is about to show.
quickMenu | the quick menu that is about to show |
---|---|
annot | the selected annot, null if no annot is selected |
Called when the androidx.appcompat.widget.Toolbar toolbar of the containing host fragment will be shown.
true
if the toolbar can be shown, false
otherwise.
The overloaded implementation of onSingleTapConfirmed(MotionEvent)
.
The overloaded implementation of Fragment#onStop().
Handles when thumbnails view dialog is dismissed.
pageNum | The selected page number |
---|---|
docPagesModified | True if the document pages are modified. |
The overloaded implementation of onUp(MotionEvent, PDFViewCtrl.PriorEventMode)
.
The overloaded implementation of Fragment#onViewCreated(View, Bundle).
Opens the navigation list as a side sheet
Opens the redaction search dialog as a side sheet
Opens a dialog fragment as side sheet
Submits the query text.
text | The query text |
---|
Redo the last undo operation.
Refreshes the number of pages.
Removes the current file from the recent list.
Removes PdfViewCtrlTabBaseFragment.PageStackListener
listener.
listener | The listener |
---|
Removes the PdfViewCtrlTabBaseFragment.PasswordProtectedListener
.
listener | The listener that needs to be removed |
---|
Removes ToolManager.QuickMenuListener
listener.
listener | The listener |
---|
Resets full text results.
Saves the changes to the document.
close | True if the document should be closed |
---|---|
forceSave | True if save should be done forcefully |
skipSpecialFileCheck | True if special file check should be skipped |
upload | True if the document should be uploaded |
Saves the changes to the document.
close | True if the document should be closed |
---|---|
forceSave | True if save should be done forcefully |
skipSpecialFileCheck | True if special file check should be skipped |
Saves external document file.
close | True if the document should be closed |
---|---|
forceSave | True if save should be forcefully |
Saves local document file.
close | True if the document should be closed |
---|---|
forceSave | True if save should be forcefully |
Sets the which tab in bookmarks dialog should be selected.
index | The index of tab |
---|
Sets if the file an be added to tab info.
enabled | True if enabled |
---|
Specifies that color mode has been changed.
Helper to set the current page.
nextPageNum | The next page number |
---|---|
setPDFViewCtrl | True if PDFViewCtrl should be set too |
Specifies that the warning about can not edit during conversion has been shown.
Sets the reflow mode.
isReflowMode | True if reflow mode is enabled |
---|
Sets right-to-left mode
isRtlMode | True if right-to-left mode is enabled |
---|
Confirms that document saved toast has been shown.
Set enable or disable auto-saving annotations.
enabled | True to enable auto-saving is enabled (default value is True), false otherwise |
---|
Sets the search rule for match case.
matchCase | True if match case is enabled |
---|
Sets search mode
enabled | true if search mode is enabled; false otherwise. |
---|
Sets the visibility of search navigation buttons.
visible | True if visible |
---|
Specifies the search query.
text | The search query |
---|
Sets the search rules for match case and whole word.
matchCase | True if match case is enabled |
---|---|
wholeWord | True if whole word is enabled |
Sets the search rule for whole word.
wholeWord | True if whole word is enabled |
---|
set enable or disable saving state of document from outside
enabled | True to enable auto-saving is enabled (default value is True), false otherwise |
---|
Sets the PdfViewCtrlTabBaseFragment.TabListener
listener.
listener | The listener |
---|
Sets the visibility of thumbnail slider.
visible | True if the thumbnail slider should be visible |
---|---|
animateThumbSlider | True if the visibility should be changed with animation |
Shows backward/forward buttons.
Toggles the reflow mode.
Toggles right-to-left mode.
Event called when the tool changes.
newTool | the new tool |
---|---|
oldTool | the old tool |
Undo the last modification.
Updates the color mode.
Updates the current page info.
Updates annotation mode in print.
enabled | True if the annotation mode is checked |
---|
Updates documentation mode in print.
enabled | True if the documentation mode is checked |
---|
Updates summery mode in print.
enabled | True if the summery mode is checked |
---|
Updates the recent list.
Updates the view mode.
pagePresentationMode | The page presentation mode |
---|
Dismisses the user crop dialog.
Zooms in/out reflow mode.
flagZoomIn | True if zoom in; False if zoom out |
---|