public
class
ListRowPresenter
extends RowPresenter
java.lang.Object | |||
↳ | android.support.v17.leanback.widget.Presenter | ||
↳ | android.support.v17.leanback.widget.RowPresenter | ||
↳ | android.support.v17.leanback.widget.ListRowPresenter |
ListRowPresenter renders ListRow
using a
HorizontalGridView
hosted in a ListRowView
.
setHoverCardPresenterSelector(PresenterSelector)
can be used to
display a view for the currently focused list item below the rendered
list. This view is known as a hover card.
RowPresenter
's default dimming effect and draws
a dim overlay on each view individually. A subclass may override and disable
isUsingDefaultListSelectEffect()
and write its own dim effect in
onSelectLevelChanged(RowPresenter.ViewHolder)
.
setShadowEnabled(boolean)
to disable shadows. A subclass may override and return
false in isUsingDefaultShadow()
and replace with its own shadow implementation.
Nested classes | |
---|---|
class |
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. |
class |
ListRowPresenter.ViewHolder
ViewHolder for the ListRowPresenter. |
Inherited constants |
---|
From
class
android.support.v17.leanback.widget.RowPresenter
|
Public constructors | |
---|---|
ListRowPresenter()
Constructs a ListRowPresenter with defaults. |
|
ListRowPresenter(int focusZoomFactor)
Constructs a ListRowPresenter with the given parameters. |
|
ListRowPresenter(int focusZoomFactor, boolean useFocusDimmer)
Constructs a ListRowPresenter with the given parameters. |
Public methods | |
---|---|
final
boolean
|
areChildRoundedCornersEnabled()
Returns true if rounded corners are enabled for children of this row. |
final
void
|
enableChildRoundedCorners(boolean enable)
Enables or disabled rounded corners on children of this row. |
void
|
freeze(RowPresenter.ViewHolder holder, boolean freeze)
Freezes/unfreezes the row, typically used when a transition starts/ends. |
int
|
getExpandedRowHeight()
Returns the expanded row height for rows created by this Presenter. |
final
int
|
getFocusZoomFactor()
Returns the zoom factor used for focus highlighting. |
final
PresenterSelector
|
getHoverCardPresenterSelector()
Returns the |
int
|
getRecycledPoolSize(Presenter presenter)
Returns the recycled pool size for the given presenter. |
int
|
getRowHeight()
Returns the row height for list rows created by this Presenter. |
final
boolean
|
getShadowEnabled()
Returns true if child shadow is enabled. |
final
int
|
getZoomFactor()
This method is deprecated.
use |
final
boolean
|
isFocusDimmerUsed()
Returns true if the focus dimmer is used for focus highlighting; false otherwise. |
final
boolean
|
isKeepChildForeground()
Returns true if keeps foreground of child of this row, false otherwise. |
boolean
|
isUsingDefaultListSelectEffect()
Returns true so that default select effect is applied to each individual
child of |
final
boolean
|
isUsingDefaultSelectEffect()
ListRowPresenter overrides the default select effect of |
boolean
|
isUsingDefaultShadow()
Returns true if SDK >= 18, where default shadow
is applied to each individual child of |
boolean
|
isUsingZOrder(Context context)
Returns true if SDK >= L, where Z shadow is enabled so that Z order is enabled on each child of horizontal list. |
void
|
setEntranceTransitionState(RowPresenter.ViewHolder holder, boolean afterEntrance)
Changes the visibility of views. |
void
|
setExpandedRowHeight(int rowHeight)
Sets the expanded row height for rows created by this Presenter. |
final
void
|
setHoverCardPresenterSelector(PresenterSelector selector)
Sets the |
final
void
|
setKeepChildForeground(boolean keep)
When ListRowPresenter applies overlay color on the child, it may change child's foreground Drawable. |
void
|
setNumRows(int numRows)
Sets the numbers of rows for rendering the list of items. |
void
|
setRecycledPoolSize(Presenter presenter, int size)
Sets the recycled pool size for the given presenter. |
void
|
setRowHeight(int rowHeight)
Sets the row height for rows created by this Presenter. |
final
void
|
setShadowEnabled(boolean enabled)
Enables or disables child shadow. |
Protected methods | |
---|---|
RowPresenter.ViewHolder
|
createRowViewHolder(ViewGroup parent)
Called to create a ViewHolder object for a Row. |
ShadowOverlayHelper.Options
|
createShadowOverlayOptions()
Create ShadowOverlayHelper Options. |
void
|
dispatchItemSelectedListener(RowPresenter.ViewHolder holder, boolean selected)
Dispatch item selected event using current selected item in the |
void
|
initializeRowViewHolder(RowPresenter.ViewHolder holder)
Called after a |
void
|
onBindRowViewHolder(RowPresenter.ViewHolder holder, Object item)
Binds the given row object to the given ViewHolder. |
void
|
onRowViewExpanded(RowPresenter.ViewHolder holder, boolean expanded)
Called when the row view's expanded state changes. |
void
|
onRowViewSelected(RowPresenter.ViewHolder holder, boolean selected)
Called when the given row view changes selection state. |
void
|
onSelectLevelChanged(RowPresenter.ViewHolder holder)
Applies select level to header and draw a default color dim over each child
of |
void
|
onUnbindRowViewHolder(RowPresenter.ViewHolder holder)
Unbinds the given ViewHolder. |
Inherited methods | |
---|---|
From
class
android.support.v17.leanback.widget.RowPresenter
| |
From
class
android.support.v17.leanback.widget.Presenter
| |
From
class
java.lang.Object
| |
From
interface
android.support.v17.leanback.widget.FacetProvider
|
ListRowPresenter ()
Constructs a ListRowPresenter with defaults.
Uses ZOOM_FACTOR_MEDIUM
for focus zooming and
disabled dimming on focus.
ListRowPresenter (int focusZoomFactor)
Constructs a ListRowPresenter with the given parameters.
Parameters | |
---|---|
focusZoomFactor |
int :
Controls the zoom factor used when an item view is focused. One of
ZOOM_FACTOR_NONE ,
ZOOM_FACTOR_SMALL ,
ZOOM_FACTOR_XSMALL ,
ZOOM_FACTOR_MEDIUM ,
ZOOM_FACTOR_LARGE
Dimming on focus defaults to disabled.
|
ListRowPresenter (int focusZoomFactor, boolean useFocusDimmer)
Constructs a ListRowPresenter with the given parameters.
Parameters | |
---|---|
focusZoomFactor |
int :
Controls the zoom factor used when an item view is focused. One of
ZOOM_FACTOR_NONE ,
ZOOM_FACTOR_SMALL ,
ZOOM_FACTOR_XSMALL ,
ZOOM_FACTOR_MEDIUM ,
ZOOM_FACTOR_LARGE |
useFocusDimmer |
boolean :
determines if the FocusHighlighter will use the dimmer
|
boolean areChildRoundedCornersEnabled ()
Returns true if rounded corners are enabled for children of this row.
Returns | |
---|---|
boolean |
void enableChildRoundedCorners (boolean enable)
Enables or disabled rounded corners on children of this row. Supported on Android SDK >= L.
Parameters | |
---|---|
enable |
boolean
|
void freeze (RowPresenter.ViewHolder holder, boolean freeze)
Freezes/unfreezes the row, typically used when a transition starts/ends. This method is called by the fragment, it should not call it directly by the application.
Parameters | |
---|---|
holder |
RowPresenter.ViewHolder
|
freeze |
boolean
|
int getExpandedRowHeight ()
Returns the expanded row height for rows created by this Presenter.
Returns | |
---|---|
int |
int getFocusZoomFactor ()
Returns the zoom factor used for focus highlighting.
Returns | |
---|---|
int |
PresenterSelector getHoverCardPresenterSelector ()
Returns the PresenterSelector
used for showing a select object in a hover card.
Returns | |
---|---|
PresenterSelector |
int getRecycledPoolSize (Presenter presenter)
Returns the recycled pool size for the given presenter.
Parameters | |
---|---|
presenter |
Presenter
|
Returns | |
---|---|
int |
int getRowHeight ()
Returns the row height for list rows created by this Presenter.
Returns | |
---|---|
int |
boolean getShadowEnabled ()
Returns true if child shadow is enabled. This is not only for enable/disable default shadow implementation but also subclass must respect this flag.
Returns | |
---|---|
boolean |
int getZoomFactor ()
This method is deprecated.
use getFocusZoomFactor()
instead.
Returns the zoom factor used for focus highlighting.
Returns | |
---|---|
int |
boolean isFocusDimmerUsed ()
Returns true if the focus dimmer is used for focus highlighting; false otherwise.
Returns | |
---|---|
boolean |
boolean isKeepChildForeground ()
Returns true if keeps foreground of child of this row, false otherwise. When ListRowPresenter applies overlay color on the child, it may change child's foreground Drawable. If application uses child's foreground for other purposes such as ripple effect, it needs tell ListRowPresenter to keep the child's foreground. The default value is true.
Returns | |
---|---|
boolean |
true if keeps foreground of child of this row, false otherwise. |
boolean isUsingDefaultListSelectEffect ()
Returns true so that default select effect is applied to each individual
child of HorizontalGridView
. Subclass may return false to disable
the default implementation.
Returns | |
---|---|
boolean |
boolean isUsingDefaultSelectEffect ()
ListRowPresenter overrides the default select effect of RowPresenter
and return false.
Returns | |
---|---|
boolean |
boolean isUsingDefaultShadow ()
Returns true if SDK >= 18, where default shadow
is applied to each individual child of HorizontalGridView
.
Subclass may return false to disable.
Returns | |
---|---|
boolean |
boolean isUsingZOrder (Context context)
Returns true if SDK >= L, where Z shadow is enabled so that Z order is enabled on each child of horizontal list. If subclass returns false in isUsingDefaultShadow() and does not use Z-shadow on SDK >= L, it should override isUsingZOrder() return false.
Parameters | |
---|---|
context |
Context
|
Returns | |
---|---|
boolean |
void setEntranceTransitionState (RowPresenter.ViewHolder holder, boolean afterEntrance)
Changes the visibility of views. The entrance transition will be run against the views that change visibilities. A subclass may override and begin with calling super.setEntranceTransitionState(). This method is called by the fragment, it should not be called directly by the application.
Parameters | |
---|---|
holder |
RowPresenter.ViewHolder :
The ViewHolder of the row. |
afterEntrance |
boolean :
true if children of row participating in entrance transition
should be set to visible, false otherwise.
|
void setExpandedRowHeight (int rowHeight)
Sets the expanded row height for rows created by this Presenter. If not set, expanded rows have the same height as unexpanded rows.
Parameters | |
---|---|
rowHeight |
int :
The row height in to use when the row is expanded,
in pixels, or WRAP_CONTENT, or 0 to use the default.
|
void setHoverCardPresenterSelector (PresenterSelector selector)
Sets the PresenterSelector
used for showing a select object in a hover card.
Parameters | |
---|---|
selector |
PresenterSelector
|
void setKeepChildForeground (boolean keep)
When ListRowPresenter applies overlay color on the child, it may change child's foreground Drawable. If application uses child's foreground for other purposes such as ripple effect, it needs tell ListRowPresenter to keep the child's foreground. The default value is true.
Parameters | |
---|---|
keep |
boolean :
true if keep foreground of child of this row, false ListRowPresenter might change
the foreground of the child.
|
void setNumRows (int numRows)
Sets the numbers of rows for rendering the list of items. By default, it is set to 1.
Parameters | |
---|---|
numRows |
int
|
void setRecycledPoolSize (Presenter presenter, int size)
Sets the recycled pool size for the given presenter.
Parameters | |
---|---|
presenter |
Presenter
|
size |
int
|
void setRowHeight (int rowHeight)
Sets the row height for rows created by this Presenter. Rows created before calling this method will not be updated.
Parameters | |
---|---|
rowHeight |
int :
Row height in pixels, or WRAP_CONTENT, or 0
to use the default height.
|
void setShadowEnabled (boolean enabled)
Enables or disables child shadow. This is not only for enable/disable default shadow implementation but also subclass must respect this flag.
Parameters | |
---|---|
enabled |
boolean
|
RowPresenter.ViewHolder createRowViewHolder (ViewGroup parent)
Called to create a ViewHolder object for a Row. Subclasses will override this method to return a different concrete ViewHolder object.
Parameters | |
---|---|
parent |
ViewGroup :
The parent View for the Row's view holder. |
Returns | |
---|---|
RowPresenter.ViewHolder |
A ViewHolder for the Row's View. |
ShadowOverlayHelper.Options createShadowOverlayOptions ()
Create ShadowOverlayHelper Options. Subclass may override.
e.g.
return new ShadowOverlayHelper.Options().roundedCornerRadius(10);
Returns | |
---|---|
ShadowOverlayHelper.Options |
The options to be used for shadow, overlay and rouded corner. |
void dispatchItemSelectedListener (RowPresenter.ViewHolder holder, boolean selected)
Dispatch item selected event using current selected item in the HorizontalGridView
.
The method should only be called from onRowViewSelected().
Parameters | |
---|---|
holder |
RowPresenter.ViewHolder
|
selected |
boolean
|
void initializeRowViewHolder (RowPresenter.ViewHolder holder)
Called after a RowPresenter.ViewHolder
is created for a Row.
Subclasses may override this method and start by calling
super.initializeRowViewHolder(ViewHolder).
Parameters | |
---|---|
holder |
RowPresenter.ViewHolder :
The ViewHolder to initialize for the Row.
|
void onBindRowViewHolder (RowPresenter.ViewHolder holder, Object item)
Binds the given row object to the given ViewHolder.
Derived classes of RowPresenter
overriding
onBindRowViewHolder(ViewHolder, Object)
must call through the super class's
implementation of this method.
Parameters | |
---|---|
holder |
RowPresenter.ViewHolder
|
item |
Object
|
void onRowViewExpanded (RowPresenter.ViewHolder holder, boolean expanded)
Called when the row view's expanded state changes. A subclass may override this method to respond to expanded state changes of a Row. The default implementation will hide/show the header view. Subclasses may make visual changes to the Row View but must not create animation on the Row view.
Parameters | |
---|---|
holder |
RowPresenter.ViewHolder
|
expanded |
boolean
|
void onRowViewSelected (RowPresenter.ViewHolder holder, boolean selected)
Called when the given row view changes selection state. A subclass may override this to respond to selected state changes of a Row. A subclass may make visual changes to Row view but must not create animation on the Row view.
Parameters | |
---|---|
holder |
RowPresenter.ViewHolder
|
selected |
boolean
|
void onSelectLevelChanged (RowPresenter.ViewHolder holder)
Applies select level to header and draw a default color dim over each child
of HorizontalGridView
.
Subclass may override this method. A subclass
needs to call super.onSelectLevelChanged() for applying header select level
and optionally applying a default select level to each child view of
HorizontalGridView
if isUsingDefaultListSelectEffect()
is true. Subclass may override isUsingDefaultListSelectEffect()
to return
false and deal with the individual item select level by itself.
Parameters | |
---|---|
holder |
RowPresenter.ViewHolder
|
void onUnbindRowViewHolder (RowPresenter.ViewHolder holder)
Unbinds the given ViewHolder.
Derived classes of RowPresenter
overriding onUnbindRowViewHolder(ViewHolder)
must call through the super class's implementation of this method.
Parameters | |
---|---|
holder |
RowPresenter.ViewHolder
|