com.atakmap.android.toolbar

Class ButtonTool

java.lang.Object

com.atakmap.android.toolbar.Tool

com.atakmap.android.toolbar.ButtonTool

All Implemented Interfaces:

android.view.View.OnKeyListener

Direct Known Subclasses:

BloodHoundTool, BullseyeTool, CircleEditTool, DrawingEllipseCreationTool, DrawingEllipseEditTool, EditablePolylineEditTool, IntentLauncherTool, LaserBasketDisplayTool, PlaceHostileTool, RangeAndBearingTool, RectangleEditTool, SensorFOVTool, VehicleRotationTool

public abstract class ButtonTool
extends Tool

Handles button selected state, enabled state, and sends begin_tool/end_tool intents when you press the button.

Field Summary

Fields

Modifier and Type	Field and Description
protected android.widget.Button	_button
protected android.widget.ImageButton	_imageButton

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

_identifier, _mapListenerCount, _mapView

Constructor Summary

Constructors

Constructor and Description
ButtonTool(MapView mapView, android.widget.Button button, java.lang.String identifier)
ButtonTool(MapView mapView, android.widget.ImageButton button, java.lang.String identifier)

Method Summary

Modifier and Type	Method and Description
void	dispose() Called only by the parent during final cleanup activities.
protected void	initButton() Performs button initialization, setting up onclick listeners etc.
void	onButtonClicked()
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	setActive(boolean active) Called to set whether a tool is actively being used.

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

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

Methods inherited from class java.lang.Object

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

Field Detail

_button

protected android.widget.Button _button

_imageButton

protected android.widget.ImageButton _imageButton

Constructor Detail

ButtonTool

public ButtonTool(MapView mapView,
                  android.widget.Button button,
                  java.lang.String identifier)

ButtonTool

public ButtonTool(MapView mapView,
                  android.widget.ImageButton button,
                  java.lang.String identifier)

Method Detail

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.

dispose

public void dispose()

Description copied from class: Tool

Called only by the parent during final cleanup activities.

Specified by:

dispose in class Tool

onButtonClicked

public void onButtonClicked()

initButton

protected void initButton()

Performs button initialization, setting up onclick listeners etc. Overide if the default behavior (start tool if it isn't started, stop if if it is) isn't sufficient.

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