com.atak.plugins.impl

Class AbstractPluginTool

java.lang.Object

transapps.maps.plugin.tool.Tool

com.atak.plugins.impl.AbstractPluginTool

All Implemented Interfaces:

ToolDescriptor

public abstract class AbstractPluginTool
extends Tool
implements ToolDescriptor

Nested Class Summary

Nested classes/interfaces inherited from class transapps.maps.plugin.tool.Tool

Tool.ToolCallback

Constructor Summary

Constructors

Constructor and Description
AbstractPluginTool(android.content.Context context, java.lang.String shortDescription, java.lang.String description, android.graphics.drawable.Drawable icon, java.lang.String action) Construct an abstract PluginTool

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDescription()
Group[]	getGroups() Unused in ATAK, will always return just GENERAL.
android.graphics.drawable.Drawable	getIcon()
java.lang.String	getShortDescription()
Tool	getTool()
void	onActivate(android.app.Activity arg0, MapView arg1, android.view.ViewGroup arg2, android.os.Bundle arg3, Tool.ToolCallback arg4)
void	onDeactivate(Tool.ToolCallback arg0)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractPluginTool

public AbstractPluginTool(android.content.Context context,
                          java.lang.String shortDescription,
                          java.lang.String description,
                          android.graphics.drawable.Drawable icon,
                          java.lang.String action)

Construct an abstract PluginTool

Parameters:

context - the context to use

shortDescription - the short dscription

description - the description

icon - the icon

action - the action

Method Detail

getDescription

public final java.lang.String getDescription()

Specified by:

getDescription in interface ToolDescriptor

Returns:

the name for this tool/layer/item

getIcon

public final android.graphics.drawable.Drawable getIcon()

Specified by:

getIcon in interface ToolDescriptor

Specified by:

getIcon in class Tool

Returns:

The icon for this tool/layer/item

getGroups

public final Group[] getGroups()

Description copied from interface: ToolDescriptor

Unused in ATAK, will always return just GENERAL.

Specified by:

getGroups in interface ToolDescriptor

Overrides:

getGroups in class Tool

Returns:

an array of length one of { Group.GENERAL }

getShortDescription

public final java.lang.String getShortDescription()

Specified by:

getShortDescription in interface ToolDescriptor

Returns:

the short name for this tool. return getDescription() if unsure

getTool

public final Tool getTool()

Specified by:

getTool in interface ToolDescriptor

Overrides:

getTool in class Tool

Returns:

The tool

onActivate

public final void onActivate(android.app.Activity arg0,
                             MapView arg1,
                             android.view.ViewGroup arg2,
                             android.os.Bundle arg3,
                             Tool.ToolCallback arg4)

Specified by:

onActivate in class Tool

onDeactivate

public final void onDeactivate(Tool.ToolCallback arg0)

Specified by:

onDeactivate in class Tool