com.atakmap.android.hierarchy.items

Class LayerHierarchyListItem

java.lang.Object

com.atakmap.android.hierarchy.items.LayerHierarchyListItem

All Implemented Interfaces:

Action, Visibility, Visibility2, HierarchyListItem

public final class LayerHierarchyListItem
extends java.lang.Object
implements HierarchyListItem, Visibility2, Visibility

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 inherited from interface com.atakmap.android.hierarchy.action.Visibility2

INVISIBLE, SEMI_VISIBLE, VISIBLE

Constructor Summary

Constructors

Constructor and Description
LayerHierarchyListItem(Layer subject)
LayerHierarchyListItem(Layer subject, java.lang.String iconUri, boolean unwrapProxy)

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.
int	getVisibility()
boolean	isChildSupported() Check if list item can contain children
boolean	isVisible() Gets the current visibility state.
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.
boolean	setVisible(boolean visible) Encapsulation of the visibility toggle implementation as an action.

Methods inherited from class java.lang.Object

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

Constructor Detail

LayerHierarchyListItem

public LayerHierarchyListItem(Layer subject)

LayerHierarchyListItem

public LayerHierarchyListItem(Layer subject,
                              java.lang.String iconUri,
                              boolean unwrapProxy)

Method Detail

getChildCount

public int getChildCount()

Description copied from interface: HierarchyListItem

Returns the number of children that this node has.

Specified by:

getChildCount in interface HierarchyListItem

Returns:

The number of children that the node has.

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.

getChildAt

public HierarchyListItem getChildAt(int index)

Description copied from interface: HierarchyListItem

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

Specified by:

getChildAt in interface HierarchyListItem

Parameters:

index - The index

Returns:

The child node at the specified index.

isChildSupported

public boolean isChildSupported()

Description copied from interface: HierarchyListItem

Check if list item can contain children

Specified by:

isChildSupported in interface HierarchyListItem

Returns:

getUID

public final 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

getTitle

public final 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.

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

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.

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.

setLocalData

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

getAction

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

Description copied from interface: HierarchyListItem

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

Specified by:

getAction in interface HierarchyListItem

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

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

Returns:

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

refresh

public HierarchyListItem.Sort refresh(HierarchyListItem.Sort sortHint)

Description copied from interface: HierarchyListItem

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

Specified by:

refresh in interface HierarchyListItem

Parameters:

sortHint - The new sort

Returns:

The sort that is actually being used.

getVisibility

public int getVisibility()

Specified by:

getVisibility in interface Visibility2

setVisible

public final boolean setVisible(boolean visible)

Description copied from interface: Visibility

Encapsulation of the visibility toggle implementation as an action.

Specified by:

setVisible in interface Visibility

Parameters:

visible - boolean true is visible, false invisible.

Returns:

success or failure of setting the visibility.

isVisible

public final boolean isVisible()

Description copied from interface: Visibility

Gets the current visibility state.

Specified by:

isVisible in interface Visibility

Returns:

true if the item is visible, false if invisible.