com.atakmap.android.user

Class SpiButtonTool

java.lang.Object

com.atakmap.android.toolbar.Tool

com.atakmap.android.user.SpecialPointButtonTool

com.atakmap.android.user.SpiButtonTool

All Implemented Interfaces:

android.view.View.OnKeyListener, MapItem.OnVisibleChangedListener

public class SpiButtonTool
extends SpecialPointButtonTool
implements MapItem.OnVisibleChangedListener

Nested Class Summary

Nested classes/interfaces inherited from class com.atakmap.android.user.SpecialPointButtonTool

SpecialPointButtonTool.States

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	IDENTIFIER
static java.lang.String	SPI_OFF
static java.lang.String	TAG

Fields inherited from class com.atakmap.android.user.SpecialPointButtonTool

_buttonClickListener, _buttonLongClickListener, _marker

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

_identifier, _mapListenerCount, _mapView

Constructor Summary

Constructors

Constructor and Description
SpiButtonTool(MapView mapView, android.widget.ImageButton button, int index) This tool is similar to the SelectPointButtonTool, but only one instance of each button should exist, making it easy to define.

Method Summary

Modifier and Type	Method and Description
void	dispose() Called only by the parent during final cleanup activities.
boolean	onToolBegin(android.os.Bundle bundle) Called when this tool has been asked to start (and after the last tool has cleaned up)
void	onVisibleChanged(MapItem item)

Methods inherited from class com.atakmap.android.user.SpecialPointButtonTool

addButton, createMarker, exectuteLongClick, executeClick, getMarker, getNavReference, getResourceId, getState, off, onToolEnd, removeMarker, setActionMenuData, setCurrentState, shouldEndOnBack

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

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

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

IDENTIFIER

public static final java.lang.String IDENTIFIER

See Also:

Constant Field Values

SPI_OFF

public static final java.lang.String SPI_OFF

See Also:

Constant Field Values

Constructor Detail

SpiButtonTool

public SpiButtonTool(MapView mapView,
                     android.widget.ImageButton button,
                     int index)

This tool is similar to the SelectPointButtonTool, but only one instance of each button should exist, making it easy to define. Unlike the SelectPointButtonTool, the SpiButtonTool needs to publish its information should it be turned on (enabled or disabled state). The index specified pulls the resources to draw the appropriate icon. Currently there are only 1, 2, and 3 available, but additional would simply be a matter of creating new resources. Perhaps these can be created on the fly at some point.

Parameters:

mapView - MapView used to construct this button

button - Button to associated with this tool

index -

Method Detail

dispose

public void dispose()

Description copied from class: Tool

Called only by the parent during final cleanup activities.

Overrides:

dispose in class SpecialPointButtonTool

onToolBegin

public boolean onToolBegin(android.os.Bundle bundle)

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 SpecialPointButtonTool

Parameters:

bundle - extra params that were passed by the GUI

Returns:

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

onVisibleChanged

public void onVisibleChanged(MapItem item)

Specified by:

onVisibleChanged in interface MapItem.OnVisibleChangedListener