Android APIs
public static abstract class

RecyclerView.ItemDecoration

extends Object
java.lang.Object
   ↳ android.support.v7.widget.RecyclerView.ItemDecoration

Class Overview

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

Summary

Public Constructors
RecyclerView.ItemDecoration()
Public Methods
void getItemOffsets(Rect outRect, View view, RecyclerView parent, RecyclerView.State state)
Retrieve any offsets for the given item.
void getItemOffsets(Rect outRect, int itemPosition, RecyclerView parent)
This method is deprecated. Use getItemOffsets(Rect, View, RecyclerView, State)
void onDraw(Canvas c, RecyclerView parent)
This method is deprecated. Override onDraw(Canvas, RecyclerView, RecyclerView.State)
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)
This method is deprecated. Override onDrawOver(Canvas, RecyclerView, RecyclerView.State)
void onDrawOver(Canvas c, RecyclerView parent, RecyclerView.State state)
Draw any appropriate decorations into the Canvas supplied to the RecyclerView.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public RecyclerView.ItemDecoration ()

Public Methods

public 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 to receive the output.
view The child view to decorate
parent RecyclerView this ItemDecoration is decorating
state The current state of RecyclerView.

public void getItemOffsets (Rect outRect, int itemPosition, RecyclerView parent)

This method is deprecated.
Use getItemOffsets(Rect, View, RecyclerView, State)

public void onDraw (Canvas c, RecyclerView parent)

This method is deprecated.
Override onDraw(Canvas, RecyclerView, RecyclerView.State)

public 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 to draw into
parent RecyclerView this ItemDecoration is drawing into
state The current state of RecyclerView

public void onDrawOver (Canvas c, RecyclerView parent)

This method is deprecated.
Override onDrawOver(Canvas, RecyclerView, RecyclerView.State)

public 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 to draw into
parent RecyclerView this ItemDecoration is drawing into
state The current state of RecyclerView.