com.atakmap.android.widgets

Class TextWidget

java.lang.Object

<any>

com.atakmap.android.widgets.MapWidget

com.atakmap.android.widgets.MapWidget2

com.atakmap.android.widgets.TextWidget

Direct Known Subclasses:

AttributionWidget, BloodHoundHUD, MapFocusTextWidget

public class TextWidget
extends MapWidget2

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TextWidget.OnColorChangedListener
static interface	TextWidget.OnHasBackgroundChangedListener
static interface	TextWidget.OnTextChangedListener

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 int	_lineCount
protected java.lang.String	_text
protected MapTextFormat	_textFormat
protected int	background
static int	TRANSLUCENT
static int	TRANSLUCENT_BLACK

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

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

Constructor Summary

Constructors

Constructor and Description
TextWidget()
TextWidget(java.lang.String text)
TextWidget(java.lang.String text, MapTextFormat textFormat)
TextWidget(java.lang.String text, MapTextFormat textFormat, boolean hasBackgound)
TextWidget(java.lang.String text, MapTextFormat textFormat, int background) The Text widget created with some text, formating and the background set to a specific color.

Method Summary

Modifier and Type	Method and Description
void	addOnColorChangedListener(ITextWidget.OnColorChangedListener l)
void	addOnHasBackgroundChangedListener(ITextWidget.OnHasBackgroundChangedListener l)
void	addOnTextChangedListener(ITextWidget.OnTextChangedListener 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()
int	getLineCount()
java.lang.String	getText() Get the text for the TextWidget.
MapTextFormat	getTextFormat()
TextFormat	getWidgetTextFormat()
protected void	onTextChanged()
void	orientationChanged() Subclass to allow for a new x,y,height,width to be computed when the orientation has changed.
protected void	recalcSize()
void	removeOnColorChangedListener(ITextWidget.OnColorChangedListener l)
void	removeOnHasBackgroundChangedListener(ITextWidget.OnHasBackgroundChangedListener l)
void	removeOnTextChangedListener(ITextWidget.OnTextChangedListener l)
void	setBackground(int background) Should be set to true if the TextWidget 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	setText(java.lang.CharSequence text)
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

_text

protected java.lang.String _text

_lineCount

protected int _lineCount

_textFormat

protected MapTextFormat _textFormat

background

protected int background

TRANSLUCENT_BLACK

public static final int TRANSLUCENT_BLACK

See Also:

Constant Field Values

TRANSLUCENT

public static final int TRANSLUCENT

See Also:

Constant Field Values

Constructor Detail

TextWidget

public TextWidget(java.lang.String text,
                  MapTextFormat textFormat,
                  boolean hasBackgound)

TextWidget

public TextWidget(java.lang.String text,
                  MapTextFormat textFormat,
                  int background)

The Text widget created with some text, formating and the background set to a specific color.

Parameters:

text - the text which can be broken up by newlines.

textFormat - the format to use when rendering the text

background - the background color.

TextWidget

public TextWidget(java.lang.String text,
                  MapTextFormat textFormat)

TextWidget

public TextWidget(java.lang.String text)

TextWidget

public TextWidget()

Method Detail

addOnTextChangedListener

public final void addOnTextChangedListener(ITextWidget.OnTextChangedListener l)

removeOnTextChangedListener

public final void removeOnTextChangedListener(ITextWidget.OnTextChangedListener l)

addOnColorChangedListener

public final void addOnColorChangedListener(ITextWidget.OnColorChangedListener l)

removeOnColorChangedListener

public final void removeOnColorChangedListener(ITextWidget.OnColorChangedListener l)

addOnHasBackgroundChangedListener

public final void addOnHasBackgroundChangedListener(ITextWidget.OnHasBackgroundChangedListener l)

removeOnHasBackgroundChangedListener

public final void removeOnHasBackgroundChangedListener(ITextWidget.OnHasBackgroundChangedListener 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.

setText

public void setText(java.lang.CharSequence text)

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()

setBackground

public void setBackground(int background)

Should be set to true if the TextWidget 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 TextWidget.

Returns:

String representation of the text currently in the widget.

setTextFormat

public void setTextFormat(MapTextFormat textFormat)

getTextFormat

public MapTextFormat getTextFormat()

getWidgetTextFormat

public TextFormat getWidgetTextFormat()

onTextChanged

protected void onTextChanged()

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