java.lang.Object
   ↳ DialogFragment
     ↳ com.pdftron.pdf.controls.NavigationListDialogFragment
       ↳ com.pdftron.pdf.controls.OutlineDialogFragment

Class Overview

The OutlineDialogFragment shows a document outline (bookmarks) that can be used to navigate the document in the PDFViewCtrl.

Summary

Nested Classes
interface OutlineDialogFragment.OutlineDialogListener Callback interface to be invoked when an interaction is needed. 
class OutlineDialogFragment.Theme  
Constants
String BUNDLE_CREATE_BUTTON
String BUNDLE_EDITING_ENABLED
String BUNDLE_EDIT_BUTTON
Public Constructors
OutlineDialogFragment()
Public Methods
void enterEditMode()
void exitEditMode(Boolean isOnPause)
String getQueryText()
boolean handleBackPress()
boolean isEditingEnabled()
boolean isEmpty()
boolean moveBookmarkSelected(Bookmark destination)
static OutlineDialogFragment newInstance()
Returns a new instance of the class
static OutlineDialogFragment newInstance(boolean editingEnabled, String editButtonEditTxt, String createButtonEditText)
boolean onClick(TreeNode<BookmarkNode> node, RecyclerView.ViewHolder holder)
called when TreeNodes were clicked.
void onCreate(Bundle savedInstanceState)
View onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState)
void onDestroyView()
void onExpandNode(TreeNode<BookmarkNode> selectedNode, int position)
void onNodeCheckBoxSelected(TreeNode<BookmarkNode> treeNode, RecyclerView.ViewHolder viewHolder)
boolean onOptionsItemSelected(MenuItem item)
void onPause()
boolean onQueryTextChange(String newText)
boolean onQueryTextSubmit(String query)
void onResume()
void onStartDrag(TreeNode<BookmarkNode> treeNode, int position, RecyclerView.ViewHolder viewHolder)
void onToggle(boolean isExpand, RecyclerView.ViewHolder holder)
called when TreeNodes were toggle.
void onViewCreated(View view, Bundle savedInstanceState)
void prepareOutlineSearch(Menu menu)
void resetBookmarkListFilter()
OutlineDialogFragment setCurrentBookmark(Bookmark currentBookmark)
Sets the current bookmark.
void setEditButtonText(String editBtnText, String createButtonTxt)
void setOutlineDialogListener(OutlineDialogFragment.OutlineDialogListener listener)
Sets the OutlineDialogListener listener.
OutlineDialogFragment setPdfViewCtrl(PDFViewCtrl pdfViewCtrl)
Sets the PDFViewCtrl
[Expand]
Inherited Methods
From class com.pdftron.pdf.controls.NavigationListDialogFragment
From class java.lang.Object
From interface com.pdftron.recyclertreeview.BookmarkNodeBinder.BookmarkNodeClickListener
From interface com.pdftron.recyclertreeview.EditOutlineMoveDialog.EditOutlineMoveClickListener
From interface com.pdftron.recyclertreeview.OutlineTreeViewAdapter.OnBookmarkTreeNodeListener

Constants

public static final String BUNDLE_CREATE_BUTTON

Constant Value: "OutlineDialogFragment_create_button"

public static final String BUNDLE_EDITING_ENABLED

Constant Value: "OutlineDialogFragment_editing_enabled"

public static final String BUNDLE_EDIT_BUTTON

Constant Value: "OutlineDialogFragment_edit_button"

Public Constructors

public OutlineDialogFragment ()

Public Methods

public void enterEditMode ()

public void exitEditMode (Boolean isOnPause)

public String getQueryText ()

public boolean handleBackPress ()

public boolean isEditingEnabled ()

public boolean isEmpty ()

public boolean moveBookmarkSelected (Bookmark destination)

public static OutlineDialogFragment newInstance ()

Returns a new instance of the class

public static OutlineDialogFragment newInstance (boolean editingEnabled, String editButtonEditTxt, String createButtonEditText)

public boolean onClick (TreeNode<BookmarkNode> node, RecyclerView.ViewHolder holder)

called when TreeNodes were clicked.

Returns
  • weather consume the click event.

public void onCreate (Bundle savedInstanceState)

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

public void onDestroyView ()

public void onExpandNode (TreeNode<BookmarkNode> selectedNode, int position)

public void onNodeCheckBoxSelected (TreeNode<BookmarkNode> treeNode, RecyclerView.ViewHolder viewHolder)

public boolean onOptionsItemSelected (MenuItem item)

public void onPause ()

public boolean onQueryTextChange (String newText)

public boolean onQueryTextSubmit (String query)

public void onResume ()

public void onStartDrag (TreeNode<BookmarkNode> treeNode, int position, RecyclerView.ViewHolder viewHolder)

public void onToggle (boolean isExpand, RecyclerView.ViewHolder holder)

called when TreeNodes were toggle.

Parameters
isExpand the status of TreeNodes after being toggled.

public void onViewCreated (View view, Bundle savedInstanceState)

public void prepareOutlineSearch (Menu menu)

public void resetBookmarkListFilter ()

public OutlineDialogFragment setCurrentBookmark (Bookmark currentBookmark)

Sets the current bookmark.

Parameters
currentBookmark The current bookmark
Returns
  • This class

public void setEditButtonText (String editBtnText, String createButtonTxt)

public void setOutlineDialogListener (OutlineDialogFragment.OutlineDialogListener listener)

Sets the OutlineDialogListener listener.

Parameters
listener The listener

public OutlineDialogFragment setPdfViewCtrl (PDFViewCtrl pdfViewCtrl)

Sets the PDFViewCtrl

Parameters
pdfViewCtrl The PDFViewCtrl
Returns
  • This class