Section:

Customize the document viewer in Android

DocumentActivity and PdfViewCtrlTabHostFragment2 are highly configurable and can be easily customized using our document viewer configuration classes. UI components can be hidden and functionality can be disabled by initializing the document viewer using ViewerConfig.Builder.

For further customization, PDFViewCtrlConfig allows you to initialize PDFViewCtrl with low-level viewer settings, and ToolManagerBuilder allows you to customize annotation functionality in ToolManager.

Configure Document Viewer

DocumentActivity and PdfViewCtrlTabHostFragment2 can be initialized using ViewerConfig, which can be created with a ViewerConfig.Builder object.

For example:

1// Customize settings in ViewerConfig
2ViewerConfig config = new ViewerConfig.Builder()
3    .fullscreenModeEnabled(true)
4    .multiTabEnabled(true)
5    .documentEditingEnabled(true)
6    .longPressQuickMenuEnabled(true)
7    .showPageNumberIndicator(true)
8    .showBottomNavBar(true)
9    .showThumbnailView(true)
10    .showBookmarksView(true)
11    .toolbarTitle("My Reader")
12    .showSearchView(true)
13    .showShareOption(true)
14    .showDocumentSettingsOption(true)
15    .showAnnotationToolbarOption(true)
16    .showOpenFileOption(true)
17    .showOpenUrlOption(true)
18    .showEditPagesOption(true)
19    .showPrintOption(true)
20    .showCloseTabOption(true)
21    .showAnnotationsList(true)
22    .showOutlineList(true)
23    .showUserBookmarksList(true)
24    .build();
25
26// Initialize your document viewer with a 
27// a ViewerConfig when you open a document
28DocumentActivity.openDocument(context, localFilePath, config);

A full list of settings for ViewerConfig.Builder can be found in the API documentation.

Configure PDFViewCtrl

PDFViewCtrl specific functionality can be configured using PDFViewCtrlConfig. You can then pass the configuration to ViewerConfig to initialize PDFViewCtrl in your document viewer with your specific settings.

For example:

1// Customize settings in PDFViewCtrlConfig
2PDFViewCtrlConfig pdfViewCtrlConfig = PDFViewCtrlConfig.getDefaultConfig(this)
3    .setClientBackgroundColor(Color.YELLOW)
4    .setClientBackgroundColorDark(Color.BLUE)
5    .setHighlightFields(true)
6    .setImageSmoothing(true)
7    .setUrlExtraction(true)
8    .setMaintainZoomEnabled(true);
9
10// Pass the PDFViewCtrlConfig into your ViewerConfig
11// so that it can be used to initialize PDFViewCtrl 
12// in your document viewer
13ViewerConfig.Builder builder = new ViewerConfig.Builder();
14ViewerConfig config = builder
15    .pdfViewCtrlConfig(pdfViewCtrlConfig)
16    // ...
17    .build();

A full list of settings for PDFViewCtrlConfig can be found in the API documentation.

Configure ToolManager

Annotation tool functionality can be configured using ToolManagerBuilder, such as hiding/disabling specific annotation creation tools or disabling the quick menu. You can then pass the configuration to ViewerConfig to initialize ToolManager in your document viewer with your specific settings. Alternatively, you can also modify the style resource for ToolManager directly, and pass it to ViewerConfig.

  • Configure ToolManager by setting ToolManagerBuilder to an instance of ViewerConfig:A full list of settings for ToolManagerBuilder can be found in the API documentation.
1// Customize settings in ToolManagerBuilder
2ToolManagerBuilder toolManagerBuilder = ToolManagerBuilder.from()
3    .setEditFreeTextOnTap(false)
4    .setDisableQuickMenu(true);
5
6// Pass the ToolManagerBuilder into your ViewerConfig
7// so that it can be used to initialize ToolManager
8// in your document viewer
9ViewerConfig.Builder builder = new ViewerConfig.Builder();
10ViewerConfig config = builder
11    .toolManagerBuilder(toolManagerBuilder)
12    // ...
13    .build();
1ViewerConfig.Builder builder = new ViewerConfig.Builder();
2// Pass the XML style resource R.style.MyToolManager to ViewerConfig
3ViewerConfig config = builder
4    .toolManagerBuilderStyleRes(R.style.MyToolManager)
5    // ...
6    .build();

Did you find this helpful?

Trial setup questions?

Ask experts on Discord

Need other help?

Contact Support

Pricing or product questions?

Contact Sales