it.xabaras.android.recyclerview.swipedecorator

Class RecyclerViewSwipeDecorator.Builder

java.lang.Object

it.xabaras.android.recyclerview.swipedecorator.RecyclerViewSwipeDecorator.Builder

Enclosing class:

RecyclerViewSwipeDecorator

public static class RecyclerViewSwipeDecorator.Builder
extends java.lang.Object

A Builder for the RecyclerViewSwipeDecorator class

Constructor Summary

Constructors

Constructor and Description
Builder(android.graphics.Canvas canvas, RecyclerView recyclerView, RecyclerView.ViewHolder viewHolder, float dX, float dY, int actionState, boolean isCurrentlyActive) Create a builder for a RecyclerViewsSwipeDecorator
Builder(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
RecyclerViewSwipeDecorator.Builder	addActionIcon(int drawableId) Add an action icon to both swiping directions
RecyclerViewSwipeDecorator.Builder	addBackgroundColor(int color) Add a background color to both swiping directions
RecyclerViewSwipeDecorator.Builder	addSwipeLeftActionIcon(int drawableId) Add an action icon while swiping left
RecyclerViewSwipeDecorator.Builder	addSwipeLeftBackgroundColor(int color) Adds a background color while swiping left
RecyclerViewSwipeDecorator.Builder	addSwipeLeftLabel(java.lang.String label) Add a label to be shown while swiping left
RecyclerViewSwipeDecorator.Builder	addSwipeRightActionIcon(int drawableId) Add an action icon while swiping right
RecyclerViewSwipeDecorator.Builder	addSwipeRightBackgroundColor(int color) Add a background color while swiping right
RecyclerViewSwipeDecorator.Builder	addSwipeRightLabel(java.lang.String label) Add a label to be shown while swiping right
RecyclerViewSwipeDecorator	create() Create a RecyclerViewSwipeDecorator
RecyclerViewSwipeDecorator.Builder	setActionIconTint(int color) Set the tint color for either (left/right) action icons
RecyclerViewSwipeDecorator.Builder	setIconHorizontalMargin(int pixels) Deprecated. in RecyclerViewSwipeDecorator 1.2, use setIconHorizontalMargin(int, int) instead.
RecyclerViewSwipeDecorator.Builder	setIconHorizontalMargin(int unit, int iconHorizontalMargin) Set the horizontal margin of the icon in the given unit (default is 16dp)
RecyclerViewSwipeDecorator.Builder	setSwipeLeftActionIconTint(int color) Set the tint color for action icon shown while swiping left
RecyclerViewSwipeDecorator.Builder	setSwipeLeftLabelColor(int color) Set the color of the label to be shown while swiping left
RecyclerViewSwipeDecorator.Builder	setSwipeLeftLabelTextSize(int unit, float size) Set the size of the label to be shown while swiping left
RecyclerViewSwipeDecorator.Builder	setSwipeLeftLabelTypeface(android.graphics.Typeface typeface) Set the Typeface of the label to be shown while swiping left
RecyclerViewSwipeDecorator.Builder	setSwipeRightActionIconTint(int color) Set the tint color for action icon shown while swiping right
RecyclerViewSwipeDecorator.Builder	setSwipeRightLabelColor(int color) Set the color of the label to be shown while swiping right
RecyclerViewSwipeDecorator.Builder	setSwipeRightLabelTextSize(int unit, float size) Set the size of the label to be shown while swiping right
RecyclerViewSwipeDecorator.Builder	setSwipeRightLabelTypeface(android.graphics.Typeface typeface) Set the Typeface of the label to be shown while swiping right

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

@Deprecated
public Builder(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 builder for a RecyclerViewsSwipeDecorator

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

Builder

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

Create a builder for a RecyclerViewsSwipeDecorator

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

addBackgroundColor

public RecyclerViewSwipeDecorator.Builder addBackgroundColor(int color)

Add a background color to both swiping directions

Parameters:

color - A single color value in the form 0xAARRGGBB

Returns:

This instance of @RecyclerViewSwipeDecorator.Builder

addActionIcon

public RecyclerViewSwipeDecorator.Builder addActionIcon(int drawableId)

Add an action icon to both swiping directions

Parameters:

drawableId - The resource id of the icon to be set

Returns:

This instance of @RecyclerViewSwipeDecorator.Builder

setActionIconTint

public RecyclerViewSwipeDecorator.Builder 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)

Returns:

This instance of @RecyclerViewSwipeDecorator.Builder

addSwipeRightBackgroundColor

public RecyclerViewSwipeDecorator.Builder addSwipeRightBackgroundColor(int color)

Add a background color while swiping right

Parameters:

color - A single color value in the form 0xAARRGGBB

Returns:

This instance of @RecyclerViewSwipeDecorator.Builder

addSwipeRightActionIcon

public RecyclerViewSwipeDecorator.Builder addSwipeRightActionIcon(int drawableId)

Add an action icon while swiping right

Parameters:

drawableId - The resource id of the icon to be set

Returns:

This instance of @RecyclerViewSwipeDecorator.Builder

setSwipeRightActionIconTint

public RecyclerViewSwipeDecorator.Builder setSwipeRightActionIconTint(int color)

Set the tint color for action icon shown while swiping right

Parameters:

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

Returns:

This instance of @RecyclerViewSwipeDecorator.Builder

addSwipeRightLabel

public RecyclerViewSwipeDecorator.Builder addSwipeRightLabel(java.lang.String label)

Add a label to be shown while swiping right

Parameters:

label - The string to be shown as label

Returns:

This instance of @RecyclerViewSwipeDecorator.Builder

setSwipeRightLabelColor

public RecyclerViewSwipeDecorator.Builder setSwipeRightLabelColor(int color)

Set the color of the label to be shown while swiping right

Parameters:

color - the color to be set

Returns:

This instance of @RecyclerViewSwipeDecorator.Builder

setSwipeRightLabelTextSize

public RecyclerViewSwipeDecorator.Builder setSwipeRightLabelTextSize(int unit,
                                                                     float size)

Set the size of the label to be shown while swiping right

Parameters:

unit - the unit to convert from

size - the size to be set

Returns:

This instance of @RecyclerViewSwipeDecorator.Builder

setSwipeRightLabelTypeface

public RecyclerViewSwipeDecorator.Builder setSwipeRightLabelTypeface(android.graphics.Typeface typeface)

Set the Typeface of the label to be shown while swiping right

Parameters:

typeface - the Typeface to be set

Returns:

This instance of @RecyclerViewSwipeDecorator.Builder

addSwipeLeftBackgroundColor

public RecyclerViewSwipeDecorator.Builder addSwipeLeftBackgroundColor(int color)

Adds a background color while swiping left

Parameters:

color - A single color value in the form 0xAARRGGBB

Returns:

This instance of @RecyclerViewSwipeDecorator.Builder

addSwipeLeftActionIcon

public RecyclerViewSwipeDecorator.Builder addSwipeLeftActionIcon(int drawableId)

Add an action icon while swiping left

Parameters:

drawableId - The resource id of the icon to be set

Returns:

This instance of @RecyclerViewSwipeDecorator.Builder

setSwipeLeftActionIconTint

public RecyclerViewSwipeDecorator.Builder setSwipeLeftActionIconTint(int color)

Set the tint color for action icon shown while swiping left

Parameters:

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

Returns:

This instance of @RecyclerViewSwipeDecorator.Builder

addSwipeLeftLabel

public RecyclerViewSwipeDecorator.Builder addSwipeLeftLabel(java.lang.String label)

Add a label to be shown while swiping left

Parameters:

label - The string to be shown as label

Returns:

This instance of @RecyclerViewSwipeDecorator.Builder

setSwipeLeftLabelColor

public RecyclerViewSwipeDecorator.Builder setSwipeLeftLabelColor(int color)

Set the color of the label to be shown while swiping left

Parameters:

color - the color to be set

Returns:

This instance of @RecyclerViewSwipeDecorator.Builder

setSwipeLeftLabelTextSize

public RecyclerViewSwipeDecorator.Builder setSwipeLeftLabelTextSize(int unit,
                                                                    float size)

Set the size of the label to be shown while swiping left

Parameters:

unit - the unit to convert from

size - the size to be set

Returns:

This instance of @RecyclerViewSwipeDecorator.Builder

setSwipeLeftLabelTypeface

public RecyclerViewSwipeDecorator.Builder setSwipeLeftLabelTypeface(android.graphics.Typeface typeface)

Set the Typeface of the label to be shown while swiping left

Parameters:

typeface - the Typeface to be set

Returns:

This instance of @RecyclerViewSwipeDecorator.Builder

setIconHorizontalMargin

@Deprecated
public RecyclerViewSwipeDecorator.Builder setIconHorizontalMargin(int pixels)

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

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

Parameters:

pixels - margin in pixels

Returns:

This instance of @RecyclerViewSwipeDecorator.Builder

setIconHorizontalMargin

public RecyclerViewSwipeDecorator.Builder 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

Returns:

This instance of @RecyclerViewSwipeDecorator.Builder

create

public RecyclerViewSwipeDecorator create()

Create a RecyclerViewSwipeDecorator

Returns:

The created @RecyclerViewSwipeDecorator