com.atakmap.android.navigation.models

Class LoadoutItemModel

java.lang.Object

com.atakmap.android.navigation.models.LoadoutItemModel

public class LoadoutItemModel
extends java.lang.Object

Model used for a button loadout (the tool buttons in the top left)

Constructor Summary

Constructors

Constructor and Description
LoadoutItemModel(LoadoutItemModel copy)
LoadoutItemModel(java.lang.String title) Generates a navigation bar load out with just a provided name.
LoadoutItemModel(java.lang.String title, LoadoutItemModel copy) Generates a navigation bar load out with a provided name and loadout
LoadoutItemModel(java.lang.String uid, java.lang.String title) Generates a navigation bar load out with a reference and a name
LoadoutItemModel(java.lang.String uid, java.lang.String title, java.util.List<java.lang.String> stringSet) Generates a navigation bar load out with a reference and a name

Method Summary

Modifier and Type	Method and Description
boolean	containsButton(NavButtonModel btn) Check if this loadout contains the given button model
boolean	containsButton(java.lang.String reference) Check if this loadout contains the given button model
void	copy(LoadoutItemModel other) Copy data from another loadout
static LoadoutItemModel	fromStringSet(java.util.Set<java.lang.String> set) Parse a loadout from the preference string set
NavButtonModel	getButton(java.lang.String key) Get a button given its position key
java.lang.String	getButtonKey(NavButtonModel mdl) Get the key for a given button model
int	getNumButtons() Get the current number of buttons
java.util.List<NavButtonModel>	getSortedModels() Get all button models sorted by this loadout's sort order
java.lang.String	getTitle() Get the title of this loadout
java.lang.String	getUID() Get the unique ID for this loadout
boolean	isDefault() Check if this loadout is the default loadout
boolean	isTemporary() Check whether or not this loadout is temporary (non-persistable)
boolean	isToolVisible(java.lang.String modelRef) Check whether a tool is visible
void	persist() Persist this loadout to shared preferences
void	refreshButtons() Refresh loadout button models Useful in cases where a plugin has been loaded or unloaded
void	removeButton(NavButtonModel btn) Remove button with the given button model
void	removeButton(java.lang.String key) Remove button at the given position key
void	setButton(int index, NavButtonModel btn) Set the button at the given position
void	setButton(int index, java.lang.String reference) Set the button at the given position
void	setButton(java.lang.String key, NavButtonModel btn) Set the button at the given position key
void	setButton(java.lang.String key, java.lang.String reference) Set the given button to a model by its reference If the reference is not found a blank placeholder will be used
void	setSortOrder(java.util.List<?> models) Set the sort order for this loadout using a list of sorted button models
void	setTemporary(boolean temp) Set whether this loadout is temporary
void	setTitle(java.lang.String title) Set the displayed title for this loadout
void	setToolsVisible(java.util.Collection<java.lang.String> modelRefs, boolean visible) Set whether a tool in this loadout is visible or not This determines whether the tool shows in the "overflow" menu list of available tools
void	setToolVisible(java.lang.String modelRef, boolean visible) Set whether a tool in this loadout is visible or not This determines whether the tool shows in the "overflow" menu list of available tools
void	showZoomButton(boolean showZoom) Set whether to show the zoom button in the loadout
java.util.Set<java.lang.String>	toStringSet() Serialize a loadout to the preferences string set format

Methods inherited from class java.lang.Object

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

Constructor Detail

LoadoutItemModel

public LoadoutItemModel(java.lang.String title)

Generates a navigation bar load out with just a provided name.

Parameters:

title - the provided name

LoadoutItemModel

public LoadoutItemModel(java.lang.String title,
                        LoadoutItemModel copy)

Generates a navigation bar load out with a provided name and loadout

Parameters:

title - the provided name

copy - Loadout copy

LoadoutItemModel

public LoadoutItemModel(LoadoutItemModel copy)

LoadoutItemModel

public LoadoutItemModel(java.lang.String uid,
                        java.lang.String title)

Generates a navigation bar load out with a reference and a name

Parameters:

uid - the reference should be unique across all navigation bars

title - the title for the load out

LoadoutItemModel

public LoadoutItemModel(java.lang.String uid,
                        java.lang.String title,
                        java.util.List<java.lang.String> stringSet)

Generates a navigation bar load out with a reference and a name

Parameters:

uid - the reference should be unique across all navigation bars

title - the title for the load out

