com.atakmap.android.hierarchy

Interface HierarchyListItem

All Known Subinterfaces:

HierarchyListItem2

All Known Implementing Classes:

AbstractChildlessListItem, AbstractHierarchyListItem, AbstractHierarchyListItem2, AtmosphereToggle, AttachmentMapOverlay.AttachmentListItem, AttachmentMapOverlay.AttachmentOverlayListModel, CollisionOptions, Contact, ContourLinesOverlay, FeatureDataStoreHierarchyListItem, FeatureDataStoreMapOverlay.ListItem, FeatureHierarchyListItem, FeatureSetHierarchyListItem, FileDatabaseMapGroupHierarchyListItem, FilterMapOverlay.ListModelImpl, GalleryFileItem, GeoFenceListModel, GRGMapOverlay.GRGMapOverlayListItem, GRGMapOverlay.GRGMapOverlayListModel, GroupContact, HashtagContentListItem, HashtagListItem, HashtagMapOverlay.ListModel, HeatMapOverlay, HierarchyListAdapter.ListModelImpl, HierarchyListAdapter.SearchResults, IlluminationListItem, ImageryTransparencyListItem, ImportManagerMapOverlay.RemoteResourcesOverlayListModel, IndividualContact, LayerHierarchyListItem, LegacyAltitudeRenderingListItem, LollipopListItem, MapGroupHierarchyListItem, MapItemHierarchyListItem, MapOverlayParent.ListModelImpl, MissionPackageHierarchyListItem, ModelFileHierarchyListItem, ModelInfoHierarchyListItem, ModelsHierarchyListItem, MvtFileListItem, NonExportableMapGroupHierarchyListItem, NonExportableMapItemHierarchyListItem, RasterLayerHierarchyListItem, RasterLayerSelectionHierarchyListItem, RemoteResourceListItem, RoleGroup, RouteListModel, ServerGroupHierarchyListItem, SheetGroupListItem, TadilJContact, TakServerHierarchyListItem, TeamGroup, VideoBrowserMapOverlay.ListModel, ViewShedLayer2

public interface HierarchyListItem

Hierarchial list model inspired by javax.swing.tree.TreeNode.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	HierarchyListItem.ComparatorSort
static class	HierarchyListItem.Sort
static class	HierarchyListItem.SortAlphabet
static class	HierarchyListItem.SortAlphabetDesc
static class	HierarchyListItem.SortDistanceFrom

Method Summary

Modifier and Type	Method and Description
<T extends Action> T	getAction(java.lang.Class<T> clazz) Returns an instance of the specified action that can be used to interact with the node's underlying content.
HierarchyListItem	getChildAt(int index) Returns the child node at the specified index.
int	getChildCount() Returns the number of children that this node has.
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.
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	getTitle() Returns the title to be displayed for the item.
java.lang.String	getUID() Returns the unique ID of the list item
java.lang.Object	getUserObject() Returns the user object associated with the node.
boolean	isChildSupported() Check if list item can contain children
HierarchyListItem.Sort	refresh(HierarchyListItem.Sort sortHint) Refreshes this node's descendants on the specified sort.
java.lang.Object	setLocalData(java.lang.String s, java.lang.Object o) Sets the specified local data on the object.

Method Detail

getUID

java.lang.String getUID()

Returns the unique ID of the list item

Returns:

the unique ID of the list item

getTitle

java.lang.String getTitle()

Returns the title to be displayed for the item.

Returns:

The title to be displayed for the item.

getPreferredListIndex

int getPreferredListIndex()

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

Returns:

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

getChildCount

int getChildCount()

Returns the number of children that this node has.

Returns:

The number of children that the node has.

getDescendantCount

int getDescendantCount()

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

Returns:

The total number of descendant nodes that this node has.

getChildAt

HierarchyListItem getChildAt(int index)

Returns the child node at the specified index. Behavior is undefined if the index is invalid.

Parameters:

index - The index

Returns:

The child node at the specified index.

isChildSupported

boolean isChildSupported()

Check if list item can contain children

Returns:

getIconUri

java.lang.String getIconUri()

Returns the URI for the icon for the node.

Returns:

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

getIconColor

int getIconColor()

Returns the color to be applied to the icon.

Returns:

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

setLocalData

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

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

Parameters:

s - The key for the data

o - The value for the data

Returns:

The previously assigned value for the specified key.

getLocalData

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

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

Parameters:

s - The key for the local data

Returns:

The local data associated with the specified key

getLocalData

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

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

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.

getAction

<T extends Action> T getAction(java.lang.Class<T> clazz)

Returns an instance of the specified action that can be used to interact with the node's underlying content.

Parameters:

clazz - The action class

Returns:

An object that can effect the specified action or null if the specified action is not supported for the node.

getUserObject

java.lang.Object getUserObject()

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

Returns:

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

getExtraView

android.view.View getExtraView()

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.

Returns:

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

refresh

HierarchyListItem.Sort refresh(HierarchyListItem.Sort sortHint)

Refreshes this node's descendants on the specified sort. If the specified sort cannot be supported, the current sort remains unchanged.

Parameters:

sortHint - The new sort

Returns:

The sort that is actually being used.