com.atakmap.android.user.icon

Interface IconPallet

All Known Implementing Classes:

Icon2525cPallet, MissionSpecificPallet, SpotMapPallet, UserIconPallet, VehicleModelPallet, VehiclePallet

public interface IconPallet

An icon pallet that allows user to drop markers/points

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IconPallet.CreatePointException

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

Method Detail

getTitle

java.lang.String getTitle()

Get title/label for this pallet

Returns:

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

getUid

java.lang.String getUid()

Get unique ID for this pallet.

Returns:

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

getPointPlacedIntent

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

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

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

getFragment

Fragment getFragment()

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

Returns:

The Android fragment that defines this Pallet.

select

void select(int resId)

Select an icon by resource id

Parameters:

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

clearSelection

void clearSelection(boolean bPauseListener)

Clear current user selection

refresh

void refresh()

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