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.content.res.TypedArray;
13
import android.os.Bundle;
14
import android.view.MenuItem;
15
import android.widget.ArrayAdapter;
16
import android.widget.ListView;
17
import androidx.annotation.NonNull;
18
import androidx.appcompat.graphics.drawable.DrawerArrowDrawable;
19
import androidx.appcompat.widget.Toolbar;
20
import androidx.core.content.ContextCompat;
21
import androidx.drawerlayout.widget.DrawerLayout;
22
import com.pspdfkit.catalog.R;
23
import com.pspdfkit.catalog.SdkExample;
24
import com.pspdfkit.configuration.activity.PdfActivityConfiguration;
25
import com.pspdfkit.configuration.activity.TabBarHidingMode;
26
import com.pspdfkit.document.DocumentSource;
27
import com.pspdfkit.document.providers.AssetDataProvider;
28
import com.pspdfkit.ui.DocumentDescriptor;
29
import com.pspdfkit.ui.PdfActivity;
30
import com.pspdfkit.ui.PdfActivityIntentBuilder;
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
        protected 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
            // Setup the navigation drawer menu icon.
116
            final DrawerArrowDrawable drawerDrawable = new DrawerArrowDrawable(this);
117

118
            // We want to use the same color as the main toolbar items are tinted.
119
            final TypedArray a = getTheme()
120
                    .obtainStyledAttributes(
121
                            null,
122
                            com.pspdfkit.R.styleable.pspdf__ActionBarIcons,
123
                            com.pspdfkit.R.attr.pspdf__actionBarIconsStyle,
124
                            com.pspdfkit.R.style.PSPDFKit_ActionBarIcons);
125
            int toolbarIconsColor = a.getColor(
126
                    com.pspdfkit.R.styleable.pspdf__ActionBarIcons_pspdf__iconsColor,
127
                    ContextCompat.getColor(this, com.pspdfkit.R.color.pspdf__onPrimaryLight));
128
            a.recycle();
129

130
            drawerDrawable.setColor(toolbarIconsColor);
131

132
            // Get toolbar and set navigation icon directly
133
            final Toolbar toolbar = findViewById(com.pspdfkit.R.id.pspdf__toolbar_main);
134
            if (toolbar != null) {
135
                toolbar.setNavigationIcon(drawerDrawable);
136
            }
137
        }
138

139
        /**
140
         * If the user presses the navigation drawer icon, we toggle the drawer visibility. Otherwise we
141
         * pass the event on to the default implementation.
142
         */
143
        @Override
144
        public boolean onOptionsItemSelected(@NonNull MenuItem item) {
145
            if (item.getItemId() == android.R.id.home) {
146
                if (drawerLayout.isDrawerOpen(drawerListView)) {
147
                    drawerLayout.closeDrawer(drawerListView);
148
                } else {
149
                    drawerLayout.openDrawer(drawerListView);
150
                }
151

152
                return true;
153
            }
154

155
            return super.onOptionsItemSelected(item);
156
        }
157

158
        private void showDocument(@NonNull final DocumentDescriptor visibleItem) {
159
            // Close the drawer.
160
            drawerLayout.closeDrawer(drawerListView, false);
161
            // Show the visible document.
162
            getDocumentCoordinator().setVisibleDocument(visibleItem);
163
        }
164
    }
165
}