RecyclerView.LayoutParams
public
static
class
RecyclerView.LayoutParams
extends ViewGroup.MarginLayoutParams
java.lang.Object | |||
↳ | android.view.ViewGroup.LayoutParams | ||
↳ | android.view.ViewGroup.MarginLayoutParams | ||
↳ | androidx.recyclerview.widget.RecyclerView.LayoutParams |
LayoutParams
subclass for children of
RecyclerView
. Custom layout managers
are encouraged
to create their own subclass of this LayoutParams
class
to store any additional required per-child view metadata about the layout.
Summary
Inherited constants |
---|
Inherited fields |
---|
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 | |
---|---|
int
|
getAbsoluteAdapterPosition()
Returns the up-to-date adapter position that the view this LayoutParams is attached to
corresponds to in the |
int
|
getBindingAdapterPosition()
Returns the up-to-date adapter position that the view this LayoutParams is attached to
corresponds to with respect to the |
int
|
getViewAdapterPosition()
This method is deprecated.
This method is confusing when nested adapters are used.
If you are calling from the context of an |
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 |
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. |
Inherited methods | |
---|---|
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 |
LayoutParams
public LayoutParams (RecyclerView.LayoutParams source)
Parameters | |
---|---|
source |
RecyclerView.LayoutParams |
Public methods
getAbsoluteAdapterPosition
public int getAbsoluteAdapterPosition ()
Returns the up-to-date adapter position that the view this LayoutParams is attached to
corresponds to in the RecyclerView
. If the RecyclerView
has an
RecyclerView.Adapter
that merges other adapters, this position will be with respect to the
adapter that is assigned to the RecyclerView
.
Returns | |
---|---|
int |
the up-to-date adapter position this view with respect to the RecyclerView. It
may return RecyclerView.NO_POSITION if item represented by this View has been
removed or
its up-to-date position cannot be calculated.
|
getBindingAdapterPosition
public 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.
Returns | |
---|---|
int |
the up-to-date adapter position this view relative to the RecyclerView.Adapter that
bound this View. It may return RecyclerView.NO_POSITION if item represented by
this View has been removed or its up-to-date position cannot be calculated.
|
getViewAdapterPosition
public 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()
.
Returns | |
---|---|
int |
getViewLayoutPosition
public int getViewLayoutPosition ()
Returns the adapter position that the view this LayoutParams is attached to corresponds to as of latest layout calculation.
Returns | |
---|---|
int |
the adapter position this view as of latest layout pass |
getViewPosition
public int getViewPosition ()
This method is deprecated.
use getViewLayoutPosition()
or getViewAdapterPosition()
Returns | |
---|---|
int |
isItemChanged
public 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.
Returns | |
---|---|
boolean |
true if the item the view corresponds to was changed in the data set |
isItemRemoved
public 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.
Returns | |
---|---|
boolean |
true if the item the view corresponds to was removed from the data set |
isViewInvalid
public boolean isViewInvalid ()
Returns true if the view this LayoutParams is attached to is now representing potentially invalid data. A LayoutManager should scrap/recycle it.
Returns | |
---|---|
boolean |
true if the view is invalid |
viewNeedsUpdate
public boolean viewNeedsUpdate ()
Returns true if the view this LayoutParams is attached to needs to have its content updated from the corresponding adapter.
Returns | |
---|---|
boolean |
true if the view should have its content updated |