com.mikepenz.materialdrawer.model

Class AbstractDrawerItem<T,VH extends android.support.v7.widget.RecyclerView.ViewHolder>

java.lang.Object

com.mikepenz.materialdrawer.model.AbstractDrawerItem<T,VH>

All Implemented Interfaces:

com.mikepenz.fastadapter.IExpandable<T,IDrawerItem>, com.mikepenz.fastadapter.IIdentifyable<T>, com.mikepenz.fastadapter.IItem<T,VH>, com.mikepenz.fastadapter.ISubItem<IDrawerItem,IDrawerItem>, IDrawerItem<T,VH>, Selectable<T>, Tagable<T>

Direct Known Subclasses:

BaseDrawerItem, ContainerDrawerItem, DividerDrawerItem, MiniProfileDrawerItem, ProfileDrawerItem, ProfileSettingDrawerItem, SectionDrawerItem

public abstract class AbstractDrawerItem<T,VH extends android.support.v7.widget.RecyclerView.ViewHolder>
extends java.lang.Object
implements IDrawerItem<T,VH>, Selectable<T>, Tagable<T>

Created by mikepenz on 14.07.15.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	mEnabled
protected long	mIdentifier
Drawer.OnDrawerItemClickListener	mOnDrawerItemClickListener
protected OnPostBindViewListener	mOnPostBindViewListener
protected boolean	mSelectable
protected boolean	mSelected
protected java.util.List<IDrawerItem>	mSubItems
protected java.lang.Object	mTag

Constructor Summary

Constructors

Constructor and Description
AbstractDrawerItem()

Method Summary

Modifier and Type	Method and Description
boolean	equals(int id)
boolean	equals(long id) If this item equals to the given identifier
boolean	equals(java.lang.Object o) If this item equals to the given object
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
abstract com.mikepenz.fastadapter.utils.ViewHolderFactory<VH>	getFactory() the abstract method to retrieve the ViewHolder factory The ViewHolder factory implementation should look like (see the commented code above)
long	getIdentifier() returns the identifier of this item -1 is the default not set state
Drawer.OnDrawerItemClickListener	getOnDrawerItemClickListener()
OnPostBindViewListener	getOnPostBindViewListener()
IDrawerItem	getParent()
java.util.List<IDrawerItem>	getSubItems()
java.lang.Object	getTag()
VH	getViewHolder(android.view.ViewGroup parent) This method returns the ViewHolder for our item, using the provided View.
int	hashCode() the hashCode implementation
boolean	isAutoExpanding() overwrite this method and return true if the item should auto expand on click, false if you want to disable this
boolean	isEnabled()
boolean	isExpanded()
boolean	isSelectable()
boolean	isSelected()
void	onPostBindView(IDrawerItem drawerItem, android.view.View view) is called after bindView to allow some post creation setps
void	unbindView(VH holder) called when the view is unbound
T	withEnabled(boolean enabled) set if this item is enabled
T	withIdentifier(long identifier) set the identifier of this item
T	withIsExpanded(boolean expanded)
T	withOnDrawerItemClickListener(Drawer.OnDrawerItemClickListener onDrawerItemClickListener) this listener is called when an item is clicked in the drawer.
IDrawerItem	withParent(IDrawerItem parent) the parent for this item
T	withPostOnBindViewListener(OnPostBindViewListener onPostBindViewListener) add this listener and hook in if you want to modify a drawerItems view without creating a custom drawer item
T	withSelectable(boolean selectable) set if this item is selectable
T	withSetSelected(boolean selected) set if this item is selected
T	withSubItems(IDrawerItem... subItems) an array of subItems
T	withSubItems(java.util.List<IDrawerItem> subItems) a list of subItems
T	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.materialdrawer.model.interfaces.IDrawerItem

bindView, 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

mOnDrawerItemClickListener

public Drawer.OnDrawerItemClickListener mOnDrawerItemClickListener

mOnPostBindViewListener

protected OnPostBindViewListener mOnPostBindViewListener

mSubItems

protected java.util.List<IDrawerItem> mSubItems

Constructor Detail

AbstractDrawerItem

public AbstractDrawerItem()

Method Detail

withIdentifier

public T withIdentifier(long identifier)

set the identifier of this item

