androidx.leanback.widget


Copyright (C) 2015 The Android Open Source Project Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Interfaces

BaseGridView.OnKeyInterceptListener

Listener for intercepting key dispatch events.

BaseGridView.OnLayoutCompletedListener

Interface for receiving notification when BaseGridView has completed a full layout calculation.

BaseGridView.OnMotionInterceptListener

Listener for intercepting generic motion dispatch events.

BaseGridView.OnTouchInterceptListener

Listener for intercepting touch dispatch events.

BaseGridView.OnUnhandledKeyListener

Listener for intercepting unhandled key events.

BaseGridView.SmoothScrollByBehavior

Defines behavior of duration and interpolator for smoothScrollBy().

BaseOnItemViewClickedListener

Interface for receiving notification when an item view holder is clicked.

BaseOnItemViewSelectedListener

Interface for receiving notification when a row or item becomes selected.

BrowseFrameLayout.OnChildFocusListener

Interface for managing child focus in a BrowseFrameLayout.

BrowseFrameLayout.OnFocusSearchListener

Interface for selecting a focused view in a BrowseFrameLayout when the system focus finder couldn't find a view to focus.

FacetProvider

This is the query interface to supply optional features(aka facets) on an object without the need of letting the object to subclass or implement java interfaces.

FacetProviderAdapter

Optional interface that implemented by androidx.recyclerview.widget.RecyclerView.Adapter to query FacetProvider for a given item view type within Adapter.

FocusHighlight

Interface for highlighting the item that has focus.

FragmentAnimationProvider

FragmentAnimationProvider supplies animations for use during a fragment's onCreateAnimator callback.

GuidedActionAutofillSupport

Interface for a custom EditText subclass to support autofill in androidx.leanback.app.GuidedStepSupportFragment.

GuidedActionAutofillSupport.OnAutofillListener

Listener for autofill event.

ImeKeyMonitor

Interface for an EditText subclass that can delegate calls to onKeyPreIme up to a registered listener.

ImeKeyMonitor.ImeKeyListener

Listener interface for key events intercepted pre-IME by edit text objects.

MultiActionsProvider

An interface implemented by the user if they wish to provide actions for a media item row to be displayed by an AbstractMediaItemPresenter.

OnActionClickedListener

Interface for receiving notification when an Action is clicked.

OnChildLaidOutListener

Interface for receiving notification when a child of this ViewGroup has been laid out.

OnChildSelectedListener

This interface is deprecated.

Use OnChildViewHolderSelectedListener

OnItemViewClickedListener

Interface for receiving notification when a item view holder is clicked.

OnItemViewSelectedListener

Interface for receiving notification when a row or item becomes selected.

PlaybackSeekUi

Interface to be implemented by UI component to support seeking.

SearchBar.SearchBarListener

Interface for receiving notification of search query changes.

SearchBar.SearchBarPermissionListener

Interface that handles runtime permissions requests.

SearchEditText.OnKeyboardDismissListener

Interface for receiving notification when the keyboard is dismissed.

SpeechRecognitionCallback

This interface is deprecated.

Launching voice recognition activity is no longer supported.

TitleViewAdapter.Provider

Interface to be implemented by a customized widget class to implement TitleViewAdapter.

ViewHolderTask

Interface for schedule task on a ViewHolder.

Classes

AbstractDetailsDescriptionPresenter

An abstract Presenter for rendering a detailed description of an item.

AbstractDetailsDescriptionPresenter.ViewHolder

The ViewHolder for the AbstractDetailsDescriptionPresenter.

AbstractMediaItemPresenter

Abstract Presenter class for rendering media items in a playlist format.

AbstractMediaItemPresenter.ViewHolder

The ViewHolder for the AbstractMediaItemPresenter.

AbstractMediaListHeaderPresenter

Abstract presenter class for rendering the header for a list of media items in a playlist.

AbstractMediaListHeaderPresenter.ViewHolder

The ViewHolder for the AbstractMediaListHeaderPresenter.

Action

An action contains one or two lines of text, an optional image and an optional id.

ArrayObjectAdapter

An ObjectAdapter implemented with an ArrayList.

BaseCardView

