public
static
abstract
class
RecyclerView.ItemDecoration
extends Object
| java.lang.Object | |
| ↳ | android.support.v7.widget.RecyclerView.ItemDecoration |
 Known Direct Subclasses
|
An ItemDecoration allows the application to add a special drawing and layout offset to specific item views from the adapter's data set. This can be useful for drawing dividers between items, highlights, visual grouping boundaries and more.
All ItemDecorations are drawn in the order they were added, before the item
views (in onDraw()
and after the items (in onDrawOver(Canvas, RecyclerView, RecyclerView.State).
Public constructors | |
|---|---|
RecyclerView.ItemDecoration()
|
|
Public methods | |
|---|---|
void
|
getItemOffsets(Rect outRect, int itemPosition, RecyclerView parent)
This method is deprecated.
Use |
void
|
getItemOffsets(Rect outRect, View view, RecyclerView parent, RecyclerView.State state)
Retrieve any offsets for the given item. |
void
|
onDraw(Canvas c, RecyclerView parent)
This method is deprecated.
Override |
void
|
onDraw(Canvas c, RecyclerView parent, RecyclerView.State state)
Draw any appropriate decorations into the Canvas supplied to the RecyclerView. |
void
|
onDrawOver(Canvas c, RecyclerView parent, RecyclerView.State state)
Draw any appropriate decorations into the Canvas supplied to the RecyclerView. |
void
|
onDrawOver(Canvas c, RecyclerView parent)
This method is deprecated.
Override |
Inherited methods | |
|---|---|
From
class
java.lang.Object
| |
RecyclerView.ItemDecoration ()
void getItemOffsets (Rect outRect, int itemPosition, RecyclerView parent)
This method is deprecated.
Use getItemOffsets(Rect, View, RecyclerView, State)
| Parameters | |
|---|---|
outRect |
Rect
|
itemPosition |
int
|
parent |
RecyclerView
|
void getItemOffsets (Rect outRect, View view, RecyclerView parent, RecyclerView.State state)
Retrieve any offsets for the given item. Each field of outRect specifies
the number of pixels that the item view should be inset by, similar to padding or margin.
The default implementation sets the bounds of outRect to 0 and returns.
If this ItemDecoration does not affect the positioning of item views, it should set
all four fields of outRect (left, top, right, bottom) to zero
before returning.
If you need to access Adapter for additional data, you can call
getChildAdapterPosition(View) to get the adapter position of the
View.
| Parameters | |
|---|---|
outRect |
Rect:
Rect to receive the output. |
view |
View:
The child view to decorate |
parent |
RecyclerView:
RecyclerView this ItemDecoration is decorating |
state |
RecyclerView.State:
The current state of RecyclerView.
|
void onDraw (Canvas c, RecyclerView parent)
This method is deprecated.
Override onDraw(Canvas, RecyclerView, RecyclerView.State)
| Parameters | |
|---|---|
c |
Canvas
|
parent |
RecyclerView
|
void onDraw (Canvas c, RecyclerView parent, RecyclerView.State state)
Draw any appropriate decorations into the Canvas supplied to the RecyclerView. Any content drawn by this method will be drawn before the item views are drawn, and will thus appear underneath the views.
| Parameters | |
|---|---|
c |
Canvas:
Canvas to draw into |
parent |
RecyclerView:
RecyclerView this ItemDecoration is drawing into |
state |
RecyclerView.State:
The current state of RecyclerView
|
void onDrawOver (Canvas c, RecyclerView parent, RecyclerView.State state)
Draw any appropriate decorations into the Canvas supplied to the RecyclerView. Any content drawn by this method will be drawn after the item views are drawn and will thus appear over the views.
| Parameters | |
|---|---|
c |
Canvas:
Canvas to draw into |
parent |
RecyclerView:
RecyclerView this ItemDecoration is drawing into |
state |
RecyclerView.State:
The current state of RecyclerView.
|
void onDrawOver (Canvas c, RecyclerView parent)
This method is deprecated.
Override onDrawOver(Canvas, RecyclerView, RecyclerView.State)
| Parameters | |
|---|---|
c |
Canvas
|
parent |
RecyclerView
|
Developers