com.atakmap.android.layers.overlay

Class MapControlsOverlay

java.lang.Object

com.atakmap.android.overlay.AbstractMapOverlay2

com.atakmap.android.layers.overlay.MapControlsOverlay

All Implemented Interfaces:

MapOverlay, MapOverlay2

public class MapControlsOverlay
extends AbstractMapOverlay2

Overlay parent for map controls such as changing transparency of base imagery

Constructor Summary

Constructors

Constructor and Description
MapControlsOverlay(MapView mapView)

Method Summary

Modifier and Type	Method and Description
void	dispose()
java.lang.String	getIdentifier() Returns the application unique identifier for the overlay.
HierarchyListItem	getListModel(android.widget.BaseAdapter listener, 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

Constructor Detail

MapControlsOverlay

public MapControlsOverlay(MapView mapView)

Method Detail

dispose

public void dispose()

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 listener,
                                      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:

listener - 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.