Specified by:

withIdentifier in interface com.mikepenz.fastadapter.IIdentifyable<T>

Parameters:

identifier -

Returns:

getIdentifier

public long getIdentifier()

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

Specified by:

getIdentifier in interface com.mikepenz.fastadapter.IIdentifyable<T>

Returns:

withTag

public T withTag(java.lang.Object object)

set the tag of this item

Specified by:

withTag in interface com.mikepenz.fastadapter.IItem<T,VH extends android.support.v7.widget.RecyclerView.ViewHolder>

Specified by:

withTag in interface Tagable<T>

Parameters:

object -

Returns:

getTag

public java.lang.Object getTag()

Specified by:

getTag in interface com.mikepenz.fastadapter.IItem<T,VH extends android.support.v7.widget.RecyclerView.ViewHolder>

Specified by:

getTag in interface IDrawerItem<T,VH extends android.support.v7.widget.RecyclerView.ViewHolder>

Specified by:

getTag in interface Tagable<T>

Returns:

the tag of this item

withEnabled

public T withEnabled(boolean enabled)

set if this item is enabled

Specified by:

withEnabled in interface com.mikepenz.fastadapter.IItem<T,VH extends android.support.v7.widget.RecyclerView.ViewHolder>

Parameters:

enabled - true if this item is enabled

Returns:

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface com.mikepenz.fastadapter.IItem<T,VH extends android.support.v7.widget.RecyclerView.ViewHolder>

Specified by:

isEnabled in interface IDrawerItem<T,VH extends android.support.v7.widget.RecyclerView.ViewHolder>

Returns:

if this item is enabled

withSetSelected

public T withSetSelected(boolean selected)

set if this item is selected

Specified by:

withSetSelected in interface com.mikepenz.fastadapter.IItem<T,VH extends android.support.v7.widget.RecyclerView.ViewHolder>

Specified by:

withSetSelected in interface IDrawerItem<T,VH extends android.support.v7.widget.RecyclerView.ViewHolder>

Parameters:

selected - true if this item is selected

Returns:

isSelected

public boolean isSelected()

Specified by:

isSelected in interface com.mikepenz.fastadapter.IItem<T,VH extends android.support.v7.widget.RecyclerView.ViewHolder>

Specified by:

isSelected in interface IDrawerItem<T,VH extends android.support.v7.widget.RecyclerView.ViewHolder>

Returns:

if this item is selected

withSelectable

public T withSelectable(boolean selectable)

set if this item is selectable

Specified by:

withSelectable in interface com.mikepenz.fastadapter.IItem<T,VH extends android.support.v7.widget.RecyclerView.ViewHolder>

Specified by:

withSelectable in interface IDrawerItem<T,VH extends android.support.v7.widget.RecyclerView.ViewHolder>

Specified by:

withSelectable in interface Selectable<T>

Parameters:

selectable - true if this item is selectable

Returns:

isSelectable

public boolean isSelectable()

Specified by:

isSelectable in interface com.mikepenz.fastadapter.IItem<T,VH extends android.support.v7.widget.RecyclerView.ViewHolder>

Specified by:

isSelectable in interface IDrawerItem<T,VH extends android.support.v7.widget.RecyclerView.ViewHolder>

Specified by:

isSelectable in interface Selectable<T>

Returns:

if this item is selectable

getOnDrawerItemClickListener

public Drawer.OnDrawerItemClickListener getOnDrawerItemClickListener()

withOnDrawerItemClickListener

public T withOnDrawerItemClickListener(Drawer.OnDrawerItemClickListener onDrawerItemClickListener)

this listener is called when an item is clicked in the drawer. WARNING: don't overwrite this in the Switch / Toggle drawerItems if you want the toggle / switch to be selected if the item is clicked and the item is not selectable.

Parameters:

onDrawerItemClickListener -

Returns:

getOnPostBindViewListener

public OnPostBindViewListener getOnPostBindViewListener()

withPostOnBindViewListener

public T withPostOnBindViewListener(OnPostBindViewListener onPostBindViewListener)

add this listener and hook in if you want to modify a drawerItems view without creating a custom drawer item

Parameters:

onPostBindViewListener -

Returns:

onPostBindView

