com.atakmap.android.user

Class SpecialPointButtonTool

java.lang.Object

com.atakmap.android.toolbar.Tool

com.atakmap.android.user.SpecialPointButtonTool

All Implemented Interfaces:

android.view.View.OnKeyListener

Direct Known Subclasses:

SelectPointButtonTool, SpiButtonTool

public abstract class SpecialPointButtonTool
extends Tool

This class is the base for the buttons that have more than an on and off state. Examples of these buttons are the Red X (SelectPoint) and the SPI points. These buttons currently have three states off (marker not visible), enabled (where the tool is on), and disabled (where the tool is off, but the point still visible). This should eliminate most of the confusion and weird states previously associated with the Red X and SPI.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SpecialPointButtonTool.States

Field Summary

Fields

Modifier and Type	Field and Description
protected android.view.View.OnClickListener	_buttonClickListener
protected android.view.View.OnLongClickListener	_buttonLongClickListener
protected Marker	_marker

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

_identifier, _mapListenerCount, _mapView

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SpecialPointButtonTool(MapView mapView, android.widget.ImageButton button, java.lang.String identifier)

Method Summary

Modifier and Type	Method and Description
protected void	addButton(android.widget.ImageButton button)
protected void	createMarker(java.lang.String assetURL, java.lang.String uid, java.lang.String callsign, java.lang.String menu, java.lang.String deleteAction) creates a marker that is shared across all of the special points.
void	dispose() Called only by the parent during final cleanup activities.
SpecialPointButtonTool.States	exectuteLongClick()
SpecialPointButtonTool.States	executeClick()
Marker	getMarker()
protected java.lang.String	getNavReference() Get the NavButtonModel reference for this tool
protected int	getResourceId(java.lang.String name)
SpecialPointButtonTool.States	getState()
SpecialPointButtonTool.States	off()
boolean	onToolBegin(android.os.Bundle bundle) 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	removeMarker()
boolean	setActionMenuData(ActionMenuData amd) Deprecated. No longer used - see NavView
protected void	setCurrentState(SpecialPointButtonTool.States s)
boolean	shouldEndOnBack() Returns whether this tool should end when the back button is pressed.

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

_marker

protected Marker _marker

_buttonLongClickListener

protected android.view.View.OnLongClickListener _buttonLongClickListener

_buttonClickListener

protected android.view.View.OnClickListener _buttonClickListener

Constructor Detail

SpecialPointButtonTool

protected SpecialPointButtonTool(MapView mapView,
                                 android.widget.ImageButton button,
                                 java.lang.String identifier)

Method Detail

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 Tool

Parameters:

bundle - 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

dispose

public void dispose()

Description copied from class: Tool

Called only by the parent during final cleanup activities.

Specified by:

dispose in class Tool

getMarker

public Marker getMarker()

addButton

protected void addButton(android.widget.ImageButton button)

setActionMenuData

@Deprecated
public boolean setActionMenuData(ActionMenuData amd)

Deprecated. No longer used - see NavView

Set the ActionMenuData object for this tool. Only one instance per tool. If the ActionMenuData item is already set, it will not be overwritten.

Parameters:

amd - ActionMenuData item to set.

Returns:

Result of setting. True indicates success and the ActionMenuData item has been set. False indicates that the item was already set and has not been saved.

getNavReference

protected java.lang.String getNavReference()

Get the NavButtonModel reference for this tool

Returns:

Nav button XML reference or null if N/A

getState

public SpecialPointButtonTool.States getState()

exectuteLongClick

public SpecialPointButtonTool.States exectuteLongClick()

off

public SpecialPointButtonTool.States off()

executeClick

public SpecialPointButtonTool.States executeClick()

createMarker

protected void createMarker(java.lang.String assetURL,
                            java.lang.String uid,
                            java.lang.String callsign,
                            java.lang.String menu,
                            java.lang.String deleteAction)

creates a marker that is shared across all of the special points. uses an assetUri in the format icon/xxx.png and not asset://icon/xxx.png

removeMarker

protected void removeMarker()

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:

getResourceId

protected int getResourceId(java.lang.String name)

setCurrentState

protected void setCurrentState(SpecialPointButtonTool.States s)