com.atakmap.android.hierarchy

Class HierarchyListUserSelect

java.lang.Object

com.atakmap.android.hierarchy.HierarchyListFilter

com.atakmap.android.hierarchy.HierarchyListUserSelect

Direct Known Subclasses:

AsyncListUserSelect, FeatureEditListUserSelect, HashtagListUserSelect, HierarchyListUserFileSelect, HierarchyListUserGeoFence, HierarchyListUserMissionPackage

public abstract class HierarchyListUserSelect
extends HierarchyListFilter

Interface to add functionality to the Hierarchy List Tool e.g. delete all items selected by user. Note, to be instantiated via Reflection by the HierarchyListReceiver, implementations must implement a constructor with signature: ctor(Context, String)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HierarchyListUserSelect.ButtonMode ALWAYS_VISIBLE Button always visible VISIBLE_WHEN_SELECTED Button visible when at least one item is selected

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	_multiSelect
protected java.lang.String	_tag Tag e.g.
protected long	actions
static java.util.Comparator<HierarchyListUserSelect>	COMP_TITLE
protected java.util.List<java.lang.String>	mapItemUIDs List of specific Map Items to display, others will be filtered out by base impl

Fields inherited from class com.atakmap.android.hierarchy.HierarchyListFilter

sort

Constructor Summary

Constructors

Constructor and Description
HierarchyListUserSelect(java.lang.String tag, long actions)

Method Summary

Modifier and Type	Method and Description
boolean	accept(HierarchyListItem item) Return true if item should be displayed, otherwise item will be hidden
boolean	acceptEntry(HierarchyListItem item) Test to allow user to enter this item's sub-list
boolean	acceptRootList() Whether to show this select handler as a multi-select option when the user is on the root list of Overlay Manager.
void	cancel(android.content.Context context) The user has cancelled multi-select
protected boolean	filterGroup(MapGroup group) Default impl filters out if group has no items in mapItemUIDs If mapItemsUIDs is empty, does not filter
protected boolean	filterItem(MapItem item) Default impl filters out if item is not in mapItemUIDs If mapItemsUIDs is empty, does not filter
protected boolean	filterListItemImpl(HierarchyListItem item) Default impl filters out misc list items (not MapItem, MapGroup, MapOverlay)
protected boolean	filterOverlay(MapOverlay overlay) Default impl filters out if it is a FilterMapOverlay, and it has no unfiltered children
long	getActions() Returns the action(s) that may be performed by the selection handler.
abstract HierarchyListUserSelect.ButtonMode	getButtonMode() Get Button Mode for the user select handler
abstract java.lang.String	getButtonText() Provide text for button once item(s) are selected
int	getChildCount(HierarchyListItem item) Default impl applies filters to MapGroup and FilterMapOverlay
int	getDescendantCount(HierarchyListItem item) Default impl applies filters to MapGroup and FilterMapOverlay
protected ExportFilters	getFilter() Get the filter to be used in getChildCount and getDescendantCount Default impl does not filter
android.graphics.drawable.Drawable	getIcon() Get the icon representing this selector - used externally
java.lang.String	getTag()
abstract java.lang.String	getTitle() Provide title for HierarchyListReceiver Drop Down
IToolbarExtension	getToolbar() Toolbar view that is displayed while using this select handler
boolean	isExternalUsageSupported() Whether or not this selector can be used externally by other tools If this selector is only used for a specific workflow then leave this as false Otherwise if you want the selector to show up under Overlay Manager > Multi Select, return true
boolean	isMultiSelect() Whether or not this accepts multiple selections
boolean	onItemDeselected(HierarchyListAdapter om, HierarchyListItem item) An item has been deselected
boolean	onItemSelected(HierarchyListAdapter om, HierarchyListItem item) An item has been selected
abstract boolean	processUserSelections(android.content.Context context, java.util.Set<HierarchyListItem> selected) Process the user selections.
void	setMapItemUIDs(java.util.List<java.lang.String> mapItemUIDs)
void	setMultiSelect(boolean multiSelect)
void	setTag(java.lang.String tag)

Methods inherited from class com.atakmap.android.hierarchy.HierarchyListFilter

isDefaultFilter, toString

Methods inherited from class java.lang.Object

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

Field Detail

COMP_TITLE

public static final java.util.Comparator<HierarchyListUserSelect> COMP_TITLE

_tag

protected java.lang.String _tag

Tag e.g. to associate user selected items with some other content

actions

protected final long actions

_multiSelect

protected boolean _multiSelect

mapItemUIDs

protected java.util.List<java.lang.String> mapItemUIDs

List of specific Map Items to display, others will be filtered out by base impl

Constructor Detail

HierarchyListUserSelect

public HierarchyListUserSelect(java.lang.String tag,
                               long actions)

Method Detail

getTag

