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 com.pspdfkit.catalog.R
14
import com.pspdfkit.catalog.SdkExample
15
import com.pspdfkit.catalog.tasks.ExtractAssetTask
16
import com.pspdfkit.compose.toolbar.state.ToolbarItem
17
import com.pspdfkit.compose.toolbar.state.ToolbarItem.ItemEdge
18
import com.pspdfkit.compose.toolbar.state.ToolbarItem.OverflowBehavior
19
import com.pspdfkit.compose.toolbar.state.ToolbarItemState
20
import com.pspdfkit.configuration.activity.PdfActivityConfiguration
21
import com.pspdfkit.configuration.activity.ThumbnailBarMode
22
import com.pspdfkit.listeners.scrolling.ScrollState
23
import com.pspdfkit.ui.PdfActivity
24
import com.pspdfkit.ui.PdfActivityIntentBuilder
25
import com.pspdfkit.ui.PdfThumbnailBar
26
import com.pspdfkit.utils.PdfLog
27

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

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

48
            context.startActivity(intent)
49
        }
50
    }
51
}
52

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

58
    companion object {
59
        private const val KEY_THUMBNAIL_BAR_MODE = "thumbnail_bar_mode"
60
        private const val KEY_THUMBNAIL_BAR_TAG = "thumbnail_bar"
61
        private const val ITEM_MODE_FLOATING = 90
62
        private const val ITEM_MODE_PINNED = 91
63
        private const val ITEM_MODE_SCROLLABLE = 92
64
        private const val ITEM_MODE_NONE = 93
65
    }
66

67
    private var currentMode = ThumbnailBarMode.THUMBNAIL_BAR_MODE_FLOATING
68
    private val onScrollListener: PdfThumbnailBar.OnScrollListener = object : PdfThumbnailBar.OnScrollListener() {
69
        override fun onScroll(firstVisiblePage: Int, firstVisibleOffsetPx: Int) {
70
            super.onScroll(firstVisiblePage, firstVisibleOffsetPx)
71
            PdfLog.i(KEY_THUMBNAIL_BAR_TAG, "firstVisiblePage $firstVisiblePage firstVisibleOffsetPx $firstVisibleOffsetPx")
72
        }
73

74
        override fun onScrollStateChanged(newState: ScrollState) {
75
            super.onScrollStateChanged(newState)
76
            PdfLog.i(KEY_THUMBNAIL_BAR_TAG, "ScrollState $newState")
77
        }
78
    }
79

80
    override fun onCreate(savedInstanceState: Bundle?) {
81
        super.onCreate(savedInstanceState)
82

83
        setToolbarItemsProvider { defaultItems ->
84
            // Recompute the selected mode each time so the toolbar reflects the current state.
85
            defaultItems +
86
                thumbnailBarModeToggle(ITEM_MODE_FLOATING, ThumbnailBarMode.THUMBNAIL_BAR_MODE_FLOATING) +
87
                thumbnailBarModeToggle(ITEM_MODE_PINNED, ThumbnailBarMode.THUMBNAIL_BAR_MODE_PINNED) +
88
                thumbnailBarModeToggle(ITEM_MODE_SCROLLABLE, ThumbnailBarMode.THUMBNAIL_BAR_MODE_SCROLLABLE) +
89
                thumbnailBarModeToggle(ITEM_MODE_NONE, ThumbnailBarMode.THUMBNAIL_BAR_MODE_NONE)
90
        }
91

92
        setOnToolbarItemClickListener { itemId ->
93
            val newMode = when (itemId) {
94
                ITEM_MODE_FLOATING -> ThumbnailBarMode.THUMBNAIL_BAR_MODE_FLOATING
95
                ITEM_MODE_PINNED -> ThumbnailBarMode.THUMBNAIL_BAR_MODE_PINNED
96
                ITEM_MODE_SCROLLABLE -> ThumbnailBarMode.THUMBNAIL_BAR_MODE_SCROLLABLE
97
                ITEM_MODE_NONE -> ThumbnailBarMode.THUMBNAIL_BAR_MODE_NONE
98
                else -> return@setOnToolbarItemClickListener false
99
            }
100

101
            val bar = pspdfKitViews.thumbnailBarView
102
            currentMode = newMode
103
            bar?.setThumbnailBarMode(newMode)
104
            if (newMode == ThumbnailBarMode.THUMBNAIL_BAR_MODE_SCROLLABLE) bar?.setOnScrollListener(onScrollListener)
105

106
//            a custom outer margin can be added to the thumbnail bar by using
107
//            bar?.setOuterMargin(100, 100, 100, 100)
108

109
            invalidateToolbarItems()
110
            true
111
        }
112
    }
113

114
    private fun thumbnailBarModeToggle(itemId: Int, mode: ThumbnailBarMode): ToolbarItem.Toggle {
115
        val title = when (itemId) {
116
            ITEM_MODE_FLOATING -> getString(R.string.thumbnail_bar_mode_floating)
117
            ITEM_MODE_PINNED -> getString(R.string.thumbnail_bar_mode_pinned)
118
            ITEM_MODE_SCROLLABLE -> getString(R.string.thumbnail_bar_mode_scrollable)
119
            else -> getString(R.string.thumbnail_bar_mode_none)
120
        }
121
        return ToolbarItem.Toggle(
122
            id = itemId,
123
            actionId = "thumbnail_bar_mode_${mode.name}",
124
            contentDescription = title,
125
            state = ToolbarItemState(isSelected = currentMode == mode),
126
            position = ItemEdge.End,
127
            overflowBehavior = OverflowBehavior.Never,
128
        )
129
    }
130

131
    override fun onSaveInstanceState(outState: Bundle) {
132
        super.onSaveInstanceState(outState)
133
        outState.putString(KEY_THUMBNAIL_BAR_MODE, currentMode.name)
134
    }
135

136
    override fun onRestoreInstanceState(savedInstanceState: Bundle) {
137
        super.onRestoreInstanceState(savedInstanceState)
138
        currentMode = savedInstanceState.getString(KEY_THUMBNAIL_BAR_MODE)
139
            ?.let { ThumbnailBarMode.valueOf(it) }
140
            ?: ThumbnailBarMode.THUMBNAIL_BAR_MODE_FLOATING
141
        pspdfKitViews.thumbnailBarView?.setThumbnailBarMode(currentMode)
142
        invalidateToolbarItems()
143
    }
144
}