com.mikepenz.fastadapter.items

Class AbstractItem<Item extends IItem & IClickable,VH extends android.support.v7.widget.RecyclerView.ViewHolder>

java.lang.Object

com.mikepenz.fastadapter.items.AbstractItem<Item,VH>

All Implemented Interfaces:

IClickable<Item>, IIdentifyable<Item>, IItem<Item,VH>

Direct Known Subclasses:

GenericAbstractItem

public abstract class AbstractItem<Item extends IItem & IClickable,VH extends android.support.v7.widget.RecyclerView.ViewHolder>
extends java.lang.Object
implements IItem<Item,VH>, IClickable<Item>

Created by mikepenz on 14.07.15. Implements the general methods of the IItem interface to speed up development.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	mEnabled
protected long	mIdentifier
protected FastAdapter.OnClickListener<Item>	mOnItemClickListener
protected FastAdapter.OnClickListener<Item>	mOnItemPreClickListener
protected boolean	mSelectable
protected boolean	mSelected
protected java.lang.Object	mTag

Constructor Summary

Constructors

Constructor and Description
AbstractItem()

Method Summary

Modifier and Type	Method and Description
void	attachToWindow(VH holder) View got attached to the window
void	bindView(VH holder, java.util.List<java.lang.Object> payloads) Binds the data of this item to the given holder
android.view.View	createView(android.content.Context ctx, android.view.ViewGroup parent) this method is called by generateView(Context ctx), generateView(Context ctx, ViewGroup parent) and getViewHolder(ViewGroup parent) it will generate the View from the layout, overwrite this if you want to implement your view creation programatically
void	detachFromWindow(VH holder) View got detached from the window
boolean	equals(int id) If this item equals to the given identifier
boolean	equals(java.lang.Object o) If this item equals to the given object
boolean	failedToRecycle(VH holder) RecyclerView was not able to recycle that viewHolder because it's in a transient state Implement this and clear any animations, to allow recycling.
android.view.View	generateView(android.content.Context ctx) generates a view by the defined LayoutRes
android.view.View	generateView(android.content.Context ctx, android.view.ViewGroup parent) generates a view by the defined LayoutRes and pass the LayoutParams from the parent
long	getIdentifier() returns the identifier of this item -1 is the default not set state
FastAdapter.OnClickListener<Item>	getOnItemClickListener()
FastAdapter.OnClickListener<Item>	getOnPreItemClickListener()
java.lang.Object	getTag() return a Tag of the Item
abstract VH	getViewHolder(android.view.View v) This method returns the ViewHolder for our item, using the provided View.
VH	getViewHolder(android.view.ViewGroup parent) Generates a ViewHolder from this Item with the given parent
int	hashCode() the hashCode implementation
boolean	isEnabled() return if the item is enabled
boolean	isSelectable() return if the item is selectable
boolean	isSelected() return if the item is selected
void	unbindView(VH holder) View needs to release resources when its recycled
Item	withEnabled(boolean enabled) set if this item is enabled
Item	withIdentifier(long identifier) set the identifier of this item
Item	withOnItemClickListener(FastAdapter.OnClickListener<Item> onItemClickListener) provide a listener which is called before the click listener is called within the adapter return true if you want to consume the event
Item	withOnItemPreClickListener(FastAdapter.OnClickListener<Item> onItemPreClickListener) provide a listener which is called before any processing is done within the adapter return true if you want to consume the event
Item	withSelectable(boolean selectable) set if this item is selectable
Item	withSetSelected(boolean selected) set if this item is selected
Item	withTag(java.lang.Object object) set the tag of this item

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.mikepenz.fastadapter.IItem

getLayoutRes, getType

Field Detail

mIdentifier

protected long mIdentifier

mTag

protected java.lang.Object mTag

mEnabled

protected boolean mEnabled

mSelected

protected boolean mSelected

mSelectable

protected boolean mSelectable

mOnItemPreClickListener

