com.atakmap.android.hierarchy.items

Class AbstractHierarchyListItem

java.lang.Object

com.atakmap.android.hierarchy.items.AbstractHierarchyListItem

All Implemented Interfaces:

HierarchyListItem

Direct Known Subclasses:

ContourLinesOverlay, HeatMapOverlay, MvtFileListItem

public abstract class AbstractHierarchyListItem
extends java.lang.Object
implements HierarchyListItem

Nested Class Summary

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

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractHierarchyListItem()

Method Summary

Modifier and Type	Method and Description
int	getIconColor() Returns the color to be applied to the icon.
java.lang.String	getIconUri() Returns the URI for the icon for the node.
java.lang.Object	getLocalData(java.lang.String s) Returns the local data associated with the node for the specified key.
<T> T	getLocalData(java.lang.String s, java.lang.Class<T> clazz) Returns the local data associated with the node for the specified key.
int	getPreferredListIndex() Returns the preferred index in the list for the item to be displayed at.
java.lang.String	getUID() Returns the unique ID of the list item
boolean	isChildSupported() Check if list item can contain children
java.lang.Object	setLocalData(java.lang.String s, java.lang.Object o) Sets the specified local data on the object.

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

getAction, getChildAt, getChildCount, getDescendantCount, getExtraView, getTitle, getUserObject, refresh

Constructor Detail

AbstractHierarchyListItem

protected AbstractHierarchyListItem()

Method Detail

getUID

public java.lang.String getUID()

Description copied from interface: HierarchyListItem

Returns the unique ID of the list item

Specified by:

getUID in interface HierarchyListItem

Returns:

the unique ID of the list item

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

Returns:

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

isChildSupported

public boolean isChildSupported()

Description copied from interface: HierarchyListItem

Check if list item can contain children

Specified by:

isChildSupported in interface HierarchyListItem

Returns:

getIconColor

public int getIconColor()

Description copied from interface: HierarchyListItem

Returns the color to be applied to the icon.

Specified by:

getIconColor in interface HierarchyListItem

Returns:

The color to be applied to the icon, return 0xFFFFFFFF (-1) to use the original color.

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

Returns:

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

setLocalData

public final java.lang.Object setLocalData(java.lang.String s,
                                           java.lang.Object o)

Description copied from interface: HierarchyListItem

Sets the specified local data on the object. Local data is user specific data that the external object displaying the list can use for its own purposes (e.g. associate some runtime computed property with a node).

Specified by:

setLocalData in interface HierarchyListItem

Parameters:

s - The key for the data

o - The value for the data

Returns:

The previously assigned value for the specified key.

getLocalData

public final java.lang.Object getLocalData(java.lang.String s)

Description copied from interface: HierarchyListItem

Returns the local data associated with the node for the specified key. Local data is user specific data that the external object displaying the list can use for its own purposes (e.g. associate some runtime computed property with a node).

Specified by:

getLocalData in interface HierarchyListItem

Parameters:

s - The key for the local data

Returns:

The local data associated with the specified key

getLocalData

public final <T> T getLocalData(java.lang.String s,
                                java.lang.Class<T> clazz)

Description copied from interface: HierarchyListItem

Returns the local data associated with the node for the specified key. Local data is user specific data that the external object displaying the list can use for its own purposes (e.g. associate some runtime computed property with a node).

Specified by:

getLocalData in interface HierarchyListItem

Parameters:

s - The key for the local data

clazz - The return type for the data

Returns:

The local data associated with the specified key, cast to an object of template class T.