NASA World Wind

gov.nasa.worldwind.render
Class UserFacingIcon

java.lang.Object
  extended by gov.nasa.worldwind.avlist.AVListImpl
      extended by gov.nasa.worldwind.render.UserFacingIcon
All Implemented Interfaces:
AVList, Movable, WWIcon, Restorable
Direct Known Subclasses:
Pedestal

public class UserFacingIcon
extends AVListImpl
implements WWIcon, Movable


Field Summary
 
Fields inherited from class gov.nasa.worldwind.avlist.AVListImpl
changeSupport
 
Constructor Summary
UserFacingIcon(java.lang.Object imageSource, Position iconPosition)
           
UserFacingIcon(java.lang.String iconPath, Position iconPosition)
           
 
Method Summary
 java.lang.Object getBackgroundImage()
           
 double getBackgroundScale()
           
 double getHighlightScale()
           
 java.lang.Object getImageSource()
           
 java.lang.String getPath()
           
 Position getPosition()
           
 Position getReferencePosition()
           
 java.lang.String getRestorableState()
          Returns an XML state document String describing the public attributes of this UserFacingIcon.
 java.awt.Dimension getSize()
           
 java.awt.Font getToolTipFont()
           
 java.lang.String getToolTipText()
           
 java.awt.Color getToolTipTextColor()
           
 boolean isAlwaysOnTop()
           
 boolean isHighlighted()
           
 boolean isShowToolTip()
           
 boolean isVisible()
           
 void move(Position position)
          Shift the shape over the globe's surface while maintaining its original azimuth -- its orientation relative to North.
 void moveTo(Position position)
          Move the shape over the globe's surface while maintaining its original azimuth -- its orientation relative to North.
 void restoreState(java.lang.String stateInXml)
          Restores publicly settable attribute values found in the specified XML state document String.
 void setAlwaysOnTop(boolean alwaysOnTop)
           
 void setBackgroundImage(java.lang.Object background)
           
 void setBackgroundScale(double backgroundScale)
           
 void setHighlighted(boolean highlighted)
           
 void setHighlightScale(double highlightScale)
           
 void setImageSource(java.lang.Object imageSource)
           
 void setPosition(Position iconPosition)
           
 void setShowToolTip(boolean showToolTip)
           
 void setSize(java.awt.Dimension size)
           
 void setToolTipFont(java.awt.Font toolTipFont)
           
 void setToolTipText(java.lang.String toolTipText)
           
 void setToolTipTextColor(java.awt.Color textColor)
           
 void setVisible(boolean visible)
           
 java.lang.String toString()
           
 
Methods inherited from class gov.nasa.worldwind.avlist.AVListImpl
addPropertyChangeListener, addPropertyChangeListener, clearList, copy, firePropertyChange, firePropertyChange, getDoubleValue, getDoubleValue, getEntries, getIntegerValue, getIntegerValue, getLongValue, getLongValue, getStringValue, getStringValue, getStringValue, getValue, getValues, hasKey, removeKey, removePropertyChangeListener, removePropertyChangeListener, setValue, setValues
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

UserFacingIcon

public UserFacingIcon(java.lang.Object imageSource,
                      Position iconPosition)

UserFacingIcon

public UserFacingIcon(java.lang.String iconPath,
                      Position iconPosition)
Method Detail

getBackgroundImage

public java.lang.Object getBackgroundImage()
Specified by:
getBackgroundImage in interface WWIcon

getBackgroundScale

public double getBackgroundScale()
Specified by:
getBackgroundScale in interface WWIcon

getHighlightScale

public double getHighlightScale()
Specified by:
getHighlightScale in interface WWIcon

getImageSource

public java.lang.Object getImageSource()
Specified by:
getImageSource in interface WWIcon

getPath

public java.lang.String getPath()

getPosition

public Position getPosition()
Specified by:
getPosition in interface WWIcon

getReferencePosition

public Position getReferencePosition()
Specified by:
getReferencePosition in interface Movable

getRestorableState

public java.lang.String getRestorableState()
Returns an XML state document String describing the public attributes of this UserFacingIcon.

Specified by:
getRestorableState in interface Restorable
Returns:
XML state document string describing this UserFacingIcon.

getSize

public java.awt.Dimension getSize()
Specified by:
getSize in interface WWIcon

getToolTipFont

public java.awt.Font getToolTipFont()
Specified by:
getToolTipFont in interface WWIcon

getToolTipText

public java.lang.String getToolTipText()
Specified by:
getToolTipText in interface WWIcon

getToolTipTextColor

public java.awt.Color getToolTipTextColor()
Specified by:
getToolTipTextColor in interface WWIcon

isAlwaysOnTop

public boolean isAlwaysOnTop()
Specified by:
isAlwaysOnTop in interface WWIcon

isHighlighted

public boolean isHighlighted()
Specified by:
isHighlighted in interface WWIcon

isShowToolTip

public boolean isShowToolTip()
Specified by:
isShowToolTip in interface WWIcon

isVisible

public boolean isVisible()
Specified by:
isVisible in interface WWIcon

move

public void move(Position position)
Description copied from interface: Movable
Shift the shape over the globe's surface while maintaining its original azimuth -- its orientation relative to North.

Specified by:
move in interface Movable
Parameters:
position - the latitude and longitude to add to the shapes reference position.

moveTo

public void moveTo(Position position)
Description copied from interface: Movable
Move the shape over the globe's surface while maintaining its original azimuth -- its orientation relative to North.

Specified by:
moveTo in interface Movable
Parameters:
position - the new position of the shapes reference position.

restoreState

public void restoreState(java.lang.String stateInXml)
Restores publicly settable attribute values found in the specified XML state document String. The document specified by stateInXml must be a well formed XML document String, or this will throw an IllegalArgumentException. Unknown structures in stateInXml are benign, because they will simply be ignored.

Specified by:
restoreState in interface Restorable
Parameters:
stateInXml - an XML document String describing a UserFacingIcon.
Throws:
java.lang.IllegalArgumentException - If stateInXml is null, or if stateInXml is not a well formed XML document String.

setAlwaysOnTop

public void setAlwaysOnTop(boolean alwaysOnTop)
Specified by:
setAlwaysOnTop in interface WWIcon

setBackgroundImage

public void setBackgroundImage(java.lang.Object background)
Specified by:
setBackgroundImage in interface WWIcon

setBackgroundScale

public void setBackgroundScale(double backgroundScale)
Specified by:
setBackgroundScale in interface WWIcon

setHighlighted

public void setHighlighted(boolean highlighted)
Specified by:
setHighlighted in interface WWIcon

setHighlightScale

public void setHighlightScale(double highlightScale)
Specified by:
setHighlightScale in interface WWIcon

setImageSource

public void setImageSource(java.lang.Object imageSource)
Specified by:
setImageSource in interface WWIcon

setPosition

public void setPosition(Position iconPosition)
Specified by:
setPosition in interface WWIcon

setShowToolTip

public void setShowToolTip(boolean showToolTip)
Specified by:
setShowToolTip in interface WWIcon

setSize

public void setSize(java.awt.Dimension size)
Specified by:
setSize in interface WWIcon

setToolTipFont

public void setToolTipFont(java.awt.Font toolTipFont)
Specified by:
setToolTipFont in interface WWIcon

setToolTipText

public void setToolTipText(java.lang.String toolTipText)
Specified by:
setToolTipText in interface WWIcon

setToolTipTextColor

public void setToolTipTextColor(java.awt.Color textColor)
Specified by:
setToolTipTextColor in interface WWIcon

setVisible

public void setVisible(boolean visible)
Specified by:
setVisible in interface WWIcon

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

NASA World Wind