com.atakmap.android.hierarchy.items

Class MapGroupHierarchyListItem

java.lang.Object

com.atakmap.android.hierarchy.items.AbstractHierarchyListItem2

com.atakmap.android.hierarchy.items.MapGroupHierarchyListItem

All Implemented Interfaces:

HashtagSearch, Action, Delete, Export, GroupDelete, Search, Visibility, Visibility2, HierarchyListItem, HierarchyListItem2, Exportable, MapGroup.OnGroupListChangedListener, MapGroup.OnItemListChangedListener

Direct Known Subclasses:

FileDatabaseMapGroupHierarchyListItem, NonExportableMapGroupHierarchyListItem

public class MapGroupHierarchyListItem
extends AbstractHierarchyListItem2
implements MapGroup.OnGroupListChangedListener, MapGroup.OnItemListChangedListener, Visibility2, GroupDelete, Search, Export

Nested Class Summary

Nested classes/interfaces inherited from interface com.atakmap.android.hierarchy.HierarchyListItem

HierarchyListItem.ComparatorSort, HierarchyListItem.Sort, HierarchyListItem.SortAlphabet, HierarchyListItem.SortAlphabetDesc, HierarchyListItem.SortDistanceFrom

Field Summary

Fields

Modifier and Type	Field and Description
static MapGroup.MapItemsCallback	ADD_TO_OBJ_LIST_FUNC
protected int	deepCount
protected MapGroup	group
protected java.util.Map<MapGroup,HierarchyListItem>	groupMap
protected MapGroup.MapItemsCallback	itemFilter
protected MapView	mapView
protected java.util.Comparator<HierarchyListItem>	order
protected MapGroupHierarchyListItem	parent

Fields inherited from class com.atakmap.android.hierarchy.items.AbstractHierarchyListItem2

asyncRefresh, children, disposed, filter, listener, postFilter, reusable, uiHandler

Fields inherited from interface com.atakmap.android.hierarchy.action.Visibility2

INVISIBLE, SEMI_VISIBLE, VISIBLE

Constructor Summary

Constructors

Constructor and Description
MapGroupHierarchyListItem(MapGroupHierarchyListItem parent, MapView mapView, MapGroup group, HierarchyListFilter filter, android.widget.BaseAdapter listener)
MapGroupHierarchyListItem(MapGroupHierarchyListItem parent, MapView mapView, MapGroup group, MapGroup.MapItemsCallback itemFilter, HierarchyListFilter filter, android.widget.BaseAdapter listener)

Method Summary

Modifier and Type	Method and Description
static boolean	addToObjList(MapGroup group)
static boolean	addToObjList(MapGroup group, MapGroup.MapItemsCallback filter)
protected HierarchyListItem	createChild(MapGroup group)
protected HierarchyListItem	createChild(MapItem item)
void	dispose() Unregister any listeners,
java.util.Set<HierarchyListItem>	find(java.lang.String terms)
java.util.List<Delete>	getDeleteActions() Get the list of delete actions in this class Meant to serve as a default implementation of GroupDelete.getDeleteActions()
int	getDescendantCount() Returns the total number of descendant nodes that this node has.
android.view.View	getExtraView() Returns the extra view, if any, associated with the node.
java.lang.String	getIconUri() Returns the URI for the icon for the node.
int	getPreferredListIndex() Returns the preferred index in the list for the item to be displayed at.
java.lang.String	getTitle() Returns the title to be displayed for the item.
java.lang.Object	getUserObject() Returns the user object associated with the node.
boolean	hideIfEmpty() Count towards parent children if this item's children is empty
protected void	invalidate(boolean deep)
boolean	isSupported(java.lang.Class<?> target) Check if this instance supports the specified target class type
boolean	isVisible() Gets the current visibility state.
void	onGroupAdded(MapGroup group, MapGroup parent)
void	onGroupRemoved(MapGroup group, MapGroup parent)
void	onItemAdded(MapItem item, MapGroup group)
void	onItemRemoved(MapItem item, MapGroup group)
protected void	refreshImpl() Refresh implementation to be run on a background thread If your class doesn't need to refresh then override the filter method above to avoid unnecessary threading
boolean	setVisible(boolean visible) Encapsulation of the visibility toggle implementation as an action.
java.lang.Object	toObjectOf(java.lang.Class<?> target, ExportFilters filters) Export to the specified target class type