protected FastAdapter.OnClickListener<Item extends IItem & IClickable> mOnItemPreClickListener

mOnItemClickListener

protected FastAdapter.OnClickListener<Item extends IItem & IClickable> mOnItemClickListener

Constructor Detail

AbstractItem

public AbstractItem()

Method Detail

withIdentifier

public Item withIdentifier(long identifier)

set the identifier of this item

Specified by:

withIdentifier in interface IIdentifyable<Item extends IItem & IClickable>

Parameters:

identifier -

Returns:

getIdentifier

public long getIdentifier()

Description copied from interface: IIdentifyable

returns the identifier of this item -1 is the default not set state

Specified by:

getIdentifier in interface IIdentifyable<Item extends IItem & IClickable>

Returns:

the identifier of this item

withTag

public Item withTag(java.lang.Object object)

set the tag of this item

Specified by:

withTag in interface IItem<Item extends IItem & IClickable,VH extends android.support.v7.widget.RecyclerView.ViewHolder>

Parameters:

object -

Returns:

getTag

public java.lang.Object getTag()

Description copied from interface: IItem

return a Tag of the Item

Specified by:

getTag in interface IItem<Item extends IItem & IClickable,VH extends android.support.v7.widget.RecyclerView.ViewHolder>

Returns:

the tag of this item

withEnabled

public Item withEnabled(boolean enabled)

set if this item is enabled

Specified by:

withEnabled in interface IItem<Item extends IItem & IClickable,VH extends android.support.v7.widget.RecyclerView.ViewHolder>

Parameters:

enabled - true if this item is enabled

Returns:

isEnabled

public boolean isEnabled()

Description copied from interface: IItem

return if the item is enabled

Specified by:

isEnabled in interface IItem<Item extends IItem & IClickable,VH extends android.support.v7.widget.RecyclerView.ViewHolder>

Returns:

if this item is enabled

withSetSelected

public Item withSetSelected(boolean selected)

set if this item is selected

Specified by:

withSetSelected in interface IItem<Item extends IItem & IClickable,VH extends android.support.v7.widget.RecyclerView.ViewHolder>

Parameters:

selected - true if this item is selected

Returns:

isSelected

public boolean isSelected()

Description copied from interface: IItem

return if the item is selected

Specified by:

isSelected in interface IItem<Item extends IItem & IClickable,VH extends android.support.v7.widget.RecyclerView.ViewHolder>

Returns:

if this item is selected

withSelectable

public Item withSelectable(boolean selectable)

set if this item is selectable

Specified by:

withSelectable in interface IItem<Item extends IItem & IClickable,VH extends android.support.v7.widget.RecyclerView.ViewHolder>

Parameters:

selectable - true if this item is selectable

Returns:

isSelectable

public boolean isSelectable()

Description copied from interface: IItem

return if the item is selectable

Specified by:

isSelectable in interface IItem<Item extends IItem & IClickable,VH extends android.support.v7.widget.RecyclerView.ViewHolder>

Returns:

if this item is selectable

withOnItemPreClickListener

public Item withOnItemPreClickListener(FastAdapter.OnClickListener<Item> onItemPreClickListener)

provide a listener which is called before any processing is done within the adapter return true if you want to consume the event

Specified by:

withOnItemPreClickListener in interface IClickable<Item extends IItem & IClickable>

Parameters:

onItemPreClickListener - the listener

Returns:

this

getOnPreItemClickListener

public FastAdapter.OnClickListener<Item> getOnPreItemClickListener()

Specified by:

getOnPreItemClickListener in interface IClickable<Item extends IItem & IClickable>

Returns:

the on PRE item click listener

withOnItemClickListener

public Item withOnItemClickListener(FastAdapter.OnClickListener<Item> onItemClickListener)

provide a listener which is called before the click listener is called within the adapter return true if you want to consume the event

Specified by:

withOnItemClickListener in interface IClickable<Item extends IItem & IClickable>

