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

Summary

Public Constructors
	RecyclerView.ItemDecoration()

Public Constructors

RecyclerView.ItemDecoration()

Public Methods
void	getItemOffsets(Rect outRect, int itemPosition, RecyclerView parent) Retrieve any offsets for the given item.
void	onDraw(Canvas c, RecyclerView parent) Draw any appropriate decorations into the Canvas supplied to the RecyclerView.
void	onDrawOver(Canvas c, RecyclerView parent) Draw any appropriate decorations into the Canvas supplied to the RecyclerView.

Public Methods

void

getItemOffsets(Rect outRect, int itemPosition, RecyclerView parent)

Retrieve any offsets for the given item.

void

onDraw(Canvas c, RecyclerView parent)

Draw any appropriate decorations into the Canvas supplied to the RecyclerView.

void

onDrawOver(Canvas c, RecyclerView parent)

Draw any appropriate decorations into the Canvas supplied to the RecyclerView.

[Expand]

Inherited Methods

From class java.lang.Object

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals(Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of `Class` that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

Public Methods

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

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.

Parameters

outRect	Rect to receive the output.
itemPosition	Adapter position of the item to offset
parent	RecyclerView this ItemDecoration is decorating

public void onDraw (Canvas c, RecyclerView parent)

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

public void onDrawOver (Canvas c, RecyclerView parent)

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

Results

Interfaces

Classes

Class Overview

Summary

Public Constructors

public RecyclerView.ItemDecoration ()

Public Methods

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

Parameters

public void onDraw (Canvas c, RecyclerView parent)

Parameters

public void onDrawOver (Canvas c, RecyclerView parent)

Parameters

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