com.atakmap.android.menu

Class MapMenuReceiver

java.lang.Object

android.content.BroadcastReceiver

com.atakmap.android.menu.MapMenuReceiver

public class MapMenuReceiver
extends android.content.BroadcastReceiver

Nested Class Summary

Nested classes/interfaces inherited from class android.content.BroadcastReceiver

android.content.BroadcastReceiver.PendingResult

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	HIDE_MENU
static java.lang.String	REGISTER_MENU
static java.lang.String	SHOW_MENU
static java.lang.String	TAG
static java.lang.String	UNREGISTER_MENU

Constructor Summary

Constructors

Constructor and Description
MapMenuReceiver(MapView mapView, MenuLayoutWidget menuLayout, MenuMapAdapter adapter)

Method Summary

Modifier and Type	Method and Description
void	addEventListener(MapMenuEventListener listener) Add a listener to MapMenuWidget lifecycle events.
static MapItem	getCurrentItem() Find the map item that the radial is currently opened on
static MapMenuReceiver	getInstance()
static MenuLayoutWidget	getMenuWidget() Gets root level MenuLayoutWidget.
void	hideMenu()
java.lang.String	lookupMenu(MapItem mi) Allows for an application to lookup what type of menu might be provided for a specific map menu type.
java.lang.String	lookupMenu(java.lang.String type) Allows for an application to lookup what type of menu might be provided for a specific map menu type.
void	onReceive(android.content.Context context, android.content.Intent intent)
boolean	registerMapMenuFactory(MapMenuFactory factory) Add an additional map menu factory that creates radial menus.
void	registerMenu(java.lang.String type, java.lang.String menu) Allows for an application to register a globally used menu for a specific Map Item type.
void	removeEventListener(MapMenuEventListener listener) Remove menu event listener from receiving lifecycle events.
boolean	unregisterMapMenuFactory(MapMenuFactory factory) Removes an added map menu factory.
void	unregisterMenu(java.lang.String type) Allows for an application to unregister a globally used menu for a specific Map Item type.

Methods inherited from class android.content.BroadcastReceiver

abortBroadcast, clearAbortBroadcast, getAbortBroadcast, getDebugUnregister, getResultCode, getResultData, getResultExtras, goAsync, isInitialStickyBroadcast, isOrderedBroadcast, peekService, setDebugUnregister, setOrderedHint, setResult, setResultCode, setResultData, setResultExtras

Methods inherited from class java.lang.Object

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

Field Detail

TAG

public static final java.lang.String TAG

See Also:

Constant Field Values

SHOW_MENU

public static final java.lang.String SHOW_MENU

See Also:

Constant Field Values

HIDE_MENU

public static final java.lang.String HIDE_MENU

See Also:

Constant Field Values

REGISTER_MENU

public static final java.lang.String REGISTER_MENU

See Also:

Constant Field Values

UNREGISTER_MENU

public static final java.lang.String UNREGISTER_MENU

See Also:

Constant Field Values

Constructor Detail

MapMenuReceiver

public MapMenuReceiver(MapView mapView,
                       MenuLayoutWidget menuLayout,
                       MenuMapAdapter adapter)

Method Detail

getInstance

public static MapMenuReceiver getInstance()

onReceive

public void onReceive(android.content.Context context,
                      android.content.Intent intent)

Specified by:

onReceive in class android.content.BroadcastReceiver

lookupMenu

public java.lang.String lookupMenu(java.lang.String type)

Allows for an application to lookup what type of menu might be provided for a specific map menu type.

Parameters:

type - the string of the type to match

Returns:

the stringified menu - this could have submenus which is the responsibility of the caller of this method to lookup.

lookupMenu

public java.lang.String lookupMenu(MapItem mi)

Allows for an application to lookup what type of menu might be provided for a specific map menu type.

Parameters:

mi - the map item to match

Returns:

the stringified menu - this could have submenus which is the responsibility of the caller of this method to lookup.

registerMenu

public void registerMenu(java.lang.String type,
                         java.lang.String menu)

Allows for an application to register a globally used menu for a specific Map Item type. This is the same as calling sendBroadcast of the intent com.atakmap.android.maps.REGISTER_MENU with the String type and the String menu.

Parameters:

type - the string of the type to match

menu - the stringified menu

unregisterMenu

public void unregisterMenu(java.lang.String type)

Allows for an application to unregister a globally used menu for a specific Map Item type.

Parameters:

type - the string of the type to match

hideMenu

public void hideMenu()

addEventListener

public void addEventListener(MapMenuEventListener listener)

Add a listener to MapMenuWidget lifecycle events. Listeners are visited prior to menu display. Listeners should return true when the menu should not be created.

Parameters:

listener - receives fully formed menus after creation prior to display

removeEventListener

public void removeEventListener(MapMenuEventListener listener)

Remove menu event listener from receiving lifecycle events.

Parameters:

listener -

getMenuWidget

public static MenuLayoutWidget getMenuWidget()

Gets root level MenuLayoutWidget. This layout widget is the parent of all displayed radial menus.

Returns:

layout widget

getCurrentItem

public static MapItem getCurrentItem()

Find the map item that the radial is currently opened on

Returns:

Focused map item

registerMapMenuFactory

public boolean registerMapMenuFactory(MapMenuFactory factory)

Add an additional map menu factory that creates radial menus. Factories return a MapMenuWidget in response to a MapItem. Factories should return a "default" menu when the provided item is null.

Parameters:

factory - creator of fully populated MapItemWidgets

unregisterMapMenuFactory

public boolean unregisterMapMenuFactory(MapMenuFactory factory)

Removes an added map menu factory.

Parameters:

factory - instance to be removed from list of factories

Returns:

whether a factory was actually removed from the list.