java.lang.Object
   ↳ Fragment
     ↳ com.pdftron.pdf.controls.PdfViewCtrlTabHostBaseFragment
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

The PdfViewCtrlTabHostBaseFragment is a base class for other viewer host classes.

Summary

Nested Classes
interface PdfViewCtrlTabHostBaseFragment.AppBarVisibilityListener Callback interface to be invoked when AppBar visibility changes. 
interface PdfViewCtrlTabHostBaseFragment.ReflowControlListener  
interface PdfViewCtrlTabHostBaseFragment.TabHostListener Callback interface to be invoked when an interaction is needed. 
Constants
int ANIMATE_DURATION_HIDE
int ANIMATE_DURATION_SHOW
String BUNDLE_TAB_FRAGMENT_CLASS
String BUNDLE_TAB_HOST_CONFIG
String BUNDLE_TAB_HOST_NAV_ICON
String BUNDLE_TAB_HOST_QUIT_APP_WHEN_DONE_VIEWING
String BUNDLE_TAB_HOST_TOOLBAR_MENU
String BUNDLE_THEME
Public Constructors
PdfViewCtrlTabHostBaseFragment()
Public Methods
void addHostListener(PdfViewCtrlTabHostBaseFragment.TabHostListener listener)
Adds the PdfViewCtrlTabHostBaseFragment.TabHostListener listener.
void addNewPage()
Adds a new page.
void addReflowControlListener(PdfViewCtrlTabHostBaseFragment.ReflowControlListener listener)
Adds a PdfViewCtrlTabHostBaseFragment.ReflowControlListener listener.
TabLayout.Tab addTab(Bundle args, String tag, String title, String fileExtension, String password, int itemSource)
Adds a new tab
boolean checkTabConversionAndAlert(int messageID, boolean allowConverted, boolean skipSpecialFileCheck)
Checks tab conversion and shows the alert.
boolean checkTabConversionAndAlert(int messageID, boolean allowConverted)
The overloaded implementation of checkTabConversionAndAlert(int, boolean).
void clearHostListeners()
Removes all PdfViewCtrlTabHostBaseFragment.TabHostListener listeners.
void clearReflowControlListeners()
Removes all PdfViewCtrlTabHostBaseFragment.ReflowControlListener listeners.
void closeAllTabs()
Closes all tabs.
void closeTab(String tag)
Closes the specified tab.
void createTabs(Bundle args)
Creates tabs.
void exitSearchMode()
Exits the search mode.
PdfViewCtrlTabBaseFragment getCurrentPdfViewCtrlFragment()
Returns the selected PdfViewCtrlTabBaseFragment.
int getTabCount()
Returns the number of tabs.
Toolbar getToolbar()
int getToolbarHeight()
The overload implementation of getToolbarHeight().
boolean handleBackPressed()
Handles when back button is pressed.
boolean handleKeyShortcutEvent(int keyCode, KeyEvent event)
boolean handleKeyUp(int keyCode, KeyEvent event)
Handles key when pressed up.
abstract void hideUI()
Hides the UI.
boolean isInFullScreenMode()
void onActivityCreated(Bundle savedInstanceState)
The overload implementation of Fragment#onActivityCreated(Bundle).
void onAnnotationClicked(Annot annotation, int pageNum)
The overload implementation of onAnnotationClicked(Annot, int).
void onAutoCropTaskDone()
The overload implementation of onAutoCropTaskDone().
boolean onBackPressed()
Called when onBackPressed is called when viewing a document.
void onBookmarksDialogDismissed(int tabIndex)
The overloaded implementation of onBookmarksDialogDismissed(int).
void onBookmarksDialogWillDismiss(int tabIndex)
void onConfigurationChanged(Configuration newConfig)
The overload implementation of Fragment#onConfigurationChanged(Configuration).
void onCreate(Bundle savedInstanceState)
The overload implementation of Fragment#onCreate(Bundle).
void onCreateOptionsMenu(Menu menu, MenuInflater inflater)
The overload implementation of Fragment#onCreateOptionsMenu(Menu, MenuInflater).
View onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState)
The overload implementation of Fragment#onCreateView(LayoutInflater, ViewGroup, Bundle).
boolean onCustomColorModeSelected(int bgColor, int txtColor)
The overloaded implementation of onCustomColorModeSelected(int, int).
void onDestroy()
The overload implementation of Fragment#onDestroy().
void onDestroyView()
The overload implementation of Fragment#onDestroyView().
void onDownloadedSuccessful()
The overload implementation of onDownloadedSuccessful().
abstract void onEditToolbarMenu()
void onExportAnnotations(PDFDoc pdfDoc)
The overload implementation of onExportAnnotations(PDFDoc).
void onExportThumbnails(SparseBooleanArray pageNums)
The overload implementation of onExportThumbnails(SparseBooleanArray).
void onFlattenOptionSelected()
SearchResultsView.SearchResultStatus onFullTextSearchFindText(boolean searchUp)
The overload implementation of onFullTextSearchFindText(boolean).
void onFullTextSearchStart()
The overload implementation of onFullTextSearchStart().
boolean onHandleKeyShortcutEvent(int keyCode, KeyEvent event)
Called when key shortcut event triggered
void onInkEditSelected(Annot inkAnnot, int pageNum)
The overload implementation of onInkEditSelected(Annot, int).
void onLayoutChange(View v, int left, int top, int right, int bottom, int oldLeft, int oldTop, int oldRight, int oldBottom)
The overload implementation of onLayoutChange(View, int, int, int, int, int, int, int, int).
void onOpenAddNewTab(Bundle args)
Creates and opens a new tab.
void onOpenAddNewTab(int itemSource, String tag, String title, String password)
The overload implementation of onOpenAddNewTab(int, String, String, String).
abstract void onOpenAnnotationToolbar(ToolManager.ToolMode mode)
The overload implementation of onOpenAnnotationToolbar(ToolMode).
abstract void onOpenEditToolbar(ToolManager.ToolMode mode)
The overload implementation of onOpenEditToolbar(ToolMode).
boolean onOptionsItemSelected(MenuItem item)
The overload implementation of Fragment#onOptionsItemSelected(MenuItem).
void onOutlineClicked(Bookmark parent, Bookmark bookmark)
The overload implementation of onOutlineClicked(Bookmark, Bookmark).
void onOutlineOptionSelected(int initialTabIndex)
Called when outline option has been selected.
void onOutlineOptionSelected()
Called when outline option has been selected.
void onPageThumbnailOptionSelected(boolean thumbnailEditMode, Integer checkedItem)
The overload implementation of onPageThumbnailOptionSelected(boolean, Integer).
void onPause()
The overload implementation of Fragment#onPause().
void onPrepareOptionsMenu(Menu menu)
The overload implementation of Fragment#onPrepareOptionsMenu(Menu).
boolean onQuickMenuClicked(QuickMenuItem menuItem)
The overloaded implementation of onQuickMenuClicked(QuickMenuItem).
void onQuickMenuDismissed()
The overloaded implementation of onQuickMenuDismissed().
void onQuickMenuShown()
The overloaded implementation of onQuickMenuShown().
int onReflowZoomInOut(boolean flagZoomIn)
The overloaded implementation of onReflowZoomInOut(boolean).
void onResume()
The overload implementation of Fragment#onResume().
void onSaveAsOptionSelected()
void onSaveCroppedCopySelected()
void onSaveInstanceState(Bundle outState)
The overload implementation of Fragment#onSaveInstanceState(Bundle).
void onSaveOptimizedCopySelected()
void onSavePasswordCopySelected()
void onSearchOptionSelected()
void onSearchProgressHide()
The overload implementation of onSearchProgressHide().
void onSearchProgressShow()
The overload implementation of onSearchProgressShow().
void onSearchResultClicked(TextSearchResult result)
The overload implementation of onSearchResultClicked(TextSearchResult).
void onSearchResultFound(TextSearchResult result)
The overload implementation of onSearchResultFound(TextSearchResult).
boolean onShowQuickMenu(QuickMenu quickmenu, Annot annot)
Called when quick menu is about to show.
void onShowTabInfo(String tag, String title, String fileExtension, int itemSource, int duration)
Called when show tab info has been triggered.
void onStart()
void onStop()
void onSystemUiVisibilityChange(int visibility)
The overload implementation of onSystemUiVisibilityChange(int).
void onTabDocumentLoaded(String tag)
The overload implementation of onTabDocumentLoaded(String).
void onTabError(int errorCode, String info)
The overload implementation of onTabError(int, String).
void onTabIdentityChanged(String oldTabTag, String newTabTag, String newTabTitle, String newFileExtension, int newTabSource)
The overload implementation of onTabIdentityChanged(String, String, String, String, int).
void onTabJumpToSdCardFolder()
Called when an SD card file is opened as a local file
void onTabPaused(FileInfo fileInfo, boolean isDocModifiedAfterOpening)
The overload implementation of onTabPaused(FileInfo, boolean).
abstract void onTabSingleTapConfirmed()
The overload implementation of onTabSingleTapConfirmed().
void onTabThumbSliderStopTrackingTouch()
The overload implementation of onTabThumbSliderStopTrackingTouch().
void onThumbnailsEditAttemptWhileReadOnly()
The overload implementation of onThumbnailsEditAttemptWhileReadOnly().
void onThumbnailsViewDialogDismiss(int pageNum, boolean docPagesModified)
The overload implementation of onThumbnailsViewDialogDismiss(int, boolean).
void onToggleReflow()
The overload implementation of onToggleReflow().
void onUndoRedoPopupClosed()
The overload implementation of onUndoRedoPopupClosed().
void onUpdateOptionsMenu()
Called when toolbar overflow menu should be updated
void onUserBookmarkClick(int pageNum)
The overload implementation of onUserBookmarkClicked(int).
void onUserCropDialogDismiss(int pageNumberAtDismiss)
The overload implementation of onUserCropDialogDismiss(int).
void onUserCropMethodSelected(int cropMode)
The overload implementation of onUserCropMethodSelected(int).
void onUserCropSelectionDialogFragmentDismiss()
The overload implementation of onUserCropSelectionDialogFragmentDismiss().
void onViewCreated(View view, Bundle savedInstanceState)
The overload implementation of Fragment#onViewCreated(View, Bundle).
boolean onViewModeColorSelected(int colorMode)
The overloaded implementation of onViewModeColorSelected(int).
void onViewModeOptionSelected()
Called when view mode option has been selected.
void onViewModePickerDialogFragmentDismiss()
The overloaded implementation of onViewModePickerDialogFragmentDismiss().
void onViewModeSelected(String viewMode, boolean thumbnailEditMode, Integer checkedItem)
Handles when view mode is selected.
void onViewModeSelected(String viewMode)
The overloaded implementation of onViewModeSelected(String).
boolean readAndUnsetFileSystemChanged()
Reads and Unsets file system changed.
void removeExtraTabs()
Removes extra tabs.
void removeHostListener(PdfViewCtrlTabHostBaseFragment.TabHostListener listener)
Removes the PdfViewCtrlTabHostBaseFragment.TabHostListener listener.
void removeReflowControlListener(PdfViewCtrlTabHostBaseFragment.ReflowControlListener listener)
Removes the PdfViewCtrlTabHostBaseFragment.ReflowControlListener listener.
void removeTab(String filepath)
Removes the specified tab.
void removeTab(String filepath, String nextTabTagToSelect)
Removes the specified tab.
void removeTabAt(int index)
Removes the specified tab at index.
void resetHideToolbarsTimer()
The overloaded implementation of resetHideToolbarsTimer().
void setAppBarVisibilityListener(PdfViewCtrlTabHostBaseFragment.AppBarVisibilityListener listener)
Sets the PdfViewCtrlTabHostBaseFragment.AppBarVisibilityListener listener.
void setCurrentTabByTag(String tag)
Selects the tab that has the specified tag.
static void setDebug(boolean debug)
void setLongPressEnabled(boolean enabled)
Sets if the host can dispatch long press event.
void setThumbSliderVisibility(boolean visible, boolean animate)
Sets the visibility of thumbnail slider.
void setToolbarTimerDisabled(boolean disable)
Whether to disable the auto hide Toolbar timer
void setToolbarsVisible(boolean visible)
Handles changing the visibility of toolbars.
abstract void setToolbarsVisible(boolean visible, boolean animateBottomBar)
Handles changing the visibility of toolbars.
void setViewerOverlayUIVisible(boolean visible)
The implementation should change the visibility of top toolbar, bottom navigation bar as well as system navigation bar.
void setupRedaction()
void showTabInfo(String message, String path, String tag, int itemSource, int duration)
Shows tab information in a snack bar
abstract void showUI()
Shows the UI.
void startSearchMode()
void stopHideToolbarsTimer()
Stops timer for hiding toolbar.
boolean updateColorMode()
Updates color mode.
void updateToolbarDrawable()
[Expand]
Inherited Methods
From class java.lang.Object
From interface android.view.View.OnLayoutChangeListener
From interface android.view.View.OnSystemUiVisibilityChangeListener
From interface com.pdftron.pdf.controls.BookmarksTabLayout.BookmarksTabsListener
From interface com.pdftron.pdf.controls.PdfViewCtrlTabBaseFragment.TabListener
From interface com.pdftron.pdf.controls.SearchResultsView.SearchResultsListener
From interface com.pdftron.pdf.controls.ThumbnailsViewFragment.OnExportThumbnailsListener
From interface com.pdftron.pdf.controls.ThumbnailsViewFragment.OnThumbnailsEditAttemptWhileReadOnlyListener
From interface com.pdftron.pdf.controls.ThumbnailsViewFragment.OnThumbnailsViewDialogDismissListener
From interface com.pdftron.pdf.controls.UserCropDialogFragment.OnUserCropDialogDismissListener
From interface com.pdftron.pdf.controls.UserCropSelectionDialogFragment.UserCropSelectionDialogFragmentListener
From interface com.pdftron.pdf.dialog.BookmarksDialogFragment.BookmarksDialogListener
From interface com.pdftron.pdf.dialog.ViewModePickerDialogFragment.ViewModePickerDialogFragmentListener
From interface com.pdftron.pdf.tools.ToolManager.QuickMenuListener
From interface com.pdftron.pdf.utils.UserCropUtilities.AutoCropInBackgroundTask.AutoCropTaskListener

