LayoutParams

Kotlin |Java

open class LayoutParams : RecyclerView.LayoutParams

kotlin.Any
↳	android.view.ViewGroup.LayoutParams
	↳	android.view.ViewGroup.MarginLayoutParams
		↳	androidx.recyclerview.widget.RecyclerView.LayoutParams
			↳	androidx.recyclerview.widget.GridLayoutManager.LayoutParams

LayoutParams used by GridLayoutManager.

Note that if the orientation is VERTICAL, the width parameter is ignored and if the orientation is HORIZONTAL the height parameter is ignored because child view is expected to fill all of the space given to it.

Summary

Constants
static Int	`INVALID_SPAN_ID` Span Id for Views that are not laid out yet.

Public constructors
`<init>(c: Context!, attrs: AttributeSet!)`
`<init>(width: Int, height: Int)`
`<init>(source: MarginLayoutParams!)`
`<init>(source: LayoutParams!)`
`<init>(source: RecyclerView.LayoutParams!)`

Public methods
open Int	`getSpanIndex()` Returns the current span index of this View.
open Int	`getSpanSize()` Returns the number of spans occupied by this View.

Inherited functions

From class LayoutParams

`Int`	`getViewAdapterPosition()` Returns the up-to-date adapter position that the view this LayoutParams is attached to corresponds to.
`Int`	`getViewLayoutPosition()` Returns the adapter position that the view this LayoutParams is attached to corresponds to as of latest layout calculation.
`Int`	`getViewPosition()`
`Boolean`	`isItemChanged()` Returns true if the adapter data item corresponding to the view this LayoutParams is attached to has been changed in the data set. A LayoutManager may choose to treat it differently in order to animate its changing state.
`Boolean`	`isItemRemoved()` Returns true if the adapter data item corresponding to the view this LayoutParams is attached to has been removed from the data set. A LayoutManager may choose to treat it differently in order to animate its outgoing or disappearing state.
`Boolean`	`isViewInvalid()` Returns true if the view this LayoutParams is attached to is now representing potentially invalid data. A LayoutManager should scrap/recycle it.
`Boolean`	`viewNeedsUpdate()` Returns true if the view this LayoutParams is attached to needs to have its content updated from the corresponding adapter.

Constants

INVALID_SPAN_ID

static val INVALID_SPAN_ID: Int

Span Id for Views that are not laid out yet.

Value: -1

Public constructors

<init>

LayoutParams(
    c: Context!, 
    attrs: AttributeSet!)

<init>

LayoutParams(
    width: Int, 
    height: Int)

<init>

LayoutParams(source: MarginLayoutParams!)

<init>

LayoutParams(source: LayoutParams!)

<init>

LayoutParams(source: RecyclerView.LayoutParams!)

Public methods

getSpanIndex

open fun getSpanIndex(): Int

Returns the current span index of this View. If the View is not laid out yet, the return value is undefined.

Starting with RecyclerView 24.2.0, span indices are always indexed from position 0 even if the layout is RTL. In a vertical GridLayoutManager, leftmost span is span 0 if the layout is LTR and rightmost span is span 0 if the layout is RTL. Prior to 24.2.0, it was the opposite which was conflicting with SpanSizeLookup#getSpanIndex(int, int).

If the View occupies multiple spans, span with the minimum index is returned.

Return
Int: The span index of the View.

getSpanSize

open fun getSpanSize(): Int

Returns the number of spans occupied by this View. If the View not laid out yet, the return value is undefined.

Return
Int: The number of spans occupied by this View.