public class

UserBookmarkDialogFragment

extends NavigationListDialogFragment
java.lang.Object
   ↳ DialogFragment
     ↳ com.pdftron.pdf.controls.NavigationListDialogFragment
       ↳ com.pdftron.pdf.controls.UserBookmarkDialogFragment

Class Overview

The UserBookmarkDialogFragment shows a list of user-defined bookmarks that can be used to navigate the document in the PDFViewCtrl. This is different from OutlineDialogFragment as user can add new custom bookmarks with any name at any time. Modification to existing bookmarks is also supported.

Summary

Nested Classes
interface UserBookmarkDialogFragment.UserBookmarkDialogListener Callback interface to be invoked when an interaction is needed. 
Constants
String BUNDLE_ALLOW_EDITING
String BUNDLE_AUTO_SORT_BOOKMARKS
String BUNDLE_BOOKMARK_CREATION_ENABLED
String BUNDLE_FILE_PATH Bundle key to set the file path
String BUNDLE_IS_READ_ONLY Bundle key to specify whether the document is read only or not
Public Constructors
UserBookmarkDialogFragment()
Public Methods
String getQueryText()
boolean handleBackPress()
void loadBookmarks()
static UserBookmarkDialogFragment newInstance()
Returns a new instance of the class
void onCreate(Bundle savedInstanceState)
View onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState)
void onPause()
boolean onQueryTextChange(String newText)
boolean onQueryTextSubmit(String query)
void onResume()
void prepareOptionsMenu(Menu menu)
void resetBookmarkListFilter()
UserBookmarkDialogFragment setAllowEditing(boolean allowEditing)
Sets if the user bookmark dialog allow modification to existing items
UserBookmarkDialogFragment setFilePath(String filePath)
Sets the file path.
UserBookmarkDialogFragment setPdfViewCtrl(PDFViewCtrl pdfViewCtrl)
Sets the PDFViewCtrl
UserBookmarkDialogFragment setReadOnly(boolean isReadOnly)
Sets if the document is read only
void setUserBookmarkListener(UserBookmarkDialogFragment.UserBookmarkDialogListener listener)
Sets the listener to UserBookmarkDialogFragment
[Expand]
Inherited Methods
From class com.pdftron.pdf.controls.NavigationListDialogFragment
From class java.lang.Object

Constants

public static final String BUNDLE_ALLOW_EDITING

Constant Value: "allow_editing"

public static final String BUNDLE_AUTO_SORT_BOOKMARKS

Constant Value: "auto_sort_bookmarks"

public static final String BUNDLE_BOOKMARK_CREATION_ENABLED

Constant Value: "bookmark_creation_enabled"

public static final String BUNDLE_FILE_PATH

Bundle key to set the file path

Constant Value: "file_path"

public static final String BUNDLE_IS_READ_ONLY

Bundle key to specify whether the document is read only or not

Constant Value: "is_read_only"

Public Constructors

public UserBookmarkDialogFragment ()

Public Methods

public String getQueryText ()

public boolean handleBackPress ()

public void loadBookmarks ()

public static UserBookmarkDialogFragment newInstance ()

Returns a new instance of the class

public void onCreate (Bundle savedInstanceState)

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

public void onPause ()

public boolean onQueryTextChange (String newText)

public boolean onQueryTextSubmit (String query)

public void onResume ()

public void prepareOptionsMenu (Menu menu)

public void resetBookmarkListFilter ()

public UserBookmarkDialogFragment setAllowEditing (boolean allowEditing)

Sets if the user bookmark dialog allow modification to existing items

Parameters
allowEditing True if allow modification to existing items
Returns
  • This class

public UserBookmarkDialogFragment setFilePath (String filePath)

Sets the file path. If not specified it is extracted from PDFViewCtrl.

Parameters
filePath The file path
Returns
  • This class

public UserBookmarkDialogFragment setPdfViewCtrl (PDFViewCtrl pdfViewCtrl)

Sets the PDFViewCtrl

Parameters
pdfViewCtrl The PDFViewCtrl
Returns
  • This class

public UserBookmarkDialogFragment setReadOnly (boolean isReadOnly)

Sets if the document is read only

Parameters
isReadOnly True if the document is read only
Returns
  • This class

public void setUserBookmarkListener (UserBookmarkDialogFragment.UserBookmarkDialogListener listener)

Sets the listener to UserBookmarkDialogFragment

Parameters
listener The listener