Constants

public static final int ANIMATE_DURATION_HIDE

Constant Value: 250 (0x000000fa)

public static final int ANIMATE_DURATION_SHOW

Constant Value: 250 (0x000000fa)

public static final String BUNDLE_TAB_FRAGMENT_CLASS

Constant Value: "PdfViewCtrlTabHostFragment_tab_fragment_class"

public static final String BUNDLE_TAB_HOST_CONFIG

Constant Value: "bundle_tab_host_config"

public static final String BUNDLE_TAB_HOST_NAV_ICON

Constant Value: "bundle_tab_host_nav_icon"

public static final String BUNDLE_TAB_HOST_QUIT_APP_WHEN_DONE_VIEWING

Constant Value: "bundle_tab_host_quit_app_when_done_viewing"

public static final String BUNDLE_TAB_HOST_TOOLBAR_MENU

Constant Value: "bundle_tab_host_toolbar_menu"

public static final String BUNDLE_THEME

Constant Value: "bundle_theme"

Public Constructors

public PdfViewCtrlTabHostBaseFragment ()

Public Methods

public void addHostListener (PdfViewCtrlTabHostBaseFragment.TabHostListener listener)

Adds the PdfViewCtrlTabHostBaseFragment.TabHostListener listener.

Parameters
listener The listener

