indexscroll/androidx.indexscroll.widget/SeslIndexScrollView

SeslIndexScrollView

open class SeslIndexScrollView : FrameLayout(source)

SeslIndexScrollView is a view that shows the scroll bar and the index bar on the right or left side of the screen. It is used to scroll the list to the position of the selected index. It can be used with RecyclerView.

The index bar can be shown in two modes: text mode and dot mode. In text mode, the index bar shows the text of the index. In dot mode, the index bar shows the dot of the index.

Constructors

SeslIndexScrollView

constructor(@NonNull context: Context)

constructor(@NonNull context: Context, @Nullable attrs: AttributeSet)

Types

GravityIndexBar

@RestrictTo(value = LIBRARY_GROUP_PREFIX)

@Retention(value = RetentionPolicy.SOURCE)

annotation class GravityIndexBar

OnIndexBarEventListener

interface OnIndexBarEventListener

Properties

GRAVITY_INDEX_BAR_LEFT

val GRAVITY_INDEX_BAR_LEFT: Int = 0

GRAVITY_INDEX_BAR_RIGHT

val GRAVITY_INDEX_BAR_RIGHT: Int = 1

Functions

attachToRecyclerView

open fun attachToRecyclerView(@NotNull recyclerView: @NotNull RecyclerView)

Attaches the SeslIndexScrollView to the provided RecyclerView, by calling addOnScrollListener.

dispatchKeyEvent

open fun dispatchKeyEvent(event: KeyEvent): Boolean

enableScrollThumb

open fun enableScrollThumb(enabled: Boolean)

open fun onTouchEvent(ev: MotionEvent): Boolean

setEffectBackgroundColor

open fun setEffectBackgroundColor(effectBackgroundColor: Int)

Sets the background color of the index scroll preview.

setEffectTextColor

open fun setEffectTextColor(effectTextColor: Int)

Sets the text color for the effect preview.

setIndexBarBackgroundColor

open fun setIndexBarBackgroundColor(bgColor: Int)

Sets the background color of the index bar.

setIndexBarBackgroundDrawable

open fun setIndexBarBackgroundDrawable(bgDrawable: Drawable)

Sets the background drawable for the index bar.

setIndexBarGravity

open fun setIndexBarGravity(gravity: Int)

Sets the gravity of the index bar.

setIndexBarPressedTextColor

open fun setIndexBarPressedTextColor(pressedTextColor: Int)

Sets the text color of the index bar when it is pressed.

setIndexBarTextColor

open fun setIndexBarTextColor(textColor: Int)

Sets the text color of the index bar.

setIndexBarTextMode

open fun setIndexBarTextMode(textMode: Boolean)

Sets the text mode for the index bar.

open fun setIndexer(@NonNull indexer: SeslArrayIndexer)

Sets the array indexer for the SeslIndexScrollView.

open fun setIndexer(@NonNull indexer: SeslCursorIndexer)

Sets the SeslCursorIndexer for this IndexScrollView.

setIndexScrollMargin

open fun setIndexScrollMargin(topMargin: Int, bottomMargin: Int)

Sets the top and bottom margins for the index scroll background.

setOnIndexBarEventListener

open fun setOnIndexBarEventListener(iOnIndexBarEventListener: SeslIndexScrollView.OnIndexBarEventListener)

setSimpleIndexScroll

open fun setSimpleIndexScroll(indexBarChar: Array<String>, width: Int)

Sets the index bar to a simple scroll mode with a custom character array and width.