Section:

Customize the Document Viewer UI

Customize the theme

The theme of PdfViewCtrlTabHostFragment2 can be set by calling the following method when creating the fragment using ViewerBuilder2:

1// Add a viewer fragment to the layout container in the specified 
2// activity, and returns the added fragment
3public PdfViewCtrlTabHostFragment2 addViewerFragment(
4        @IdRes int fragmentContainer,
5        @NonNull AppCompatActivity activity, 
6        @NonNull Uri fileUri, 
7        @Nullable String password,
8        @StyleRes int customTheme) {
9
10    // Create the viewer fragment
11    PdfViewCtrlTabHostFragment2 fragment =
12            ViewerBuilder2.withUri(fileUri, password)
13                    // Add custom theme here
14                    .usingTheme(customTheme)
15                    .build(activity);
16
17    // Add the fragment to the layout fragment container
18    activity.getSupportFragmentManager().beginTransaction()
19            .replace(fragmentContainer, fragment)
20            .commit();
21
22    return fragment;
23}

Theme supplied to ViewerBuilder2.usingTheme(int) is recommended to extend PDFTronAppThemeBase. If you cannot extend PDFTronAppThemeBase and is extending an AppCompat theme, then you will need to define custom theme attributes for the theme to work properly. Custom attributes are listed in the table below. PDFTronAppThemeBase contains a number of attributes which can be used to define the style for certain UI components. A full list of theme attributes can be found below:

Attribute

Description

pt_toolbar_theme

Used to style the options menu toolbar. See ToolbarTheme.

pt_toolbar_popup_style

Used to style the popup menu in the toolbar. See ToolbarPopupTheme.

pt_toolbar_style

Used to style the options menu toolbar background. See ToolbarStyle.

quick_menu_item

Used to style the quick menu. See QuickMenuItem.

custom_bookmarks_tab_layout

Used to style the outline/user bookmark/annotation list dialog. See BookmarksTabLayoutStyle.

pt_stamp_tab_layout_style

Used to style the stamp dialog tab layout. See StampTabLayoutStyle.

pt_bottom_bar_style

Used to style the bottom navigation bar. See PTBottomBarTheme.

pt_preset_bar_style

Used to style the annotation preset bar. See PTPresetBarTheme.

pt_annotation_toolbar_style

Used to style the annotation toolbar. See PTAnnotationToolbarTheme.

pt_toolbar_switcher_dialog_style

Used to style the toolbar switcher popup dialog. See PTToolbarSwitcherDialogTheme.

pt_toolbar_switcher_button_style

Used to style the toolbar switcher menu button. See PTToolbarSwitcherButtonTheme .

pt_toolbar_tab_action_button_style

Used to style the tab action button. See TabActionButtonTheme .

pt_document_slider_style

Used to style the page slider. See DocumentSliderStyle.

pt_pdf_tab_layout_style

Used to style the document tabs. See PdfTabLayoutStyle.

pt_floating_nav_style

Used to style the floating action buttons. See DefaultFloatingButtonNavStyle.

pt_sound_dialog_style

Used to style the sound annotation dialog. See SoundDialogStyle.

pt_page_indicator_style

Used to style the page indicator. See PageIndicatorTheme.

pt_sticky_note_dialog

Used to style the sticky note dialog. See DialogStickyNote.

pt_create_signature_dialog_style

Used to style the signature creation dialog. See CreateSignatureDialogTheme.

pt_menu_editor_dialog_style

Used to style the toolbar editor dialog. See MenuEditorDialogTheme.

pt_annot_style_dialog_style

Used to style the annotation style dialog. See AnnotStyleDialogTheme.

pt_annotation_filter_dialog_style

Used to style the annotation filter dialog. See AnnotationFilterDialogTheme.

pt_create_stamp_dialog_style

Used to style the stamp creation dialog. See CreateStampDialogTheme.

pt_add_page_dialog_style

Used to style the add page dialog. See AddPageDialogTheme.

pt_tab_switcher_dialog_style

Used to style the tab switcher dialog. See TabSwitcherDialogTheme.

pt_outline_dialog_style

Used to style the outline dialog. See OutlineDialogTheme

A full list of attributes can be found in the styles.xml file in the Apryse Android SDK Tools package.

Customizing the default annotation toolbars

The built-in default toolbars can be customized using the ViewerConfig and ToolManagerBuilder classes. To hide a specific toolbar, call ViewerConfig.Builder.hideToolbars(String[]) with the toolbar's tag. For example to hide the annotate toolbar:

1ViewerConfig.Builder builder = new ViewerConfig.Builder()
2        .hideToolbars(
3                new String[]{
4                        DefaultToolbars.TAG_ANNOTATE_TOOLBAR
5                }
6        );

Hide annotation toolbar buttons

To hide certain tool buttons, you can disable tool modes using ToolManagerBuilder as described in this guide.

Customize the options toolbar

The options toolbar can be customized using a similar method as described in this guide, however the ViewerBuilder2 class will be used instead of ViewerBuilder.

Did you find this helpful?

Trial setup questions?

Ask experts on Discord

Need other help?

Contact Support

Pricing or product questions?

Contact Sales