belongs to Maven artifact com.android.support:leanback-v17:28.0.0-alpha1
DetailsOverviewRow
public
class
DetailsOverviewRow
extends Row
java.lang.Object | ||
↳ | android.support.v17.leanback.widget.Row | |
↳ | android.support.v17.leanback.widget.DetailsOverviewRow |
An overview Row
for a details fragment. This row consists of an image, a
description view, and optionally a series of Action
s that can be taken for
the item.
Actions
Application usessetActionsAdapter(ObjectAdapter)
to set actions on the overview
row. SparseArrayObjectAdapter
is recommended for easily updating actions while
maintaining the order. The application can add or remove actions on the UI thread after the
row is bound to a view.
Updating main item
After the row is bound to a view, the application may callsetItem(Object)
on UI thread and the view will be updated.
Updating image
After the row is bound to view, the application may change the image by callingsetImageBitmap(Context, Bitmap)
or setImageDrawable(Drawable)
on the UI thread,
and the view will be updated.
Summary
Nested classes | |
---|---|
class |
DetailsOverviewRow.Listener
Listener for changes of DetailsOverviewRow. |
Public constructors | |
---|---|
DetailsOverviewRow(Object item)
Constructor for a DetailsOverviewRow. |
Public methods | |
---|---|
final
void
|
addAction(Action action)
This method was deprecated
in API level 22.1.0.
Use |
final
void
|
addAction(int pos, Action action)
This method was deprecated
in API level 22.1.0.
Use |
Action
|
getActionForKeyCode(int keyCode)
Returns the Action associated with the given keycode, or null if no associated action exists. |
final
List<Action>
|
getActions()
This method was deprecated
in API level 22.1.0.
Use |
final
ObjectAdapter
|
getActionsAdapter()
Returns the |
final
Drawable
|
getImageDrawable()
Returns the image drawable of this details overview. |
final
Object
|
getItem()
Returns the main item for the details page. |
boolean
|
isImageScaleUpAllowed()
Returns true if the image may be scaled up; false otherwise. |
final
boolean
|
removeAction(Action action)
This method was deprecated
in API level 22.1.0.
Use |
final
void
|
setActionsAdapter(ObjectAdapter adapter)
Sets the |
final
void
|
setImageBitmap(Context context, Bitmap bm)
Sets a Bitmap as the image of this details overview. |
final
void
|
setImageDrawable(Drawable drawable)
Sets a drawable as the image of this details overview. |
void
|
setImageScaleUpAllowed(boolean allowed)
Allows or disallows scaling up of images. |
final
void
|
setItem(Object item)
Sets the main item for the details page. |
Inherited methods | |
---|---|
From
class
android.support.v17.leanback.widget.Row
| |
From
class
java.lang.Object
|
Public constructors
DetailsOverviewRow
DetailsOverviewRow (Object item)
Constructor for a DetailsOverviewRow.
Parameters | |
---|---|
item |
Object : The main item for the details page.
|
Public methods
addAction
void addAction (Action action)
This method was deprecated
in API level 22.1.0.
Use setActionsAdapter(ObjectAdapter)
and getActionsAdapter()
Adds an Action to the overview. It will throw ClassCastException if the current actions
adapter is not an instance of ArrayObjectAdapter
. Must be called on the UI thread.
Parameters | |
---|---|
action |
Action : The Action to add. |
addAction
void addAction (int pos, Action action)
This method was deprecated
in API level 22.1.0.
Use setActionsAdapter(ObjectAdapter)
and getActionsAdapter()
Adds an Action to the overview at the specified position. It will throw ClassCastException if
current actions adapter is not an instance of fArrayObjectAdapter
. Must be called
on the UI thread.
Parameters | |
---|---|
pos |
int : The position to insert the Action. |
action |
Action : The Action to add. |
getActionForKeyCode
Action getActionForKeyCode (int keyCode)
Returns the Action associated with the given keycode, or null if no associated action exists.
Parameters | |
---|---|
keyCode |
int |
Returns | |
---|---|
Action |
getActions
List<Action> getActions ()
This method was deprecated
in API level 22.1.0.
Use setActionsAdapter(ObjectAdapter)
and getActionsAdapter()
Returns a read-only view of the list of Actions of this details overview. It will throw
ClassCastException if current actions adapter is not ArrayObjectAdapter
. Must be
called on UI thread.
Returns | |
---|---|
List<Action> |
An unmodifiable view of the list of Actions. |
getActionsAdapter
ObjectAdapter getActionsAdapter ()
Returns the ObjectAdapter
for actions.
Returns | |
---|---|
ObjectAdapter |
getImageDrawable
Drawable getImageDrawable ()
Returns the image drawable of this details overview.
Returns | |
---|---|
Drawable |
The overview's image drawable, or null if no drawable has been assigned. |
getItem
Object getItem ()
Returns the main item for the details page.
Returns | |
---|---|
Object |
isImageScaleUpAllowed
boolean isImageScaleUpAllowed ()
Returns true if the image may be scaled up; false otherwise.
Returns | |
---|---|
boolean |
removeAction
boolean removeAction (Action action)
This method was deprecated
in API level 22.1.0.
Use setActionsAdapter(ObjectAdapter)
and getActionsAdapter()
Removes the given Action from the overview. It will throw ClassCastException if current
actions adapter is not ArrayObjectAdapter
. Must be called on UI thread.
Parameters | |
---|---|
action |
Action : The Action to remove. |
Returns | |
---|---|
boolean |
true if the overview contained the specified Action. |
setActionsAdapter
void setActionsAdapter (ObjectAdapter adapter)
Sets the ObjectAdapter
for actions. A default PresenterSelector
will be
attached to the adapter if it doesn't have one.
Parameters | |
---|---|
adapter |
ObjectAdapter : Adapter for actions.
|
setImageBitmap
void setImageBitmap (Context context, Bitmap bm)
Sets a Bitmap as the image of this details overview. Must be called on UI thread after row is bound to view.
Parameters | |
---|---|
context |
Context : The context to retrieve display metrics from. |
bm |
Bitmap : The bitmap to set.
|
setImageDrawable
void setImageDrawable (Drawable drawable)
Sets a drawable as the image of this details overview. Must be called on UI thread after row is bound to view.
Parameters | |
---|---|
drawable |
Drawable : The drawable to set.
|
setImageScaleUpAllowed
void setImageScaleUpAllowed (boolean allowed)
Allows or disallows scaling up of images. Images will always be scaled down if necessary. Must be called on UI thread after row is bound to view.
Parameters | |
---|---|
allowed |
boolean |
setItem
void setItem (Object item)
Sets the main item for the details page. Must be called on UI thread after row is bound to view.
Parameters | |
---|---|
item |
Object |
Interfaces
- BaseGridView.OnKeyInterceptListener
- BaseGridView.OnMotionInterceptListener
- BaseGridView.OnTouchInterceptListener
- BaseGridView.OnUnhandledKeyListener
- BaseOnItemViewClickedListener
- BaseOnItemViewSelectedListener
- BrowseFrameLayout.OnChildFocusListener
- BrowseFrameLayout.OnFocusSearchListener
- FacetProvider
- FacetProviderAdapter
- FocusHighlight
- FragmentAnimationProvider
- ImeKeyMonitor
- ImeKeyMonitor.ImeKeyListener
- MultiActionsProvider
- OnActionClickedListener
- OnChildLaidOutListener
- OnChildSelectedListener
- OnItemViewClickedListener
- OnItemViewSelectedListener
- PlaybackSeekUi
- SearchBar.SearchBarListener
- SearchBar.SearchBarPermissionListener
- SearchEditText.OnKeyboardDismissListener
- SpeechRecognitionCallback
- TitleViewAdapter.Provider
- ViewHolderTask
Classes
- AbstractDetailsDescriptionPresenter
- AbstractDetailsDescriptionPresenter.ViewHolder
- AbstractMediaItemPresenter
- AbstractMediaItemPresenter.ViewHolder
- AbstractMediaListHeaderPresenter
- AbstractMediaListHeaderPresenter.ViewHolder
- Action
- ArrayObjectAdapter
- BaseCardView
- BaseCardView.LayoutParams
- BaseGridView
- BrowseFrameLayout
- ClassPresenterSelector
- ControlButtonPresenterSelector
- CursorObjectAdapter
- DetailsOverviewLogoPresenter
- DetailsOverviewLogoPresenter.ViewHolder
- DetailsOverviewRow
- DetailsOverviewRow.Listener
- DetailsOverviewRowPresenter
- DetailsOverviewRowPresenter.ViewHolder
- DetailsParallax
- DiffCallback
- DividerPresenter
- DividerRow
- FocusHighlightHelper
- FullWidthDetailsOverviewRowPresenter
- FullWidthDetailsOverviewRowPresenter.Listener
- FullWidthDetailsOverviewRowPresenter.ViewHolder
- FullWidthDetailsOverviewRowPresenter.ViewHolder.DetailsOverviewRowListener
- FullWidthDetailsOverviewSharedElementHelper
- GuidanceStylist
- GuidanceStylist.Guidance
- GuidedAction
- GuidedAction.Builder
- GuidedAction.BuilderBase
- GuidedActionDiffCallback
- GuidedActionEditText
- GuidedActionsStylist
- GuidedActionsStylist.ViewHolder
- GuidedDatePickerAction
- GuidedDatePickerAction.Builder
- GuidedDatePickerAction.BuilderBase
- HeaderItem
- HorizontalGridView
- HorizontalHoverCardSwitcher
- ImageCardView
- ItemAlignmentFacet
- ItemAlignmentFacet.ItemAlignmentDef
- ItemBridgeAdapter
- ItemBridgeAdapter.AdapterListener
- ItemBridgeAdapter.ViewHolder
- ItemBridgeAdapter.Wrapper
- ItemBridgeAdapterShadowOverlayWrapper
- ListRow
- ListRowHoverCardView
- ListRowPresenter
- ListRowPresenter.SelectItemViewHolderTask
- ListRowPresenter.ViewHolder
- ListRowView
- MultiActionsProvider.MultiAction
- ObjectAdapter
- ObjectAdapter.DataObserver
- OnChildViewHolderSelectedListener
- PageRow
- Parallax
- Parallax.FloatProperty
- Parallax.IntProperty
- Parallax.PropertyMarkerValue
- ParallaxEffect
- ParallaxTarget
- ParallaxTarget.DirectPropertyTarget
- ParallaxTarget.PropertyValuesHolderTarget
- PlaybackControlsRow
- PlaybackControlsRow.ClosedCaptioningAction
- PlaybackControlsRow.FastForwardAction
- PlaybackControlsRow.HighQualityAction
- PlaybackControlsRow.MoreActions
- PlaybackControlsRow.MultiAction
- PlaybackControlsRow.OnPlaybackProgressCallback
- PlaybackControlsRow.PictureInPictureAction
- PlaybackControlsRow.PlayPauseAction
- PlaybackControlsRow.RepeatAction
- PlaybackControlsRow.RewindAction
- PlaybackControlsRow.ShuffleAction
- PlaybackControlsRow.SkipNextAction
- PlaybackControlsRow.SkipPreviousAction
- PlaybackControlsRow.ThumbsAction
- PlaybackControlsRow.ThumbsDownAction
- PlaybackControlsRow.ThumbsUpAction
- PlaybackControlsRowPresenter
- PlaybackControlsRowPresenter.ViewHolder
- PlaybackRowPresenter
- PlaybackRowPresenter.ViewHolder
- PlaybackSeekDataProvider
- PlaybackSeekDataProvider.ResultCallback
- PlaybackSeekUi.Client
- PlaybackTransportRowPresenter
- PlaybackTransportRowPresenter.ViewHolder
- Presenter
- Presenter.ViewHolder
- Presenter.ViewHolderTask
- PresenterSelector
- PresenterSwitcher
- RecyclerViewParallax
- RecyclerViewParallax.ChildPositionProperty
- Row
- RowHeaderPresenter
- RowHeaderPresenter.ViewHolder
- RowHeaderView
- RowPresenter
- RowPresenter.ViewHolder
- SearchBar
- SearchEditText
- SearchOrbView
- SearchOrbView.Colors
- SectionRow
- ShadowOverlayContainer
- ShadowOverlayHelper
- ShadowOverlayHelper.Builder
- ShadowOverlayHelper.Options
- SinglePresenterSelector
- SparseArrayObjectAdapter
- SpeechOrbView
- TitleHelper
- TitleView
- TitleViewAdapter
- VerticalGridPresenter
- VerticalGridPresenter.ViewHolder
- VerticalGridView
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2024-04-11 UTC.