mva2.adapter.decorator

Class Decorator

java.lang.Object

mva2.adapter.decorator.Decorator

public abstract class Decorator
extends java.lang.Object

A Decorator allows the application to add a special drawing and layout offset to specific itemviews from the adapter's data set. This can be useful for drawing dividers between items, highlights and more.

Decorations will be drawn in the order by which they were added to the ItemBinder or Section. Also ItemBinder's decoration will be applied only after applying the Section's decoration

Constructor Summary

Constructors

Constructor and Description
Decorator(MultiViewAdapter adapter) Constructor which initialized the Decorator with the adapter object.

Method Summary

Modifier and Type	Method and Description
void	addToRect(android.graphics.Rect outRect, int left, int top, int right, int bottom) Utility method to add the coordinates to the existing values to the Rect class
abstract void	getItemOffsets(android.graphics.Rect outRect, android.view.View view, RecyclerView parent, RecyclerView.State state, int adapterPosition) Retrieve item offsets for the given position.
int	getPositionType(int adapterPosition, RecyclerView parent) Returns the position type of the item for given adapter position.
SectionPositionType	getSectionPositionType(int adapterPosition) Returns the SectionPositionType for the given adapter position.
boolean	isFirst(int positionType) Returns whether the item is first element in the LinearLayoutManager.
boolean	isItemOnBottomEdge(int positionType) Returns whether the item is on the bottom edge of the RecyclerView.
boolean	isItemOnLeftEdge(int positionType) Returns whether the item is on the left edge of the RecyclerView.
boolean	isItemOnRightEdge(int positionType) Returns whether the item is on the right edge of the RecyclerView.
boolean	isItemOnTopEdge(int positionType) Returns whether the item is on the top edge of the RecyclerView.
boolean	isLast(int positionType) Returns whether the item is last element in the LinearLayoutManager.
void	onDraw(android.graphics.Canvas canvas, RecyclerView parent, RecyclerView.State state, android.view.View child, int adapterPosition) Draw any appropriate decorations into the Canvas supplied to the RecyclerView.
void	onDrawOver(android.graphics.Canvas canvas, RecyclerView parent, RecyclerView.State state, android.view.View child, int adapterPosition) Draw any appropriate decorations into the Canvas supplied to the RecyclerView.

Methods inherited from class java.lang.Object

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

Constructor Detail

Decorator

public Decorator(MultiViewAdapter adapter)

Constructor which initialized the Decorator with the adapter object.

Parameters:

adapter - MultiViewAaapter that is attached with this decorator.

Method Detail

addToRect

public void addToRect(android.graphics.Rect outRect,
                      int left,
                      int top,
                      int right,
                      int bottom)

Utility method to add the coordinates to the existing values to the Rect class

Parameters:

outRect - Rect object for which the values are updated

left - The X coordinate of the left side of the rectangle

top - The Y coordinate of the top of the rectangle

right - The X coordinate of the right side of the rectangle

bottom - The Y coordinate of the bottom of the rectangle

getPositionType

public int getPositionType(int adapterPosition,
                           RecyclerView parent)

Returns the position type of the item for given adapter position.

Parameters:

adapterPosition - Item position inside the adapter for which position type is calculated

parent - Parent recyclerview

Returns:

Position type of the given item

See Also:

PositionType

getSectionPositionType

public SectionPositionType getSectionPositionType(int adapterPosition)

Returns the SectionPositionType for the given adapter position.

Parameters:

adapterPosition - Position of the item inside the recyclerview

Returns:

SectionPositionType for given position

isFirst

public boolean isFirst(int positionType)

Returns whether the item is first element in the LinearLayoutManager. Avoid using this method on GridLayoutManager

See Also:

PositionType

isItemOnBottomEdge

public boolean isItemOnBottomEdge(int positionType)

Returns whether the item is on the bottom edge of the RecyclerView.

See Also:

PositionType

isItemOnLeftEdge

public boolean isItemOnLeftEdge(int positionType)

Returns whether the item is on the left edge of the RecyclerView.

See Also:

PositionType

isItemOnRightEdge

public boolean isItemOnRightEdge(int positionType)

Returns whether the item is on the right edge of the RecyclerView.

See Also:

PositionType

isItemOnTopEdge

public boolean isItemOnTopEdge(int positionType)

Returns whether the item is on the top edge of the RecyclerView.

See Also:

PositionType

isLast

public boolean isLast(int positionType)

Returns whether the item is last element in the LinearLayoutManager. Avoid using this method on GridLayoutManager

See Also:

PositionType

onDraw

public void onDraw(android.graphics.Canvas canvas,
                   RecyclerView parent,
                   RecyclerView.State state,
                   android.view.View child,
                   int adapterPosition)

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:

canvas - The canvas to draw into

parent - The recyclerView this decoration is drawing into

state - The current state of RecyclerView

child - The child for which item decoration is being drawn

adapterPosition - The item's position inside the recyclerview

See Also:

SectionPositionType, PositionType

onDrawOver

public void onDrawOver(android.graphics.Canvas canvas,
                       RecyclerView parent,
                       RecyclerView.State state,
                       android.view.View child,
                       int adapterPosition)

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 above the views.

Parameters:

canvas - The canvas to draw into

parent - The recyclerView this decoration is drawing into

state - The current state of RecyclerView

child - The child for which item decoration is being drawn

adapterPosition - The item's position inside the recyclerview

See Also:

SectionPositionType, PositionType

getItemOffsets

public abstract void getItemOffsets(android.graphics.Rect outRect,
                                    android.view.View view,
                                    RecyclerView parent,
                                    RecyclerView.State state,
                                    int adapterPosition)

Retrieve item offsets for the given position.

Each field of rectUtil 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 rectUtil to 0 and returns.

If this ItemDecoration does affect the positioning of item views, it should set any of four fields of rectUtil (left, top, right, bottom).

Parameters:

outRect - Rect to receive the output.

view - The child view to decorate

parent - RecyclerView this ItemDecoration is decorating

state - The current state of RecyclerView.

adapterPosition - The item's position inside the recyclerview

See Also:

SectionPositionType, PositionType