A card style layout that responds to certain state changes.

BaseCardView.LayoutParams

Per-child layout information associated with BaseCardView.

BaseGridView

An abstract base class for vertically and horizontally scrolling lists.

BrowseFrameLayout

A ViewGroup for managing focus behavior between overlapping views.

ClassPresenterSelector

A ClassPresenterSelector selects a Presenter based on the item's Java class.

ControlButtonPresenterSelector

Displays primary and secondary controls for a PlaybackControlsRow.

CursorObjectAdapter

An ObjectAdapter implemented with a Cursor.

DetailsOverviewLogoPresenter

Presenter that responsible to create a ImageView and bind to DetailsOverviewRow.

DetailsOverviewLogoPresenter.ViewHolder

ViewHolder for Logo view of DetailsOverviewRow.

DetailsOverviewRow

An overview Row for a details fragment.

DetailsOverviewRow.Listener

Listener for changes of DetailsOverviewRow.

DetailsOverviewRowPresenter

This class is deprecated.

Use FullWidthDetailsOverviewRowPresenter

DetailsOverviewRowPresenter.ViewHolder

A ViewHolder for the DetailsOverviewRow.

DetailsParallax

Subclass of Parallax object that tracks overview row's top and bottom edge in DetailsFragment or DetailsSupportFragment.

DiffCallback

Callback that informs ArrayObjectAdapter how to compute list updates when using DiffUtil in setItems method.

DividerPresenter

DividerPresenter provides a default presentation for DividerRow in HeadersFragment.

DividerRow

Used to represent divider in HeadersFragment.

FocusHighlightHelper

Sets up the highlighting behavior when an item gains focus.

FullWidthDetailsOverviewRowPresenter

Renders a DetailsOverviewRow to display an overview of an item.

FullWidthDetailsOverviewRowPresenter.Listener

Listeners for events on ViewHolder.

FullWidthDetailsOverviewRowPresenter.ViewHolder

A ViewHolder for the DetailsOverviewRow.

FullWidthDetailsOverviewRowPresenter.ViewHolder.DetailsOverviewRowListener
FullWidthDetailsOverviewSharedElementHelper

Helper class to assist delayed shared element activity transition for view created by FullWidthDetailsOverviewRowPresenter.

GridLayoutManager

A RecyclerView.LayoutManager implementation that lays out items in a grid for leanback VerticalGridView and HorizontalGridView.

GuidanceStylist

GuidanceStylist is used within a androidx.leanback.app.GuidedStepFragment to display contextual information for the decision(s) required at that step.

GuidanceStylist.Guidance

A data class representing contextual information for a .

GuidedAction

A data class which represents an action within a .

GuidedAction.Builder

Builds a GuidedAction object.

GuidedAction.BuilderBase

Base builder class to build a GuidedAction object.

GuidedActionAppCompatEditText

A custom EditText that satisfies the IME key monitoring requirements of GuidedStepFragment.

GuidedActionDiffCallback

DiffCallback used for GuidedActions, see setActionsDiffCallback.

GuidedActionEditText

A custom EditText that satisfies the IME key monitoring requirements of GuidedStepFragment.

GuidedActionsStylist

GuidedActionsStylist is used within a androidx.leanback.app.GuidedStepFragment to supply the right-side panel where users can take actions.

GuidedActionsStylist.ViewHolder

ViewHolder caches information about the action item layouts' subviews.

GuidedDatePickerAction

Subclass of GuidedAction that can choose a date.

GuidedDatePickerAction.Builder

Builder class to build a GuidedDatePickerAction.

GuidedDatePickerAction.BuilderBase

Base Builder class to build GuidedDatePickerAction.

HeaderItem

A header item describes the metadata of a Row, such as a category of media items.

HorizontalGridView

A android.view.ViewGroup that shows items in a horizontal scrolling list.

HorizontalHoverCardSwitcher

A helper class for showing a hover card view below a HorizontalGridView.

ImageCardView

A subclass of BaseCardView with an ImageView as its main region.

ItemAlignmentFacet

Optional facet provided by androidx.recyclerview.widget.RecyclerView.Adapter or androidx.recyclerview.widget.RecyclerView.ViewHolder for use in HorizontalGridView and VerticalGridView.

