Document Switcher

1
/*
2
 *   Copyright © 2014-2026 PSPDFKit GmbH. All rights reserved.
3
 *
4
 *   The PSPDFKit Sample applications are licensed with a modified BSD license.
5
 *   Please see License for details. This notice may not be removed from this file.
6
 */
7

8
package com.pspdfkit.catalog.examples.java;
9

10
import android.content.Context;
11
import android.content.Intent;
12
import android.os.Bundle;
13
import android.widget.ArrayAdapter;
14
import android.widget.ListView;
15
import androidx.annotation.NonNull;
16
import androidx.drawerlayout.widget.DrawerLayout;
17
import com.pspdfkit.catalog.R;
18
import com.pspdfkit.catalog.SdkExample;
19
import com.pspdfkit.compose.toolbar.state.ToolbarIcon;
20
import com.pspdfkit.compose.toolbar.state.ToolbarItem;
21
import com.pspdfkit.compose.toolbar.state.ToolbarItemState;
22
import com.pspdfkit.configuration.activity.PdfActivityConfiguration;
23
import com.pspdfkit.configuration.activity.TabBarHidingMode;
24
import com.pspdfkit.document.DocumentSource;
25
import com.pspdfkit.document.providers.AssetDataProvider;
26
import com.pspdfkit.ui.DocumentDescriptor;
27
import com.pspdfkit.ui.PdfActivity;
28
import com.pspdfkit.ui.PdfActivityIntentBuilder;
29
import java.util.ArrayList;
30
import java.util.List;
31

32
/**
33
 * This example extends the default `PdfActivity` and adds a side navigation drawer that allows to
34
 * switch between documents without leaving the activity.
35
 */
36
public class DocumentSwitcherExample extends SdkExample {
37

38
    public DocumentSwitcherExample(Context context) {
39
        super(context, R.string.documentSwitcherExampleTitle, R.string.documentSwitcherExampleDescription);
40
    }
41

42
    @Override
43
    public void launchExample(
44
            @NonNull final Context context, @NonNull final PdfActivityConfiguration.Builder configuration) {
45
        // Use a custom activity and a custom PdfActivity subclass.
46
        configuration
47
                .hideUserInterfaceWhenCreatingAnnotations(false)
48
                // Disable tab bar - example displays list of documents in a drawer instead.
49
                .setTabBarHidingMode(TabBarHidingMode.HIDE)
50
                // The custom layout has no content editor. In order to prevent the activity from accessing
51
                // it we have to deactivate it in the configuration.
52
                .contentEditingEnabled(false)
53
                .layout(R.layout.activity_document_switcher);
54

55
        // Launch the custom example activity using the (read-only) document from assets and
56
        // configuration.
57
        final Intent intent = PdfActivityIntentBuilder.fromDataProvider(context, new AssetDataProvider(WELCOME_DOC))
58
                .configuration(configuration.build())
59
                .activityClass(DocumentSwitcherActivity.class)
60
                .build();
61
        context.startActivity(intent);
62
    }
63

64
    /**
65
     * This example activity adds a navigation drawer menu to the default {@link PdfActivity} which
66
     * allows to navigate between different documents within the same activity.
67
     */
68
    public static class DocumentSwitcherActivity extends PdfActivity {
69

70
        /** List of documents presented in the navigation menu */
71
        private static final String[] assetFiles =
72
                new String[] {SdkExample.WELCOME_DOC, "Classbook.pdf", "Aviation.pdf", "Annotations.pdf"};
73

74
        private DrawerLayout drawerLayout;
75
        private ListView drawerListView;
76

77
        @SuppressWarnings("ConstantConditions")
78
        @Override
79
        public void onCreate(Bundle savedInstanceState) {
80
            super.onCreate(savedInstanceState);
81

82
            // Extract the drawer views from the layout.
83
            drawerLayout = findViewById(R.id.drawerLayout);
84
            drawerListView = findViewById(R.id.drawerListView);
85

86
            // We create a list of documents that can be loaded by this example. In a real-word scenario
87
            // this list would
88
            // probably be dynamic.
89
            drawerListView.setAdapter(new ArrayAdapter<>(this, android.R.layout.simple_list_item_1, assetFiles));
90
            drawerListView.setOnItemClickListener((parent, view, position, id) -> {
91
                // Get the name of the clicked asset file.
92
                final String assetName = (String) parent.getItemAtPosition(position);
93

94
                // Create document source for the document from assets.
95
                DocumentSource documentSource = new DocumentSource(new AssetDataProvider(assetName));
96

97
                // Search for document with the same source in the document coordinator.
98
                for (DocumentDescriptor documentDescriptor :
99
                        getDocumentCoordinator().getDocuments()) {
100
                    if (documentDescriptor.getDocumentSource().getUid().equals(documentSource.getUid())) {
101
                        // Show existing document immediately.
102
                        showDocument(documentDescriptor);
103
                        return;
104
                    }
105
                }
106

107
                // Document was not found in the document coordinator - create it manually
108
                // before showing.
109
                DocumentDescriptor documentDescriptor = DocumentDescriptor.fromDocumentSource(documentSource);
110
                if (getDocumentCoordinator().addDocument(documentDescriptor)) {
111
                    showDocument(documentDescriptor);
112
                }
113
            });
114

115
            // The main toolbar is Compose now: instead of setting a navigation icon on the legacy
116
            // AppCompat Toolbar, declare a drawer item pinned to the toolbar's leading edge via the
117
            // toolbar items provider. The icon picks up the toolbar's icon tint automatically.
118
            setToolbarItemsProvider(defaultItems -> {
119
                final List<ToolbarItem> items = new ArrayList<>(defaultItems.size() + 1);
120
                items.add(new ToolbarItem.Button(
121
                        "catalog.document_switcher.drawer",
122
                        R.id.document_switcher_drawer,
123
                        "Open document list",
124
                        new ToolbarIcon.Resource(R.drawable.ic_drawer_menu),
125
                        new ToolbarItemState(),
126
                        ToolbarItem.ItemEdge.Start,
127
                        ToolbarItem.OverflowBehavior.AlwaysShow));
128
                items.addAll(defaultItems);
129
                return items;
130
            });
131

132
            // Toggle the drawer when the item is tapped; everything else keeps the SDK handling.
133
            setOnToolbarItemClickListener(id -> {
134
                if (id == R.id.document_switcher_drawer) {
135
                    if (drawerLayout.isDrawerOpen(drawerListView)) {
136
                        drawerLayout.closeDrawer(drawerListView);
137
                    } else {
138
                        drawerLayout.openDrawer(drawerListView);
139
                    }
140
                    return true;
141
                }
142
                return false;
143
            });
144
        }
145

146
        private void showDocument(@NonNull final DocumentDescriptor visibleItem) {
147
            // Close the drawer.
148
            drawerLayout.closeDrawer(drawerListView, false);
149
            // Show the visible document.
150
            getDocumentCoordinator().setVisibleDocument(visibleItem);
151
        }
152
    }
153
}