com.atakmap.android.routes

Class PolylineSelectTool

java.lang.Object

com.atakmap.android.toolbar.Tool

com.atakmap.android.routes.PolylineSelectTool

All Implemented Interfaces:

android.view.View.OnKeyListener, MapEventDispatcher.MapEventDispatchListener

public class PolylineSelectTool
extends Tool
implements MapEventDispatcher.MapEventDispatchListener

Tool used to implement the a polyline selector. 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. In order to activate it from your button or gui component, call this code:

 Bundle extras = new Bundle();
 ToolManagerBroadcastReceiver.getInstance().startTool(
                 PolylineSelectTool.TOOL_IDENTIFIER, extras);
 

Please note that the TOOL_IDENTIFER must be unique - otherwise issues might occur.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TAG
static java.lang.String	TOOL_FINISHED
static java.lang.String	TOOL_IDENTIFIER

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

_identifier, _mapListenerCount, _mapView

Constructor Summary

Constructors

Constructor and Description
PolylineSelectTool(MapView mapView)

Method Summary

Modifier and Type	Method and Description
void	dispose() Called only by the parent during final cleanup activities.
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

Field Detail

TAG

public static final java.lang.String TAG

See Also:

Constant Field Values

TOOL_IDENTIFIER

public static final java.lang.String TOOL_IDENTIFIER

See Also:

Constant Field Values

TOOL_FINISHED

public static final java.lang.String TOOL_FINISHED

See Also:

Constant Field Values

Constructor Detail

PolylineSelectTool

public PolylineSelectTool(MapView mapView)

Method Detail

dispose

public void dispose()

Description copied from class: Tool

Called only by the parent during final cleanup activities.

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

onMapEvent

public void onMapEvent(MapEvent event)

Specified by:

onMapEvent in interface MapEventDispatcher.MapEventDispatchListener