com.atakmap.android.util

Class AbstractMapItemSelectionTool

java.lang.Object

com.atakmap.android.toolbar.Tool

com.atakmap.android.util.AbstractMapItemSelectionTool

All Implemented Interfaces:

android.view.View.OnKeyListener, MapEventDispatcher.MapEventDispatchListener

Direct Known Subclasses:

ShapeToolUtils

public abstract class AbstractMapItemSelectionTool
extends Tool
implements MapEventDispatcher.MapEventDispatchListener

Abstract pick a map item from the map tool. This encapsulates all of the actions required to push and pop the map event dispatch stack. This tool self registers, so the only thing that needs to be done is that it needs to be added to the corresponding MapComponent. Bundle extras = new Bundle(); ToolManagerBroadcastReceiver.getInstance().startTool( TOOL_IDENTIFIER, extras);

Field Summary

Fields inherited from class com.atakmap.android.toolbar.Tool

_identifier, _mapListenerCount, _mapView

Constructor Summary

Constructors

Constructor and Description
AbstractMapItemSelectionTool(MapView mapView, java.lang.String toolId, java.lang.String toolFinished, java.lang.String prompt, java.lang.String invalidSelection) The implementation of the map item selection tool appropriately manages the stack and provides the appropriate level of feedback when an incorrect item is selected.

Method Summary

Modifier and Type	Method and Description
void	dispose() Must call dispose when the isim is no longer being used.
protected abstract boolean	isItem(MapItem mi) Implementation of this should decide if the map item is appropriate.
void	onMapEvent(MapEvent event)
boolean	onToolBegin(android.os.Bundle extras) Called when this tool has been asked to start (and after the last tool has cleaned up)
void	onToolEnd() Called when this tool has been asked to end, either directly or by the user selecting a new tool or possibly a new toolbar.

Methods inherited from class com.atakmap.android.toolbar.Tool

clearExtraListeners, endTool, findPoint, getActive, getIdentifier, onKey, popAllMapListeners, popMapListeners, pushMapListeners, requestBeginTool, requestEndTool, setActive, shouldEndOnBack

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractMapItemSelectionTool

public AbstractMapItemSelectionTool(MapView mapView,
                                    java.lang.String toolId,
                                    java.lang.String toolFinished,
                                    java.lang.String prompt,
                                    java.lang.String invalidSelection)

The implementation of the map item selection tool appropriately manages the stack and provides the appropriate level of feedback when an incorrect item is selected.

Parameters:

mapView - The mapView.

toolId - the unique identifier used to start the tool. This should be unique across the application and the recommendation is to make use of the package name and class for the concrete implementation. This intent is also fired when the

toolFinished - the intent action that is fired with the result when the map item is selected or when the tool is ended. If there was an item selected the "uid" string extra is set.

prompt - the prompt to show the user on the screen.

invalidSelection - the toast shown when an invalid item is selected.

Method Detail

dispose

public void dispose()

Must call dispose when the isim is no longer being used. After this object is disposed, it will no lonfger respond to intents.

Specified by:

dispose in class Tool

onToolBegin

public boolean onToolBegin(android.os.Bundle extras)

Description copied from class: Tool

Called when this tool has been asked to start (and after the last tool has cleaned up)

Overrides:

onToolBegin in class Tool

Parameters:

extras - extra params that were passed by the GUI

Returns:

true if tool is now active, false if it has already finished.

onToolEnd

public void onToolEnd()

Description copied from class: Tool

Called when this tool has been asked to end, either directly or by the user selecting a new tool or possibly a new toolbar.

Overrides:

onToolEnd in class Tool

isItem

protected abstract boolean isItem(MapItem mi)

Implementation of this should decide if the map item is appropriate.

Parameters:

mi - the map item selected.

Returns:

true if the map selected item is appropriate

onMapEvent

public void onMapEvent(MapEvent event)

Specified by:

onMapEvent in interface MapEventDispatcher.MapEventDispatchListener