Parameters:

onItemClickListener - the listener

Returns:

this

getOnItemClickListener

public FastAdapter.OnClickListener<Item> getOnItemClickListener()

Specified by:

getOnItemClickListener in interface IClickable<Item extends IItem & IClickable>

Returns:

the OnItemClickListener

bindView

@CallSuper
public void bindView(VH holder,
                                java.util.List<java.lang.Object> payloads)

Binds the data of this item to the given holder

Specified by:

bindView in interface IItem<Item extends IItem & IClickable,VH extends android.support.v7.widget.RecyclerView.ViewHolder>

Parameters:

holder -

payloads -

unbindView

public void unbindView(VH holder)

View needs to release resources when its recycled

Specified by:

unbindView in interface IItem<Item extends IItem & IClickable,VH extends android.support.v7.widget.RecyclerView.ViewHolder>

Parameters:

holder -

attachToWindow

public void attachToWindow(VH holder)

View got attached to the window

Specified by:

attachToWindow in interface IItem<Item extends IItem & IClickable,VH extends android.support.v7.widget.RecyclerView.ViewHolder>

Parameters:

holder -

detachFromWindow

public void detachFromWindow(VH holder)

View got detached from the window

Specified by:

detachFromWindow in interface IItem<Item extends IItem & IClickable,VH extends android.support.v7.widget.RecyclerView.ViewHolder>

Parameters:

holder -

failedToRecycle

public boolean failedToRecycle(VH holder)

RecyclerView was not able to recycle that viewHolder because it's in a transient state Implement this and clear any animations, to allow recycling. Return true in that case

Specified by:

failedToRecycle in interface IItem<Item extends IItem & IClickable,VH extends android.support.v7.widget.RecyclerView.ViewHolder>

Parameters:

holder -

Returns:

true if you want it to get recycled

createView

public android.view.View createView(android.content.Context ctx,
                                    @Nullable
                                    android.view.ViewGroup parent)

this method is called by generateView(Context ctx), generateView(Context ctx, ViewGroup parent) and getViewHolder(ViewGroup parent) it will generate the View from the layout, overwrite this if you want to implement your view creation programatically

Parameters:

ctx -

parent -

Returns:

generateView

public android.view.View generateView(android.content.Context ctx)

generates a view by the defined LayoutRes

Specified by:

generateView in interface IItem<Item extends IItem & IClickable,VH extends android.support.v7.widget.RecyclerView.ViewHolder>

Parameters:

ctx -

Returns:

generateView

public android.view.View generateView(android.content.Context ctx,
                                      android.view.ViewGroup parent)

generates a view by the defined LayoutRes and pass the LayoutParams from the parent

Specified by:

generateView in interface IItem<Item extends IItem & IClickable,VH extends android.support.v7.widget.RecyclerView.ViewHolder>

Parameters:

ctx -

parent -

Returns:

getViewHolder

public VH getViewHolder(android.view.ViewGroup parent)

Generates a ViewHolder from this Item with the given parent

Specified by:

getViewHolder in interface IItem<Item extends IItem & IClickable,VH extends android.support.v7.widget.RecyclerView.ViewHolder>

Parameters:

parent -

Returns:

getViewHolder

public abstract VH getViewHolder(android.view.View v)

This method returns the ViewHolder for our item, using the provided View.

Parameters:

v -

Returns:

the ViewHolder for this Item

equals

public boolean equals(int id)

If this item equals to the given identifier

Specified by:

equals in interface IItem<Item extends IItem & IClickable,VH extends android.support.v7.widget.RecyclerView.ViewHolder>

Parameters:

id - identifier

Returns:

true if identifier equals id, false otherwise

equals

public boolean equals(java.lang.Object o)

If this item equals to the given object

Overrides:

equals in class java.lang.Object

Parameters:

o -

Returns:

hashCode

public int hashCode()

the hashCode implementation

Overrides:

hashCode in class java.lang.Object

Returns: