com.atakmap.android.overlay

Class MapOverlayParent

java.lang.Object

com.atakmap.android.overlay.AbstractMapOverlay2

com.atakmap.android.overlay.MapOverlayParent

All Implemented Interfaces:

MapOverlay, MapOverlay2

public class MapOverlayParent
extends AbstractMapOverlay2

Wrapper to group child overlays

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	MapOverlayParent.ListModelImpl

Constructor Summary

Constructors

Constructor and Description
MapOverlayParent(MapView mapView, java.lang.String id, java.lang.String name, java.lang.String iconUri, int order, boolean alwaysVisible)

Method Summary

Modifier and Type	Method and Description
boolean	add(MapOverlay overlay)
void	clear()
MapOverlay	get(java.lang.String id)
java.lang.String	getIdentifier() Returns the application unique identifier for the overlay.
HierarchyListItem	getListModel(android.widget.BaseAdapter adapter, long capabilities, 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.
static MapOverlayParent	getOrAddParent(MapView mapView, java.lang.String id, java.lang.String name, java.lang.String iconUri, int order, boolean alwaysVisible) Fetch and return MapOverlayParent with specified ID.
java.util.List<MapOverlay>	getOverlays()
static MapOverlayParent	getParent(MapView mapView, java.lang.String id)
DeepMapItemQuery	getQueryFunction()
MapGroup	getRootGroup() Returns the root MapGroup which will contain all subgroups and MapItem instances for the overlay.
void	remove(MapOverlay overlay)
MapOverlay	remove(java.lang.String id)

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

MapOverlayParent

public MapOverlayParent(MapView mapView,
                        java.lang.String id,
                        java.lang.String name,
                        java.lang.String iconUri,
                        int order,
                        boolean alwaysVisible)

Method Detail

add

public boolean add(MapOverlay overlay)

get

public MapOverlay get(java.lang.String id)

getOverlays

public java.util.List<MapOverlay> getOverlays()

remove

public void remove(MapOverlay overlay)

remove

public MapOverlay remove(java.lang.String id)

clear

public void clear()

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 adapter,
                                      long capabilities,
                                      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:

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.

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.

getOrAddParent

public static MapOverlayParent getOrAddParent(MapView mapView,
                                              java.lang.String id,
                                              java.lang.String name,
                                              java.lang.String iconUri,
                                              int order,
                                              boolean alwaysVisible)

Fetch and return MapOverlayParent with specified ID. If it does not exists, then create it, add it, return it

Parameters:

mapView - the map view needed for looking up the map overlay

id - the identifier usedto identify the map overlay

name - the parent name

iconUri - the icon name for the parent

order - the ordering as an integer

alwaysVisible - true if the parent is always visible

Returns:

the overlay parent

getParent

public static MapOverlayParent getParent(MapView mapView,
                                         java.lang.String id)