com.atakmap.android.toolbar

Class Tool

java.lang.Object

com.atakmap.android.toolbar.Tool

All Implemented Interfaces:

android.view.View.OnKeyListener

Direct Known Subclasses:

AbstractMapItemSelectionTool, ButtonTool, CircleCreationTool, DrawingRectangleCreationTool, DynamicRangeAndBearingTool, EnterLocationTool, GridTool, MapClickTool, MapClickTool, MapItemSelectTool, MovePointTool, PolylineSelectTool, RangeAndBearingEndpointMoveTool, RegionShapeTool, RouteConfirmationTool, ShapeCreationTool, SpecialPointButtonTool, SpecifyLockItemTool, SpecifySelfLocationTool, TelestrationTool

public abstract class Tool
extends java.lang.Object
implements android.view.View.OnKeyListener

A Tool is a modal operation which changes the way that the user interacts with the map. Only one tool can be active at a time; if the user starts a new tool, the old tool ends.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	_identifier
protected int	_mapListenerCount
protected MapView	_mapView

Constructor Summary

Constructors

Constructor and Description
Tool(MapView mapView, java.lang.String identifier)

Method Summary

Modifier and Type	Method and Description
protected void	clearExtraListeners() Clears all listeners from the map except for those involved with fundamental map operations, ie pan and pinch.
abstract void	dispose() Called only by the parent during final cleanup activities.
protected void	endTool() Used by ToolbarLibrary to stop a running tool.
protected GeoPointMetaData	findPoint(MapEvent event) Helper method that finds a point given a map event (i.e.
boolean	getActive() Returns whether the tool is currently active, ie, onToolBegin has been called but onToolEnd has not yet been called.
java.lang.String	getIdentifier() Returns the identifier used to refer to this tool in intents.
boolean	onKey(android.view.View v, int keyCode, android.view.KeyEvent event)
protected boolean	onToolBegin(android.os.Bundle extras) Called when this tool has been asked to start (and after the last tool has cleaned up)
protected 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.
protected void	popAllMapListeners() Pop all map listeners that were pushed with this tool
protected void	popMapListeners() Pop a set of map listeners while tracking the current push count
protected void	pushMapListeners() Push a new set of map listeners while tracking the current push count
void	requestBeginTool() Helper method to send the intent required to ask the ToolbarLibrary to make this tool active.
void	requestEndTool() Helper method to send the intent required to ask the ToolbarLibrary to make this tool inactive.
protected void	setActive(boolean active) Called to set whether a tool is actively being used.
boolean	shouldEndOnBack() Returns whether this tool should end when the back button is pressed.

Methods inherited from class java.lang.Object

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

Field Detail

_mapView

protected final MapView _mapView

_identifier

protected java.lang.String _identifier

_mapListenerCount

protected int _mapListenerCount

Constructor Detail

Tool

public Tool(MapView mapView,
            java.lang.String identifier)

Method Detail

onToolBegin

protected boolean onToolBegin(android.os.Bundle extras)

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

Parameters:

extras - extra params that were passed by the GUI

Returns:

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

onToolEnd

protected 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.

dispose

public abstract void dispose()

Called only by the parent during final cleanup activities.

endTool

protected void endTool()

Used by ToolbarLibrary to stop a running tool. Shouldn't be called directly, instead send an END_TOOL intent or use the requestEndTool() method which sends such an intent.

getIdentifier

public java.lang.String getIdentifier()

Returns the identifier used to refer to this tool in intents.

Returns:

onKey

public boolean onKey(android.view.View v,
                     int keyCode,
                     android.view.KeyEvent event)

Specified by:

onKey in interface android.view.View.OnKeyListener

Parameters:

v -

keyCode -

event -

Returns:

shouldEndOnBack

public boolean shouldEndOnBack()

Returns whether this tool should end when the back button is pressed.

Returns:

requestBeginTool

public void requestBeginTool()

Helper method to send the intent required to ask the ToolbarLibrary to make this tool active. You can call this if you need to start your tool.

requestEndTool

public void requestEndTool()

Helper method to send the intent required to ask the ToolbarLibrary to make this tool inactive. You can call this if you need to stop your tool while it's running.

getActive

public boolean getActive()

Returns whether the tool is currently active, ie, onToolBegin has been called but onToolEnd has not yet been called. In most cases the tool's button's selected state should reflect this value.

Returns:

setActive

protected void setActive(boolean active)

Called to set whether a tool is actively being used. Generally, this should be automatically handled by the onToolBegin(), onToolEnd() life cycle. Override to update GUI elements to reflect the new value.

clearExtraListeners

protected void clearExtraListeners()

Clears all listeners from the map except for those involved with fundamental map operations, ie pan and pinch.

pushMapListeners

protected void pushMapListeners()

Push a new set of map listeners while tracking the current push count

popMapListeners

protected void popMapListeners()

Pop a set of map listeners while tracking the current push count

popAllMapListeners

protected void popAllMapListeners()

Pop all map listeners that were pushed with this tool

findPoint

protected GeoPointMetaData findPoint(MapEvent event)

Helper method that finds a point given a map event (i.e. map click)

Parameters:

event - Map event

Returns:

Point or null if not found TODO: Probably should get the actual touch point of both the terrain and the model as two different things so that the user of this tool can decide what makes the most sense to use.