Methods inherited from class com.atakmap.android.hierarchy.items.AbstractHierarchyListItem2

async, buildQueryParams, delete, disposeChildren, disposeItems, findChild, getAction, getAssociationKey, getChildActions, getChildAt, getChildCount, getChildren, getCustomLayout, getDefaultSortModes, getDescription, getDropDownSize, getExtraView, getFilter, getFooterView, getHeaderView, getIconColor, getIconDrawable, getListItemView, getLocalData, getLocalData, getSorts, getUID, getVisibility, isChildSupported, isDisposed, isGetChildrenSupported, isMultiSelectSupported, notifyListener, notifyListener, postAccept, postRefresh, refresh, refresh, refresh, refresh, requestRefresh, requestRefresh, search, setLocalData, setPostFilter, sortItems, syncRefresh, updateChildren

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atakmap.android.hierarchy.action.Visibility2

getVisibility

Methods inherited from interface com.atakmap.android.hierarchy.action.GroupDelete

delete

Field Detail

ADD_TO_OBJ_LIST_FUNC

public static final MapGroup.MapItemsCallback ADD_TO_OBJ_LIST_FUNC

parent

protected final MapGroupHierarchyListItem parent

mapView

protected final MapView mapView

group

protected final MapGroup group

itemFilter

protected final MapGroup.MapItemsCallback itemFilter

deepCount

protected int deepCount

groupMap

protected final java.util.Map<MapGroup,HierarchyListItem> groupMap

order

protected java.util.Comparator<HierarchyListItem> order

Constructor Detail

MapGroupHierarchyListItem

public MapGroupHierarchyListItem(MapGroupHierarchyListItem parent,
                                 MapView mapView,
                                 MapGroup group,
                                 HierarchyListFilter filter,
                                 android.widget.BaseAdapter listener)

MapGroupHierarchyListItem

public MapGroupHierarchyListItem(MapGroupHierarchyListItem parent,
                                 MapView mapView,
                                 MapGroup group,
                                 MapGroup.MapItemsCallback itemFilter,
                                 HierarchyListFilter filter,
                                 android.widget.BaseAdapter listener)

Method Detail

dispose

public void dispose()

Description copied from interface: HierarchyListItem2

Unregister any listeners,

Specified by:

dispose in interface HierarchyListItem2

Overrides:

dispose in class AbstractHierarchyListItem2

createChild

protected HierarchyListItem createChild(MapGroup group)

createChild

protected HierarchyListItem createChild(MapItem item)

invalidate

protected void invalidate(boolean deep)

getPreferredListIndex

public int getPreferredListIndex()

Description copied from interface: HierarchyListItem

Returns the preferred index in the list for the item to be displayed at.

Specified by:

getPreferredListIndex in interface HierarchyListItem

Overrides:

getPreferredListIndex in class AbstractHierarchyListItem2

Returns:

The preferred list index for display or -1 to indicate no preference (FIFO).

getTitle

public java.lang.String getTitle()

Description copied from interface: HierarchyListItem

Returns the title to be displayed for the item.

Specified by:

getTitle in interface HierarchyListItem

Returns:

The title to be displayed for the item.

getDescendantCount

public int getDescendantCount()

Description copied from interface: HierarchyListItem

Returns the total number of descendant nodes that this node has.

Specified by:

getDescendantCount in interface HierarchyListItem

Returns:

The total number of descendant nodes that this node has.

getIconUri

public java.lang.String getIconUri()

Description copied from interface: HierarchyListItem

Returns the URI for the icon for the node.

Specified by:

getIconUri in interface HierarchyListItem

Overrides:

getIconUri in class AbstractHierarchyListItem2

Returns:

The URI for the icon for the node, null if the node has no icon, or "gone" to remove the icon space entirely.

getUserObject

public java.lang.Object getUserObject()

Description copied from interface: HierarchyListItem

