org.mars_sim.msp.ui.standard.unit_display_info
Interface UnitDisplayInfo

All Known Implementing Classes:
LUVDisplayInfoBean, RoverDisplayInfoBean

public interface UnitDisplayInfo

Provides display information about a unit.


Method Summary
 javax.swing.Icon getButtonIcon()
          Gets icon for unit button.
 double getMapClickRange()
          Gets the range (km) for clicking on unit on navigator map.
 java.awt.Font getMapLabelFont()
          Gets the label font for navigator map.
 java.lang.String getSound(Unit unit)
          Gets a sound appropriate for this unit.
 java.awt.Color getSurfGlobeColor()
          Gets display color for surface globe.
 javax.swing.Icon getSurfMapIcon(Unit unit)
          Gets display icon for the surface navigator map.
 java.awt.Color getSurfMapLabelColor()
          Gets the label color for surface navigator map.
 java.awt.Color getTopoGlobeColor()
          Gets display color for topo globe.
 javax.swing.Icon getTopoMapIcon(Unit unit)
          Gets display icon for topo navigator map.
 java.awt.Color getTopoMapLabelColor()
          Gets the label color for topo navigator map.
 boolean isGlobeDisplayed(Unit unit)
          Checks if the unit is to be displayed on the navigator tool globe.
 boolean isMapBlink(Unit unit)
          Checks if the map icon should blink on and off.
 boolean isMapDisplayed(Unit unit)
          Checks if unit is to be displayed on the navigator tool map.
 

Method Detail

isMapDisplayed

boolean isMapDisplayed(Unit unit)
Checks if unit is to be displayed on the navigator tool map.

Parameters:
unit - the unit to display
Returns:
true if unit is to be displayed on navigator map.

getSurfMapIcon

javax.swing.Icon getSurfMapIcon(Unit unit)
Gets display icon for the surface navigator map.

Parameters:
unit - the unit to display
Returns:
icon

getTopoMapIcon

javax.swing.Icon getTopoMapIcon(Unit unit)
Gets display icon for topo navigator map.

Parameters:
unit - the unit to display
Returns:
icon

isMapBlink

boolean isMapBlink(Unit unit)
Checks if the map icon should blink on and off.

Parameters:
unit - the unit to display
Returns:
true if blink

getSurfMapLabelColor

java.awt.Color getSurfMapLabelColor()
Gets the label color for surface navigator map.

Returns:
color

getTopoMapLabelColor

java.awt.Color getTopoMapLabelColor()
Gets the label color for topo navigator map.

Returns:
color

getMapLabelFont

java.awt.Font getMapLabelFont()
Gets the label font for navigator map.

Returns:
font

getMapClickRange

double getMapClickRange()
Gets the range (km) for clicking on unit on navigator map.

Returns:
clicking range

isGlobeDisplayed

boolean isGlobeDisplayed(Unit unit)
Checks if the unit is to be displayed on the navigator tool globe.

Parameters:
unit - the unit to display.
Returns:
true if unit is to be displayed on globe

getSurfGlobeColor

java.awt.Color getSurfGlobeColor()
Gets display color for surface globe.

Returns:
color

getTopoGlobeColor

java.awt.Color getTopoGlobeColor()
Gets display color for topo globe.

Returns:
color

getButtonIcon

javax.swing.Icon getButtonIcon()
Gets icon for unit button.

Returns:
icon

getSound

java.lang.String getSound(Unit unit)
Gets a sound appropriate for this unit.

Parameters:
unit - the unit to display.
Returns:
sound filepath for unit or empty string if none.