ListRowPresenter

public ListRowPresenter()

Constructs a ListRowPresenter with defaults. Uses ZOOM_FACTOR_MEDIUM for focus zooming and disabled dimming on focus.

public ListRowPresenter(int focusZoomFactor)

Constructs a ListRowPresenter with the given parameters.

public ListRowPresenter(int focusZoomFactor, boolean useFocusDimmer)

Constructs a ListRowPresenter with the given parameters.

public final boolean areChildRoundedCornersEnabled()

Returns true if rounded corners are enabled for children of this row.

public final void enableChildRoundedCorners(boolean enable)

Enables or disabled rounded corners on children of this row. Supported on Android SDK >= L.

public void freeze(@NonNull 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.

public int getExpandedRowHeight()

Returns the expanded row height for rows created by this Presenter.

public final int getFocusZoomFactor()

Returns the zoom factor used for focus highlighting.

public final PresenterSelector getHoverCardPresenterSelector()

Returns the PresenterSelector used for showing a select object in a hover card.

public int getRecycledPoolSize(Presenter presenter)

Returns the recycled pool size for the given presenter.

public int getRowHeight()

Returns the row height for list rows created by this Presenter.

public final 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.

public final int getZoomFactor()

Returns the zoom factor used for focus highlighting.

public final boolean isFocusDimmerUsed()

Returns true if the focus dimmer is used for focus highlighting; false otherwise.

public final 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.

public 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 and implement applySelectLevelToChild.

public final boolean isUsingDefaultSelectEffect()

ListRowPresenter overrides the default select effect of RowPresenter and return false.

public boolean isUsingDefaultShadow()

Default implementation returns true if SDK version >= 21, shadow (either static or z-order based) will be applied to each individual child of HorizontalGridView. Subclass may return false to disable default implementation of shadow and provide its own.

public boolean isUsingOutlineClipping(Context context)

Returns true if leanback view outline is enabled on the system or false otherwise. When false, rounded corner will not be enabled even enableChildRoundedCorners is called with true.

public 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.

public void setEntranceTransitionState(
    @NonNull 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.

public 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.

public final void setHoverCardPresenterSelector(PresenterSelector selector)

Sets the PresenterSelector used for showing a select object in a hover card.

public final 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.

public void setNumRows(int numRows)

Sets the numbers of rows for rendering the list of items. By default, it is set to 1.

public void setRecycledPoolSize(Presenter presenter, int size)

Sets the recycled pool size for the given presenter.

public void setRowHeight(int rowHeight)

Sets the row height for rows created by this Presenter. Rows created before calling this method will not be updated.

public final 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.

protected void applySelectLevelToChild(
    ListRowPresenter.ViewHolder rowViewHolder,
    View childView
)

Applies select level to a child. Default implementation draws a default color dim over each child of HorizontalGridView. This method is called on all children in onSelectLevelChanged and when a child is attached to HorizontalGridView.

Subclass may disable the default implementation by override isUsingDefaultListSelectEffect to return false and deal with the individual item select level by itself.

protected 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.

protected ShadowOverlayHelper.Options createShadowOverlayOptions()

Create ShadowOverlayHelper Options. Subclass may override. e.g. return new ShadowOverlayHelper.Options().roundedCornerRadius(10);

protected 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().

protected void initializeRowViewHolder(RowPresenter.ViewHolder vh)

Called after a RowPresenter.ViewHolder is created for a Row. Subclasses may override this method and start by calling super.initializeRowViewHolder(ViewHolder).

protected void onBindRowViewHolder(
    @NonNull RowPresenter.ViewHolder holder,
    @NonNull Object item
)

Binds the given row object to the given ViewHolder. Derived classes of RowPresenter overriding onBindRowViewHolder must call through the super class's implementation of this method.

protected 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.

protected 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.

protected void onSelectLevelChanged(RowPresenter.ViewHolder holder)

Applies select level to header and draws a default color dim over each child of HorizontalGridView.

Subclass may override this method and starts with calling super if it has views to apply select effect other than header and HorizontalGridView. To override the default color dim over each child of HorizontalGridView, app should override isUsingDefaultListSelectEffect to return false and override applySelectLevelToChild.

protected void onUnbindRowViewHolder(@NonNull RowPresenter.ViewHolder holder)

Unbinds the given ViewHolder. Derived classes of RowPresenter overriding onUnbindRowViewHolder must call through the super class's implementation of this method.