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, VerticalGridView

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	`animateIn()` Undo animateOut() and slide in child views.
open Unit	`animateOut()` Temporarily slide out child views to bottom (for VerticalGridView) or end (for HorizontalGridView).
open Boolean	`dispatchKeyEvent(event: KeyEvent!)`
open Boolean	`dispatchTouchEvent(event: MotionEvent!)`
open View!	`focusSearch(direction: Int)`
open Int	`getChildDrawingOrder(childCount: Int, i: Int)`
open Int	`getHorizontalMargin()` Returns the spacing in pixels between two child items horizontally.
open Int	`getHorizontalSpacing()` Returns the horizontal spacing in pixels between two child items.
open Int	`getInitialPrefetchItemCount()` Gets the number of items to prefetch in `RecyclerView.LayoutManager#collectInitialPrefetchPositions(int, RecyclerView.LayoutManager.LayoutPrefetchRegistry)`, which defines how many inner items should be prefetched when this GridView is nested inside another RecyclerView.
open Int	`getItemAlignmentOffset()` Returns number of pixels to the end of low edge.
open Float	`getItemAlignmentOffsetPercent()` Returns the offset percent for item alignment in addition to .
open Int	`getItemAlignmentViewId()` Returns the id of the view to align with, or `android.view.View#NO_ID` for the root `RecyclerView.ViewHolder#itemView`.
open BaseGridView.OnUnhandledKeyListener!	`getOnUnhandledKeyListener()` Returns the unhandled key listener.
Int	`getSaveChildrenLimitNumber()` Returns the limit used when when `getSaveChildrenPolicy()` is `SAVE_LIMITED_CHILD`
Int	`getSaveChildrenPolicy()` Returns the policy for saving children.
open Int	`getSelectedPosition()` Returns the adapter position of selected item.
open BaseGridView.SmoothScrollByBehavior?	`getSmoothScrollByBehavior()` Returns custom behavior for smoothScrollBy().
Int	`getSmoothScrollMaxPendingMoves()` When holding DPAD, DPAD events are generated faster than the grid view can scroll.
Float	`getSmoothScrollSpeedFactor()`
open Int	`getVerticalMargin()` Returns the spacing in pixels between two child items vertically.
open Int	`getVerticalSpacing()` Returns the vertical spacing in pixels between two child items.
open Unit	`getViewSelectedOffsets(view: View!, offsets: IntArray!)` Returns the x/y offsets to final position from current position if the view is selected.
open Int	`getWindowAlignment()` Returns the method for focused item alignment in the view.
open Int	`getWindowAlignmentOffset()` Returns the offset in pixels for window alignment key line.
open Float	`getWindowAlignmentOffsetPercent()` Returns the offset percent for window alignment key line in addition to `getWindowAlignmentOffset()`.
open Boolean	`hasOverlappingRendering()`
open Boolean	`hasPreviousViewInSameRow(position: Int)` Returns true if the view at the given position has a same row sibling in front of it.
open Boolean	`isChildLayoutAnimated()` Returns true if an animation will run when a child changes size or when adding or removing a child.
open Boolean	`isFocusDrawingOrderEnabled()` Returns true if draws selected child at last, false otherwise.
Boolean	`isFocusSearchDisabled()` Returns true if focus search is disabled.
open Boolean	`isItemAlignmentOffsetWithPadding()` Returns true if applies padding to item alignment when `getItemAlignmentOffsetPercent()` is 0 or 100; returns false otherwise.
open Boolean	`isScrollEnabled()` Returns true if scrolling is enabled, false otherwise.
open Boolean	`isWindowAlignmentPreferKeyLineOverHighEdge()` Returns whether prefer key line over high edge when `WINDOW_ALIGN_HIGH_EDGE` is used.
open Boolean	`isWindowAlignmentPreferKeyLineOverLowEdge()` Returns whether prefer key line over low edge when `WINDOW_ALIGN_LOW_EDGE` is used.
open Boolean	`onRequestFocusInDescendants(direction: Int, previouslyFocusedRect: Rect!)`
open Unit	`onRtlPropertiesChanged(layoutDirection:`