com.atakmap.android.maps.selector

Class MapItemList

java.lang.Object

com.atakmap.android.maps.selector.MapItemList

public final class MapItemList
extends java.lang.Object

A displayable list of map items for selection and filtering purposes Basic usage is to call setItems(Collection) with a non-empty list and then show() to display the list in a drop-down.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MapItemList.OnCancel Callback for when cancel has been selected
static interface	MapItemList.OnItemSelected Callback for when a single map item can be selected
static interface	MapItemList.OnItemsSelected Callback for when multiple map items can be selected

Constructor Summary

Constructors

Constructor and Description
MapItemList(MapView mapView) Create a new map item list
MapItemList(MapView mapView, android.content.Context plugin) Create a new map item list

Method Summary

Modifier and Type	Method and Description
MapItemList	setButtonText(int textId) Set the text displayed in the confirm button in the top-right
MapItemList	setButtonText(java.lang.String text) Set the text displayed in the confirm button in the top-right
MapItemList	setItems(java.util.Collection<? extends MapItem> items) Set the map items displayed in this list
MapItemList	setOnCancel(MapItemList.OnCancel onCancel) Set callback invoked when a user cancels out of the list
MapItemList	setOnItemSelected(MapItemList.OnItemSelected onSelect) Set callback invoked when an item has been selected This will automatically configure the list for single-select mode
MapItemList	setOnItemsSelected(MapItemList.OnItemsSelected onSelect) Set callback invoked when a selection of multiple items has been confirmed This will automatically configure the list for multi-select mode
MapItemList	setTitle(int titleId) Set the title to display at the top of the list
MapItemList	setTitle(java.lang.String title) Set the title to display at the top of the list
boolean	show() Show this map item list in a drop-down

Methods inherited from class java.lang.Object

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

Constructor Detail

MapItemList

public MapItemList(MapView mapView,
                   android.content.Context plugin)

Create a new map item list

Parameters:

mapView - Map view instance

plugin - Plugin context used for resource lookups

MapItemList

public MapItemList(MapView mapView)

Create a new map item list

Parameters:

mapView - Map view instance

Method Detail

setItems

public MapItemList setItems(java.util.Collection<? extends MapItem> items)

Set the map items displayed in this list

Parameters:

items - List of items to display

Returns:

List instance

setOnItemSelected

public MapItemList setOnItemSelected(MapItemList.OnItemSelected onSelect)

Set callback invoked when an item has been selected This will automatically configure the list for single-select mode

Parameters:

onSelect - Callback

Returns:

List instance

setOnItemsSelected

public MapItemList setOnItemsSelected(MapItemList.OnItemsSelected onSelect)

Set callback invoked when a selection of multiple items has been confirmed This will automatically configure the list for multi-select mode

Parameters:

onSelect - Callback

Returns:

List instance

setOnCancel

public MapItemList setOnCancel(MapItemList.OnCancel onCancel)

Set callback invoked when a user cancels out of the list

Parameters:

onCancel - Callback

Returns:

List instance

setTitle

public MapItemList setTitle(java.lang.String title)

Set the title to display at the top of the list

Parameters:

title - Title

Returns:

List instance

setTitle

public MapItemList setTitle(int titleId)

Set the title to display at the top of the list

Parameters:

titleId - String resource ID (plugin context)

Returns:

List instance

setButtonText

public MapItemList setButtonText(java.lang.String text)

Set the text displayed in the confirm button in the top-right

Parameters:

text - Button text

Returns:

List instance

setButtonText

public MapItemList setButtonText(int textId)

Set the text displayed in the confirm button in the top-right

Parameters:

textId - String resource ID (plugin context)

Returns:

List instance

show

public boolean show()

Show this map item list in a drop-down

Returns:

True if list successfully shown