BaseGridView

Kotlin |Java

abstract class BaseGridView : RecyclerView

kotlin.Any
↳	android.view.View
	↳	android.view.ViewGroup
		↳	androidx.recyclerview.widget.RecyclerView
			↳	androidx.leanback.widget.BaseGridView

Known Direct Subclasses

HorizontalGridView	A `android.view.ViewGroup` that shows items in a horizontal scrolling list.
VerticalGridView	A `android.view.ViewGroup` that shows items in a vertically scrolling list.

An abstract base class for vertically and horizontally scrolling lists. The items come from the RecyclerView.Adapter associated with this view. Do not directly use this class, use VerticalGridView and HorizontalGridView. The class is not intended to be subclassed other than VerticalGridView and HorizontalGridView.

Summary

Nested classes
abstract	`OnKeyInterceptListener` Listener for intercepting key dispatch events.
abstract	`OnLayoutCompletedListener` Interface for receiving notification when BaseGridView has completed a full layout calculation.
abstract	`OnMotionInterceptListener` Listener for intercepting generic motion dispatch events.
abstract	`OnTouchInterceptListener` Listener for intercepting touch dispatch events.
abstract	`OnUnhandledKeyListener`
abstract	`SmoothScrollByBehavior` Defines behavior of duration and interpolator for smoothScrollBy().

Constants
static Float	`ITEM_ALIGN_OFFSET_PERCENT_DISABLED` Value indicates that percent is not used.
static Int	`SAVE_ALL_CHILD` Save on screen views plus save off screen child views without any limitation.
static Int	`SAVE_LIMITED_CHILD` Save on screen views plus save off screen child views states up to `getSaveChildrenLimitNumber()`.
static Int	`SAVE_NO_CHILD` Dont save states of any child views.
static Int	`SAVE_ON_SCREEN_CHILD` Only save on screen child views, the states are lost when they become off screen.
static Int	`WINDOW_ALIGN_BOTH_EDGE` The first item and last item are aligned with the two edges of the viewport.
static Int	`WINDOW_ALIGN_HIGH_EDGE` The last item is aligned with the high edge of the viewport when navigating to the end of list.
static Int	`WINDOW_ALIGN_LOW_EDGE` The first item is aligned with the low edge of the viewport.
static Int	`WINDOW_ALIGN_NO_EDGE` The focused item always stays in a key line location.
static Float	`WINDOW_ALIGN_OFFSET_PERCENT_DISABLED` Value indicates that percent is not used.

Inherited constants

From class RecyclerView

`Int`	`HORIZONTAL`
`Int`	`INVALID_TYPE`
`Long`	`NO_ID`
`Int`	`NO_POSITION`
`Int`	`SCROLL_STATE_DRAGGING` The RecyclerView is currently being dragged by outside input such as user touch input.
`Int`	`SCROLL_STATE_IDLE` The RecyclerView is not currently scrolling.
`Int`	`SCROLL_STATE_SETTLING` The RecyclerView is currently animating to a final position while not under outside control.
`Int`	`TOUCH_SLOP_DEFAULT` Constant for use with `setScrollingTouchSlop(int)`. Indicates that the RecyclerView should use the standard touch slop for smooth, continuous scrolling.
`Int`	`TOUCH_SLOP_PAGING` Constant for use with `setScrollingTouchSlop(int)`. Indicates that the RecyclerView should use the standard touch slop for scrolling widgets that snap to a page or other coarse-grained barrier.
`Int`	`UNDEFINED_DURATION` Constant that represents that a duration has not been defined.
`Int`	`VERTICAL`

Public methods
open Unit	`addOnChildViewHolderSelectedListener(listener: OnChildViewHolderSelectedListener!)` Registers a callback to be invoked when an item in BaseGridView has been selected.
Unit	`addOnLayoutCompletedListener(@NonNull listener: BaseGridView.OnLayoutCompletedListener)` Registers a callback to be invoked when the BaseGridView completes a full layout calculation.
open Unit	`animat`