com.atakmap.android.menu

Class MapMenuButtonWidget

java.lang.Object

<any>

com.atakmap.android.widgets.MapWidget

com.atakmap.android.widgets.AbstractButtonWidget

com.atakmap.android.widgets.RadialButtonWidget

com.atakmap.android.menu.MapMenuButtonWidget

public class MapMenuButtonWidget
extends RadialButtonWidget

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MapMenuButtonWidget.OnBackingColorChangedListener Radial menu container containing buttons and controlling layout.

Nested classes/interfaces inherited from class com.atakmap.android.widgets.RadialButtonWidget

RadialButtonWidget.OnOrientationChangedListener, RadialButtonWidget.OnSizeChangedListener

Nested classes/interfaces inherited from class com.atakmap.android.widgets.AbstractButtonWidget

AbstractButtonWidget.OnBackgroundChangedListener, AbstractButtonWidget.OnIconChangedListener, AbstractButtonWidget.OnStateChangedListener, AbstractButtonWidget.OnTextChangedListener

Nested classes/interfaces inherited from class com.atakmap.android.widgets.MapWidget

MapWidget.OnClickListener, MapWidget.OnLongPressListener, MapWidget.OnMoveListener, MapWidget.OnPressListener, MapWidget.OnUnpressListener, MapWidget.OnVisibleChangedListener, MapWidget.OnWidgetPointChangedListener

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TAG

Fields inherited from class com.atakmap.android.widgets.AbstractButtonWidget

STATE_DISABLED, STATE_PRESSED, STATE_SELECTED

Fields inherited from class com.atakmap.android.widgets.MapWidget

_height, _margin, _padding, _touchable, BOTTOM, LEFT, RIGHT, TOP

Constructor Summary

Constructors

Constructor and Description
MapMenuButtonWidget(android.content.Context context) Button widget children of radial menu widgets.

Method Summary

Modifier and Type	Method and Description
void	copyAction(IMapMenuButtonWidget other)
void	delayShow(int milliSeconds) How long to delay showing widget, to animate menu
float	getDelayAlpha() Get menu widget alpha based on delay value
float	getLayoutWeight() Gets the layout weight for the button.
OnButtonClickHandler	getOnButtonClickHandler()
MapAction	getOnClickAction() Deprecated. Use IMapMenuButtonWidget#getOnButtonClickHandler() or IMapMenuButtonWidget#onButtonClick(Object)
java.util.List<java.lang.String>	getPrefKeys() Get preference keys associated with the button widget
java.util.List<java.lang.String>	getPrefValues() Get preference values associated with the button widget
int	getState()
IMapMenuWidget	getSubmenu()
MapMenuWidget	getSubmenuWidget() Deprecated. Use IMapMenuButtonWidget#getSubmenu()
IWidgetBackground	getWidgetBackground()
IIcon	getWidgetIcon()
boolean	isBackButton()
boolean	isDelaying()
boolean	isDisabled() Get whether the state of the button includes a disabled flag
protected void	onBackingColorChanged()
void	onButtonClick(java.lang.Object opaque)
void	setDisableActionSwap(boolean disableActionSwap)
void	setDisabled(boolean disabled) Disable or enable the state of the button
void	setDisableIconSwap(boolean disableIconSwap)
void	setIsBackButton(boolean _isBackButton) Set this as a back button in a submenu
void	setLayoutWeight(float weight) Set the layout weight for the button to determine is span dimension upon layout.
void	setOnButtonClickHandler(OnButtonClickHandler o)
void	setOnClickAction(MapAction mapAction) Deprecated. Use IMapMenuButtonWidget#setOnButtonClickHandler(OnButtonClickHandler)
void	setPrefKeys(java.util.List<java.lang.String> keys) Set preference keys associated with the button widget
void	setPrefValues(java.util.List<java.lang.String> values) Set preference values associated with the button widget
void	setSelectable(boolean selectable)
void	setShowSubmenu(boolean showSubmenu)
void	setShowSubmenuPref(java.lang.String showSubmenuPref)
void	setState(int state)
void	setSubmenu(IMapMenuWidget mapMenuWidget)
void	setSubmenuWidget(MapMenuWidget submenuWidget) Deprecated. Use IMapMenuButtonWidget#setSubmenu(IMapMenuWidget)
void	setWidgetBackground(IWidgetBackground bg)
void	setWidgetIcon(IIcon icon)

Methods inherited from class com.atakmap.android.widgets.RadialButtonWidget

addOnOrientationChangedListener, addOnSizeChangedListener, getButtonSpan, getButtonWidth, getOrientationAngle, getOrientationRadius, onOrientationChanged, onSizeChanged, removeOnOrientationChangedListener, removeOnSizeChangedListener, seekWidgetHit, setButtonSize, setOrientation

Methods inherited from class com.atakmap.android.widgets.AbstractButtonWidget

addOnBackgroundChangedListener, addOnIconChangedListener, addOnStateChangedListener, addOnTextChangedListener, getBackground, getIcon, getText, onBackgroundChanged, onClick, onIconChanged, onPress, onStateChanged, onTextChanged, onUnpress, removeOnBackgroundChangedListener, removeOnIconChangedListener, removeOnStateChangedListener, removeOnTextChangedListener, setBackground, setIcon, setText

Methods inherited from class com.atakmap.android.widgets.MapWidget