Returns the user object associated with the node. This is the underlying object that the node represents; the actual returned value is implementation dependent.

Specified by:

getUserObject in interface HierarchyListItem

Returns:

The user object associated with the node. May be null.

getExtraView

public android.view.View getExtraView()

Description copied from interface: HierarchyListItem

Returns the extra view, if any, associated with the node. The extra view occupies the space to the right of the line item and can be defined as the developer sees fit. Clicks should be passed through so you can include simple stuff like text, or more interactive things like buttons or check boxes. Should occupy space nicely with range and bearing values if any are present. If no extra view is associated with the node, the space will be empty.

Specified by:

getExtraView in interface HierarchyListItem

Overrides:

getExtraView in class AbstractHierarchyListItem2

Returns:

The extra view associated with this node, or null if there is no view.

refreshImpl

protected void refreshImpl()

Description copied from class: AbstractHierarchyListItem2

Refresh implementation to be run on a background thread If your class doesn't need to refresh then override the filter method above to avoid unnecessary threading

Specified by:

refreshImpl in class AbstractHierarchyListItem2

hideIfEmpty

public boolean hideIfEmpty()

Description copied from interface: HierarchyListItem2

Count towards parent children if this item's children is empty

Specified by:

hideIfEmpty in interface HierarchyListItem2

Returns:

True to hide, false to always show

isVisible

public boolean isVisible()

Description copied from interface: Visibility

Gets the current visibility state.

Specified by:

isVisible in interface Visibility

Overrides:

isVisible in class AbstractHierarchyListItem2

Returns:

true if the item is visible, false if invisible.

setVisible

public boolean setVisible(boolean visible)

Description copied from interface: Visibility

Encapsulation of the visibility toggle implementation as an action.

Specified by:

setVisible in interface Visibility

Overrides:

setVisible in class AbstractHierarchyListItem2

Parameters:

visible - boolean true is visible, false invisible.

Returns:

success or failure of setting the visibility.

getDeleteActions

public java.util.List<Delete> getDeleteActions()

Description copied from class: AbstractHierarchyListItem2

Get the list of delete actions in this class Meant to serve as a default implementation of GroupDelete.getDeleteActions()

Specified by:

getDeleteActions in interface GroupDelete

Overrides:

getDeleteActions in class AbstractHierarchyListItem2

Returns:

List of delete actions

find

public java.util.Set<HierarchyListItem> find(java.lang.String terms)

Specified by:

find in interface Search

Overrides:

find in class AbstractHierarchyListItem2

onItemAdded

public void onItemAdded(MapItem item,
                        MapGroup group)

Specified by:

onItemAdded in interface MapGroup.OnItemListChangedListener

onItemRemoved

public void onItemRemoved(MapItem item,
                          MapGroup group)

Specified by:

onItemRemoved in interface MapGroup.OnItemListChangedListener

onGroupAdded

public void onGroupAdded(MapGroup group,
                         MapGroup parent)

Specified by:

onGroupAdded in interface MapGroup.OnGroupListChangedListener

onGroupRemoved

public void onGroupRemoved(MapGroup group,
                           MapGroup parent)

Specified by:

onGroupRemoved in interface MapGroup.OnGroupListChangedListener

addToObjList

public static boolean addToObjList(MapGroup group)

addToObjList

public static boolean addToObjList(MapGroup group,
                                   MapGroup.MapItemsCallback filter)

isSupported

public boolean isSupported(java.lang.Class<?> target)

Description copied from interface: Exportable

Check if this instance supports the specified target class type

Specified by:

isSupported in interface Exportable

Parameters:

target - the target class

Returns:

true if this instance supports the target.

toObjectOf

public java.lang.Object toObjectOf(java.lang.Class<?> target,
                                   ExportFilters filters)
                            throws FormatNotSupportedException

Description copied from interface: Exportable

Export to the specified target class type

Specified by:

toObjectOf in interface Exportable

Parameters:

target - the target class

filters - Allows ExportMarshal instances to filter e.g. based on geographic region or other criteria

Returns:

the object that represents the instance based on the target and filter

Throws:

FormatNotSupportedException - if there is an issue creating the object.