com.atakmap.android.drawing.tools

Class CircleCreationTool

java.lang.Object

com.atakmap.android.toolbar.Tool

com.atakmap.android.drawing.tools.CircleCreationTool

All Implemented Interfaces:

android.view.View.OnKeyListener, MapEventDispatcher.MapEventDispatchListener

Direct Known Subclasses:

DrawingCircleCreationTool, RangeCircleCreationTool

public abstract class CircleCreationTool
extends Tool
implements MapEventDispatcher.MapEventDispatchListener

Field Summary

Fields

Modifier and Type	Field and Description
protected DrawingCircle	_circle
protected android.content.Context	_context
protected MapGroup	_mapGroup
protected DrawingPreferences	_prefs
protected Marker	_tempCenter

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

_identifier, _mapListenerCount, _mapView

Constructor Summary

Constructors

Constructor and Description
CircleCreationTool(MapView mapView, MapGroup mapGroup, java.lang.String toolIdentifier)

Method Summary

Modifier and Type	Method and Description
protected abstract void	addCircle(DrawingCircle circle) Add the circle to map
protected DrawingCircle	createCircle() Create a new empty circle to be used by this tool
void	dispose() Called only by the parent during final cleanup activities.
protected int	getDefaultColor() Get teh default color for newly created circles with this tool
protected java.lang.String	getDefaultName(java.lang.String prefix) Helper method to generate a new circle name
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.
protected void	placeCenter(MapItem mi, GeoPointMetaData point)
protected void	placeRadius(MapItem mi, GeoPointMetaData point)
protected void	showCenterPrompt() Show the text prompt for placing the circle center
protected void	showRadiusPrompt() Show the text prompt for placing the radius marker

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

_context

protected final android.content.Context _context

_mapGroup

protected final MapGroup _mapGroup

_prefs

protected final DrawingPreferences _prefs

_circle

protected DrawingCircle _circle

_tempCenter

protected Marker _tempCenter

Constructor Detail

CircleCreationTool

public CircleCreationTool(MapView mapView,
                          MapGroup mapGroup,
                          java.lang.String toolIdentifier)

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.

showCenterPrompt

protected void showCenterPrompt()

Show the text prompt for placing the circle center

showRadiusPrompt

protected void showRadiusPrompt()

Show the text prompt for placing the radius marker

createCircle

protected DrawingCircle createCircle()

Create a new empty circle to be used by this tool

Returns:

New circle

addCircle

protected abstract void addCircle(DrawingCircle circle)

Add the circle to map

Parameters:

circle - The new circle to be added

getDefaultColor

protected int getDefaultColor()

Get teh default color for newly created circles with this tool

Returns:

Default color

getDefaultName

protected java.lang.String getDefaultName(java.lang.String prefix)

Helper method to generate a new circle name

Parameters:

prefix - Circle name prefix

Returns:

New circle name

onMapEvent

public void onMapEvent(MapEvent event)

Specified by:

onMapEvent in interface MapEventDispatcher.MapEventDispatchListener

placeCenter

protected void placeCenter(MapItem mi,
                           GeoPointMetaData point)

placeRadius

protected void placeRadius(MapItem mi,
                           GeoPointMetaData point)

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