it.xabaras.android.recyclerview.swipedecorator

Class RecyclerViewSwipeDecorator

java.lang.Object

it.xabaras.android.recyclerview.swipedecorator.RecyclerViewSwipeDecorator

public class RecyclerViewSwipeDecorator
extends java.lang.Object

A simple utility class to add a background and/or an icon while swiping a RecyclerView item left or right.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RecyclerViewSwipeDecorator.Builder A Builder for the RecyclerViewSwipeDecorator class

Constructor Summary

Constructors

Constructor and Description
RecyclerViewSwipeDecorator(android.graphics.Canvas canvas, RecyclerView recyclerView, RecyclerView.ViewHolder viewHolder, float dX, float dY, int actionState, boolean isCurrentlyActive) Create a @RecyclerViewSwipeDecorator
RecyclerViewSwipeDecorator(android.content.Context context, android.graphics.Canvas canvas, RecyclerView recyclerView, RecyclerView.ViewHolder viewHolder, float dX, float dY, int actionState, boolean isCurrentlyActive) Deprecated. in RecyclerViewSwipeDecorator 1.2.2

Method Summary

Modifier and Type	Method and Description
void	decorate() Decorate the RecyclerView item with the chosen backgrounds and icons
void	setActionIconId(int actionIconId) Set the action icon for either (left/right) swipe directions
void	setActionIconTint(int color) Set the tint color for either (left/right) action icons
void	setBackgroundColor(int backgroundColor) Set the background color for either (left/right) swipe directions
void	setIconHorizontalMargin(int iconHorizontalMargin) Deprecated. in RecyclerViewSwipeDecorator 1.2, use setIconHorizontalMargin(int, int) instead.
void	setIconHorizontalMargin(int unit, int iconHorizontalMargin) Set the horizontal margin of the icon in the given unit (default is 16dp)
void	setSwipeLeftActionIconId(int swipeLeftActionIconId) Set the action icon for left swipe direction
void	setSwipeLeftActionIconTint(int color) Set the tint color for action icon drawn while swiping left
void	setSwipeLeftBackgroundColor(int swipeLeftBackgroundColor) Set the background color for left swipe direction
void	setSwipeLeftLabel(java.lang.String label) Set the label shown when swiping left
void	setSwipeLeftTextColor(int color) Set the color of the text shown when swiping left
void	setSwipeLeftTextSize(int unit, float size) Set the size of the text shown when swiping left
void	setSwipeLeftTypeface(android.graphics.Typeface typeface) Set the Typeface of the text shown when swiping left
void	setSwipeRightActionIconId(int swipeRightActionIconId) Set the action icon for right swipe direction
void	setSwipeRightActionIconTint(int color) Set the tint color for action icon drawn while swiping right
void	setSwipeRightBackgroundColor(int swipeRightBackgroundColor) Set the background color for right swipe direction
void	setSwipeRightLabel(java.lang.String label) Set the label shown when swiping right
void	setSwipeRightTextColor(int color) Set the color of the text shown when swiping right
void	setSwipeRightTextSize(int unit, float size) Set the size of the text shown when swiping right
void	setSwipeRightTypeface(android.graphics.Typeface typeface) Set the Typeface of the text shown when swiping right

Methods inherited from class java.lang.Object

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

Constructor Detail

RecyclerViewSwipeDecorator

@Deprecated
public RecyclerViewSwipeDecorator(android.content.Context context,
                                              android.graphics.Canvas canvas,
                                              RecyclerView recyclerView,
                                              RecyclerView.ViewHolder viewHolder,
                                              float dX,
                                              float dY,
                                              int actionState,
                                              boolean isCurrentlyActive)

Deprecated. in RecyclerViewSwipeDecorator 1.2.2

Create a @RecyclerViewSwipeDecorator

Parameters:

context - A valid Context object for the RecyclerView

canvas - The canvas which RecyclerView is drawing its children

recyclerView - The RecyclerView to which ItemTouchHelper is attached to

viewHolder - The ViewHolder which is being interacted by the User or it was interacted and simply animating to its original position

dX - The amount of horizontal displacement caused by user's action

dY - The amount of vertical displacement caused by user's action

actionState - The type of interaction on the View. Is either ACTION_STATE_DRAG or ACTION_STATE_SWIPE.

isCurrentlyActive - True if this view is currently being controlled by the user or false it is simply animating back to its original state

RecyclerViewSwipeDecorator

public RecyclerViewSwipeDecorator(android.graphics.Canvas canvas,
                                  RecyclerView recyclerView,
                                  RecyclerView.ViewHolder viewHolder,
                                  float dX,
                                  float dY,
                                  int actionState,
                                  boolean isCurrentlyActive)