ItemAlignmentFacet.ItemAlignmentDef

Definition of an alignment position under a view.

ItemBridgeAdapter

Bridge from Presenter to RecyclerView.Adapter.

ItemBridgeAdapter.AdapterListener

Interface for listening to ViewHolder operations.

ItemBridgeAdapter.ViewHolder

ViewHolder for the ItemBridgeAdapter.

ItemBridgeAdapter.Wrapper

Interface for wrapping a view created by a Presenter into another view.

ItemBridgeAdapterShadowOverlayWrapper

A wrapper class working with ItemBridgeAdapter to wrap item view in a ShadowOverlayContainer.

LeanbackAppCompatViewInflater

Inflater that converts leanback non-AppCpmpat views in layout to AppCompat versions.

ListRow

A Row composed of a optional HeaderItem, and an ObjectAdapter describing the items in the list.

ListRowHoverCardView

ListRowHoverCardView contains a title and description.

ListRowPresenter

ListRowPresenter renders ListRow using a HorizontalGridView hosted in a ListRowView.

ListRowPresenter.SelectItemViewHolderTask

A task on the ListRowPresenter.ViewHolder that can select an item by position in the HorizontalGridView and perform an optional item task on it.

ListRowPresenter.ViewHolder

ViewHolder for the ListRowPresenter.

ListRowView

ListRowView is a android.view.ViewGroup which always contains a HorizontalGridView, and may optionally include a hover card.

MultiActionsProvider.MultiAction

MultiAction represents an action that can have multiple states.

ObjectAdapter

Base class adapter to be used in leanback activities.

ObjectAdapter.DataObserver

A DataObserver can be notified when an ObjectAdapter's underlying data changes.

OnChildViewHolderSelectedListener

Interface for receiving notification when a child of this ViewGroup has been selected.

PageRow

Used to represent content spanning full page.

Parallax

Parallax tracks a list of dynamic Propertys typically representing foreground UI element positions on screen.

Parallax.FloatProperty

FloatProperty provide access to an index based integer type property inside Parallax.

Parallax.IntProperty

IntProperty provide access to an index based integer type property inside Parallax.

Parallax.PropertyMarkerValue

Class holding a fixed value for a Property in Parallax.

ParallaxEffect

ParallaxEffect class drives changes in ParallaxTarget in response to changes in variables defined in Parallax.

ParallaxTarget

ParallaxTarget is responsible for updating the target through the update method or the directUpdate method when isDirectMapping is true.

ParallaxTarget.DirectPropertyTarget

DirectPropertyTarget is to support direct mapping into either Integer Property or Float Property.

ParallaxTarget.PropertyValuesHolderTarget

PropertyValuesHolderTarget is an implementation of ParallaxTarget that uses PropertyValuesHolder to update the target object.

PlaybackControlsRow

A Row of playback controls to be displayed by a PlaybackControlsRowPresenter.

PlaybackControlsRow.ClosedCaptioningAction

An action for displaying a CC (Closed Captioning) icon.

PlaybackControlsRow.FastForwardAction

An action displaying an icon for fast forward.

PlaybackControlsRow.HighQualityAction

An action for displaying a HQ (High Quality) icon.

PlaybackControlsRow.MoreActions

An action displaying an icon for "more actions".

PlaybackControlsRow.MultiAction

Base class for an action comprised of a series of icons.

PlaybackControlsRow.OnPlaybackProgressCallback

Listener for progress or duration change.

PlaybackControlsRow.PictureInPictureAction

An action displaying an icon for picture-in-picture.

PlaybackControlsRow.PlayPauseAction

An action displaying icons for play and pause.

PlaybackControlsRow.RepeatAction

An action for displaying three repeat states: none, one, or all.

PlaybackControlsRow.RewindAction

An action displaying an icon for rewind.

PlaybackControlsRow.ShuffleAction

An action for displaying a shuffle icon.

PlaybackControlsRow.SkipNextAction

An action displaying an icon for skip next.

PlaybackControlsRow.SkipPreviousAction

An action displaying an icon for skip previous.

