com.atakmap.android.widgets

Class DisplayWidget

java.lang.Object

<any>

com.atakmap.android.widgets.MapWidget

com.atakmap.android.widgets.MapWidget2

com.atakmap.android.widgets.DisplayWidget

public class DisplayWidget
extends MapWidget2

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DisplayWidget.OnDisplayColorChangedListener
static interface	DisplayWidget.OnDisplayHasBackgroundChangedListener
static interface	DisplayWidget.OnDisplayTextChangedListener
static interface	DisplayWidget.OnHasIconChangedListener

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.Factory, MapWidget.OnClickListener, MapWidget.OnLongPressListener, MapWidget.OnMoveListener, MapWidget.OnPressListener, MapWidget.OnUnpressListener, MapWidget.OnVisibleChangedListener, MapWidget.OnWidgetPointChangedListener

Field Summary

Fields

Modifier and Type	Field and Description
protected MapTextFormat	_textFormat
protected int	background
static int	TRANSLUCENT

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

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

Constructor Summary

Constructors

Constructor and Description
DisplayWidget(java.lang.String text, MapTextFormat textFormat, int icon, int background, MapView mapView)

Method Summary

Modifier and Type	Method and Description
void	addOnDisplayChangedListener(DisplayWidget.OnDisplayTextChangedListener l)
void	addOnDisplayColorChangedListener(DisplayWidget.OnDisplayColorChangedListener l)
void	addOnDisplayHasBackgroundChangedListener(DisplayWidget.OnDisplayHasBackgroundChangedListener l)
int	getBackground()
int	getColor() Get the first color in the color array or white if the color is not set.
int	getColor(int lineNumber) Returns the color of a line.
int[]	getColors()
Icon	getIcon()
int	getLineCount()
java.lang.String	getText() Get the text for the DisplayWidget.
MapTextFormat	getTextFormat()
protected void	onDisplayTextChanged()
void	orientationChanged() Subclass to allow for a new x,y,height,width to be computed when the orientation has changed.
protected void	recalcSize()
void	removeOnDisplayChangedListener(DisplayWidget.OnDisplayTextChangedListener l)
void	removeOnDisplayColorChangedListener(DisplayWidget.OnDisplayColorChangedListener l)
void	removeOnDisplayHasBackgroundChangedListener(DisplayWidget.OnDisplayHasBackgroundChangedListener l)
void	setBackground(int background) Should be set to true if the DisplayWidget needs to render a background.
void	setColor(int color)
void	setColors(int[] colors) An array of the colors with each postition in the array corresponding to a line in the text.
void	setIcon(int icon)
void	setText(java.lang.String text) Set the test for the widget.
void	setTextFormat(MapTextFormat textFormat)

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

addOnWidgetSizeChangedListener, getSize, onSizeChanged, removeOnWidgetSizeChangedListener, seekHit, seekHit, seekWidgetHit, 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, getParent, 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, setZOrder, unregisterForwardedListener, visitPropertyInfos

Methods inherited from class java.lang.Object

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

Field Detail

_textFormat

protected MapTextFormat _textFormat

background

protected int background

TRANSLUCENT

public static final int TRANSLUCENT

See Also:

Constant Field Values

Constructor Detail

DisplayWidget

public DisplayWidget(java.lang.String text,
                     MapTextFormat textFormat,
                     int icon,
                     int background,
                     MapView mapView)

Method Detail

addOnDisplayChangedListener

public void addOnDisplayChangedListener(DisplayWidget.OnDisplayTextChangedListener l)

removeOnDisplayChangedListener

public void removeOnDisplayChangedListener(DisplayWidget.OnDisplayTextChangedListener l)

addOnDisplayColorChangedListener

public void addOnDisplayColorChangedListener(DisplayWidget.OnDisplayColorChangedListener l)

removeOnDisplayColorChangedListener

public void removeOnDisplayColorChangedListener(DisplayWidget.OnDisplayColorChangedListener l)

addOnDisplayHasBackgroundChangedListener

public void addOnDisplayHasBackgroundChangedListener(DisplayWidget.OnDisplayHasBackgroundChangedListener l)

removeOnDisplayHasBackgroundChangedListener

public void removeOnDisplayHasBackgroundChangedListener(DisplayWidget.OnDisplayHasBackgroundChangedListener l)

getLineCount

public int getLineCount()

setText

public void setText(java.lang.String text)

Set the test for the widget. The text can be multiline if the \n is present.

Parameters:

text - The text to be contained in the Widget.

setColor

public void setColor(int color)

setColors

public void setColors(int[] colors)

An array of the colors with each postition in the array corresponding to a line in the text.

Parameters:

colors - an integer array that contains the int color values for each line.

getColor

public int getColor()

Get the first color in the color array or white if the color is not set.

Returns:

the first color in the color array.

getColor

public int getColor(int lineNumber)

Returns the color of a line.

Parameters:

lineNumber - A zero based index for the line

Returns:

The color

getColors

public int[] getColors()

setIcon

public void setIcon(int icon)

setBackground

public void setBackground(int background)

Should be set to true if the DisplayWidget needs to render a background. If false, the background is transparent. See TRANSLUCENT BLACK commonly used background.

Parameters:

background - the background to be used for rendering the widget.

getBackground

public int getBackground()

getText

public java.lang.String getText()

Get the text for the DisplayWidget.

Returns:

String representation of the text currently in the widget.

getIcon

public Icon getIcon()

setTextFormat

public void setTextFormat(MapTextFormat textFormat)

getTextFormat

public MapTextFormat getTextFormat()

onDisplayTextChanged

protected void onDisplayTextChanged()

recalcSize

protected void recalcSize()

orientationChanged

public void orientationChanged()

Description copied from class: MapWidget

Subclass to allow for a new x,y,height,width to be computed when the orientation has changed.

Overrides:

orientationChanged in class MapWidget