com.atakmap.android.contact

Class Contact

java.lang.Object

com.atakmap.android.hierarchy.items.AbstractHierarchyListItem2

com.atakmap.android.contact.Contact

All Implemented Interfaces:

HashtagSearch, HierarchyListItem, HierarchyListItem2

Direct Known Subclasses:

GroupContact, IndividualContact

public abstract class Contact
extends AbstractHierarchyListItem2

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Contact.UpdateStatus

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 int	BACKGROUND_COLOR_ALIVE
static int	BACKGROUND_COLOR_DEAD
static int	BACKGROUND_COLOR_NA
static int	BACKGROUND_COLOR_STALE
protected java.lang.String	contactUUID
static int	FOREGROUND_COLOR_ALIVE
static int	FOREGROUND_COLOR_DEAD
static int	FOREGROUND_COLOR_STALE

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

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

Method Summary

Modifier and Type	Method and Description
boolean	descendedFrom(java.lang.String uid) Determine if this contact is within the hierarchy of UID
void	dispatchChangeEvent()
void	dispose() Unregister any listeners,
java.util.List<java.lang.String[]>	findChildPaths(java.lang.String uid) Find the path to the child contact UID to this contact
<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.
int	getBackgroundColor() Get the color of the contact view background
java.util.List<Contact>	getChildContacts()
int	getDescendantCount() Returns the total number of descendant nodes that this node has.
android.os.Bundle	getExtras()
android.view.View	getExtraView() Returns the extra view, if any, associated with the node.
java.util.List<Contact>	getFiltered(boolean onlineOnly, boolean incParents) Return a complete list of filtered contacts This includes descendant contacts
java.util.List<java.lang.String>	getFilteredUIDs(boolean onlineOnly)
java.lang.String[]	getHierarchyPath() Get the path to this contact as a string array Form is [name1, uid1, name2, uid2, ..., nameN, uidN] This is used specifically for CoT events
java.lang.String	getName() Return the display name of the contact
Contact	getParent()
java.util.List<Contact>	getParentContacts(boolean filtered)
java.util.List<Contact>	getParentHierarchy()
java.lang.String	getParentUID() Return the UID of this contact's parent For individual contacts this is "Root"
java.lang.Integer	getPresenceColor() Get color of presence indicator, or null if not applicable
int	getTextColor() Get the text color of the contact name text view
java.lang.String	getTitle() Returns the title to be displayed for the item.
java.lang.String	getUID() Hierarchy list item methods
int	getUnreadCount()
Contact.UpdateStatus	getUpdateStatus()
java.lang.Object	getUserObject() Returns the user object associated with the node.
protected void	notifyListener()
HierarchyListFilter	refresh(HierarchyListFilter filter) Send a refresh request to the thread pool
void	refresh(java.lang.String reason)
void	setDispatch(boolean bDispatch)
void	setExtras(android.os.Bundle extras)
void	setListener(android.widget.BaseAdapter listener) Set the listener adapter that is notified when refresh is finished
void	setName(java.lang.String name) Set the display name of the contact
void	setParentUID(java.lang.String uid) Set the parent UID of this contact For groups, should typically let addContact handle this
protected void	setUid(java.lang.String uid) Set the uid of the contact This should only be used for special cases (see RoleGroup)
void	setUnreadCount(int unreadCount)
void	setUpdateStatus(Contact.UpdateStatus status)
protected void	updateChildren(java.util.List<HierarchyListItem> items) Copy a list of items to the children array on the UI thread
protected boolean	validChild(HierarchyListItem item) Check if a child item is valid Assumes item is already part of this.children

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

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

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

hideIfEmpty

Field Detail

BACKGROUND_COLOR_ALIVE

public static final int BACKGROUND_COLOR_ALIVE

See Also:

Constant Field Values

BACKGROUND_COLOR_STALE

public static final int BACKGROUND_COLOR_STALE

See Also:

Constant Field Values

BACKGROUND_COLOR_DEAD

public static final int BACKGROUND_COLOR_DEAD

See Also:

Constant Field Values

BACKGROUND_COLOR_NA

public static final int BACKGROUND_COLOR_NA

See Also:

Constant Field Values

FOREGROUND_COLOR_ALIVE

public static final int FOREGROUND_COLOR_ALIVE

See Also:

Constant Field Values

FOREGROUND_COLOR_STALE

public static final int FOREGROUND_COLOR_STALE

See Also:

Constant Field Values

FOREGROUND_COLOR_DEAD

public static final int FOREGROUND_COLOR_DEAD

See Also:

Constant Field Values

contactUUID

protected java.lang.String contactUUID

Method Detail

setDispatch

public void setDispatch(boolean bDispatch)

getName

public java.lang.String getName()

