GridLayoutManager.LayoutParams

Artifact: androidx.recyclerview:recyclerview

Added in 1.0.0

Kotlin |Java

public class GridLayoutManager.LayoutParams extends RecyclerView.LayoutParams

java.lang.Object
↳	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 final int`	`INVALID_SPAN_ID = -1` Span Id for Views that are not laid out yet.

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

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

Inherited Constants

From android.view.ViewGroup.LayoutParams

`static final int`	`FILL_PARENT = -1` This field is deprecated.
`static final int`	`MATCH_PARENT = -1`
`static final int`	`WRAP_CONTENT = -2`

Inherited fields

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`

Inherited methods

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 method 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 method 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

void

setBaseAttributes(TypedArray a, int widthAttr, int heightAttr)

From android.view.ViewGroup.MarginLayoutParams

`int`	`getLayoutDirection()`
`int`	`getMarginEnd()`
`int`	`getMarginStart()`
`boolean`	`isMarginRelative()`
`void`	`resolveLayoutDirection(int layoutDirection)`
`void`	`setLayoutDirection(int layoutDirection)`
`void`	`setMarginEnd(int end)`
`void`	`setMarginStart(int start)`
`void`	`setMargins(int left, int top, int right, int bottom)`

Constants

INVALID_SPAN_ID

Added in 1.0.0

public static final int INVALID_SPAN_ID = -1

Span Id for Views that are not laid out yet.

Public constructors

Added in 1.4.0-rc01

public LayoutParams(RecyclerView.LayoutParams source)

LayoutParams

Added in 1.4.0-rc01

public LayoutParams(ViewGroup.LayoutParams source)

LayoutParams

Added in 1.4.0-rc01

public LayoutParams(ViewGroup.MarginLayoutParams source)

LayoutParams

Added in 1.4.0-rc01

public LayoutParams(Context c, AttributeSet attrs)

LayoutParams

Added in 1.4.0-rc01

public LayoutParams(int width, int height)

Public methods

getSpanIndex

Added in 1.0.0

public int getSpanIndex()

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

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

Returns
`int`	The span index of the View.

getSpanSize

Added in 1.0.0

public int getSpanSize()

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

Returns
`int`	The number of spans occupied by this View.