HorizontalGridView

open class HorizontalGridView : BaseGridView
kotlin.Any
   ↳ android.view.View
   ↳ android.view.ViewGroup
   ↳ androidx.recyclerview.widget.RecyclerView
   ↳ androidx.leanback.widget.BaseGridView
   ↳ androidx.leanback.widget.HorizontalGridView

A android.view.ViewGroup that shows items in a horizontal scrolling list. The items come from the RecyclerView.Adapter associated with this view.

RecyclerView.Adapter can optionally implement FacetProviderAdapter which provides FacetProvider for a given view type; RecyclerView.ViewHolder can also implement FacetProvider. Facet from ViewHolder has a higher priority than the one from FacetProviderAdapter associated with viewType. Supported optional facets are:

  1. ItemAlignmentFacet When this facet is provided by ViewHolder or FacetProviderAdapter, it will override the item alignment settings set on HorizontalGridView. This facet also allows multiple alignment positions within one ViewHolder.

Summary

Inherited constants
Public constructors
<init>(context: Context!)

<init>(context: Context!, attrs: AttributeSet!)

<init>(context: Context!, attrs: AttributeSet!, defStyle: Int)

Public methods
Boolean

Returns true if left edge fading is enabled.

Unit

Sets the right edge fading length in pixels.

Int

Sets the distance in pixels between fading start position and right padding edge.

open Unit
setNumRows(numRows: Int)

Sets the number of rows.

Unit

Sets the distance in pixels between fading start position and left padding edge.

Int

Returns the left edge fading length in pixels.

Unit

Returns the distance in pixels between fading start position and right padding edge.

open Unit
setRowHeight(height: Int)

Sets the row height.

Unit

Sets the fade out right edge to transparent.

open Unit
draw(canvas: Canvas!)

Int

Returns the right edge fading length in pixels.

Boolean

Returns true if fading right edge is enabled.

Unit

Sets the left edge fading length in pixels.

Int

Returns the distance in pixels between fading start position and left padding edge.

Unit

Sets the fade out left edge to transparent.

Protected methods
open Unit
initAttributes(context: Context!, attrs: AttributeSet!)

Inherited functions

Public constructors

<init>

HorizontalGridView(context: Context!)

<init>

HorizontalGridView(context: Context!, attrs: AttributeSet!)

<init>

HorizontalGridView(context: Context!, attrs: AttributeSet!, defStyle: Int)

Public methods

getFadingLeftEdge

fun getFadingLeftEdge(): Boolean

Returns true if left edge fading is enabled.

setFadingRightEdgeLength

fun setFadingRightEdgeLength(fadeLength: Int): Unit

Sets the right edge fading length in pixels.

getFadingRightEdgeOffset

fun getFadingRightEdgeOffset(): Int

Sets the distance in pixels between fading start position and right padding edge. The fading start position is positive when start position is inside right padding area. Default value is 0, means that the fading starts from right padding edge.

setNumRows

open fun setNumRows(numRows: Int): Unit

Sets the number of rows. Defaults to one.

setFadingLeftEdgeOffset

fun setFadingLeftEdgeOffset(fadeOffset: Int): Unit

Sets the distance in pixels between fading start position and left padding edge. The fading start position is positive when start position is inside left padding area. Default value is 0, means that the fading starts from left padding edge.

getFadingLeftEdgeLength

fun getFadingLeftEdgeLength(): Int

Returns the left edge fading length in pixels.

setFadingRightEdgeOffset

fun setFadingRightEdgeOffset(fadeOffset: Int): Unit

Returns the distance in pixels between fading start position and right padding edge. The fading start position is positive when start position is inside right padding area. Default value is 0, means that the fading starts from right padding edge.

setRowHeight

open fun setRowHeight(height: Int): Unit

Sets the row height.

Parameters
height Int: May be WRAP_CONTENT, or a size in pixels. If zero, row height will be fixed based on number of rows and view height.

setFadingRightEdge

fun setFadingRightEdge(fading: Boolean): Unit

Sets the fade out right edge to transparent. Note turn on fading edge is very expensive that you should turn off when HorizontalGridView is scrolling.

draw

open fun draw(canvas: Canvas!): Unit

getFadingRightEdgeLength

fun getFadingRightEdgeLength(): Int

Returns the right edge fading length in pixels.

getFadingRightEdge

fun getFadingRightEdge(): Boolean

Returns true if fading right edge is enabled.

setFadingLeftEdgeLength

fun setFadingLeftEdgeLength(fadeLength: Int): Unit

Sets the left edge fading length in pixels.

getFadingLeftEdgeOffset

fun getFadingLeftEdgeOffset(): Int

Returns the distance in pixels between fading start position and left padding edge. The fading start position is positive when start position is inside left padding area. Default value is 0, means that the fading starts from left padding edge.

setFadingLeftEdge

fun setFadingLeftEdge(fading: Boolean): Unit

Sets the fade out left edge to transparent. Note turn on fading edge is very expensive that you should turn off when HorizontalGridView is scrolling.

Protected methods

initAttributes

protected open fun initAttributes(context: Context!, attrs: AttributeSet!): Unit