VerticalScrollBar Example

1
/*
2
 *   Copyright © 2017-2025 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.net.Uri;
13
import androidx.annotation.NonNull;
14
import com.pspdfkit.catalog.R;
15
import com.pspdfkit.catalog.SdkExample;
16
import com.pspdfkit.catalog.examples.java.activities.VerticalScrollbarExampleActivity;
17
import com.pspdfkit.catalog.tasks.ExtractAssetTask;
18
import com.pspdfkit.configuration.activity.PdfActivityConfiguration;
19
import com.pspdfkit.configuration.activity.TabBarHidingMode;
20
import com.pspdfkit.configuration.activity.ThumbnailBarMode;
21
import com.pspdfkit.configuration.page.PageScrollDirection;
22
import com.pspdfkit.configuration.page.PageScrollMode;
23
import com.pspdfkit.ui.PdfActivity;
24
import com.pspdfkit.ui.PdfActivityIntentBuilder;
25
import com.pspdfkit.ui.scrollbar.VerticalScrollBar;
26

27
/**
28
 * This example shows how to use the {@link VerticalScrollBar} widget inside a {@link PdfActivity}.
29
 */
30
public class VerticalScrollbarExample extends SdkExample {
31

32
    public VerticalScrollbarExample(@NonNull final Context context) {
33
        super(context, R.string.verticalScrollbarExampleTitle, R.string.verticalScrollbarExampleDescription);
34
    }
35

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

58
        // We use a custom utility class to extract the example document from the assets.
59
        ExtractAssetTask.extract(WELCOME_DOC, getTitle(), context, documentFile -> {
60
            final Intent intent = PdfActivityIntentBuilder.fromUri(context, Uri.fromFile(documentFile))
61
                    .configuration(configuration.build())
62
                    .activityClass(VerticalScrollbarExampleActivity.class)
63
                    .build();
64

65
            // Start the VerticalScrollbarExampleActivity for the extracted document.
66
            context.startActivity(intent);
67
        });
68
    }
69
}