StaggeredGridLayoutManager.LayoutParams

Artifact: androidx.recyclerview:recyclerview

Added in 1.0.0

Kotlin |Java

class StaggeredGridLayoutManager.LayoutParams : RecyclerView.LayoutParams

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

LayoutParams used by StaggeredGridLayoutManager.

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
`const Int`	`INVALID_SPAN_ID = -1` Span Id for Views that are not laid out yet.

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

Public functions
`Int`	`getSpanIndex()` Returns the Span index to which this View is assigned.
`Boolean`	`isFullSpan()` Returns whether this View occupies all available spans or just one.
`Unit`	`setFullSpan(fullSpan: Boolean)` When set to true, the item will layout using all span area.

Inherited Constants

From android.view.ViewGroup.LayoutParams

`const Int`	`FILL_PARENT = -1` This property is deprecated.
`const Int`	`MATCH_PARENT = -1`
`const Int`	`WRAP_CONTENT = -2`

Inherited functions

From androidx.recyclerview.widget.RecyclerView.LayoutParams

`Int`	`getAbsoluteAdapterPosition()` Returns the up-to-date adapter position that the view this LayoutParams is attached to corresponds to in the `RecyclerView`.
`Int`	`getBindingAdapterPosition()` Returns the up-to-date adapter position that the view this LayoutParams is attached to corresponds to with respect to the `Adapter` that bound this View.
`Int`	`getViewAdapterPosition()` This function is deprecated. This method is confusing when nested adapters are used.
`Int`	`getViewLayoutPosition()` Returns the adapter position that the view this LayoutParams is attached to corresponds to as of latest layout calculation.
`Int`	`getViewPosition()` This function is deprecated. use `getViewLayoutPosition` or `getViewAdapterPosition`
`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.
`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.
`Boolean`	`isViewInvalid()` Returns true if the view this LayoutParams is attached to is now representing potentially invalid data.
`Boolean`	`viewNeedsUpdate()` Returns true if the view this LayoutParams is attached to needs to have its content updated from the corresponding adapter.

From android.view.ViewGroup.LayoutParams

Unit

setBaseAttributes(a: TypedArray!, widthAttr: Int, heightAttr: Int)

From android.view.ViewGroup.MarginLayoutParams

`Int`	`getLayoutDirection()`
`Int`	`getMarginEnd()`
`Int`	`getMarginStart()`
`Boolean`	`isMarginRelative()`
`Unit`	`resolveLayoutDirection(layoutDirection: Int)`
`Unit`	`setLayoutDirection(layoutDirection: Int)`
`Unit`	`setMarginEnd(end: Int)`
`Unit`	`setMarginStart(start: Int)`
`Unit`	`setMargins(left: Int, top: Int, right: Int, bottom: Int)`

Inherited properties

From android.view.ViewGroup.LayoutParams

`Int`	`height`
`LayoutAnimationController.AnimationParameters!`	`layoutAnimationParameters`
`Int`	`width`

From android.view.ViewGroup.MarginLayoutParams

`Int`	`bottomMargin`
`Int`	`leftMargin`
`Int`	`rightMargin`
`Int`	`topMargin`

Constants

INVALID_SPAN_ID

Added in 1.0.0

const val INVALID_SPAN_ID = -1: Int

Span Id for Views that are not laid out yet.

Public constructors

Added in 1.4.0

LayoutParams(source: RecyclerView.LayoutParams!)

LayoutParams

Added in 1.4.0

LayoutParams(source: ViewGroup.LayoutParams!)

LayoutParams

Added in 1.4.0

LayoutParams(source: ViewGroup.MarginLayoutParams!)

LayoutParams

Added in 1.4.0

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

LayoutParams

Added in 1.4.0

LayoutParams(width: Int, height: Int)

Public functions

getSpanIndex

Added in 1.0.0

fun getSpanIndex(): Int

Returns the Span index to which this View is assigned.

Returns
`Int`	The Span index of the View. If View is not yet assigned to any span, returns `INVALID_SPAN_ID`.

isFullSpan

Added in 1.0.0

fun isFullSpan(): Boolean

Returns whether this View occupies all available spans or just one.

Returns
`Boolean`	True if the View occupies all spans or false otherwise.

See also
`setFullSpan`

setFullSpan

Added in 1.0.0

fun setFullSpan(fullSpan: Boolean): Unit

When set to true, the item will layout using all span area. That means, if orientation is vertical, the view will have full width; if orientation is horizontal, the view will have full height.

Parameters
`fullSpan: Boolean`	True if this item should traverse all spans.

See also
`isFullSpan`