public void addNewPage ()

Adds a new page.

public void addReflowControlListener (PdfViewCtrlTabHostBaseFragment.ReflowControlListener listener)

Adds a PdfViewCtrlTabHostBaseFragment.ReflowControlListener listener.

Parameters
listener The listener

public TabLayout.Tab addTab (Bundle args, String tag, String title, String fileExtension, String password, int itemSource)

Adds a new tab

Parameters
args The argument needed to create PdfViewCtrlTabBaseFragment
tag The tab tag
title The title
fileExtension The file extension
password The password
itemSource The item source of the document
Returns
  • The created tab

public boolean checkTabConversionAndAlert (int messageID, boolean allowConverted, boolean skipSpecialFileCheck)

Checks tab conversion and shows the alert.

Parameters
messageID The message ID
allowConverted True if conversion is allowed
skipSpecialFileCheck True if spcecial files should be skipped
Returns
  • True if handled

public boolean checkTabConversionAndAlert (int messageID, boolean allowConverted)

The overloaded implementation of checkTabConversionAndAlert(int, boolean).

Parameters
messageID The message ID
allowConverted True if conversion is allowed
Returns
  • True if handled

public void clearHostListeners ()

Removes all PdfViewCtrlTabHostBaseFragment.TabHostListener listeners.

