com.atakmap.android.navigation.models

Class NavButtonModel

java.lang.Object

com.atakmap.android.navigation.models.NavButtonModel

public class NavButtonModel
extends java.lang.Object

Model for use with NavButton It's recommend to use NavButtonModel.Builder for creation

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NavButtonModel.Builder Button model builder

Field Summary

Fields

Modifier and Type	Field and Description
static int	LEFT
static NavButtonModel	NONE
static int	TOP

Constructor Summary

Constructors

Constructor and Description
NavButtonModel(java.lang.String reference, android.graphics.drawable.Drawable image) Construct a NavButtonModel given the provided parameters
NavButtonModel(java.lang.String reference, java.lang.String name, android.graphics.drawable.Drawable image) Construct a NavButtonModel given the provided parameters
NavButtonModel(java.lang.String reference, java.lang.String name, android.graphics.drawable.Drawable image, android.graphics.drawable.Drawable selectedImage, NavButtonIntentAction action, NavButtonIntentAction actionLong) Construct a NavButtonModel given the provided parameters

Method Summary

Modifier and Type	Method and Description
android.content.ClipData	createClipboardData(java.lang.String desc) Create clipboard data for this model
boolean	equals(java.lang.Object o)
NavButtonIntentAction	getAction() The intent to fire when pressed
android.content.Intent	getActionIntent() Get the action intent to fire when pressed
NavButtonIntentAction	getActionLong() The intent to fire when long-pressed
android.content.Intent	getActionLongIntent() Get the action intent to fire when long-pressed
int	getBadgeCount() Get the top-right badge count
android.graphics.drawable.Drawable	getBadgeImage() Get the bottom-right badge image drawable
java.util.List<NavButtonModel>	getChildButtons() Obtain the group of child buttons represented by the button model.
android.graphics.drawable.Drawable	getImage() The image when not selected
java.lang.String	getName() The name of the TakButtonModel.
java.lang.String	getReference() Get the unique reference for this button model
android.graphics.drawable.Drawable	getSelectedImage() The image when selected
int	getSupportedPositions() Get the supported positions for this button model
boolean	hasChildren() Returns true if this NavButton has children.
int	hashCode()
boolean	isPositionSupported(int position) Check if this button supports the given position
boolean	isSelected() Check if this button model is currently selected
void	setAction(android.content.Intent intent) Set the intent action to perform when this button is pressed
void	setAction(NavButtonIntentAction action) Set the intent action to perform when this button is pressed
void	setAction(java.lang.String action) Set the intent action to perform when this button is long-pressed
void	setActionLong(android.content.Intent intent) Set the intent action to perform when this button is long-pressed
void	setActionLong(NavButtonIntentAction action) Set the intent action to perform when this button is long-pressed
void	setActionLong(java.lang.String action) Set the intent action to perform when this button is pressed
void	setBadgeCount(int count) Set the count shown in a red circle in the top-right
void	setBadgeImage(android.graphics.drawable.Drawable image) Set an image drawable shown in the bottom-right
void	setChildButtons(java.util.List<NavButtonModel> childButtonModels) Set a group of children buttons for this button model
void	setSelected(boolean selected) Set whether this button model is currently selected
void	setSelectedImage(android.graphics.drawable.Drawable image) Change the selected image showing for the button.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

NONE

public static final NavButtonModel NONE

TOP

public static final int TOP

See Also:

Constant Field Values

LEFT

public static final int LEFT

See Also:

Constant Field Values

Constructor Detail

NavButtonModel

public NavButtonModel(java.lang.String reference,
                      android.graphics.drawable.Drawable image)

Construct a NavButtonModel given the provided parameters

Parameters:

reference - Unique reference string

image - Icon to show in the default state

NavButtonModel

public NavButtonModel(java.lang.String reference,
                      java.lang.String name,
                      android.graphics.drawable.Drawable image)

Construct a NavButtonModel given the provided parameters

Parameters:

reference - Unique reference string

name - The display name for this button

image - Icon to show in the default state

NavButtonModel

