Summary: Methods | [Expand All]
public static interface

PdfViewCtrlTabBaseFragment.TabListener

com.pdftron.pdf.controls.PdfViewCtrlTabBaseFragment.TabListener
Known Indirect Subclasses

Class Overview

Callback interface to be invoked when an interaction is needed.

Summary

Public Methods
abstract int getToolbarHeight()
The implementation should return the height of toolbar.
abstract boolean onBackPressed()
Called when onBackPressed is called when viewing a document.
abstract void onDownloadedSuccessful()
Called when download successfully has been finished.
abstract SearchResultsView.SearchResultStatus onFullTextSearchFindText(boolean searchUp)
Called when should find next/previous text.
abstract boolean onHandleKeyShortcutEvent(int keyCode, KeyEvent event)
Called when key shortcut event triggered
abstract void onInkEditSelected(Annot annot, int pageNum)
Called when an ink edit has been selected.
abstract void onOpenAddNewTab(int itemSource, String tag, String name, String password, int initialPage)
Called when a new tab has been opened.
abstract void onOpenAnnotationToolbar(ToolManager.ToolMode mode)
Called when the annotation toolbar should open for a tool mode.
abstract void onOpenEditToolbar(ToolManager.ToolMode mode)
Called when the edit toolbar should open for a tool mode.
abstract void onOutlineOptionSelected()
Called when outline option selected
abstract void onPageThumbnailOptionSelected(boolean thumbnailEditMode, Integer checkedItem)
Called when page thumbnail viewer selected
abstract void onSearchOptionSelected()
abstract void onSearchProgressHide()
The implementation should hide the search progress.
abstract void onSearchProgressShow()
The implementation should show the search progress.
abstract void onShowTabInfo(String tag, String title, String fileExtension, int itemSource, int duration)
Called when show tab info has been triggered.
abstract void onTabDocumentLoaded(String tag)
Called when the document has been loaded.
abstract void onTabError(int errorCode, String info)
Called when an error has been happened to this tab.
abstract void onTabIdentityChanged(String oldTabTag, String newTabTag, String newTabTitle, String newFileExtension, int newTabSource)
Called when the identity of the tab has been changed.
abstract void onTabJumpToSdCardFolder()
Called when an SD card file is opened as a local file
abstract void onTabPaused(FileInfo fileInfo, boolean isDocModifiedAfterOpening)
Called when the fragment is paused.
abstract void onTabSingleTapConfirmed()
Called when a single tap has been touched on the tab.
abstract void onTabThumbSliderStopTrackingTouch()
Called when thumbnail slider has been stopped tracking touch.
abstract void onToggleReflow()
Called when the reflow mode has been toggled.
abstract void onUndoRedoPopupClosed()
This method is deprecated. No replacement.
abstract void onUpdateOptionsMenu()
Called when toolbar overflow menu should be updated
abstract void onViewModeOptionSelected()
abstract void resetHideToolbarsTimer()
The implementation should reset timer for hiding toolbars.
abstract void setToolbarsVisible(boolean visible)
The implementation should change the visibility of toolbars.
abstract void setViewerOverlayUIVisible(boolean visible)
The implementation should change the visibility of top toolbar, bottom navigation bar as well as system navigation bar.

Public Methods

public abstract int getToolbarHeight ()

The implementation should return the height of toolbar.

Returns
  • The height of toolbar

public abstract boolean onBackPressed ()

Called when onBackPressed is called when viewing a document.

Returns
  • true if custom handling is required, false otherwise.

public abstract void onDownloadedSuccessful ()

Called when download successfully has been finished.

public abstract SearchResultsView.SearchResultStatus onFullTextSearchFindText (boolean searchUp)

Called when should find next/previous text.

Parameters
searchUp True if should go to previous search (up)
Returns
  • The status

public abstract boolean onHandleKeyShortcutEvent (int keyCode, KeyEvent event)

Called when key shortcut event triggered

public abstract void onInkEditSelected (Annot annot, int pageNum)

Called when an ink edit has been selected.

Parameters
annot The annotation
pageNum The page number

public abstract void onOpenAddNewTab (int itemSource, String tag, String name, String password, int initialPage)

Called when a new tab has been opened.

Parameters
itemSource The item source of document
tag The tab tag
name The name of the document
password The password
initialPage The initial page to scroll to when the document is opened, unused if less than 1.

public abstract void onOpenAnnotationToolbar (ToolManager.ToolMode mode)

Called when the annotation toolbar should open for a tool mode.

Parameters
mode The tool mode

public abstract void onOpenEditToolbar (ToolManager.ToolMode mode)

Called when the edit toolbar should open for a tool mode.

Parameters
mode The tool mode

public abstract void onOutlineOptionSelected ()

Called when outline option selected

public abstract void onPageThumbnailOptionSelected (boolean thumbnailEditMode, Integer checkedItem)

Called when page thumbnail viewer selected

Parameters
thumbnailEditMode true if thumbnail is in edit mode
checkedItem The index of the item that is checked

public abstract void onSearchOptionSelected ()

public abstract void onSearchProgressHide ()

The implementation should hide the search progress.

public abstract void onSearchProgressShow ()

The implementation should show the search progress.

public abstract void onShowTabInfo (String tag, String title, String fileExtension, int itemSource, int duration)

Called when show tab info has been triggered.

public abstract void onTabDocumentLoaded (String tag)

Called when the document has been loaded.

Parameters
tag The tab tab

public abstract void onTabError (int errorCode, String info)

Called when an error has been happened to this tab.

Parameters
errorCode The code of error
info The information

public abstract void onTabIdentityChanged (String oldTabTag, String newTabTag, String newTabTitle, String newFileExtension, int newTabSource)

Called when the identity of the tab has been changed.

Parameters
oldTabTag The old tab tag
newTabTag The new tab tag
newTabTitle The new title of the tab
newFileExtension The new extension of the document
newTabSource The new item source of document

public abstract void onTabJumpToSdCardFolder ()

Called when an SD card file is opened as a local file

public abstract void onTabPaused (FileInfo fileInfo, boolean isDocModifiedAfterOpening)

Called when the fragment is paused.

Parameters
fileInfo The file shown when tab has been paused
isDocModifiedAfterOpening True if document has been modified after opening

public abstract void onTabSingleTapConfirmed ()

Called when a single tap has been touched on the tab.

public abstract void onTabThumbSliderStopTrackingTouch ()

Called when thumbnail slider has been stopped tracking touch.

public abstract void onToggleReflow ()

Called when the reflow mode has been toggled.

public abstract void onUndoRedoPopupClosed ()

This method is deprecated.
No replacement.

The implementation should close undo/redo popup menu.

public abstract void onUpdateOptionsMenu ()

Called when toolbar overflow menu should be updated

public abstract void onViewModeOptionSelected ()

public abstract void resetHideToolbarsTimer ()

The implementation should reset timer for hiding toolbars.

public abstract void setToolbarsVisible (boolean visible)

The implementation should change the visibility of toolbars.

public abstract void setViewerOverlayUIVisible (boolean visible)

The implementation should change the visibility of top toolbar, bottom navigation bar as well as system navigation bar.