public void clearReflowControlListeners ()

Removes all PdfViewCtrlTabHostBaseFragment.ReflowControlListener listeners.

public void closeAllTabs ()

Closes all tabs.

public void closeTab (String tag)

Closes the specified tab.

Parameters
tag the tab tag

public void createTabs (Bundle args)

Creates tabs.

Parameters
args The arguments

public void exitSearchMode ()

Exits the search mode.

public PdfViewCtrlTabBaseFragment getCurrentPdfViewCtrlFragment ()

Returns the selected PdfViewCtrlTabBaseFragment.

Returns
  • The PdfViewCtrlTabBaseFragment

public int getTabCount ()

Returns the number of tabs.

Returns
  • The number of tabs

public Toolbar getToolbar ()

public int getToolbarHeight ()

The overload implementation of getToolbarHeight().

Returns
  • The height of toolbar

public boolean handleBackPressed ()

Handles when back button is pressed.

Returns
  • Ture if the back event is handled

public boolean handleKeyShortcutEvent (int keyCode, KeyEvent event)

public boolean handleKeyUp (int keyCode, KeyEvent event)

Handles key when pressed up.

Parameters
keyCode The key code
event The key event
Returns
  • True if the key is handled

public abstract void hideUI ()

Hides the UI.

public boolean isInFullScreenMode ()

