com.atakmap.android.menu

Class MapMenuWidget

java.lang.Object

<any>

com.atakmap.android.widgets.MapWidget

com.atakmap.android.widgets.MapWidget2

com.atakmap.android.widgets.AbstractParentWidget

com.atakmap.android.widgets.LayoutWidget

com.atakmap.android.menu.MapMenuWidget

public class MapMenuWidget
extends LayoutWidget

Nested Class Summary

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

LayoutWidget.OnBackingColorChangedListener, LayoutWidget.OnDragEnabledChangedListener

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

AbstractParentWidget.OnWidgetListChangedListener

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

MapWidget2.OnWidgetSizeChangedListener

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

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

Constructor Summary

Constructors

Constructor and Description
MapMenuWidget() Radial menu container containing buttons and controlling layout.

Method Summary

Modifier and Type	Method and Description
float	getButtonSpan() Provides expected arc length of each button.
float	getButtonWidth() Gets the default radial width of child buttons in display adjusted pixel units.
float	getCoveredAngle() Get the total angle that the radiol menu spans in degrees.
boolean	getExplicitSizing() Get whether *any* of the sizing of buttons has been explicitly set in configuration.
float	getInnerRadius() Gets the default inside radius of the radial menu in display adjusted pixel units.
float	getStartAngle() Get the angle in degrees that locates the middle of the first child button.
boolean	isClockwiseWinding() Gets the sequencing convention for the menu's child buttons.
boolean	onWidgetCanBeAdded(int index, MapWidget widget)
void	setButtonWidth(float width) Sets the default radial width of child buttons in display adjusted pixel units.
void	setClockwiseWinding(boolean winding) Sets the sequencing convention for the menu's child buttons.
void	setCoveredAngle(float angle) Set the total angle that the radiol menu spans in degrees.
void	setInnerRadius(float radius) Sets the default inside radius of the radial menu in display adjusted pixel units.
void	setStartAngle(float angle) Set the angle in degrees that locates the middle of the first child button.

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

addOnBackingColorChangedListener, addOnDragEnabledChangedListener, fadeAlpha, getAlpha, getBackingColor, getDragEnabled, getNinePatchBG, isFadingAlpha, onBackingColorChanged, onDragEnabledChanged, removeOnBackingColorChangedListener, removeOnDragEnabledChangedListener, setAlpha, setBackingColor, setDragEnabled, setNinePatchBG

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

addChildWidget, addChildWidgetAt, addOnWidgetListChangedListener, addWidget, addWidgetAt, findWidget, getChildAt, getChildCount, getChildren, getChildWidgetAt, getChildWidgetCount, getChildWidgets, getParent, getSortedChildrenWidgets, getSortedWidgets, onActionBarToggled, onChildWidgetCanBeAdded, onWidgetAdded, onWidgetAdded, onWidgetRemoved, onWidgetRemoved, orientationChanged, removeChildWidget, removeChildWidgetAt, removeOnWidgetListChangedListener, removeWidget, removeWidgetAt, seekHit, seekWidgetHit, setZOrder

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

addOnWidgetSizeChangedListener, getSize, onSizeChanged, removeOnWidgetSizeChangedListener, seekHit, testHit

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

addOnClickListener, addOnHoverListener, addOnLongPressListener, addOnMoveListener, addOnPressListener, addOnUnpressListener, addOnVisibleChangedListener, addOnWidgetPointChangedListener, equals, getAbsolutePath, getAbsolutePosition, getAbsoluteWidgetPosition, getHeight, getMargins, getName, getPadding, getPointX, getPointY, getPropertyValue, getSize, getWidth, getZOrder, hashCode, isEnterable, isTouchable, isVisible, onClick, onClick, onHover, onLongPress, onMove, onMove, onPointChanged, onPress, onPress, onUnpress, onUnpress, onVisibleChanged, registerForwardedListener, removeOnClickListener, removeOnHoverListener, removeOnLongPressListener, removeOnMoveListener, removeOnPressListener, removeOnUnpressListener, removeOnVisibleChangedListener, removeOnWidgetPointChangedListener, setHeight, setMargins, setName, setPadding, setPadding, setParent, setPoint, setSize, setTouchable, setVisible, setWidth, 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

MapMenuWidget

public MapMenuWidget()

Radial menu container containing buttons and controlling layout.

Method Detail

getExplicitSizing

public boolean getExplicitSizing()

Get whether *any* of the sizing of buttons has been explicitly set in configuration. Default values applied while reading missing configuration are not considered explicit.

Returns:

true if any of the width, span, or radius were specified.

getButtonSpan

public float getButtonSpan()

Provides expected arc length of each button.

Returns:

button span dimension.

getCoveredAngle

public float getCoveredAngle()

Get the total angle that the radiol menu spans in degrees.

Returns:

current total angle the radial menu will cover.

setCoveredAngle

public void setCoveredAngle(float angle)

Set the total angle that the radiol menu spans in degrees. Covered angle must be positive and less than 360 degrees in total.

Parameters:

angle -

getStartAngle

public float getStartAngle()

Get the angle in degrees that locates the middle of the first child button.

Returns:

positional angle for the first child button.

setStartAngle

public void setStartAngle(float angle)

Set the angle in degrees that locates the middle of the first child button. Angle to be set should be between -180 and 180 degrees. A value of -90 degrees is straight down, 0 is to the screen right, 90 is straight up, and 180 is to the screen left.

getInnerRadius

public float getInnerRadius()

Gets the default inside radius of the radial menu in display adjusted pixel units.

Returns:

current inside radius

setInnerRadius

public void setInnerRadius(float radius)

Sets the default inside radius of the radial menu in display adjusted pixel units. Inner radius value is used as a default to locate child buttons, but this value does not change button positioning after layout operations.

Parameters:

radius -

getButtonWidth

public float getButtonWidth()

Gets the default radial width of child buttons in display adjusted pixel units.

Returns:

default width of child buttons

setButtonWidth

public void setButtonWidth(float width)

Sets the default radial width of child buttons in display adjusted pixel units.

Parameters:

width - to be used to size buttons by default

isClockwiseWinding

public boolean isClockwiseWinding()

Gets the sequencing convention for the menu's child buttons. Clockwise winding is along an axis into the screen using a right handed convention. The default winding is counter clockwise, or a default return value of false.

Returns:

whether winding of child buttons is clockwise

setClockwiseWinding

public void setClockwiseWinding(boolean winding)

Sets the sequencing convention for the menu's child buttons. Clockwise winding is along an axis into the screen using a right handed convention.

Parameters:

winding - desired for the layout sequencing of buttons

onWidgetCanBeAdded

public boolean onWidgetCanBeAdded(int index,
                                  MapWidget widget)

Overrides:

onWidgetCanBeAdded in class AbstractParentWidget