com.atakmap.android.overlay

Class DefaultMapGroupOverlay

java.lang.Object

com.atakmap.android.overlay.AbstractMapOverlay2

com.atakmap.android.overlay.DefaultMapGroupOverlay

All Implemented Interfaces:

MapOverlay, MapOverlay2

Direct Known Subclasses:

FileDatabaseMapGroupOverlay, NonExportableMapGroupOverlay

public class DefaultMapGroupOverlay
extends AbstractMapOverlay2

Field Summary

Fields

Modifier and Type	Field and Description
protected MapGroupHierarchyListItem	currentList
protected MapGroup.MapItemsCallback	filter
protected static MapGroup.MapItemsCallback	HAS_DESCENDANT_ITEMS
protected java.lang.String	iconUri
protected java.lang.String	identifier
protected MapView	mapView
protected java.lang.String	name
protected MapGroup	rootGroup
static java.lang.String	TAG

Constructor Summary

Constructors

Modifier	Constructor and Description
	DefaultMapGroupOverlay(MapView mapView, MapGroup group) Create a default map group overlay with the friendly name as the name of the overlay.
	DefaultMapGroupOverlay(MapView mapView, MapGroup group, MapGroup.MapItemsCallback filter)
	DefaultMapGroupOverlay(MapView mapView, MapGroup group, java.lang.String iconUri) Construct a default map group overlay with the friendly name as the name of the overlay with a given icon described by iconUri.
protected	DefaultMapGroupOverlay(MapView mapView, java.lang.String id, MapGroup group, java.lang.String iconUri, MapGroup.MapItemsCallback filter)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getIdentifier() Returns the application unique identifier for the overlay.
HierarchyListItem	getListModel(android.widget.BaseAdapter callback, long actions, HierarchyListFilter filter) Returns the model that may be used to build a UI to interact with the overlay.
java.lang.String	getName() Returns the name of the overlay.
DeepMapItemQuery	getQueryFunction()
MapGroup	getRootGroup() Returns the root MapGroup which will contain all subgroups and MapItem instances for the overlay.

Methods inherited from class com.atakmap.android.overlay.AbstractMapOverlay2

getListModel

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

HAS_DESCENDANT_ITEMS

protected static final MapGroup.MapItemsCallback HAS_DESCENDANT_ITEMS

mapView

protected final MapView mapView

identifier

protected final java.lang.String identifier

name

protected final java.lang.String name

iconUri

protected final java.lang.String iconUri

rootGroup

protected final MapGroup rootGroup

filter

protected final MapGroup.MapItemsCallback filter

currentList

protected MapGroupHierarchyListItem currentList

Constructor Detail

DefaultMapGroupOverlay

public DefaultMapGroupOverlay(MapView mapView,
                              MapGroup group)

Create a default map group overlay with the friendly name as the name of the overlay. The icon must be set as part of the group bundle with the key iconUri.

DefaultMapGroupOverlay

public DefaultMapGroupOverlay(MapView mapView,
                              MapGroup group,
                              java.lang.String iconUri)

Construct a default map group overlay with the friendly name as the name of the overlay with a given icon described by iconUri.

DefaultMapGroupOverlay

public DefaultMapGroupOverlay(MapView mapView,
                              MapGroup group,
                              MapGroup.MapItemsCallback filter)

DefaultMapGroupOverlay

protected DefaultMapGroupOverlay(MapView mapView,
                                 java.lang.String id,
                                 MapGroup group,
                                 java.lang.String iconUri,
                                 MapGroup.MapItemsCallback filter)

Method Detail

getIdentifier

public java.lang.String getIdentifier()

Description copied from interface: MapOverlay

Returns the application unique identifier for the overlay.

Returns:

The application unique identifier for the overlay.

getName

public java.lang.String getName()

Description copied from interface: MapOverlay

Returns the name of the overlay.

Returns:

The name of the overlay.

getRootGroup

public MapGroup getRootGroup()

Description copied from interface: MapOverlay

Returns the root MapGroup which will contain all subgroups and MapItem instances for the overlay. This method may return null to indicate that the overlay does not contain any content that may be selected or interact with other map items.

Returns:

The root group for the overlay, or null if the overlay does not contain any selectable content.

getQueryFunction

public DeepMapItemQuery getQueryFunction()

getListModel

public HierarchyListItem getListModel(android.widget.BaseAdapter callback,
                                      long actions,
                                      HierarchyListFilter filter)

Description copied from interface: MapOverlay2

Returns the model that may be used to build a UI to interact with the overlay. The returned item represents the root node to be displayed in the list. If null, the overlay will not appear in the list.

Parameters:

callback - A reference to the adapter that will be responsible for displaying the list. The overlay may invoke BaseAdapter.notifyDataSetChanged() if the list content is externally modified and the adapter should update.

filter - The preferred filter to be used when constructing the list view. This argument is a hint and may be ignored in the event that executing the specified filter will compromise performance. A filter with an ascending alphabetic sort is recommended as the default.

Returns:

The list model used to build the UI for the overlay or null if the overlay should not be included in the list.