public void onActivityCreated (Bundle savedInstanceState)

The overload implementation of Fragment#onActivityCreated(Bundle).

public void onAnnotationClicked (Annot annotation, int pageNum)

The overload implementation of onAnnotationClicked(Annot, int).

Parameters
annotation The annotation
pageNum The page number that holds the annotation

public void onAutoCropTaskDone ()

The overload implementation of onAutoCropTaskDone().

public boolean onBackPressed ()

Called when onBackPressed is called when viewing a document.

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

public void onBookmarksDialogDismissed (int tabIndex)

The overloaded implementation of onBookmarksDialogDismissed(int).

Parameters
tabIndex The index of selected tab when dismissed

public void onBookmarksDialogWillDismiss (int tabIndex)

public void onConfigurationChanged (Configuration newConfig)

The overload implementation of Fragment#onConfigurationChanged(Configuration).

public void onCreate (Bundle savedInstanceState)

The overload implementation of Fragment#onCreate(Bundle).

public void onCreateOptionsMenu (Menu menu, MenuInflater inflater)

The overload implementation of Fragment#onCreateOptionsMenu(Menu, MenuInflater).

public View onCreateView (LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState)

The overload implementation of Fragment#onCreateView(LayoutInflater, ViewGroup, Bundle).

public boolean onCustomColorModeSelected (int bgColor, int txtColor)

