com.atakmap.android.tools.menu

Class ActionMenuData

java.lang.Object

com.atakmap.android.tools.menu.ActionMenuData

All Implemented Interfaces:

android.os.Parcelable

public class ActionMenuData
extends java.lang.Object
implements android.os.Parcelable

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ActionMenuData.PersistedActionMenu
static class	ActionMenuData.PreferredMenu

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

android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>

Field Summary

Fields

Modifier and Type	Field and Description
static android.os.Parcelable.Creator<ActionMenuData>	CREATOR
static java.lang.String	PLACEHOLDER_TITLE

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor and Description
ActionMenuData()
ActionMenuData(ActionMenuData copy)
ActionMenuData(java.lang.String ref, java.lang.String title, java.lang.String iconPath, java.lang.String enabledIconPath, java.lang.String selectedIconPath, java.lang.String preferredMenu, boolean hideable, java.util.List<ActionClickData> clickData, boolean bSelected, boolean bEnabled, boolean baseline) An action menu data item that corresponds with an action or set of actions when the entry is clicked or long pressed.

Method Summary

Modifier and Type	Method and Description
static void	addIconCache(java.lang.String s, android.graphics.drawable.Drawable d) Experimental hook to allow for AirOverlays to poison the cache.
static ActionMenuData	createPlaceholder() Create a placeholder with a unique broadcast so it .equals() fails, and each is unique...
static ActionMenuData	createPlaceholder(java.lang.String id) Create a placeholder with a specific associated id.
int	describeContents()
boolean	equals(ActionMenuData c)
boolean	equals(java.lang.Object o)
static ActionMenuData.PersistedActionMenu	fromItemXml(java.lang.String xml) Parse the specified action bar string
java.util.List<ActionClickData>	getActionClickData()
ActionClickData	getActionClickData(java.lang.String type)
static java.util.List<ActionMenuData>	getAllActions(android.content.Context ctx) In support of reading the actions in use by the TAK Button Maanger
java.lang.String	getIcon() Return icon path based on selection state
android.graphics.drawable.Drawable	getIcon(android.content.Context context) Attempt to create Icon for action
int	getId()
ActionMenuData.PreferredMenu	getPreferredMenu()
java.lang.String	getRef()
java.lang.String	getTitle() Deprecated. Use getTitle(Context) instead This call will fail to return the resolved string if the map view hasn't been initialized yet.
java.lang.String	getTitle(android.content.Context appContext) Get the title of this action data
boolean	hasClickData()
int	hashCode()
boolean	isBaseline()
boolean	isEnabled()
boolean	isHideable()
boolean	isPlaceholder()
boolean	isSelected()
boolean	isValid()
static void	removeIconCache(java.lang.String s) Experimental hook to allow for AirOverlays remove the poison the cache.
void	setEnabled(boolean enabled)
void	setPreferredMenu(ActionMenuData.PreferredMenu preferred)
void	setSelected(boolean selected)
java.lang.String	toString()
void	writeToParcel(android.os.Parcel parcel, int flags)

Methods inherited from class java.lang.Object

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

Field Detail

PLACEHOLDER_TITLE

public static final java.lang.String PLACEHOLDER_TITLE

See Also:

Constant Field Values

CREATOR

public static final android.os.Parcelable.Creator<ActionMenuData> CREATOR

Constructor Detail

ActionMenuData

public ActionMenuData()

ActionMenuData

public ActionMenuData(java.lang.String ref,
                      java.lang.String title,
                      java.lang.String iconPath,
                      java.lang.String enabledIconPath,
                      java.lang.String selectedIconPath,
                      java.lang.String preferredMenu,
                      boolean hideable,
                      java.util.List<ActionClickData> clickData,
                      boolean bSelected,
                      boolean bEnabled,
                      boolean baseline)

An action menu data item that corresponds with an action or set of actions when the entry is clicked or long pressed.

Parameters:

ref - the reference for this specific menu item. This should be unique and not mutable.

title - the title of the menu item