public NavButtonModel(java.lang.String reference,
                      java.lang.String name,
                      android.graphics.drawable.Drawable image,
                      android.graphics.drawable.Drawable selectedImage,
                      NavButtonIntentAction action,
                      NavButtonIntentAction actionLong)

Construct a NavButtonModel given the provided parameters

Parameters:

reference - a reference identifier which should be universally unique for this device

name - the name of the NavButton which can be localized for each language and should not be used for comparison

image - an image to show in a unselected state

selectedImage - an image to show in a selected state

Method Detail

getReference

public java.lang.String getReference()

Get the unique reference for this button model

Returns:

Model reference

getName

public java.lang.String getName()

The name of the TakButtonModel. This name will be locale specific and should not be used for comparisons or equality.

Returns:

the name of the button

getImage

public android.graphics.drawable.Drawable getImage()

The image when not selected

Returns:

a drawable representing the button in a unselected state

getSelectedImage

public android.graphics.drawable.Drawable getSelectedImage()

The image when selected

Returns:

a drawable representing the buttons selected state

setSelectedImage

public void setSelectedImage(android.graphics.drawable.Drawable image)

Change the selected image showing for the button.

Parameters:

image - the current selected image.

setBadgeCount

public void setBadgeCount(int count)

Set the count shown in a red circle in the top-right

Parameters:

count - Count

getBadgeCount

public int getBadgeCount()

Get the top-right badge count

Returns:

Count

setBadgeImage

public void setBadgeImage(android.graphics.drawable.Drawable image)

Set an image drawable shown in the bottom-right

Parameters:

image - Badge image (null to hide)

getBadgeImage

public android.graphics.drawable.Drawable getBadgeImage()

Get the bottom-right badge image drawable

Returns:

Image drawable

setSelected

public void setSelected(boolean selected)

Set whether this button model is currently selected

Parameters:

selected - True if selected

isSelected

public boolean isSelected()

Check if this button model is currently selected

Returns:

True if selected

setAction

public void setAction(NavButtonIntentAction action)

Set the intent action to perform when this button is pressed

Parameters:

action - Intent action

setAction

public void setAction(android.content.Intent intent)

Set the intent action to perform when this button is pressed

Parameters:

intent - Intent

setAction

public void setAction(java.lang.String action)

Set the intent action to perform when this button is long-pressed

Parameters:

action - Intent action

setActionLong

public void setActionLong(NavButtonIntentAction action)

Set the intent action to perform when this button is long-pressed

Parameters:

action - Intent action

setActionLong

public void setActionLong(android.content.Intent intent)

Set the intent action to perform when this button is long-pressed

Parameters:

intent - Intent

setActionLong

public void setActionLong(java.lang.String action)

Set the intent action to perform when this button is pressed

Parameters:

action - Intent action

getAction

public NavButtonIntentAction getAction()

The intent to fire when pressed

Returns:

The intent action

getActionIntent

public android.content.Intent getActionIntent()

Get the action intent to fire when pressed

Returns:

The intent

getActionLong

public NavButtonIntentAction getActionLong()

The intent to fire when long-pressed

Returns:

The intent action

getActionLongIntent

public android.content.Intent getActionLongIntent()

Get the action intent to fire when long-pressed

Returns:

The intent

hasChildren

public boolean hasChildren()

Returns true if this NavButton has children.

Returns:

true if there are 1 or more child buttons.

setChildButtons

public void setChildButtons(java.util.List<NavButtonModel> childButtonModels)

Set a group of children buttons for this button model

Parameters:

childButtonModels - the list of buttons.

getChildButtons

public java.util.List<NavButtonModel> getChildButtons()

Obtain the group of child buttons represented by the button model.

Returns:

an unmodifiable list of children.

getSupportedPositions

public int getSupportedPositions()

Get the supported positions for this button model

Returns:

Position flags

isPositionSupported

public boolean isPositionSupported(int position)

Check if this button supports the given position

Parameters:

position - Position flag (TOP or LEFT)

Returns:

True if supported

createClipboardData

public android.content.ClipData createClipboardData(java.lang.String desc)

Create clipboard data for this model

Parameters:

desc - Clipboard data description

Returns:

Clipboard data

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object