The overloaded implementation of onCustomColorModeSelected(int, int).

Parameters
bgColor The selected background color
txtColor The selected text color
Returns
  • True if the dialog should be dismissed

public void onDestroy ()

The overload implementation of Fragment#onDestroy().

public void onDestroyView ()

The overload implementation of Fragment#onDestroyView().

public void onDownloadedSuccessful ()

The overload implementation of onDownloadedSuccessful().

public abstract void onEditToolbarMenu ()

public void onExportAnnotations (PDFDoc pdfDoc)

The overload implementation of onExportAnnotations(PDFDoc).

Parameters
pdfDoc The PDFDoc containing the exported annotations

public void onExportThumbnails (SparseBooleanArray pageNums)

The overload implementation of onExportThumbnails(SparseBooleanArray).

Parameters
pageNums The page numbers to be exported

public void onFlattenOptionSelected ()

public SearchResultsView.SearchResultStatus onFullTextSearchFindText (boolean searchUp)

The overload implementation of onFullTextSearchFindText(boolean).

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

public void onFullTextSearchStart ()

The overload implementation of onFullTextSearchStart().

public boolean onHandleKeyShortcutEvent (int keyCode, KeyEvent event)

Called when key shortcut event triggered

public void onInkEditSelected (Annot inkAnnot, int pageNum)

The overload implementation of onInkEditSelected(Annot, int).

Parameters
inkAnnot The annotation
pageNum The page number

public void onLayoutChange (View v, int left, int top, int right, int bottom, int oldLeft, int oldTop, int oldRight, int oldBottom)

The overload implementation of onLayoutChange(View, int, int, int, int, int, int, int, int).

public void onOpenAddNewTab (Bundle args)

Creates and opens a new tab.

Parameters
args The arguments needed to create a new tab

public void onOpenAddNewTab (int itemSource, String tag, String title, String password)

The overload implementation of onOpenAddNewTab(int, String, String, String).

Parameters
itemSource The item source of document
tag The tab tag
title The name of the document
password The password

public abstract void onOpenAnnotationToolbar (ToolManager.ToolMode mode)

The overload implementation of onOpenAnnotationToolbar(ToolMode).

Parameters
mode The tool mode

public abstract void onOpenEditToolbar (ToolManager.ToolMode mode)

The overload implementation of onOpenEditToolbar(ToolMode).

Parameters
mode The tool mode

public boolean onOptionsItemSelected (MenuItem item)

The overload implementation of Fragment#onOptionsItemSelected(MenuItem).

public void onOutlineClicked (Bookmark parent, Bookmark bookmark)

The overload implementation of onOutlineClicked(Bookmark, Bookmark).

Parameters
parent The parent bookmark if any
bookmark The clicked bookmark

public void onOutlineOptionSelected (int initialTabIndex)

Called when outline option has been selected.

Parameters
initialTabIndex The tab index which should be selected after bookmarks dialog is created

public void onOutlineOptionSelected ()

Called when outline option has been selected.

public void onPageThumbnailOptionSelected (boolean thumbnailEditMode, Integer checkedItem)

The overload implementation of onPageThumbnailOptionSelected(boolean, Integer).

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

public void onPause ()

The overload implementation of Fragment#onPause().

public void onPrepareOptionsMenu (Menu menu)

The overload implementation of Fragment#onPrepareOptionsMenu(Menu).

public boolean onQuickMenuClicked (QuickMenuItem menuItem)

The overloaded implementation of onQuickMenuClicked(QuickMenuItem).