Return the display name of the contact

Returns:

Display name

setName

public void setName(java.lang.String name)

Set the display name of the contact

Parameters:

name - Display name

setUid

protected void setUid(java.lang.String uid)

Set the uid of the contact This should only be used for special cases (see RoleGroup)

Parameters:

uid - New UID

getExtras

public android.os.Bundle getExtras()

setExtras

public void setExtras(android.os.Bundle extras)

dispatchChangeEvent

public void dispatchChangeEvent()

setUpdateStatus

public void setUpdateStatus(Contact.UpdateStatus status)

getUpdateStatus

public Contact.UpdateStatus getUpdateStatus()

getTextColor

public int getTextColor()

Get the text color of the contact name text view

Returns:

Color as integer (black by default)

getBackgroundColor

public int getBackgroundColor()

Get the color of the contact view background

Returns:

Color as integer (gray by default)

getPresenceColor

public java.lang.Integer getPresenceColor()

Get color of presence indicator, or null if not applicable

Returns:

the integer representing the color of the presence indicator

getUID

public java.lang.String getUID()

Hierarchy list item methods

Specified by:

getUID in interface HierarchyListItem

Overrides:

getUID in class AbstractHierarchyListItem2

Returns:

the unique ID of the list item

getTitle

public java.lang.String getTitle()

Description copied from interface: HierarchyListItem

Returns the title to be displayed for the item.

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.

Returns:

The total number of descendant nodes that this node has.

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.

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.

refresh

public HierarchyListFilter refresh(HierarchyListFilter filter)

Description copied from class: AbstractHierarchyListItem2

Send a refresh request to the thread pool

Specified by:

refresh in interface HierarchyListItem2

Overrides:

refresh in class AbstractHierarchyListItem2

Parameters:

filter - The new filter

Returns:

The new filter object, in case it's changed

refresh

public void refresh(java.lang.String reason)

getChildContacts

public java.util.List<Contact> getChildContacts()

getFiltered

public java.util.List<Contact> getFiltered(boolean onlineOnly,
                                           boolean incParents)

Return a complete list of filtered contacts This includes descendant contacts

Parameters:

onlineOnly - True to only include valid (online) contacts

incParents - True to include contacts that are members of any parent groups

Returns:

List of filtered contacts

getFilteredUIDs

public java.util.List<java.lang.String> getFilteredUIDs(boolean onlineOnly)

getParentContacts

public java.util.List<Contact> getParentContacts(boolean filtered)

getParentHierarchy

public java.util.List<Contact> getParentHierarchy()

updateChildren

protected void updateChildren(java.util.List<HierarchyListItem> items)

Description copied from class: AbstractHierarchyListItem2

Copy a list of items to the children array on the UI thread

Overrides:

updateChildren in class AbstractHierarchyListItem2

Parameters:

items - List of filtered/sorted items

notifyListener

protected void notifyListener()

Overrides:

notifyListener in class AbstractHierarchyListItem2

getParentUID

public java.lang.String getParentUID()

Return the UID of this contact's parent For individual contacts this is "Root"

Returns:

Parent UID

setParentUID

public void setParentUID(java.lang.String uid)

Set the parent UID of this contact For groups, should typically let addContact handle this

Parameters:

uid - Parent UID

getParent

public Contact getParent()

getHierarchyPath

public java.lang.String[] getHierarchyPath()

Get the path to this contact as a string array Form is [name1, uid1, name2, uid2, ..., nameN, uidN] This is used specifically for CoT events

Returns:

String array of names and UIDs

descendedFrom

public boolean descendedFrom(java.lang.String uid)

Determine if this contact is within the hierarchy of UID

Parameters:

uid - UID of the parent contact to check

Returns:

True if this contact is descended from UID

findChildPaths

public java.util.List<java.lang.String[]> findChildPaths(java.lang.String uid)

Find the path to the child contact UID to this contact

Parameters:

uid - Child contact UID

Returns:

The full path to the child contact, or null if not found

setListener

public void setListener(android.widget.BaseAdapter listener)

Set the listener adapter that is notified when refresh is finished

Parameters:

listener - Listener adapter

validChild

protected boolean validChild(HierarchyListItem item)

Check if a child item is valid Assumes item is already part of this.children

Parameters:

item - Item to test

Returns:

True if item is a valid contact

dispose

public void dispose()

Description copied from interface: HierarchyListItem2

Unregister any listeners,

Specified by:

dispose in interface HierarchyListItem2

Overrides:

dispose in class AbstractHierarchyListItem2

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

Overrides:

getAction in class AbstractHierarchyListItem2

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.

getUnreadCount

public int getUnreadCount()

setUnreadCount

public void setUnreadCount(int unreadCount)