StaggeredGridLayoutManager.LayoutParams

public class StaggeredGridLayoutManager.LayoutParams extends RecyclerView.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

static final int

Span Id for Views that are not laid out yet.

Public methods

final int

Returns the Span index to which this View is assigned.

boolean

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 Constants

From android.view.ViewGroup.LayoutParams
static final int

This field is deprecated.

static final int
static final int

Inherited methods

From androidx.recyclerview.widget.RecyclerView.LayoutParams
int

Returns the up-to-date adapter position that the view this LayoutParams is attached to corresponds to in the RecyclerView.

int

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

This method is deprecated.

This method is confusing when nested adapters are used.

int

Returns the adapter position that the view this LayoutParams is attached to corresponds to as of latest layout calculation.

int

This method is deprecated.

use getViewLayoutPosition or getViewAdapterPosition

boolean

Returns true if the adapter data item corresponding to the view this LayoutParams is attached to has been changed in the data set.

boolean

Returns true if the adapter data item corresponding to the view this LayoutParams is attached to has been removed from the data set.

boolean

Returns true if the view this LayoutParams is attached to is now representing potentially invalid data.

boolean

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
int
int
boolean
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

LayoutParams

Added in 1.4.0-alpha01
public LayoutParams(RecyclerView.LayoutParams source)

LayoutParams

Added in 1.4.0-alpha01
public LayoutParams(ViewGroup.LayoutParams source)

LayoutParams

Added in 1.4.0-alpha01
public LayoutParams(ViewGroup.MarginLayoutParams source)

LayoutParams

Added in 1.4.0-alpha01
public LayoutParams(Context c, AttributeSet attrs)

LayoutParams

Added in 1.4.0-alpha01
public LayoutParams(int width, int height)

Public methods

getSpanIndex

Added in 1.0.0
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

Added in 1.0.0
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

setFullSpan

Added in 1.0.0
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
boolean fullSpan

True if this item should traverse all spans.

See also
isFullSpan