com.atakmap.android.drawing.tools

Class ShapeCreationTool

java.lang.Object

com.atakmap.android.toolbar.Tool

com.atakmap.android.drawing.tools.ShapeCreationTool

All Implemented Interfaces:

android.view.View.OnKeyListener

public class ShapeCreationTool
extends Tool

Tool for the creation of a (possibly incomplete) polygonal map region. Once the user has finished creating a shape with the tool, returns the uid of the newly created Shape in an intent specified by the user by setting the "callback" parcelable when starting the tool. This is an intent to fire when the tool is completed.

Field Summary

Fields

Modifier and Type	Field and Description
protected MapGroup	_drawingGroup
static java.lang.String	TAG
static java.lang.String	TOOL_IDENTIFIER
protected java.util.Stack<EditAction>	undoStack

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

_identifier, _mapListenerCount

Constructor Summary

Constructors

Constructor and Description
ShapeCreationTool(MapView mapView, MapGroup drawingGroup, android.widget.ImageButton shapeButton, DrawingToolsToolbar drawingToolsToolbar, android.widget.Button undoButton, android.widget.Button doneButton, android.content.Context ignored)

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.
void	dispose() Called only by the parent during final cleanup activities.
protected void	initButton()
boolean	onKey(android.view.View v, int keyCode, android.view.KeyEvent 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.
boolean	run(EditAction action)
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.
void	undo()

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

endTool, findPoint, getActive, getIdentifier, popAllMapListeners, popMapListeners, pushMapListeners, requestBeginTool, requestEndTool

Methods inherited from class java.lang.Object

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

Field Detail

undoStack

protected final java.util.Stack<EditAction> undoStack

TAG

public static final java.lang.String TAG

See Also:

Constant Field Values

_drawingGroup

protected final MapGroup _drawingGroup

TOOL_IDENTIFIER

public static final java.lang.String TOOL_IDENTIFIER

See Also:

Constant Field Values

Constructor Detail

ShapeCreationTool

public ShapeCreationTool(MapView mapView,
                         MapGroup drawingGroup,
                         android.widget.ImageButton shapeButton,
                         DrawingToolsToolbar drawingToolsToolbar,
                         android.widget.Button undoButton,
                         android.widget.Button doneButton,
                         android.content.Context ignored)

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

onKey

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

Specified by:

onKey in interface android.view.View.OnKeyListener

Overrides:

onKey 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

shouldEndOnBack

public boolean shouldEndOnBack()

Description copied from class: Tool

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

Overrides:

shouldEndOnBack in class Tool

Returns:

run

public boolean run(EditAction action)

undo

public void undo()

setActive

protected void setActive(boolean active)

Description copied from class: Tool

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.

Overrides:

setActive in class Tool

clearExtraListeners

protected void clearExtraListeners()

Description copied from class: Tool

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

Overrides:

clearExtraListeners in class Tool

initButton

protected void initButton()