Thumbnail Bar Modes

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.kotlin
9

10
import android.content.Context
11
import android.net.Uri
12
import android.os.Bundle
13
import android.view.Menu
14
import android.view.MenuItem
15
import com.pspdfkit.catalog.R
16
import com.pspdfkit.catalog.SdkExample
17
import com.pspdfkit.catalog.tasks.ExtractAssetTask
18
import com.pspdfkit.configuration.activity.PdfActivityConfiguration
19
import com.pspdfkit.configuration.activity.ThumbnailBarMode
20
import com.pspdfkit.listeners.scrolling.ScrollState
21
import com.pspdfkit.ui.PdfActivity
22
import com.pspdfkit.ui.PdfActivityIntentBuilder
23
import com.pspdfkit.ui.PdfThumbnailBar
24
import com.pspdfkit.utils.PdfLog
25

26
/**
27
 * This example demonstrates different thumbnail bar modes available in the SDK.
28
 * It allows toggling between Floating, Pinned, Scrollable, and None modes via the options menu.
29
 */
30
class ThumbnailBarExample(context: Context) :
31
    SdkExample(
32
        context,
33
        R.string.thumbnailBarExampleTitle,
34
        R.string.thumbnailBarExampleDescription,
35
    ) {
36
    override fun launchExample(context: Context, configuration: PdfActivityConfiguration.Builder) {
37
        // Start with floating thumbnail bar mode (default)
38
        configuration.setThumbnailBarMode(ThumbnailBarMode.THUMBNAIL_BAR_MODE_FLOATING)
39

40
        ExtractAssetTask.extract(WELCOME_DOC, title, context) { documentFile ->
41
            val intent = PdfActivityIntentBuilder.fromUri(context, Uri.fromFile(documentFile))
42
                .configuration(configuration.build())
43
                .activityClass(ThumbnailBarExampleActivity::class)
44
                .build()
45

46
            context.startActivity(intent)
47
        }
48
    }
49
}
50

51
/**
52
 * Activity that demonstrates switching between different thumbnail bar modes.
53
 */
54
class ThumbnailBarExampleActivity : PdfActivity() {
55

56
    companion object {
57
        private const val KEY_THUMBNAIL_BAR_MODE = "thumbnail_bar_mode"
58
        private const val KEY_THUMBNAIL_BAR_TAG = "thumbnail_bar"
59
    }
60

61
    private var currentMode = ThumbnailBarMode.THUMBNAIL_BAR_MODE_FLOATING
62
    private val onScrollListener: PdfThumbnailBar.OnScrollListener = object : PdfThumbnailBar.OnScrollListener() {
63
        override fun onScroll(firstVisiblePage: Int, firstVisibleOffsetPx: Int) {
64
            super.onScroll(firstVisiblePage, firstVisibleOffsetPx)
65
            PdfLog.i(KEY_THUMBNAIL_BAR_TAG, "firstVisiblePage $firstVisiblePage firstVisibleOffsetPx $firstVisibleOffsetPx")
66
        }
67

68
        override fun onScrollStateChanged(newState: ScrollState) {
69
            super.onScrollStateChanged(newState)
70
            PdfLog.i(KEY_THUMBNAIL_BAR_TAG, "ScrollState $newState")
71
        }
72
    }
73

74
    override fun onCreateOptionsMenu(menu: Menu): Boolean {
75
        super.onCreateOptionsMenu(menu)
76
        menuInflater.inflate(R.menu.thumbnail_bar_modes_menu, menu)
77
        return true
78
    }
79

80
    override fun onPrepareOptionsMenu(menu: Menu): Boolean {
81
        // Update checked state based on current mode
82
        menu.findItem(R.id.thumbnail_bar_mode_floating)?.isChecked =
83
            currentMode == ThumbnailBarMode.THUMBNAIL_BAR_MODE_FLOATING
84
        menu.findItem(R.id.thumbnail_bar_mode_pinned)?.isChecked =
85
            currentMode == ThumbnailBarMode.THUMBNAIL_BAR_MODE_PINNED
86
        menu.findItem(R.id.thumbnail_bar_mode_scrollable)?.isChecked =
87
            currentMode == ThumbnailBarMode.THUMBNAIL_BAR_MODE_SCROLLABLE
88
        menu.findItem(R.id.thumbnail_bar_mode_none)?.isChecked =
89
            currentMode == ThumbnailBarMode.THUMBNAIL_BAR_MODE_NONE
90
        return super.onPrepareOptionsMenu(menu)
91
    }
92

93
    override fun onSaveInstanceState(outState: Bundle) {
94
        super.onSaveInstanceState(outState)
95
        outState.putString(KEY_THUMBNAIL_BAR_MODE, currentMode.name)
96
    }
97

98
    override fun onRestoreInstanceState(savedInstanceState: Bundle) {
99
        super.onRestoreInstanceState(savedInstanceState)
100
        currentMode = savedInstanceState.getString(KEY_THUMBNAIL_BAR_MODE)
101
            ?.let { ThumbnailBarMode.valueOf(it) }
102
            ?: ThumbnailBarMode.THUMBNAIL_BAR_MODE_FLOATING
103
        pspdfKitViews.thumbnailBarView?.setThumbnailBarMode(currentMode)
104
        invalidateOptionsMenu()
105
    }
106

107
    override fun onOptionsItemSelected(item: MenuItem): Boolean {
108
        val bar = pspdfKitViews.thumbnailBarView
109
        val newMode = when (item.itemId) {
110
            R.id.thumbnail_bar_mode_floating -> ThumbnailBarMode.THUMBNAIL_BAR_MODE_FLOATING
111
            R.id.thumbnail_bar_mode_pinned -> ThumbnailBarMode.THUMBNAIL_BAR_MODE_PINNED
112
            R.id.thumbnail_bar_mode_scrollable -> ThumbnailBarMode.THUMBNAIL_BAR_MODE_SCROLLABLE
113
            R.id.thumbnail_bar_mode_none -> ThumbnailBarMode.THUMBNAIL_BAR_MODE_NONE
114
            else -> null
115
        } ?: return super.onOptionsItemSelected(item)
116

117
        currentMode = newMode
118
        bar?.setThumbnailBarMode(newMode)
119
        if (newMode == ThumbnailBarMode.THUMBNAIL_BAR_MODE_SCROLLABLE) bar?.setOnScrollListener(onScrollListener)
120

121
//        a custom outer margin can be added to the thumbnail bar by using
122
//        bar?.setOuterMargin(100, 100, 100, 100)
123

124
        invalidateOptionsMenu()
125
        return true
126
    }
127
}