addOnClickListener, addOnHoverListener, addOnLongPressListener, addOnMoveListener, addOnPressListener, addOnUnpressListener, addOnVisibleChangedListener, addOnWidgetPointChangedListener, addOnWidgetSizeChangedListener, equals, getAbsolutePath, getAbsolutePosition, getAbsoluteWidgetPosition, getHeight, getMargins, getName, getPadding, getParent, getPointX, getPointY, getPropertyValue, getSize, getWidth, getZOrder, hashCode, isEnterable, isTouchable, isVisible, onHover, onLongPress, onMove, onMove, onPointChanged, onVisibleChanged, orientationChanged, registerForwardedListener, removeOnClickListener, removeOnHoverListener, removeOnLongPressListener, removeOnMoveListener, removeOnPressListener, removeOnUnpressListener, removeOnVisibleChangedListener, removeOnWidgetPointChangedListener, removeOnWidgetSizeChangedListener, seekHit, setHeight, setMargins, setName, setPadding, setPadding, setParent, setPoint, setSize, setTouchable, setVisible, setWidth, setZOrder, testHit, unregisterForwardedListener, visitPropertyInfos

Methods inherited from class java.lang.Object

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

Field Detail

TAG

public static final java.lang.String TAG

See Also:

Constant Field Values

Constructor Detail

MapMenuButtonWidget

public MapMenuButtonWidget(android.content.Context context)

Button widget children of radial menu widgets.

Parameters:

context - application Context

Method Detail

getPrefKeys

public java.util.List<java.lang.String> getPrefKeys()

Get preference keys associated with the button widget

Returns:

list of String preference keys

setPrefKeys

public void setPrefKeys(java.util.List<java.lang.String> keys)

Set preference keys associated with the button widget

Parameters:

keys - listing string preferences

getPrefValues

public java.util.List<java.lang.String> getPrefValues()

Get preference values associated with the button widget

Returns:

list of String preference values

setPrefValues

public void setPrefValues(java.util.List<java.lang.String> values)

Set preference values associated with the button widget

Parameters:

values - listing string preferences

setDisabled

public void setDisabled(boolean disabled)

Disable or enable the state of the button

Parameters:

disabled - if the button should be inactive

isDisabled

public boolean isDisabled()

Get whether the state of the button includes a disabled flag

Returns:

true if the button is disabled

copyAction

public void copyAction(IMapMenuButtonWidget other)

setWidgetIcon

public void setWidgetIcon(IIcon icon)

Overrides:

setWidgetIcon in class AbstractButtonWidget

getWidgetIcon

public IIcon getWidgetIcon()

Overrides:

getWidgetIcon in class AbstractButtonWidget

setWidgetBackground

public void setWidgetBackground(IWidgetBackground bg)

Overrides:

setWidgetBackground in class AbstractButtonWidget

getWidgetBackground

public IWidgetBackground getWidgetBackground()

Overrides:

getWidgetBackground in class AbstractButtonWidget

setState

public void setState(int state)

Overrides:

setState in class AbstractButtonWidget

getState

public int getState()

Overrides:

getState in class AbstractButtonWidget

setSelectable

public void setSelectable(boolean selectable)

Overrides:

setSelectable in class AbstractButtonWidget

getOnButtonClickHandler

public OnButtonClickHandler getOnButtonClickHandler()

setOnButtonClickHandler

public void setOnButtonClickHandler(OnButtonClickHandler o)

onButtonClick

public void onButtonClick(java.lang.Object opaque)

getOnClickAction

@Deprecated
public MapAction getOnClickAction()

Deprecated. Use IMapMenuButtonWidget#getOnButtonClickHandler() or IMapMenuButtonWidget#onButtonClick(Object)

Gets the button's onClick handler object instance

Returns:

handler that implements MapAction

setOnClickAction

@Deprecated
public void setOnClickAction(MapAction mapAction)

Deprecated. Use IMapMenuButtonWidget#setOnButtonClickHandler(OnButtonClickHandler)

Sets an onClick handler to a MapAction instance

Parameters:

mapAction - action to execute upon click

getSubmenuWidget

@Deprecated
public MapMenuWidget getSubmenuWidget()

Deprecated. Use IMapMenuButtonWidget#getSubmenu()

Gets the current submenu widget for the button.

Returns:

current submenu widget or null if unassigned or submenu preference is false

getSubmenu

public IMapMenuWidget getSubmenu()

getLayoutWeight

public float getLayoutWeight()

Gets the layout weight for the button. Buttons are scaled along their arc dimension in accordance with their weights.

Returns:

the dimensionless weight for the button

setLayoutWeight

public void setLayoutWeight(float weight)

Set the layout weight for the button to determine is span dimension upon layout. Weights are positive dimensionless values that modify relative layout size in their parent radial menu.

Parameters:

weight - to be associated with the button instance.

setDisableActionSwap

public void setDisableActionSwap(boolean disableActionSwap)

setDisableIconSwap

public void setDisableIconSwap(boolean disableIconSwap)

setSubmenuWidget

@Deprecated
public void setSubmenuWidget(MapMenuWidget submenuWidget)

Deprecated. Use IMapMenuButtonWidget#setSubmenu(IMapMenuWidget)

Set submenu widget to provided fully formed MapMenuWidget instance.

Parameters:

submenuWidget - to be associated with the button

setSubmenu

public void setSubmenu(IMapMenuWidget mapMenuWidget)

setShowSubmenuPref

public void setShowSubmenuPref(java.lang.String showSubmenuPref)

setShowSubmenu

public void setShowSubmenu(boolean showSubmenu)

delayShow

public void delayShow(int milliSeconds)

How long to delay showing widget, to animate menu

Parameters:

milliSeconds - how long to delay

isDelaying

public boolean isDelaying()

getDelayAlpha

public float getDelayAlpha()

Get menu widget alpha based on delay value

Returns:

alpha value

isBackButton

public boolean isBackButton()

setIsBackButton

public void setIsBackButton(boolean _isBackButton)

Set this as a back button in a submenu

Parameters:

_isBackButton - back button state

onBackingColorChanged

protected void onBackingColorChanged()