iconPath - the path for the icon, can be a string path or in the case of being called from a plugin, the string resulting from the call to @see PluginMapComponent.addPluginIcon(toolDescriptor) and the addPluginIcon uses the toolDescriptor class getIcon() to return a drawable. This must also implement the short name and description.

enabledIconPath - the icon when enabled, can be null.

selectedIconPath - the icon when selected, can be null.

preferredMenu - the preferred menu - should be "overflow".

hideable - is the icon hidable by the user

clickData - the click data during a click or longpress

bSelected - selected by default

bEnabled - enabled by default

baseline - must be false.

ActionMenuData

public ActionMenuData(ActionMenuData copy)

Method Detail

addIconCache

public static void addIconCache(java.lang.String s,
                                android.graphics.drawable.Drawable d)

Experimental hook to allow for AirOverlays to poison the cache. When the cache is poisoned, the action bar needs to be refreshed

Parameters:

s - is the string that relates to the icon style to be poisoned.

d - the drawable to use.

removeIconCache

public static void removeIconCache(java.lang.String s)

Experimental hook to allow for AirOverlays remove the poison the cache. When the cache is no longer poisoned, the action bar needs to be refreshed

Parameters:

s - is the string that relates to the icon style to be unpoisoned.

createPlaceholder

public static ActionMenuData createPlaceholder()

Create a placeholder with a unique broadcast so it .equals() fails, and each is unique... sort of a hack, should probably use a UUID

Returns:

createPlaceholder

public static ActionMenuData createPlaceholder(java.lang.String id)

Create a placeholder with a specific associated id. This is used to link a placeholder with a "missing" plugin action, so that dynamically added actions can be replaced in the same spot after a restart.

Parameters:

id - Id of the associated action

Returns:

getRef

public java.lang.String getRef()

isSelected

public boolean isSelected()

setSelected

public void setSelected(boolean selected)

isEnabled

public boolean isEnabled()

setEnabled

public void setEnabled(boolean enabled)

getTitle

public java.lang.String getTitle(android.content.Context appContext)

Get the title of this action data

Parameters:

appContext - Application context used for string lookup

Returns:

Title

getTitle

@Deprecated
public java.lang.String getTitle()

Deprecated. Use getTitle(Context) instead This call will fail to return the resolved string if the map view hasn't been initialized yet.

Get the title of this action data

Returns:

Title

getIcon

public java.lang.String getIcon()

Return icon path based on selection state

Returns:

the stringified icon path

getIcon

public android.graphics.drawable.Drawable getIcon(android.content.Context context)
                                           throws android.content.res.Resources.NotFoundException

Attempt to create Icon for action

Parameters:

context -

Returns:

Throws:

android.content.res.Resources.NotFoundException

getPreferredMenu

public ActionMenuData.PreferredMenu getPreferredMenu()

setPreferredMenu

public void setPreferredMenu(ActionMenuData.PreferredMenu preferred)

isHideable

public boolean isHideable()

isPlaceholder

public boolean isPlaceholder()

isBaseline

public boolean isBaseline()

getActionClickData

public ActionClickData getActionClickData(java.lang.String type)

getActionClickData

public java.util.List<ActionClickData> getActionClickData()

hasClickData

public boolean hasClickData()

isValid

public boolean isValid()

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

equals

public boolean equals(ActionMenuData c)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getId

public int getId()

describeContents

public int describeContents()

Specified by:

describeContents in interface android.os.Parcelable

writeToParcel

public void writeToParcel(android.os.Parcel parcel,
                          int flags)

Specified by:

writeToParcel in interface android.os.Parcelable

getAllActions

public static java.util.List<ActionMenuData> getAllActions(android.content.Context ctx)

In support of reading the actions in use by the TAK Button Maanger

Parameters:

ctx -

Returns:

fromItemXml

public static ActionMenuData.PersistedActionMenu fromItemXml(java.lang.String xml)

Parse the specified action bar string

Parameters:

xml - the xml to turn into a action menu

Returns:

the action menu