universum.studios.android.recycler.decoration

Class ItemSpaceDecoration

java.lang.Object

android.support.v7.widget.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

Since:

1.0

Author:

Martin Albedinsky

See Also:

RecyclerView.addItemDecoration(RecyclerView.ItemDecoration)

Nested Class Summary

Nested classes/interfaces inherited from class universum.studios.android.recycler.decoration.RecyclerViewItemDecoration

RecyclerViewItemDecoration.Precondition

Constructor Summary

Constructors

Constructor and Description
ItemSpaceDecoration() Same as ItemSpaceDecoration(Context) with null context.
ItemSpaceDecoration(Context context) Same as ItemSpaceDecoration(Context, AttributeSet) with null attrs.
ItemSpaceDecoration(Context context, AttributeSet attrs) Same as ItemSpaceDecoration(Context, AttributeSet, int) with 0 defStyleAttr.
ItemSpaceDecoration(Context context, AttributeSet attrs, int defStyleAttr) Same as ItemSpaceDecoration(Context, AttributeSet, int, int) with 0 defStyleRes.
ItemSpaceDecoration(Context context, 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 by which to offset each item at the end in horizontal direction.
int	getHorizontalStart() Returns the amount of space by which to offset each item at the start in horizontal direction.
void	getItemOffsets(Rect rect, View view, RecyclerView parent, RecyclerView.State state)
int	getVerticalEnd() Returns the amount of space by which to offset each item at the end in vertical direction.
int	getVerticalStart() Returns the amount of space by which to offset each item at the start in vertical direction.
protected void	updateItemOffsets(Rect rect, boolean rtlDirection) Called to update the given rect with the current spacing offsets specified for this decoration.

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

getPrecondition, setPrecondition, setSkipFirst, setSkipLast, shouldDecorate, skipsFirst, skipsLast

Methods inherited from class android.support.v7.widget.RecyclerView.ItemDecoration

getItemOffsets, onDraw, onDraw, onDrawOver, onDrawOver

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(@Nullable
                           Context context)

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

ItemSpaceDecoration

public ItemSpaceDecoration(@Nullable
                           Context context,
                           @Nullable
                           AttributeSet attrs)

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

ItemSpaceDecoration

public ItemSpaceDecoration(@Nullable
                           Context context,
                           @Nullable
                           AttributeSet attrs,
                           @AttrRes
                           int defStyleAttr)

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

ItemSpaceDecoration

public ItemSpaceDecoration(@Nullable
                           Context context,
                           @Nullable
                           AttributeSet attrs,
                           @AttrRes
                           int defStyleAttr,
                           @StyleRes
                           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 by which to offset each item at the start in horizontal direction.

This value is used with respect to layout direction of the parent RecyclerView.

Returns:

Amount of space in pixels.

See Also:

getHorizontalEnd()

getHorizontalEnd

public int getHorizontalEnd()

Returns the amount of space by which to offset each item at the end in horizontal direction.

This value is used with respect to layout direction of the parent RecyclerView.

Returns:

Amount of space in pixels.

See Also:

getHorizontalStart()

getVerticalStart

public int getVerticalStart()

Returns the amount of space by which to offset each item at the start in vertical direction.

Returns:

Amount of space in pixels.

See Also:

getVerticalEnd()

getVerticalEnd

public int getVerticalEnd()

Returns the amount of space by which to offset each item at the end in vertical direction.

Returns:

Amount of space in pixels.

See Also:

getVerticalStart()

getItemOffsets

public void getItemOffsets(@NonNull
                           Rect rect,
                           @NonNull
                           View view,
                           @NonNull
                           RecyclerView parent,
                           @NonNull
                           RecyclerView.State state)

Overrides:

getItemOffsets in class RecyclerView.ItemDecoration

updateItemOffsets

protected void updateItemOffsets(@NonNull
                                 Rect rect,
                                 boolean rtlDirection)

Called to update the given rect with the current spacing offsets specified for this decoration.

Parameters:

rect - The desired item offsets rect to be updated.

rtlDirection - True if offsets should be updated for RTL layout direction, false for LTR layout direction.