Package com.pranavpandey.android.dynamic.support.model

Class DynamicMenu

java.lang.Object

com.pranavpandey.android.dynamic.support.model.DynamicMenu

All Implemented Interfaces:

Parcelable

public class DynamicMenu
extends Object
implements Parcelable

A model class to store Menu menu information with an icon and a text.

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

Parcelable.ClassLoaderCreator<T extends Object>, Parcelable.Creator<T extends Object>

Field Summary

Fields

Modifier and Type	Field	Description
static final Parcelable.Creator<DynamicMenu>	CREATOR	Parcelable creator to create from parcel.

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor	Description
DynamicMenu(Drawable icon, CharSequence title)	Constructor to initialize an object of this class.
DynamicMenu(Drawable icon, CharSequence title, CharSequence subtitle)	Constructor to initialize an object of this class.
DynamicMenu(Drawable icon, CharSequence title, CharSequence subtitle, boolean hasSubmenu)	Constructor to initialize an object of this class.
DynamicMenu(Parcel in)	Read an object of this class from the parcel.

Method Summary

Modifier and Type	Method	Description
int	describeContents()
Drawable	getIcon()	Get the icon used by this menu.
CharSequence	getSubtitle()	Get the subtitle used by this menu.
CharSequence	getTitle()	Get the title used by this menu.
boolean	isHasSubmenu()	Returns whether this menu has a submenu.
DynamicMenu	setHasSubmenu(boolean hasSubmenu)	Sets if this menu has a submenu.
DynamicMenu	setIcon(Drawable icon)	Set the icon used by this menu.
DynamicMenu	setSubtitle(CharSequence subtitle)	Set the subtitle used by this menu.
DynamicMenu	setTitle(CharSequence title)	Set the title used by this menu.
void	writeToParcel(Parcel dest, int flags)

Methods inherited from class java.lang.Object

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

Field Details

CREATOR

public static final Parcelable.Creator<DynamicMenu> CREATOR

Parcelable creator to create from parcel.

Constructor Details

DynamicMenu

public DynamicMenu(@Nullable
 Drawable icon,
 @Nullable
 CharSequence title)

Constructor to initialize an object of this class.

Parameters:

icon - The icon for this menu.

title - The title for this menu.

DynamicMenu

public DynamicMenu(@Nullable
 Drawable icon,
 @Nullable
 CharSequence title,
 @Nullable
 CharSequence subtitle)

Constructor to initialize an object of this class.

Parameters:

icon - The icon for this menu.

title - The title for this menu.

subtitle - The subtitle for this menu.

DynamicMenu

public DynamicMenu(@Nullable
 Drawable icon,
 @Nullable
 CharSequence title,
 @Nullable
 CharSequence subtitle,
 boolean hasSubmenu)

Constructor to initialize an object of this class.

Parameters:

icon - The icon for this menu.

title - The title for this menu.

subtitle - The subtitle for this menu.

hasSubmenu - true to enable submenu.

DynamicMenu

public DynamicMenu(@NonNull
 Parcel in)

Read an object of this class from the parcel.

Parameters:

in - The parcel to read the values.

Method Details

describeContents

public int describeContents()

Specified by:

describeContents in interface Parcelable

writeToParcel

public void writeToParcel(Parcel dest,
 int flags)

Specified by:

writeToParcel in interface Parcelable

getIcon

@Nullable
public Drawable getIcon()

Get the icon used by this menu.

Returns:

The icon used by this menu.

setIcon

@NonNull
public DynamicMenu setIcon(@Nullable
 Drawable icon)

Set the icon used by this menu.

Parameters:

icon - The icon to be set.

Returns:

The DynamicMenu object to allow for chaining of calls to set methods.

getTitle

@Nullable
public CharSequence getTitle()

Get the title used by this menu.

Returns:

The title used by this menu.

setTitle

@NonNull
public DynamicMenu setTitle(@Nullable
 CharSequence title)

Set the title used by this menu.

Parameters:

title - The title to be set.

Returns:

The DynamicMenu object to allow for chaining of calls to set methods.

getSubtitle

@Nullable
public CharSequence getSubtitle()

Get the subtitle used by this menu.

Returns:

The subtitle used by this menu.

setSubtitle

@NonNull
public DynamicMenu setSubtitle(@Nullable
 CharSequence subtitle)

Set the subtitle used by this menu.

Parameters:

subtitle - The subtitle to be set.

Returns:

The DynamicMenu object to allow for chaining of calls to set methods.

isHasSubmenu

public boolean isHasSubmenu()

Returns whether this menu has a submenu.

Returns:

true if this menu has a submenu.

setHasSubmenu

@NonNull
public DynamicMenu setHasSubmenu(boolean hasSubmenu)

Sets if this menu has a submenu.

Parameters:

hasSubmenu - true to enable submenu.

Returns:

The DynamicMenu object to allow for chaining of calls to set methods.