stringSet - the set of navigation buttons associated with the navigation bar load out (can be null).

Method Detail

getUID

public final java.lang.String getUID()

Get the unique ID for this loadout

Returns:

the unique identifier for this loadout

getTitle

public java.lang.String getTitle()

Get the title of this loadout

Returns:

Title

setTitle

public void setTitle(java.lang.String title)

Set the displayed title for this loadout

Parameters:

title - Title

setButton

public void setButton(java.lang.String key,
                      NavButtonModel btn)

Set the button at the given position key

Parameters:

key - Position key

btn - Button (null to remove)

setButton

public void setButton(java.lang.String key,
                      java.lang.String reference)

Set the given button to a model by its reference If the reference is not found a blank placeholder will be used

Parameters:

key - Button key

reference - Button model reference

setButton

public void setButton(int index,
                      NavButtonModel btn)

Set the button at the given position

Parameters:

index - Position index

btn - Button (null to remove)

setButton

public void setButton(int index,
                      java.lang.String reference)

Set the button at the given position

Parameters:

index - Position index

reference - Button reference

showZoomButton

public void showZoomButton(boolean showZoom)

Set whether to show the zoom button in the loadout

Parameters:

showZoom - True to show the zoom button

removeButton

public void removeButton(java.lang.String key)

Remove button at the given position key

Parameters:

key - Position key

removeButton

public void removeButton(NavButtonModel btn)

Remove button with the given button model

Parameters:

btn - Button model

getNumButtons

public int getNumButtons()

Get the current number of buttons

Returns:

Number of buttons

getButton

public NavButtonModel getButton(java.lang.String key)

Get a button given its position key

Parameters:

key - Position key

Returns:

Button or null if not found

getButtonKey

public java.lang.String getButtonKey(NavButtonModel mdl)

Get the key for a given button model

Parameters:

mdl - Button model

Returns:

Button key or null if the loadout does not contain this button

containsButton

public boolean containsButton(NavButtonModel btn)

Check if this loadout contains the given button model

Parameters:

btn - Button to check

Returns:

True if the button is contained in this loadout

containsButton

public boolean containsButton(java.lang.String reference)

Check if this loadout contains the given button model

Parameters:

reference - Button model reference

Returns:

True if the button model exists and is contained in this loadout

isDefault

public boolean isDefault()

Check if this loadout is the default loadout

Returns:

True if default

setToolVisible

public void setToolVisible(java.lang.String modelRef,
                           boolean visible)

Set whether a tool in this loadout is visible or not This determines whether the tool shows in the "overflow" menu list of available tools

Parameters:

modelRef - NavButtonModel.getReference()

visible - True if visible, false if hidden

setToolsVisible

public void setToolsVisible(java.util.Collection<java.lang.String> modelRefs,
                            boolean visible)

Set whether a tool in this loadout is visible or not This determines whether the tool shows in the "overflow" menu list of available tools

Parameters:

modelRefs - List of NavButtonModel.getReference()

visible - True if visible, false if hidden

isToolVisible

public boolean isToolVisible(java.lang.String modelRef)

Check whether a tool is visible

Parameters:

modelRef - NavButtonModel.getReference()

Returns:

True if visible

setSortOrder

public void setSortOrder(java.util.List<?> models)

Set the sort order for this loadout using a list of sorted button models

Parameters:

models - Button models to use as the order reference This can be a list of NavButtonModel or String

getSortedModels

public java.util.List<NavButtonModel> getSortedModels()

Get all button models sorted by this loadout's sort order

Returns:

List of button models

persist

public void persist()

Persist this loadout to shared preferences

refreshButtons

public void refreshButtons()

Refresh loadout button models Useful in cases where a plugin has been loaded or unloaded

copy

public void copy(LoadoutItemModel other)

Copy data from another loadout

Parameters:

other - Other loadout

isTemporary

public boolean isTemporary()

Check whether or not this loadout is temporary (non-persistable)

Returns:

True if temporary

setTemporary

public void setTemporary(boolean temp)

Set whether this loadout is temporary

Parameters:

temp - True if temporary

toStringSet

public java.util.Set<java.lang.String> toStringSet()

Serialize a loadout to the preferences string set format

Returns:

Loadout data string set

fromStringSet

public static LoadoutItemModel fromStringSet(java.util.Set<java.lang.String> set)

Parse a loadout from the preference string set

Parameters:

set - String set containing loadout data

Returns:

Loadout or null if failed