public class

AnnotationDialogFragment

extends NavigationListDialogFragment
implements BookmarksDialogFragment.IBookmarksDialogSearchView
java.lang.Object
   ↳ DialogFragment
     ↳ com.pdftron.pdf.controls.NavigationListDialogFragment
       ↳ com.pdftron.pdf.controls.AnnotationDialogFragment
Known Direct Subclasses

Class Overview

The AnnotationDialogFragment shows a list of all the annotations in a document being viewed by a PDFViewCtrl. The list will contain any comments that have been added to the annotations and clicking on an annotation will show it in the PDFViewCtrl.

Summary

Nested Classes
interface AnnotationDialogFragment.AnnotationDialogListener Callback interface to be invoked when an interaction is needed. 
class AnnotationDialogFragment.AnnotationInfo Annotation Info class. 
Constants
String BUNDLE_ANNOTATION_FILTER_ICON
String BUNDLE_ANNOTATION_TYPE_EXCLUDE_LIST
String BUNDLE_ENABLE_ANNOTATION_FILTER
String BUNDLE_EXPORT_BUTTON_SPANNABLE_STRING
String BUNDLE_IS_READ_ONLY Bundle key to specify whether the document is read only or not
String BUNDLE_IS_RTL
String BUNDLE_KEY_SORT_MODE
Public Constructors
AnnotationDialogFragment()
Public Methods
void finishSearchView()
int getAnnotationFilterIcon()
Gets the icon for annotation filter
String getQueryText()
boolean handleBackPress()
void initOptionsMenu(Menu menu)
boolean isAnnotationFilterEnabled()
boolean isFilterOn()
static Bundle newBundle(boolean isReadOnly, boolean isRtl, AnnotationListSortOrder annotationListSortOrder)
Creates a bundle containing arguments for AnnotationDialogFragment
static AnnotationDialogFragment newInstance()
Creates a default instance of AnnotationDialogFragment.
static AnnotationDialogFragment newInstance(boolean isReadOnly, boolean isRtl, AnnotationListSortOrder annotationListSortOrder)
Creates an instance of AnnotationDialogFragment, with specified settings.
void onCreate(Bundle savedInstanceState)
void onDestroyView()
boolean onOptionsItemSelected(MenuItem item)
void onPause()
boolean onQueryTextChange(String newText)
boolean onQueryTextSubmit(String query)
void prepareOptionsMenu(Menu menu)
void refreshAnnotationList()
void resetAnnotationListSearchFilter()
void setAnnotationDialogListener(AnnotationDialogFragment.AnnotationDialogListener listener)
Sets the listener to AnnotationDialogFragment.AnnotationDialogListener
void setAnnotationExportButtonText(CharSequence title)
Sets the title for annotation export button
void setAnnotationFilterIcon(int iconRes)
Sets the icon for annotation filter
AnnotationDialogFragment setPdfViewCtrl(PDFViewCtrl pdfViewCtrl)
Sets the PDFViewCtrl
AnnotationDialogFragment setReadOnly(boolean isReadOnly)
Sets if the document is read only
AnnotationDialogFragment setRtlMode(boolean isRtl)
Sets if the document is right-to-left
void updateAnnotationVisibility()
void updateAnnotationVisibilityInfo(List<AnnotationDialogFragment.AnnotationInfo> annotationInfos)
Updates visible of annotations in PDFViewCtrl based on annotation list filter state
[Expand]
Inherited Methods
From class com.pdftron.pdf.controls.NavigationListDialogFragment
From class java.lang.Object
From interface com.pdftron.pdf.dialog.BookmarksDialogFragment.IBookmarksDialogSearchView

Constants

public static final String BUNDLE_ANNOTATION_FILTER_ICON

Constant Value: "annotation_filter_icon"

public static final String BUNDLE_ANNOTATION_TYPE_EXCLUDE_LIST

Constant Value: "annotation_type_exclude_list"

public static final String BUNDLE_ENABLE_ANNOTATION_FILTER

Constant Value: "enable_annotation_filter"

public static final String BUNDLE_EXPORT_BUTTON_SPANNABLE_STRING

Constant Value: "annotation_export_button_spannable_string"

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 static final String BUNDLE_IS_RTL

Constant Value: "is_right_to_left"

public static final String BUNDLE_KEY_SORT_MODE

Constant Value: "sort_mode_as_int"

Public Constructors

public AnnotationDialogFragment ()

Public Methods

public void finishSearchView ()

public int getAnnotationFilterIcon ()

Gets the icon for annotation filter

public String getQueryText ()

public boolean handleBackPress ()

public void initOptionsMenu (Menu menu)

public boolean isAnnotationFilterEnabled ()

public boolean isFilterOn ()

public static Bundle newBundle (boolean isReadOnly, boolean isRtl, AnnotationListSortOrder annotationListSortOrder)

Creates a bundle containing arguments for AnnotationDialogFragment

Parameters
isReadOnly true if the annotation list should be read only (default false)
isRtl true if the the annotations are displayed right-to-left (default false)
annotationListSortOrder sorting order of the annotations
Returns

public static AnnotationDialogFragment newInstance ()

Creates a default instance of AnnotationDialogFragment.

Returns
  • a new default instance of this class

public static AnnotationDialogFragment newInstance (boolean isReadOnly, boolean isRtl, AnnotationListSortOrder annotationListSortOrder)

Creates an instance of AnnotationDialogFragment, with specified settings.

Parameters
isReadOnly true if the annotation list should be read only (default false)
isRtl true if the the annotations are displayed right-to-left (default false)
annotationListSortOrder sorting order of the annotations
Returns
  • a new instance of this class with specified settings.

public void onCreate (Bundle savedInstanceState)

public void onDestroyView ()

public boolean onOptionsItemSelected (MenuItem item)

public void onPause ()

public boolean onQueryTextChange (String newText)

public boolean onQueryTextSubmit (String query)

public void prepareOptionsMenu (Menu menu)

public void refreshAnnotationList ()

public void resetAnnotationListSearchFilter ()

public void setAnnotationDialogListener (AnnotationDialogFragment.AnnotationDialogListener listener)

Sets the listener to AnnotationDialogFragment.AnnotationDialogListener

Parameters
listener The listener

public void setAnnotationExportButtonText (CharSequence title)

Sets the title for annotation export button

public void setAnnotationFilterIcon (int iconRes)

Sets the icon for annotation filter

public AnnotationDialogFragment setPdfViewCtrl (PDFViewCtrl pdfViewCtrl)

Sets the PDFViewCtrl

Parameters
pdfViewCtrl The PDFViewCtrl
Returns
  • This class

public AnnotationDialogFragment setReadOnly (boolean isReadOnly)

Sets if the document is read only

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

public AnnotationDialogFragment setRtlMode (boolean isRtl)

Sets if the document is right-to-left

Parameters
isRtl True if the document is right-to-left
Returns
  • This class

public void updateAnnotationVisibility ()

public void updateAnnotationVisibilityInfo (List<AnnotationDialogFragment.AnnotationInfo> annotationInfos)

Updates visible of annotations in PDFViewCtrl based on annotation list filter state