public java.lang.String getTag()

setTag

public void setTag(java.lang.String tag)

getActions

public long getActions()

Returns the action(s) that may be performed by the selection handler. The value returned by this method will be used when building the hierarchy lists via MapOverlay.getListModel(android.widget.BaseAdapter, long, com.atakmap.android.hierarchy.HierarchyListItem.Sort).

Returns:

A bitwise-OR of one of more of the ACTION_xxx flags specified in Actions.

getTitle

public abstract java.lang.String getTitle()

Provide title for HierarchyListReceiver Drop Down

Returns:

Overlay Manager title

getButtonText

public abstract java.lang.String getButtonText()

Provide text for button once item(s) are selected

Returns:

Button text

getButtonMode

public abstract HierarchyListUserSelect.ButtonMode getButtonMode()

Get Button Mode for the user select handler

Returns:

HierarchyListUserSelect.ButtonMode.ALWAYS_VISIBLE or HierarchyListUserSelect.ButtonMode.VISIBLE_WHEN_SELECTED

onItemSelected

public boolean onItemSelected(HierarchyListAdapter om,
                              HierarchyListItem item)

An item has been selected

Parameters:

om - Overlay manager

item - Selected item

Returns:

True if handled, false to continue

onItemDeselected

public boolean onItemDeselected(HierarchyListAdapter om,
                                HierarchyListItem item)

An item has been deselected

Parameters:

om - Overlay manager

item - Selected item

Returns:

True if handled, false to continue

processUserSelections

public abstract boolean processUserSelections(android.content.Context context,
                                              java.util.Set<HierarchyListItem> selected)

Process the user selections. Invoke when button is pressed by the user

Parameters:

context - Application context

selected - Set of selected list items

Returns:

True if handled

cancel

public void cancel(android.content.Context context)

The user has cancelled multi-select

Parameters:

context - Application context

isMultiSelect

public boolean isMultiSelect()

Whether or not this accepts multiple selections

Returns:

True to accept multiple selections

setMultiSelect

public void setMultiSelect(boolean multiSelect)

getToolbar

public IToolbarExtension getToolbar()

Toolbar view that is displayed while using this select handler

Returns:

Toolbar extension object

isExternalUsageSupported

public boolean isExternalUsageSupported()

Whether or not this selector can be used externally by other tools If this selector is only used for a specific workflow then leave this as false Otherwise if you want the selector to show up under Overlay Manager > Multi Select, return true

Returns:

True if this selector can be used externally

acceptRootList

public boolean acceptRootList()

Whether to show this select handler as a multi-select option when the user is on the root list of Overlay Manager. The root list is not processed by the usual filtering methods to preserve legacy behavior, so this method handles the filtering. Note: This is only used when isExternalUsageSupported() is set to true.

Returns:

True to show this select handler as a multi-select option on the root list

getIcon

public android.graphics.drawable.Drawable getIcon()

Get the icon representing this selector - used externally

Returns:

Icon drawable

setMapItemUIDs

public void setMapItemUIDs(java.util.List<java.lang.String> mapItemUIDs)

getFilter

protected ExportFilters getFilter()

Get the filter to be used in getChildCount and getDescendantCount Default impl does not filter

Returns:

accept

public boolean accept(HierarchyListItem item)

Return true if item should be displayed, otherwise item will be hidden

Overrides:

accept in class HierarchyListFilter

Parameters:

item -

Returns:

acceptEntry

public boolean acceptEntry(HierarchyListItem item)

Description copied from class: HierarchyListFilter

Test to allow user to enter this item's sub-list

Overrides:

acceptEntry in class HierarchyListFilter

Parameters:

item - List item

Returns:

True to allow entry into sub-list, false otherwise

filterListItemImpl

protected boolean filterListItemImpl(HierarchyListItem item)

Default impl filters out misc list items (not MapItem, MapGroup, MapOverlay)

Parameters:

item -

Returns:

filterItem

protected boolean filterItem(MapItem item)

Default impl filters out if item is not in mapItemUIDs If mapItemsUIDs is empty, does not filter

Parameters:

item -

Returns:

filterGroup

protected boolean filterGroup(MapGroup group)

Default impl filters out if group has no items in mapItemUIDs If mapItemsUIDs is empty, does not filter

Parameters:

group -

Returns:

filterOverlay

protected boolean filterOverlay(MapOverlay overlay)

Default impl filters out if it is a FilterMapOverlay, and it has no unfiltered children

Parameters:

overlay -

Returns:

getChildCount

public int getChildCount(HierarchyListItem item)

Default impl applies filters to MapGroup and FilterMapOverlay

Parameters:

item -

Returns:

getDescendantCount

public int getDescendantCount(HierarchyListItem item)

Default impl applies filters to MapGroup and FilterMapOverlay

Parameters:

item -

Returns: