map

Class ToggleAnnotation

java.lang.Object

gov.nasa.worldwind.avlist.AVListImpl

gov.nasa.worldwind.render.AbstractAnnotation

gov.nasa.worldwind.render.GlobeAnnotation

map.DummyGlobeAnnotation

map.ToggleAnnotation

All Implemented Interfaces:

gov.nasa.worldwind.avlist.AVList, gov.nasa.worldwind.Disposable, gov.nasa.worldwind.drag.Draggable, gov.nasa.worldwind.Locatable, gov.nasa.worldwind.Movable, gov.nasa.worldwind.render.Annotation, gov.nasa.worldwind.render.Renderable, gov.nasa.worldwind.Restorable, java.io.Serializable

public class ToggleAnnotation
extends DummyGlobeAnnotation
implements java.io.Serializable

Map annotations that can be "toggled" with a mouse click.
WARNING! NOT ALL FIELDS ARE SERIALIZED!
Serialized fields are ONLY: _selectedText, _unselectedText, position, minActiveAltitude, maxActiveAltitude
Currently, the attributes are NOT serialized.

Author:

Scott Rixner, Stephen Wong

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class gov.nasa.worldwind.render.AbstractAnnotation

gov.nasa.worldwind.render.AbstractAnnotation.TextCacheKey

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	_selected Indicates whether this annotation is currently selected.
private java.lang.String	_selectedText Text to display when the annotation is selected.
private java.lang.String	_unselectedText Text to display when the annotation is not selected.
static java.awt.Color	DEFAULT_SELECTED_BACKGROUND_COLOR Default selected background color is a half-transparent green
private java.awt.Color	selectedBackgroundColor The background color that is used when the annotation is selected.
private static long	serialVersionUID
private java.awt.Color	unselectedBackgroundColor Temporary storage of the original unselected background color when the annotation is selected.
private java.util.UUID	uuid

Fields inherited from class gov.nasa.worldwind.render.GlobeAnnotation

altitudeMode, dragEnabled, draggableSupport, heightInMeter, position

Fields inherited from class gov.nasa.worldwind.render.AbstractAnnotation

alwaysOnTop, attributes, childList, delegateOwner, layoutManager, maxActiveAltitude, minActiveAltitude, pickEnabled, pickSupport, text, textBoundsMap, vertexBuffer, wrappedTextMap

Fields inherited from interface gov.nasa.worldwind.render.Annotation

ANTIALIAS_DONT_CARE, ANTIALIAS_FASTEST, ANTIALIAS_NICEST, IMAGE_REPEAT_NONE, IMAGE_REPEAT_X, IMAGE_REPEAT_XY, IMAGE_REPEAT_Y, SIZE_FIT_TEXT, SIZE_FIXED

Constructor Summary

Constructors

Constructor and Description
ToggleAnnotation(gov.nasa.worldwind.render.GlobeAnnotation annotation) Converts a standard GlobeAnnotation to a ToggleAnnotation where the selected and unselected texts are the same.
ToggleAnnotation(java.lang.String unselectedText, java.lang.String selectedText, gov.nasa.worldwind.geom.Position pos) Build a new toggling annotation.
ToggleAnnotation(java.lang.String unselectedText, java.lang.String selectedText, gov.nasa.worldwind.geom.Position pos, gov.nasa.worldwind.render.AnnotationAttributes attr) Build a new toggling annotation with custom attributes
ToggleAnnotation(ToggleAnnotation ta) Copy constructor

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object other)
int	hashCode()
boolean	isSelected() Accessor for the current selected state
private void	readObject(java.io.ObjectInputStream in) Custom deserialization process to deserialize non-serializable superclass.
protected void	selectedFalseAction() Protected method that performs action when annotation is set to unselected.
protected void	selectedTrueAction() Protected method that performs action when annotation is set to selected.
void	setSelected(boolean selected) Sets the annotation to either the selected or non-selected state.
void	setSelectedBackgroundColor(java.awt.Color c) Sets the background color to use when the annotation is selected.
void	toggleText() Toggle between selected and unselected.
java.lang.String	toString() Overridden toString to show values
private void	writeObject(java.io.ObjectOutputStream out) Custom serialization process to serialize non-serializable superclass

Methods inherited from class gov.nasa.worldwind.render.GlobeAnnotation

computeBounds, computeDistanceScaleAndOpacity, computeLookAtDistance, doDrag, doRenderNow, drag, getAltitudeMode, getAnnotationDrawPoint, getAnnotationDrawPointLegacy, getHeightInMeter, getPosition, getReferencePosition, getRestorableState, isDragEnabled, move, moveTo, restoreState, setAltitudeMode, setDepthFunc, setDragEnabled, setHeightInMeter, setPosition

Methods inherited from class gov.nasa.worldwind.render.AbstractAnnotation

addChild, adjustSizeToChildren, adjustSizeToText, applyBackgroundTextureState, applyColor, applyScreenTransform, beginDraw, beginDrawChildren, bindPickableObject, computeBoundingRectangle, computeFreeBounds, computeInsetBounds, computeOpacity, computeScale, computeTextBounds, dispose, doDraw, doDrawBackgroundTexture, doDrawChildren, draw, drawBackground, drawBackgroundImage, drawBorder, drawCallout, drawChildren, drawContent, drawHTML, drawPlainText, drawText, drawText, drawTopLevelAnnotation, endDraw, endDrawChildren, getAttributes, getBounds, getChildren, getDelegateOwner, getLayout, getMaxActiveAltitude, getMinActiveAltitude, getMultiLineTextRenderer, getPickSupport, getPreferredSize, getText, getTextBounds, getTextRenderer, getWrappedText, glPointFromAWTPoint, isAlwaysOnTop, isPickEnabled, modulateColorOpacity, pick, removeAllChildren, removeChild, render, renderNow, setAlwaysOnTop, setAttributes, setDelegateOwner, setLayout, setMaxActiveAltitude, setMinActiveAltitude, setPickEnabled, setPickSupport, setText, transformBackgroundImageCoordsToAnnotationCoords, transformByModelview, transformImageCoordsToBackgroundImageCoords, wrapText

Methods inherited from class gov.nasa.worldwind.avlist.AVListImpl

addPropertyChangeListener, addPropertyChangeListener, clearList, copy, firePropertyChange, firePropertyChange, getBooleanValue, getBooleanValue, getChangeSupport, getDoubleValue, getDoubleValue, getEntries, getIntegerValue, getIntegerValue, getLongValue, getLongValue, getRestorableStateForAVPair, getStringValue, getStringValue, getStringValue, getValue, getValues, hasKey, removeKey, removePropertyChangeListener, removePropertyChangeListener, setValue, setValues

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

DEFAULT_SELECTED_BACKGROUND_COLOR

public static final java.awt.Color DEFAULT_SELECTED_BACKGROUND_COLOR

Default selected background color is a half-transparent green

_unselectedText

private java.lang.String _unselectedText

Text to display when the annotation is not selected.

_selectedText

private java.lang.String _selectedText

Text to display when the annotation is selected.

_selected

private boolean _selected

Indicates whether this annotation is currently selected.

selectedBackgroundColor

private java.awt.Color selectedBackgroundColor

The background color that is used when the annotation is selected.

unselectedBackgroundColor

private java.awt.Color unselectedBackgroundColor

Temporary storage of the original unselected background color when the annotation is selected.

uuid

private java.util.UUID uuid

Constructor Detail

ToggleAnnotation

public ToggleAnnotation(java.lang.String unselectedText,
                        java.lang.String selectedText,
                        gov.nasa.worldwind.geom.Position pos)

Build a new toggling annotation.

Parameters:

unselectedText - - text to display when annotation is not selected

selectedText - - text to display when annotation is selected

pos - - position of annotation

ToggleAnnotation

public ToggleAnnotation(java.lang.String unselectedText,
                        java.lang.String selectedText,
                        gov.nasa.worldwind.geom.Position pos,
                        gov.nasa.worldwind.render.AnnotationAttributes attr)

Build a new toggling annotation with custom attributes

Parameters:

unselectedText - - text to display when annotation is not selected

selectedText - - text to display when annotation is selected

pos - - position of annotation

attr - - display attributes for the annotation.

ToggleAnnotation

public ToggleAnnotation(ToggleAnnotation ta)

Copy constructor

Parameters:

ta - ToggleAnnotation to copy

ToggleAnnotation

public ToggleAnnotation(gov.nasa.worldwind.render.GlobeAnnotation annotation)

Converts a standard GlobeAnnotation to a ToggleAnnotation where the selected and unselected texts are the same.

Parameters:

annotation - The GlobeAnnotation to convert.

Method Detail

setSelectedBackgroundColor

public void setSelectedBackgroundColor(java.awt.Color c)

Sets the background color to use when the annotation is selected. To set the unselected background color, use the inherited getAttributes().setBackgroundColor(Color c). The annotation must be unselected to set the unselected background color. The selected background color can be set at any time.

Parameters:

c - The background color to use when selected.

setSelected

public void setSelected(boolean selected)

Sets the annotation to either the selected or non-selected state. Will call the protected setSelectedTrue or setSelectedFalse methods

Parameters:

selected - Whether or not the annotation will be selected.

selectedTrueAction

protected void selectedTrueAction()

Protected method that performs action when annotation is set to selected. By default, saves the current background color as next unselected background color and sets text to _selectedText. When overriding this method, be sure to call super.selectedTrueAction() to get the default behavior.

selectedFalseAction

protected void selectedFalseAction()

Protected method that performs action when annotation is set to unselected. By default, sets background color to unselectedBackgroundColor, and sets text to _unselectedText. When overriding this method, be sure to call super.selectedFalseAction() to get the default behavior.

isSelected

public boolean isSelected()

Accessor for the current selected state

Returns:

True is currently selected, false otherwise.

toggleText

public void toggleText()

Toggle between selected and unselected.

writeObject

private void writeObject(java.io.ObjectOutputStream out)
                  throws java.io.IOException

Custom serialization process to serialize non-serializable superclass

Parameters:

out - Output stream for serialization

Throws:

java.io.IOException

readObject

private void readObject(java.io.ObjectInputStream in)
                 throws java.io.IOException,
                        java.lang.ClassNotFoundException

Custom deserialization process to deserialize non-serializable superclass.

Parameters:

in - Input stream for deserialization

Throws:

java.io.IOException

java.lang.ClassNotFoundException

toString

public java.lang.String toString()

Overridden toString to show values

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object