PlaybackControlsRow.ThumbsAction

A base class for displaying a thumbs action.

PlaybackControlsRow.ThumbsDownAction

An action displaying an icon for thumbs down.

PlaybackControlsRow.ThumbsUpAction

An action displaying an icon for thumbs up.

PlaybackControlsRowPresenter

A PlaybackControlsRowPresenter renders a PlaybackControlsRow to display a series of playback control buttons.

PlaybackControlsRowPresenter.ViewHolder

A ViewHolder for the PlaybackControlsRow.

PlaybackRowPresenter

Subclass of RowPresenter that can define the desired behavior when the view reappears.

PlaybackRowPresenter.ViewHolder

This container is used for trapping click events and passing them to the playback controls.

PlaybackSeekDataProvider

Class to be implemented by app to provide seeking data and thumbnails to UI.

PlaybackSeekDataProvider.ResultCallback

Client to receive result for getThumbnail.

PlaybackSeekUi.Client

Client (e.g. PlaybackGlue) to register on PlaybackSeekUi so that it can interact with Seeking UI.

PlaybackTransportRowPresenter

A PlaybackTransportRowPresenter renders a PlaybackControlsRow to display a series of playback control buttons.

PlaybackTransportRowPresenter.ViewHolder

A ViewHolder for the PlaybackControlsRow supporting seek UI.

Presenter

A Presenter is used to generate Views and bind Objects to them on demand.

Presenter.ViewHolder

ViewHolder can be subclassed and used to cache any view accessors needed to improve binding performance (for example, results of findViewById) without needing to subclass a View.

Presenter.ViewHolderTask

Base class to perform a task on Presenter.ViewHolder.

PresenterSelector

A PresenterSelector is used to obtain a Presenter for a given Object.

PresenterSwitcher

An abstract helper class that switches a view in its parent view using a PresenterSelector.

RecyclerViewParallax

Implementation of Parallax class for RecyclerView.

RecyclerViewParallax.ChildPositionProperty

Subclass of Parallax.IntProperty.

Row

The base class for all rows.

RowHeaderPresenter

RowHeaderPresenter provides a default presentation for HeaderItem using a RowHeaderView and optionally a TextView for description.

RowHeaderPresenter.ViewHolder

A ViewHolder for the RowHeaderPresenter.

RowHeaderView

RowHeaderView is a header text view.

RowPresenter

An abstract Presenter that renders an Object in RowsFragment, the object can be subclass Row or a generic one.

RowPresenter.ViewHolder

A ViewHolder for a Row.

SearchBar

A search widget containing a search orb and a text entry view.

SearchEditText

EditText widget that monitors keyboard changes.

SearchOrbView

A widget that draws a search affordance, represented by a round background and an icon.

SearchOrbView.Colors

A set of colors used to display the search orb.

SectionRow

Used to represent section item in HeadersFragment.

ShadowOverlayContainer

Provides an SDK version-independent wrapper to support shadows, color overlays, and rounded corners.

ShadowOverlayHelper

ShadowOverlayHelper is a helper class for shadow, overlay color and rounded corner.

ShadowOverlayHelper.Builder

Builder for creating ShadowOverlayHelper.

ShadowOverlayHelper.Options

Option values for ShadowOverlayContainer.

SinglePresenterSelector

A PresenterSelector that always returns the same Presenter.

SparseArrayObjectAdapter

An ObjectAdapter implemented with a android.util.SparseArray.

SpeechOrbView

A subclass of SearchOrbView that visualizes the state of an ongoing speech recognition.

TitleHelper

Helper for managing androidx.leanback.widget.TitleView, including transitions and focus movement.

TitleView

Title view for a leanback fragment.

TitleViewAdapter

This class allows a customized widget class to implement TitleViewAdapter.Provider and expose TitleViewAdapter methods to containing fragment (e.g. BrowseFragment or DetailsFragment).

VerticalGridPresenter

A presenter that renders objects in a VerticalGridView.

VerticalGridPresenter.ViewHolder

ViewHolder for the VerticalGridPresenter.

VerticalGridView

A android.view.ViewGroup that shows items in a vertically scrolling list.