public void onPostBindView(IDrawerItem drawerItem,
                           android.view.View view)

is called after bindView to allow some post creation setps

Parameters:

drawerItem - the drawerItem which is bound to the view

view - the currently view which will be bound

getParent

public IDrawerItem getParent()

Specified by:

getParent in interface com.mikepenz.fastadapter.ISubItem<IDrawerItem,IDrawerItem>

Returns:

the parent of this item

withParent

public IDrawerItem withParent(IDrawerItem parent)

the parent for this item

Specified by:

withParent in interface com.mikepenz.fastadapter.ISubItem<IDrawerItem,IDrawerItem>

Parameters:

parent - it's parent

Returns:

this

withSubItems

public T withSubItems(java.util.List<IDrawerItem> subItems)

a list of subItems

Specified by:

withSubItems in interface com.mikepenz.fastadapter.IExpandable<T,IDrawerItem>

Parameters:

subItems -

Returns:

withSubItems

public T withSubItems(IDrawerItem... subItems)

an array of subItems

Parameters:

subItems -

Returns:

getSubItems

public java.util.List<IDrawerItem> getSubItems()

Specified by:

getSubItems in interface com.mikepenz.fastadapter.IExpandable<T,IDrawerItem>

Returns:

the subItems for this item

withIsExpanded

public T withIsExpanded(boolean expanded)

Specified by:

withIsExpanded in interface com.mikepenz.fastadapter.IExpandable<T,IDrawerItem>

Parameters:

expanded - defines if this item is now expanded or not

Returns:

this

isExpanded

public boolean isExpanded()

Specified by:

isExpanded in interface com.mikepenz.fastadapter.IExpandable<T,IDrawerItem>

Returns:

if this item is currently expaneded

isAutoExpanding

public boolean isAutoExpanding()

overwrite this method and return true if the item should auto expand on click, false if you want to disable this

Specified by:

isAutoExpanding in interface com.mikepenz.fastadapter.IExpandable<T,IDrawerItem>

Returns:

true if this item should auto expand in the adapter

getFactory

public abstract com.mikepenz.fastadapter.utils.ViewHolderFactory<VH> getFactory()

the abstract method to retrieve the ViewHolder factory The ViewHolder factory implementation should look like (see the commented code above)

Returns:

generateView

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

generates a view by the defined LayoutRes

Specified by:

generateView in interface com.mikepenz.fastadapter.IItem<T,VH extends android.support.v7.widget.RecyclerView.ViewHolder>

Specified by:

generateView in interface IDrawerItem<T,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 com.mikepenz.fastadapter.IItem<T,VH extends android.support.v7.widget.RecyclerView.ViewHolder>

Specified by:

generateView in interface IDrawerItem<T,VH extends android.support.v7.widget.RecyclerView.ViewHolder>

Parameters:

ctx -

parent -

Returns:

unbindView

public void unbindView(VH holder)

called when the view is unbound

Specified by:

unbindView in interface com.mikepenz.fastadapter.IItem<T,VH extends android.support.v7.widget.RecyclerView.ViewHolder>

Specified by:

unbindView in interface IDrawerItem<T,VH extends android.support.v7.widget.RecyclerView.ViewHolder>

Parameters:

holder -

getViewHolder

public VH getViewHolder(android.view.ViewGroup parent)

This method returns the ViewHolder for our item, using the provided View. By default it will try to get the ViewHolder from the ViewHolderFactory. If this one is not implemented it will go over the generic way, wasting ~5ms

Specified by:

getViewHolder in interface com.mikepenz.fastadapter.IItem<T,VH extends android.support.v7.widget.RecyclerView.ViewHolder>

Specified by:

getViewHolder in interface IDrawerItem<T,VH extends android.support.v7.widget.RecyclerView.ViewHolder>

Parameters:

parent -

Returns:

the ViewHolder for this Item

equals

public boolean equals(long id)

If this item equals to the given identifier

Specified by:

equals in interface IDrawerItem<T,VH extends android.support.v7.widget.RecyclerView.ViewHolder>

Parameters:

id -

Returns:

equals

public boolean equals(int id)

Specified by:

equals in interface com.mikepenz.fastadapter.IItem<T,VH extends android.support.v7.widget.RecyclerView.ViewHolder>

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: