gov.nasa.worldwind.render
Class UserFacingText

java.lang.Object
  gov.nasa.worldwind.render.UserFacingText

All Implemented Interfaces:

GeographicText

Direct Known Subclasses:

OpenStreetMapShapefileLoader.Label

public class UserFacingText
extends Object
implements GeographicText

Constructor Summary

UserFacingText(CharSequence text, Position textPosition)

Method Summary

Color	getBackgroundColor() Indicates the background color used to draw the text.
Color	getColor() Indicates the color used to draw the text.
Font	getFont() Indicates the font used to draw the text.
Position	getPosition() Indicates the geographic position of the text.
double	getPriority() Indicates the text priority.
CharSequence	getText() Indicates the text contained in this object.
boolean	isVisible() Indicates whether or not the text is visible.
void	setBackgroundColor(Color background) Specifies the background color used to draw the text.
void	setColor(Color color) Specifies the color used to draw the text.
void	setFont(Font font) Specifies the font used to draw the text.
void	setPosition(Position position) Specifies the geographic position of the text.
void	setPriority(double priority) Specifies the text priority.
void	setText(CharSequence text) Specifies the text.
void	setVisible(boolean visible) Specifies whether or not the text is visible.

Methods inherited from class java.lang.Object

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

Constructor Detail

UserFacingText

public UserFacingText(CharSequence text,
                      Position textPosition)

Method Detail

getBackgroundColor

public Color getBackgroundColor()

Description copied from interface: GeographicText

Indicates the background color used to draw the text.

Specified by:

getBackgroundColor in interface GeographicText

Returns:

Current background color.

getColor

public Color getColor()

Description copied from interface: GeographicText

Indicates the color used to draw the text.

Specified by:

getColor in interface GeographicText

Returns:

Current text color.

getFont

public Font getFont()

Description copied from interface: GeographicText

Indicates the font used to draw the text.

Specified by:

getFont in interface GeographicText

Returns:

Current font.

getPosition

public Position getPosition()

Description copied from interface: GeographicText

Indicates the geographic position of the text.

Specified by:

getPosition in interface GeographicText

Returns:

The text position.

getPriority

public double getPriority()

Description copied from interface: GeographicText

Indicates the text priority. The priority can be used to implement text culling.

Specified by:

getPriority in interface GeographicText

Returns:

The text priority.

getText

public CharSequence getText()

Description copied from interface: GeographicText

Indicates the text contained in this object.

Specified by:

getText in interface GeographicText

Returns:

The current text.

isVisible

public boolean isVisible()

Description copied from interface: GeographicText

Indicates whether or not the text is visible. The text will not be drawn when the visibility is set to false.

Specified by:

isVisible in interface GeographicText

Returns:

true if the text is visible, otherwise false.

setBackgroundColor

public void setBackgroundColor(Color background)

Description copied from interface: GeographicText

Specifies the background color used to draw the text.

Specified by:

setBackgroundColor in interface GeographicText

Parameters:

background - New background color.

setColor

public void setColor(Color color)

Description copied from interface: GeographicText

Specifies the color used to draw the text.

Specified by:

setColor in interface GeographicText

Parameters:

color - New color.

setFont

public void setFont(Font font)

Description copied from interface: GeographicText

Specifies the font used to draw the text.

Specified by:

setFont in interface GeographicText

Parameters:

font - New font.

setPosition

public void setPosition(Position position)

Description copied from interface: GeographicText

Specifies the geographic position of the text.

Specified by:

setPosition in interface GeographicText

Parameters:

position - New text position.

setPriority

public void setPriority(double priority)

Description copied from interface: GeographicText

Specifies the text priority. The priority can be used to implement text culling.

Specified by:

setPriority in interface GeographicText

Parameters:

priority - New priority.

setText

public void setText(CharSequence text)

Description copied from interface: GeographicText

Specifies the text.

Specified by:

setText in interface GeographicText

Parameters:

text - New text.

setVisible

public void setVisible(boolean visible)

Description copied from interface: GeographicText

Specifies whether or not the text is visible. The text will not be drawn when the visibility is set to false.

Specified by:

setVisible in interface GeographicText

Parameters:

visible - true if the text should be visible. false if not.