Parameters
menuItem The quick menu item
Returns
  • True if handled

public void onQuickMenuDismissed ()

The overloaded implementation of onQuickMenuDismissed().

public void onQuickMenuShown ()

The overloaded implementation of onQuickMenuShown().

public int onReflowZoomInOut (boolean flagZoomIn)

The overloaded implementation of onReflowZoomInOut(boolean).

Parameters
flagZoomIn True if zoom in; False if zoom out
Returns
  • The text size raging from 0 to 100

public void onResume ()

The overload implementation of Fragment#onResume().

public void onSaveAsOptionSelected ()

public void onSaveCroppedCopySelected ()

public void onSaveInstanceState (Bundle outState)

The overload implementation of Fragment#onSaveInstanceState(Bundle).

public void onSaveOptimizedCopySelected ()

public void onSavePasswordCopySelected ()

public void onSearchOptionSelected ()

public void onSearchProgressHide ()

The overload implementation of onSearchProgressHide().

public void onSearchProgressShow ()

The overload implementation of onSearchProgressShow().

public void onSearchResultClicked (TextSearchResult result)

The overload implementation of onSearchResultClicked(TextSearchResult).

Parameters
result The text search result

public void onSearchResultFound (TextSearchResult result)

The overload implementation of onSearchResultFound(TextSearchResult).

Parameters
result The text search result

public boolean onShowQuickMenu (QuickMenu quickmenu, Annot annot)

Called when quick menu is about to show.

Parameters
quickmenu the quick menu that is about to show
annot the selected annot, null if no annot is selected
Returns
  • true if quick menu should not show

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

Called when show tab info has been triggered.

public void onStart ()

public void onStop ()

public void onSystemUiVisibilityChange (int visibility)

The overload implementation of onSystemUiVisibilityChange(int).

public void onTabDocumentLoaded (String tag)

The overload implementation of onTabDocumentLoaded(String).

Parameters
tag The tab tab

public void onTabError (int errorCode, String info)

The overload implementation of onTabError(int, String).

Parameters
errorCode The code of error
info The information

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

The overload implementation of onTabIdentityChanged(String, String, String, String, int).

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 void onTabJumpToSdCardFolder ()

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

public void onTabPaused (FileInfo fileInfo, boolean isDocModifiedAfterOpening)

The overload implementation of onTabPaused(FileInfo, boolean).

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

public abstract void onTabSingleTapConfirmed ()

The overload implementation of onTabSingleTapConfirmed().

public void onTabThumbSliderStopTrackingTouch ()

The overload implementation of onTabThumbSliderStopTrackingTouch().

public void onThumbnailsEditAttemptWhileReadOnly ()

The overload implementation of onThumbnailsEditAttemptWhileReadOnly().

public void onThumbnailsViewDialogDismiss (int pageNum, boolean docPagesModified)

The overload implementation of onThumbnailsViewDialogDismiss(int, boolean).

Parameters
pageNum The selected page number
docPagesModified True if the pages of the document has been modified

public void onToggleReflow ()

The overload implementation of onToggleReflow().

public void onUndoRedoPopupClosed ()

The overload implementation of onUndoRedoPopupClosed().

public void onUpdateOptionsMenu ()

Called when toolbar overflow menu should be updated

public void onUserBookmarkClick (int pageNum)

The overload implementation of onUserBookmarkClicked(int).

Parameters
pageNum The page number

public void onUserCropDialogDismiss (int pageNumberAtDismiss)

The overload implementation of onUserCropDialogDismiss(int).

Parameters
pageNumberAtDismiss The current page number when it was dismissed

public void onUserCropMethodSelected (int cropMode)

The overload implementation of onUserCropMethodSelected(int).

Parameters
cropMode The crop mode. The possible values are #MODE_AUTO_CROP, #MODE_MANUAL_CROP, #MODE_RESET_CROP

public void onUserCropSelectionDialogFragmentDismiss ()

