Skip to content
ComPDF
Guides

Annotation List (BOTA)

The BOTA (Book of Annotations) panel provides three tabs: outline, bookmarks, and annotation list. The annotation list displays summary information for all annotations in the document, supporting browsing, navigation, replies, and batch operations.

BOTA Tab Configuration

Control the tabs displayed in the BOTA panel via global.bota.tabs:

json
{
  "global": {
    "bota": {
      "tabs": ["outline", "bookmark", "annotations"]
    }
  }
}
ValueDescription
outlineDocument outline / table of contents
bookmarkBookmarks
annotationsAnnotation list

To show only the annotation list:

json
{
  "global": {
    "bota": {
      "tabs": ["annotations"]
    }
  }
}

Annotation List Menu Configuration

Configure annotation list menus via global.bota.menus.annotations.

The global menu is located at the top of the annotation list and applies to the entire list:

json
{
  "global": {
    "bota": {
      "menus": {
        "annotations": {
          "global": [
            { "id": "importAnnotation" },
            { "id": "exportAnnotation" },
            { "id": "removeAllAnnotation" },
            { "id": "removeAllReply" }
          ]
        }
      }
    }
  }
}
idDescription
importAnnotationImport annotations in XFDF format
exportAnnotationExport annotations in XFDF format
removeAllAnnotationRemove all annotations
removeAllReplyRemove all annotation replies

Item Menu

The item menu applies to individual annotation entries, shown on long press of an annotation item:

json
{
  "global": {
    "bota": {
      "menus": {
        "annotations": {
          "item": [
            {
              "id": "reviewStatus",
              "subMenus": ["accepted", "rejected", "cancelled", "completed", "none"]
            },
            { "id": "markedStatus" },
            {
              "id": "more",
              "subMenus": ["addReply", "viewReply", "delete"]
            }
          ]
        }
      }
    }
  }
}
idDescription
reviewStatusReview status, with sub-menus: accepted, rejected, cancelled, completed, none
markedStatusToggle marked status
moreMore actions, with sub-menus: addReply (add reply), viewReply (view replies), delete (delete annotation)

Core Components

CPDFAnnotationListFragment

The main Fragment for the annotation list, located in the com.compdfkit.tools.annotation.pdfannotationlist package.

Features include:

  • Display all annotations grouped by page number
  • Show annotation type icon, content summary, author, and timestamp
  • Click an annotation entry to navigate to its location in the document
  • Support for review status and marked status settings

Annotation Replies

The annotation list supports adding and viewing replies to annotations:

ComponentDescription
CPDFEditReplyDialogFragmentDialog for editing reply content
CPDFReplyDetailsDialogFragmentDialog for viewing reply details
CPDFAnnotReplyListAdapterReply list adapter
CMarkedTipsWindowMarked status tip window

BOTA Panel Components

ComponentDescription
CPDFBotaDialogFragmentBOTA panel dialog
CPDFBotaFragmentTabsTab container
CPDFBookmarkFragmentBookmark list (viewer package)
CPDFOutlineFragmentOutline/TOC list (viewer package)