VerticalScrollBar Example

1
/*
2
 *   Copyright © 2017-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.graphics.PointF;
13
import android.net.Uri;
14
import android.os.Bundle;
15
import android.view.MotionEvent;
16
import androidx.annotation.IntRange;
17
import androidx.annotation.NonNull;
18
import androidx.annotation.Nullable;
19
import androidx.annotation.UiThread;
20
import com.pspdfkit.annotations.Annotation;
21
import com.pspdfkit.catalog.R;
22
import com.pspdfkit.catalog.SdkExample;
23
import com.pspdfkit.catalog.tasks.ExtractAssetTask;
24
import com.pspdfkit.configuration.activity.PdfActivityConfiguration;
25
import com.pspdfkit.configuration.activity.TabBarHidingMode;
26
import com.pspdfkit.configuration.activity.ThumbnailBarMode;
27
import com.pspdfkit.configuration.page.PageScrollDirection;
28
import com.pspdfkit.configuration.page.PageScrollMode;
29
import com.pspdfkit.document.PdfDocument;
30
import com.pspdfkit.ui.PdfActivity;
31
import com.pspdfkit.ui.PdfActivityIntentBuilder;
32
import com.pspdfkit.ui.PdfFragment;
33
import com.pspdfkit.ui.scrollbar.VerticalScrollBar;
34

35
/**
36
 * This example shows how to use the {@link VerticalScrollBar} widget inside a {@link PdfActivity}.
37
 */
38
public class VerticalScrollbarExample extends SdkExample {
39

40
    public VerticalScrollbarExample(@NonNull final Context context) {
41
        super(context, R.string.verticalScrollbarExampleTitle, R.string.verticalScrollbarExampleDescription);
42
    }
43

44
    @Override
45
    public void launchExample(
46
            @NonNull final Context context, @NonNull final PdfActivityConfiguration.Builder configuration) {
47
        configuration
48
                // The example uses its own scrollbar implementation.
49
                .scrollbarsEnabled(false)
50
                // We use a custom layout that removes the thumbnail bar, and instead places the
51
                // vertical scrollbar widget.
52
                .layout(R.layout.custom_scrollbar_activity)
53
                .setThumbnailBarMode(ThumbnailBarMode.THUMBNAIL_BAR_MODE_NONE)
54
                .setTabBarHidingMode(TabBarHidingMode.HIDE)
55
                .documentTitleOverlayEnabled(false)
56
                .navigationButtonsEnabled(false)
57
                // Although the widget also works for horizontal scrolling, we switch to vertical
58
                // continuous scroll mode in this example.
59
                .scrollDirection(PageScrollDirection.VERTICAL)
60
                .scrollMode(PageScrollMode.CONTINUOUS)
61
                // The custom layout has no content editor. In order to prevent the activity from accessing
62
                // it we have to deactivate it in the configuration.
63
                .contentEditingEnabled(false)
64
                .setMeasurementToolsEnabled(false);
65

66
        // We use a custom utility class to extract the example document from the assets.
67
        ExtractAssetTask.extract(WELCOME_DOC, getTitle(), context, documentFile -> {
68
            final Intent intent = PdfActivityIntentBuilder.fromUri(context, Uri.fromFile(documentFile))
69
                    .configuration(configuration.build())
70
                    .activityClass(VerticalScrollbarExampleActivity.class)
71
                    .build();
72

73
            // Start the VerticalScrollbarExampleActivity for the extracted document.
74
            context.startActivity(intent);
75
        });
76
    }
77

78
    /** This activity sets up the {@link VerticalScrollBar} for using it with the loaded document. */
79
    public static class VerticalScrollbarExampleActivity extends PdfActivity {
80

81
        private VerticalScrollBar verticalScrollBar;
82

83
        @Override
84
        protected void onCreate(Bundle savedInstanceState) {
85
            super.onCreate(savedInstanceState);
86

87
            // The scrollbar widget has already been inflated from the layout file defined via the
88
            // configuration.
89
            verticalScrollBar = findViewById(R.id.customScrollbar);
90

91
            // The scrollbar also works for horizontally scrolled documents. We need to manually tell it
92
            // the used scroll direction.
93
            verticalScrollBar.setScrollDirection(
94
                    getConfiguration().getConfiguration().getScrollDirection());
95

96
            // Register the scrollbar widget to receive all scroll events of the PdfFragment.
97
            final PdfFragment fragment = getPdfFragment();
98
            fragment.addDocumentScrollListener(verticalScrollBar);
99

100
            // The scrollbar widget emits page change events (whenever the user drags the scroll
101
            // indicator).
102
            // Use those events to scroll the document inside the fragment.
103
            verticalScrollBar.setOnPageChangeListener(
104
                    (verticalScrollBar, pageIndex) -> fragment.setPageIndex(pageIndex));
105
        }
106

107
        @UiThread
108
        @Override
109
        public void onDocumentLoaded(@NonNull PdfDocument document) {
110
            // Prepare the scrollbar widget: You need to set the controlled document as well as the
111
            // configured scroll direction.
112
            verticalScrollBar.setDocument(document);
113
        }
114

115
        @Override
116
        public boolean onPageClick(
117
                @NonNull PdfDocument document,
118
                @IntRange(from = 0) int pageIndex,
119
                @Nullable MotionEvent event,
120
                @Nullable PointF pagePosition,
121
                @Nullable Annotation clickedAnnotation) {
122
            // If the page was tapped in a blank area, reveal the indicator.
123
            if (clickedAnnotation == null) {
124
                verticalScrollBar.awakenScrollBar();
125
            }
126

127
            // Do not consume the event.
128
            return false;
129
        }
130

131
        @Override
132
        public boolean onDocumentClick() {
133
            // If the document background (where no page is) is tapped, reveal the indicator.
134
            verticalScrollBar.awakenScrollBar();
135

136
            // Do not consume the event.
137
            return false;
138
        }
139
    }
140
}