The overload implementation of onUserCropSelectionDialogFragmentDismiss().

public void onViewCreated (View view, Bundle savedInstanceState)

The overload implementation of Fragment#onViewCreated(View, Bundle).

public boolean onViewModeColorSelected (int colorMode)

The overloaded implementation of onViewModeColorSelected(int).

Parameters
colorMode The color mode
Returns
  • True if the dialog should be dismissed

public void onViewModeOptionSelected ()

Called when view mode option has been selected.

public void onViewModePickerDialogFragmentDismiss ()

The overloaded implementation of onViewModePickerDialogFragmentDismiss().

public void onViewModeSelected (String viewMode, boolean thumbnailEditMode, Integer checkedItem)

Handles when view mode is selected.

Parameters
viewMode the view mode
thumbnailEditMode True if thumbnail is in edit mode
checkedItem The checked item

public void onViewModeSelected (String viewMode)

The overloaded implementation of onViewModeSelected(String).

Parameters
viewMode The selected view mode

public boolean readAndUnsetFileSystemChanged ()

Reads and Unsets file system changed.

Returns
  • True if file system changed

public void removeExtraTabs ()

Removes extra tabs.

public void removeHostListener (PdfViewCtrlTabHostBaseFragment.TabHostListener listener)

Removes the PdfViewCtrlTabHostBaseFragment.TabHostListener listener.

Parameters
listener The listener

public void removeReflowControlListener (PdfViewCtrlTabHostBaseFragment.ReflowControlListener listener)

Removes the PdfViewCtrlTabHostBaseFragment.ReflowControlListener listener.

Parameters
listener The listener

public void removeTab (String filepath)

Removes the specified tab.

Parameters
filepath The file path

public void removeTab (String filepath, String nextTabTagToSelect)

Removes the specified tab.

Parameters
filepath The file path
nextTabTagToSelect The tab tag of the tab that should be selected thereafter

public void removeTabAt (int index)

Removes the specified tab at index.

Parameters
index index of the tab

public void resetHideToolbarsTimer ()

The overloaded implementation of resetHideToolbarsTimer().

public void setAppBarVisibilityListener (PdfViewCtrlTabHostBaseFragment.AppBarVisibilityListener listener)

Sets the PdfViewCtrlTabHostBaseFragment.AppBarVisibilityListener listener.

Parameters
listener The listener

public void setCurrentTabByTag (String tag)

Selects the tab that has the specified tag.

Parameters
tag The tab tag

public static void setDebug (boolean debug)

public void setLongPressEnabled (boolean enabled)

Sets if the host can dispatch long press event.

Parameters
enabled True to make the host able to read long press event

public void setThumbSliderVisibility (boolean visible, boolean animate)

Sets the visibility of thumbnail slider.

Parameters
visible True if visible
animate True if visibility should be changed with animation

public void setToolbarTimerDisabled (boolean disable)

Whether to disable the auto hide Toolbar timer

Parameters
disable true if timer is disabled, false otherwise

public void setToolbarsVisible (boolean visible)

Handles changing the visibility of toolbars.

Parameters
visible True if toolbar is visible

public abstract void setToolbarsVisible (boolean visible, boolean animateBottomBar)

Handles changing the visibility of toolbars.

Parameters
visible True if toolbar is visible
animateBottomBar True if visibility should be changed with animation

public void setViewerOverlayUIVisible (boolean visible)

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

public void setupRedaction ()

public void showTabInfo (String message, String path, String tag, int itemSource, int duration)

Shows tab information in a snack bar

Parameters
message The message
path The file path
tag The tab tag
itemSource The item source of the document

public abstract void showUI ()

Shows the UI.

public void startSearchMode ()

public void stopHideToolbarsTimer ()

Stops timer for hiding toolbar.

public boolean updateColorMode ()

Updates color mode.

Returns
  • True if the view mode picker dialog should be dismissed

public void updateToolbarDrawable ()