Create a @RecyclerViewSwipeDecorator

Parameters:

canvas - The canvas which RecyclerView is drawing its children

recyclerView - The RecyclerView to which ItemTouchHelper is attached to

viewHolder - The ViewHolder which is being interacted by the User or it was interacted and simply animating to its original position

dX - The amount of horizontal displacement caused by user's action

dY - The amount of vertical displacement caused by user's action

actionState - The type of interaction on the View. Is either ACTION_STATE_DRAG or ACTION_STATE_SWIPE.

isCurrentlyActive - True if this view is currently being controlled by the user or false it is simply animating back to its original state

Method Detail

setBackgroundColor

public void setBackgroundColor(int backgroundColor)

Set the background color for either (left/right) swipe directions

Parameters:

backgroundColor - The resource id of the background color to be set

setActionIconId

public void setActionIconId(int actionIconId)

Set the action icon for either (left/right) swipe directions

Parameters:

actionIconId - The resource id of the icon to be set

setActionIconTint

public void setActionIconTint(int color)

Set the tint color for either (left/right) action icons

Parameters:

color - a color in ARGB format (e.g. 0xFF0000FF for blue)

setSwipeLeftBackgroundColor

public void setSwipeLeftBackgroundColor(int swipeLeftBackgroundColor)

Set the background color for left swipe direction

Parameters:

swipeLeftBackgroundColor - The resource id of the background color to be set

setSwipeLeftActionIconId

public void setSwipeLeftActionIconId(int swipeLeftActionIconId)

Set the action icon for left swipe direction

Parameters:

swipeLeftActionIconId - The resource id of the icon to be set

setSwipeLeftActionIconTint

public void setSwipeLeftActionIconTint(int color)

Set the tint color for action icon drawn while swiping left

Parameters:

color - a color in ARGB format (e.g. 0xFF0000FF for blue)

setSwipeRightBackgroundColor

public void setSwipeRightBackgroundColor(int swipeRightBackgroundColor)

Set the background color for right swipe direction

Parameters:

swipeRightBackgroundColor - The resource id of the background color to be set

setSwipeRightActionIconId

public void setSwipeRightActionIconId(int swipeRightActionIconId)

Set the action icon for right swipe direction

Parameters:

swipeRightActionIconId - The resource id of the icon to be set

setSwipeRightActionIconTint

public void setSwipeRightActionIconTint(int color)

Set the tint color for action icon drawn while swiping right

Parameters:

color - a color in ARGB format (e.g. 0xFF0000FF for blue)

setSwipeRightLabel

public void setSwipeRightLabel(java.lang.String label)

Set the label shown when swiping right

Parameters:

label - a String

setSwipeRightTextSize

public void setSwipeRightTextSize(int unit,
                                  float size)

Set the size of the text shown when swiping right

Parameters:

unit - TypedValue (default is COMPLEX_UNIT_SP)

size - the size value

setSwipeRightTextColor

public void setSwipeRightTextColor(int color)

Set the color of the text shown when swiping right

Parameters:

color - the color to be set

setSwipeRightTypeface

public void setSwipeRightTypeface(android.graphics.Typeface typeface)

Set the Typeface of the text shown when swiping right

Parameters:

typeface - the Typeface to be set

setIconHorizontalMargin

@Deprecated
public void setIconHorizontalMargin(int iconHorizontalMargin)

Deprecated. in RecyclerViewSwipeDecorator 1.2, use setIconHorizontalMargin(int, int) instead.

Set the horizontal margin of the icon in DPs (default is 16dp)

Parameters:

iconHorizontalMargin - the margin in pixels

setIconHorizontalMargin

public void setIconHorizontalMargin(int unit,
                                    int iconHorizontalMargin)

Set the horizontal margin of the icon in the given unit (default is 16dp)

Parameters:

unit - TypedValue

iconHorizontalMargin - the margin in the given unit

setSwipeLeftLabel

public void setSwipeLeftLabel(java.lang.String label)

Set the label shown when swiping left

Parameters:

label - a String

setSwipeLeftTextSize

public void setSwipeLeftTextSize(int unit,
                                 float size)

Set the size of the text shown when swiping left

Parameters:

unit - TypedValue (default is COMPLEX_UNIT_SP)

size - the size value

setSwipeLeftTextColor

public void setSwipeLeftTextColor(int color)

Set the color of the text shown when swiping left

Parameters:

color - the color to be set

setSwipeLeftTypeface

public void setSwipeLeftTypeface(android.graphics.Typeface typeface)

Set the Typeface of the text shown when swiping left

Parameters:

typeface - the Typeface to be set

decorate

public void decorate()

Decorate the RecyclerView item with the chosen backgrounds and icons