com.atakmap.android.user.icon

Class UserIconPallet

java.lang.Object

com.atakmap.android.user.icon.UserIconPallet

All Implemented Interfaces:

IconPallet

public class UserIconPallet
extends java.lang.Object
implements IconPallet

Nested Class Summary

Nested classes/interfaces inherited from interface com.atakmap.android.user.icon.IconPallet

IconPallet.CreatePointException

Constructor Summary

Constructors

Constructor and Description
UserIconPallet(UserIconSet iconset)

Method Summary

Modifier and Type	Method and Description
void	clearSelection(boolean bPauseListener) Clear current user selection
Fragment	getFragment() Provides fragment containing the view to select point details.
Marker	getPointPlacedIntent(GeoPointMetaData point, java.lang.String uid) Generate a map item at the specified point.
java.lang.String	getTitle() Get title/label for this pallet
java.lang.String	getUid() Get unique ID for this pallet.
void	refresh() Indicates drop down is being displayed again, allow pallets opportunity to refresh
void	select(int resId) Select an icon by resource id
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

UserIconPallet

public UserIconPallet(UserIconSet iconset)

Method Detail

getTitle

public java.lang.String getTitle()

Description copied from interface: IconPallet

Get title/label for this pallet

Specified by:

getTitle in interface IconPallet

Returns:

the human readable name for this pallet, should be shorter than 14 characters

getUid

public java.lang.String getUid()

Description copied from interface: IconPallet

Get unique ID for this pallet.

Specified by:

getUid in interface IconPallet

Returns:

the recommended return is a UUID that has been pregenerated and remains static through the lifespan of this implementation.

getFragment

public Fragment getFragment()

Description copied from interface: IconPallet

Provides fragment containing the view to select point details. It is suggested that this fragment fit within a 1/3 width of the screen.

Specified by:

getFragment in interface IconPallet

Returns:

The Android fragment that defines this Pallet.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getPointPlacedIntent

public Marker getPointPlacedIntent(GeoPointMetaData point,
                                   java.lang.String uid)
                            throws IconPallet.CreatePointException

Description copied from interface: IconPallet

Generate a map item at the specified point. Does not need to be implemented if the Fragment is responsible for all of the map interactions. Note, the intent should have a "uid" extra for the point to be created

Specified by:

getPointPlacedIntent in interface IconPallet

Parameters:

point - the geopoint that the user selected for the point.

Returns:

the MapItem that is a direct result from the touch of the map.

Throws:

IconPallet.CreatePointException

select

public void select(int resId)

Description copied from interface: IconPallet

Select an icon by resource id

Specified by:

select in interface IconPallet

Parameters:

resId - The button resource id or '0' if no default. For most user defined pallets, this implementation will or can be empty.

clearSelection

public void clearSelection(boolean bPauseListener)

Description copied from interface: IconPallet

Clear current user selection

Specified by:

clearSelection in interface IconPallet

refresh

public void refresh()

Description copied from interface: IconPallet

Indicates drop down is being displayed again, allow pallets opportunity to refresh

Specified by:

refresh in interface IconPallet