com.atakmap.android.overlay

Interface MapOverlay

All Known Subinterfaces:

MapOverlay2

All Known Implementing Classes:

AbstractMapOverlay2, AttachmentMapOverlay, ChannelsOverlay, ContourLinesOverlay, DefaultMapGroupOverlay, DeveloperTools, Dt2OutlineMapOverlay, FeatureDataStoreMapOverlay, FileDatabaseMapGroupOverlay, FilterMapOverlay, GeoFenceMapOverlay, GeoPackageMapOverlay, GRGMapOverlay, HashtagMapOverlay, HeatMapOverlay, ImportManagerMapOverlay, MapControlsOverlay, MapOverlayParent, MCIAGRGMapOverlay, MissionPackageMapOverlay, MvtMapOverlay, NonExportableMapGroupOverlay, RasterLayerMapOverlay, RubberSheetMapOverlay, VideoBrowserMapOverlay, ViewShedLayer2, WFSManager

public interface MapOverlay

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 adapter, long capabilities, HierarchyListItem.Sort preferredSort) 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.

Method Detail

getIdentifier

java.lang.String getIdentifier()

Returns the application unique identifier for the overlay.

Returns:

The application unique identifier for the overlay.

getName

java.lang.String getName()

Returns the name of the overlay.

Returns:

The name of the overlay.

getRootGroup

MapGroup getRootGroup()

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

DeepMapItemQuery getQueryFunction()

getListModel

HierarchyListItem getListModel(android.widget.BaseAdapter adapter,
                               long capabilities,
                               HierarchyListItem.Sort preferredSort)

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:

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

preferredSort - The preferred sorting order to be used when constructing the list view. This argument is a hint and may be ignored in the event that executing the specified sort will compromise performance. 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.