ListRowPresenter

ListRowPresenter()

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

ListRowPresenter(focusZoomFactor: Int)

Constructs a ListRowPresenter with the given parameters.

ListRowPresenter(focusZoomFactor: Int, useFocusDimmer: Boolean)

Constructs a ListRowPresenter with the given parameters.

fun areChildRoundedCornersEnabled(): Boolean

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

fun enableChildRoundedCorners(enable: Boolean): Unit

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

fun freeze(holder: RowPresenter.ViewHolder, freeze: Boolean): Unit

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.

fun getExpandedRowHeight(): Int

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

fun getFocusZoomFactor(): Int

Returns the zoom factor used for focus highlighting.

fun getHoverCardPresenterSelector(): PresenterSelector!

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

fun getRecycledPoolSize(presenter: Presenter!): Int

Returns the recycled pool size for the given presenter.

fun getRowHeight(): Int

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

fun getShadowEnabled(): Boolean

Returns true if child shadow is enabled. This is not only for enable/disable default shadow implementation but also subclass must respect this flag.

fun getZoomFactor(): Int

Returns the zoom factor used for focus highlighting.

fun isFocusDimmerUsed(): Boolean

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

fun isKeepChildForeground(): Boolean

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.

fun isUsingDefaultListSelectEffect(): Boolean

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.

fun isUsingDefaultSelectEffect(): Boolean

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

fun isUsingDefaultShadow(): Boolean

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.

fun isUsingOutlineClipping(context: Context!): Boolean

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.

fun isUsingZOrder(context: Context!): Boolean

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.

fun setEntranceTransitionState(
    holder: RowPresenter.ViewHolder,
    afterEntrance: Boolean
): Unit

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.

fun setExpandedRowHeight(rowHeight: Int): Unit

Sets the expanded row height for rows created by this Presenter. If not set, expanded rows have the same height as unexpanded rows.

fun setHoverCardPresenterSelector(selector: PresenterSelector!): Unit

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

fun setKeepChildForeground(keep: Boolean): Unit

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.

fun setNumRows(numRows: Int): Unit

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

fun setRecycledPoolSize(presenter: Presenter!, size: Int): Unit

Sets the recycled pool size for the given presenter.

fun setRowHeight(rowHeight: Int): Unit

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

fun setShadowEnabled(enabled: Boolean): Unit

Enables or disables child shadow. This is not only for enable/disable default shadow implementation but also subclass must respect this flag.

protected fun applySelectLevelToChild(
    rowViewHolder: ListRowPresenter.ViewHolder!,
    childView: View!
): Unit

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 fun createRowViewHolder(parent: ViewGroup!): RowPresenter.ViewHolder!

Called to create a ViewHolder object for a Row. Subclasses will override this method to return a different concrete ViewHolder object.

protected fun createShadowOverlayOptions(): ShadowOverlayHelper.Options!

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

protected fun dispatchItemSelectedListener(
    holder: RowPresenter.ViewHolder!,
    selected: Boolean
): Unit

Dispatch item selected event using current selected item in the HorizontalGridView. The method should only be called from onRowViewSelected().

protected fun initializeRowViewHolder(vh: RowPresenter.ViewHolder!): Unit

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

protected fun onBindRowViewHolder(holder: RowPresenter.ViewHolder, item: Any): Unit

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 fun onRowViewExpanded(holder: RowPresenter.ViewHolder!, expanded: Boolean): Unit

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 fun onRowViewSelected(holder: RowPresenter.ViewHolder!, selected: Boolean): Unit

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 fun onSelectLevelChanged(holder: RowPresenter.ViewHolder!): Unit

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 fun onUnbindRowViewHolder(holder: RowPresenter.ViewHolder): Unit

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