universum.studios.android.recycler.decoration

Class ItemSpaceDecoration

java.lang.Object

RecyclerView.ItemDecoration

universum.studios.android.recycler.decoration.RecyclerViewItemDecoration

universum.studios.android.recycler.decoration.ItemSpaceDecoration

public class ItemSpaceDecoration
extends RecyclerViewItemDecoration

A RecyclerViewItemDecoration implementation that may be used to add a space, vertically and horizontally, between items displayed in a RecyclerView.

Xml attributes

ItemSpaceDecoration Attributes

Default style attribute

none

Author:

Martin Albedinsky

See Also:

RecyclerView#addItemDecoration(RecyclerView.ItemDecoration)

Constructor Summary

Constructors

Constructor and Description
ItemSpaceDecoration() Same as ItemSpaceDecoration(Context) with null context.
ItemSpaceDecoration(android.content.Context context) Same as ItemSpaceDecoration(Context, AttributeSet) with null attrs.
ItemSpaceDecoration(android.content.Context context, android.util.AttributeSet attrs) Same as ItemSpaceDecoration(Context, AttributeSet, int) with 0 defStyleAttr.
ItemSpaceDecoration(android.content.Context context, android.util.AttributeSet attrs, int defStyleAttr) Same as ItemSpaceDecoration(Context, AttributeSet, int, int) with 0 defStyleRes.
ItemSpaceDecoration(android.content.Context context, android.util.AttributeSet attrs, int defStyleAttr, int defStyleRes) Creates a new instance of ItemSpaceDecoration for the given context.
ItemSpaceDecoration(int horizontal, int vertical) Same as ItemSpaceDecoration(int, int, int, int) where the specified horizontal amount will be used for both, horizontal start and horizontal end amounts, and the vertical amount will be used similarly for both, vertical start and vertical end amounts.
ItemSpaceDecoration(int horizontalStart, int horizontalEnd, int verticalStart, int verticalEnd) Creates a new instance of ItemSpaceDecoration with the specified spacing amounts.

Method Summary

Modifier and Type	Method and Description
int	getHorizontalEnd() Returns the amount of space that will be applied at the end of each item in horizontal direction.
int	getHorizontalStart() Returns the amount of space that will be applied at the start of each item in horizontal direction.
void	getItemOffsets(android.graphics.Rect rect, android.view.View view, RecyclerView parent, RecyclerView.State state)
int	getVerticalEnd() Returns the amount of space that will be applied at the end of each item in vertical direction.
int	getVerticalStart() Returns the amount of space that will be applied at the start of each item in vertical direction.

Methods inherited from class universum.studios.android.recycler.decoration.RecyclerViewItemDecoration

setSkipFirst, setSkipLast, shouldDecorate, skipsFirst, skipsLast

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ItemSpaceDecoration

public ItemSpaceDecoration()

Same as ItemSpaceDecoration(Context) with null context.

ItemSpaceDecoration

public ItemSpaceDecoration(int horizontal,
                           int vertical)

Same as ItemSpaceDecoration(int, int, int, int) where the specified horizontal amount will be used for both, horizontal start and horizontal end amounts, and the vertical amount will be used similarly for both, vertical start and vertical end amounts.

ItemSpaceDecoration

public ItemSpaceDecoration(int horizontalStart,
                           int horizontalEnd,
                           int verticalStart,
                           int verticalEnd)

Creates a new instance of ItemSpaceDecoration with the specified spacing amounts.

Parameters:

horizontalStart - Amount to be applied at the start of an item in horizontal direction.

horizontalEnd - Amount to be applied at the end of an item in horizontal direction.

verticalStart - Amount to be applied at the start of an item in vertical direction.

verticalEnd - Amount to be applied at the end of an item in vertical direction.

ItemSpaceDecoration

public ItemSpaceDecoration(android.content.Context context)

Same as ItemSpaceDecoration(Context, AttributeSet) with null attrs.

ItemSpaceDecoration

public ItemSpaceDecoration(android.content.Context context,
                           android.util.AttributeSet attrs)

Same as ItemSpaceDecoration(Context, AttributeSet, int) with 0 defStyleAttr.

ItemSpaceDecoration

public ItemSpaceDecoration(android.content.Context context,
                           android.util.AttributeSet attrs,
                           int defStyleAttr)

Same as ItemSpaceDecoration(Context, AttributeSet, int, int) with 0 defStyleRes.

ItemSpaceDecoration

public ItemSpaceDecoration(android.content.Context context,
                           android.util.AttributeSet attrs,
                           int defStyleAttr,
                           int defStyleRes)

Creates a new instance of ItemSpaceDecoration for the given context.

Parameters:

context - Context in which will be the new decoration presented.

attrs - Set of Xml attributes used to configure the new instance of this decoration.

defStyleAttr - An attribute which contains a reference to a default style resource for this decoration within a theme of the given context.

defStyleRes - Resource id of the default style for the new decoration.

See Also:

ItemSpaceDecoration(int, int, int, int)

Method Detail

getHorizontalStart

public int getHorizontalStart()

Returns the amount of space that will be applied at the start of each item in horizontal direction.

Returns:

Amount of space in pixels.

See Also:

getHorizontalEnd()

getHorizontalEnd

public int getHorizontalEnd()

Returns the amount of space that will be applied at the end of each item in horizontal direction.

Returns:

Amount of space in pixels.

See Also:

getHorizontalStart()

getVerticalStart

public int getVerticalStart()

Returns the amount of space that will be applied at the start of each item in vertical direction.

Returns:

Amount of space in pixels.

See Also:

getVerticalEnd()

getVerticalEnd

public int getVerticalEnd()

Returns the amount of space that will be applied at the end of each item in vertical direction.

Returns:

Amount of space in pixels.

See Also:

getVerticalStart()

getItemOffsets

public void getItemOffsets(android.graphics.Rect rect,
                           android.view.View view,
                           RecyclerView parent,
                           RecyclerView.State state)