Display & customize list container in Android

The list container provides a horizontal layout to display the following items in separate tabs:

• Annotation list
• Document outline
• User-defined bookmark list

Show list container

The list container is implemented by the BookmarksDialogFragment class. To show this fragment in your activity, create a new instance of BookmarksDialogFragment by calling newInstance(). Afterwards, initialize your fragment by setting the PDFViewCtrl and an ArrayList of DialogFragmentTab:

Java

private PDFViewCtrl mPdfViewCtrl;
// ...
public void showBookmarksDialog(ArrayList<DialogFragmentTab> dialogFragmentTabs,
                                FragmentManager fragmentManager) {
    BookmarksDialogFragment fragment = BookmarksDialogFragment.newInstance();
    fragment.setPdfViewCtrl(mPdfViewCtrl)
            .setDialogFragmentTabs(dialogFragmentTabs);
    // Set a custom style for this fragment
    fragment.setStyle(DialogFragment.STYLE_NO_TITLE, R.style.PDFTronAppTheme);
    // Show the dialog
    fragment.show(fragmentManager, "bookmarks_dialog");
}

Kotlin

private var mPdfViewCtrl: PDFViewCtrl? = null
// ...
fun showBookmarksDialog(dialogFragmentTabs: ArrayList<DialogFragmentTab>,
                        fragmentManager: FragmentManager) {
    val fragment = BookmarksDialogFragment.newInstance()
    fragment.setPdfViewCtrl(mPdfViewCtrl!!)
            .setDialogFragmentTabs(dialogFragmentTabs)
    // Set a custom style for this fragment
    fragment.setStyle(DialogFragment.STYLE_NO_TITLE, R.style.PDFTronAppTheme)
    // Show the dialog
    fragment.show(fragmentManager, "bookmarks_dialog")
}

DialogFragmentTab specifies the information about each tab including the type of class and the tab tag. You can create an instance of DialogFragmentTab using [DialogFragmentTab(Class<?>, String)](https://sdk.apryse.com/api/android/javadoc/reference/com/pdftron/pdf/utils/DialogFragmentTab.html#DialogFragmentTab(java.lang.Class<?>, java.lang.String)). Currently the following dialogs can be displayed within the bookmarks dialog:

Dialog	Type of class	Tab tag
Annotation list	AnnotationDialogFragment.class	TAG_TAB_ANNOTATION
Document outline	OutlineDialogFragment.class	TAG_TAB_OUTLINE
User bookmark list	UserBookmarkDialogFragment.class	TAG_TAB_BOOKMARK

The following example shows how to display an annotations list, a document outline, and a user-defined bookmark list tabs in BookmarksDialogFragment:

Java

BookmarksDialogFragment showBookmarksDialog(FragmentManager fragmentManager, PDFViewCtrl pdfViewCtrl) {
    DialogFragmentTab annotationsDialog = new DialogFragmentTab(
        AnnotationDialogFragment.class,
        BookmarksTabLayout.TAG_TAB_ANNOTATION,
        null,
        "Annotations",
        "Bookmarks Dialog",
        null);
    DialogFragmentTab outlineDialog = new DialogFragmentTab(
        UserBookmarkDialogFragment.class,
        BookmarksTabLayout.TAG_TAB_OUTLINE,
        null,
        "Outline",
        "Bookmarks Dialog",
        null);
    DialogFragmentTab userBookmarksDialog = new DialogFragmentTab(
        UserBookmarkDialogFragment.class,
        BookmarksTabLayout.TAG_TAB_BOOKMARK,
        null,
        "User Bookmarks",
        "Bookmarks Dialog",
        null);
    ArrayList<DialogFragmentTab> dialogFragmentTabs = new ArrayList<>();
    dialogFragmentTabs.add(annotationsDialog);
    dialogFragmentTabs.add(outlineDialog);
    dialogFragmentTabs.add(userBookmarksDialog);
    BookmarksDialogFragment bookmarksDialog = BookmarksDialogFragment.newInstance();
    bookmarksDialog.setPdfViewCtrl(pdfViewCtrl)
        .setDialogFragmentTabs(dialogFragmentTabs);
    bookmarksDialog.setBookmarksDialogListener(this)
    bookmarksDialog.setBookmarksTabsListener(this);
    bookmarksDialog.setStyle(DialogFragment.STYLE_NO_TITLE, R.style.PDFTronAppTheme);   
    bookmarksDialog.show(fragmentManager, "bookmarks_dialog");
    return bookmarksDialog;
}

@Override
public void onBookmarksDialogDismissed(int tabIndex) {
    // the bookmarks dialog was dismissed
}

@Override
public void onUserBookmarkClick(int pageNum) {
    // a user bookmark was clicked
}

@Override
public void onOutlineClicked(Bookmark parent, Bookmark bookmark) {
    // an outline was clicked
}

@Override
public void onAnnotationClicked(Annot annotation, int pageNum) {
    // an annotation was clicked
}

@Override
public void onExportAnnotationsClicked() {
    // the export annotation button was clicked
}

Kotlin

fun showBookmarksDialog(fragmentManager: FragmentManager, pdfViewCtrl: PDFViewCtrl): BookmarksDialogFragment {
    val annotationsDialog = DialogFragmentTab(
        AnnotationDialogFragment::class.java!!,
        BookmarksTabLayout.TAG_TAB_ANNOTATION,
        null,
        "Annotations",
        "Bookmarks Dialog", null)
    val outlineDialog = DialogFragmentTab(
        UserBookmarkDialogFragment::class.java!!,
        BookmarksTabLayout.TAG_TAB_OUTLINE, null,
        "Outline",
        "Bookmarks Dialog", null)
    val userBookmarksDialog = DialogFragmentTab(
        UserBookmarkDialogFragment::class.java!!,
        BookmarksTabLayout.TAG_TAB_BOOKMARK, null,
        "User Bookmarks",
        "Bookmarks Dialog", null)
    val dialogFragmentTabs = ArrayList<DialogFragmentTab>()
    dialogFragmentTabs.add(annotationsDialog)
    dialogFragmentTabs.add(outlineDialog)
    dialogFragmentTabs.add(userBookmarksDialog)
    val bookmarksDialog = BookmarksDialogFragment.newInstance()
    bookmarksDialog.setPdfViewCtrl(pdfViewCtrl)
                   .setDialogFragmentTabs(dialogFragmentTabs)
    bookmarksDialog.setBookmarksDialogListener(this)
    bookmarksDialog.setBookmarksTabsListener(this)
    bookmarksDialog.setStyle(DialogFragment.STYLE_NO_TITLE, R.style.PDFTronAppTheme)
    bookmarksDialog.show(fragmentManager, "bookmarks_dialog")
    return bookmarksDialog
}

override fun onBookmarksDialogDismissed(tabIndex: Int) {
    // the bookmarks dialog was dismissed
}

override fun onUserBookmarkClick(pageNum: Int) {
    // a user bookmark was clicked
}

override fun onOutlineClicked(parent: Bookmark, bookmark: Bookmark) {
    // an outline was clicked
}

override fun onAnnotationClicked(annotation: Annot, pageNum: Int) {
    // an annotation was clicked
}

fun onExportAnnotationsClicked() {
    // the export annotation button was clicked
}

Customization

The BookmarksDialogFragment provides a flexible API for displaying only the desired child view. Any of the annotation list, document outline, or user-defined bookmark list view can be removed by omitting them from the DialogFragmentTabs.