StaggeredGridLayoutManager.LayoutParams

Kotlin |Java

public static class StaggeredGridLayoutManager.LayoutParams
extends RecyclerView.LayoutParams

java.lang.Object
↳	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 StaggeredGridLayoutManager.VERTICAL, the width parameter is ignored and if the orientation is StaggeredGridLayoutManager.HORIZONTAL the height parameter is ignored because child view is expected to fill all of the space given to it.

Summary

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

Inherited constants

From class android.view.ViewGroup.LayoutParams

`int`	`FILL_PARENT`
`int`	`MATCH_PARENT`
`int`	`WRAP_CONTENT`

Inherited fields

From class android.view.ViewGroup.MarginLayoutParams

`public int`	`bottomMargin`
`public int`	`leftMargin`
`public int`	`rightMargin`
`public int`	`topMargin`

From class android.view.ViewGroup.LayoutParams

`public int`	`height`
`public LayoutAnimationController.AnimationParameters`	`layoutAnimationParameters`
`public int`	`width`

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

Public methods
`final 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.
`void`	`setFullSpan(boolean fullSpan)` When set to true, the item will layout using all span area.

Inherited methods

From class


        
          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 `RecyclerView.Adapter` that bound this View.
`int`	`getViewAdapterPosition()` This method is deprecated. This method is confusing when nested adapters are used. If you are calling from the context of an `RecyclerView.Adapter`, use `getBindingAdapterPosition()`. If you need the position that `RecyclerView` sees, use `getAbsoluteAdapterPosition()`.
`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 class


        
          android.view.ViewGroup.MarginLayoutParams

`int`	`getLayoutDirection()`
`int`	`getMarginEnd()`
`int`	`getMarginStart()`
`boolean`	`isMarginRelative()`
`void`	`resolveLayoutDirection(int arg0)`
`void`	`setLayoutDirection(int arg0)`
`void`	`setMarginEnd(int arg0)`
`void`	`setMarginStart(int arg0)`
`void`	`setMargins(int arg0, int arg1, int arg2, int arg3)`

From class


        
          android.view.ViewGroup.LayoutParams

`void`	`resolveLayoutDirection(int arg0)`
`void`	`setBaseAttributes(TypedArray arg0, int arg1, int arg2)`

From class


        
          java.lang.Object

`Object`	`clone()`
`boolean`	`equals(Object arg0)`
`void`	`finalize()`
`final Class<?>`	`getClass()`
`int`	`hashCode()`
`final void`	`notify()`
`final void`	`notifyAll()`
`String`	`toString()`
`final void`	`wait(long arg0, int arg1)`
`final void`	`wait(long arg0)`
`final void`	`wait()`

Constants

INVALID_SPAN_ID

public static final int INVALID_SPAN_ID

Span Id for Views that are not laid out yet.

Constant Value: -1 (0xffffffff)

Public constructors

LayoutParams

public LayoutParams (Context c, 
                AttributeSet attrs)

Parameters
`c`	`Context`
`attrs`	`AttributeSet`

LayoutParams

public LayoutParams (int width, 
                int height)

Parameters
`width`	`int`
`height`	`int`

LayoutParams

public LayoutParams (ViewGroup.MarginLayoutParams source)

Parameters
`source`	`ViewGroup.MarginLayoutParams`

LayoutParams

public LayoutParams (ViewGroup.LayoutParams source)

Parameters
`source`	`ViewGroup.LayoutParams`

public LayoutParams (RecyclerView.LayoutParams source)

Parameters
`source`	`RecyclerView.LayoutParams`

Public methods

getSpanIndex

public final int getSpanIndex ()

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

public boolean isFullSpan ()

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(boolean)

setFullSpan

public void setFullSpan (boolean fullSpan)

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()