DisplayControlBase (Unidata IDV API v6.2u2)

java.lang.Object
- ucar.unidata.collab.SharableImpl
- - ucar.unidata.idv.control.DisplayControlBase

All Implemented Interfaces:

Sharable

Direct Known Subclasses:

DisplayControlImpl
```
public abstract class DisplayControlBase
extends SharableImpl
```
Some display control oriented utilities

Version:

$Revision: 1.28 $

Author:

IDV development team

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`APPEARANCE_DARK` String used to set the appearance mode
`static java.lang.String`	`APPEARANCE_IDV` String used to set the appearance mode
`static java.lang.String`	`APPEARANCE_LIGHT` String used to set the appearance mode
`static java.lang.String`	`CMD_BARBSIZE` String used as the action command for setting the size of wind barbs
`static java.lang.String`	`CMD_COLORS` String used as the action command for the color setting button
`static java.lang.String`	`CMD_COLORTABLE` String used as the action command for setting the color table
`static java.lang.String`	`CMD_INTERVAL` String used as the action command for setting the wind barb interval
`static java.lang.String`	`CMD_LEVEL` String used as the action command for setting the level
`static java.lang.String`	`CMD_LINEWIDTH` String used as the action command for setting the level
`static java.lang.String`	`CMD_POPUP` String used as the action command for showing the control window
`static java.lang.String`	`CMD_REMOVE` String used as the action command for removing this display control
`static int`	`DEFAULT_POINT_SIZE` Default selector point size.
`protected static java.lang.String`	`DEFAULT_SAMPLING_MODE` What is the default samppling mode
`static java.lang.String`	`FIND_ALL` search string for all
`static java.lang.String`	`FIND_CATEGORY` search string for category
`static java.lang.String`	`FIND_CLASS` search string for class:
`static java.lang.String`	`FIND_SPECIAL` search string for special
`static java.lang.String`	`FIND_THIS` search string for this
`static java.lang.String`	`FIND_WITHDATA` search string for displays with data
`static java.lang.String`	`FIND_WITHTHISDATA` search string for display like this with data
`static java.lang.String`	`FIND_WITHTHISFIELD` search string for display with this data
`static java.lang.String`	`FIND_WITHTHISVIEW` search string with displays in this view
`static int`	`FLAG_COLOR` Bitmask for controls that use colors
`static int`	`FLAG_COLORTABLE` Bitmask for controls that use color tables
`static int`	`FLAG_COLORUNIT` Bitmask for controls that can change their color units
`static int`	`FLAG_CONTOUR` Bitmask for controls that use contour interval information
`static int`	`FLAG_DATACONTROL` Bitmask for controls that have the "Set data" button capability enabled
`static int`	`FLAG_DISPLAYUNIT` Bitmask for controls that can change their display units
`static int`	`FLAG_GRIDTRAJECTORY` flag for the trackcontrol to add marker widget or not
`static int`	`FLAG_LINEWIDTH` Bitmask for controls that allow line width setting
`static int`	`FLAG_NONE` No-op for attributeFlags
`static int`	`FLAG_SELECTRANGE` Bitmask for controls that allow selecting a data range
`static int`	`FLAG_SKIPFACTOR` Bitmask for controls that allow skip factor setting
`static int`	`FLAG_SMOOTHING` Bitmask for controls that allow grid smoothing setting
`static int`	`FLAG_TEXTUREQUALITY` Bitmask for controls that allow texture quality setting
`static int`	`FLAG_TIMERANGE` Bitmask for controls that allow selecting a time range
`static int`	`FLAG_ZPOSITION` Bitmask for controls that have a fixed z position
`protected static java.awt.Insets`	`GRID_INSETS` Used for doing doLayout calls
`protected static javax.swing.ImageIcon`	`ICON_LOCK` The icon used to show locked legend components
`static javax.swing.ImageIcon`	`ICON_REMOVE` Icon used to remove displays
`protected static javax.swing.ImageIcon`	`ICON_UNLOCK` The icon used to show unlocked legend components
`static java.lang.String`	`LABEL_NONE` A label for None
`static LogUtil.LogCategory`	`log_` Use this member to log messages (through calls to LogUtil)
`static java.lang.String`	`MACRO_DATASOURCENAME` Macro for the data source name (or names) for the label
`static java.lang.String`	`MACRO_DISPLAYNAME` Macro for the display name for the label
`static java.lang.String`	`MACRO_DISPLAYUNIT` Macro for the display unit for the label
`static java.lang.String`	`MACRO_FHOUR` forecast hour macro
`static java.lang.String`	`MACRO_FHOUR2` forecast hour macro without the 'H' -- user can format their own
`static java.lang.String`	`MACRO_LONGNAME` Macro for the long parameter name for the label
`static java.lang.String`	`MACRO_POSITION` Macro for the short parameter name for the label
`static java.lang.String`	`MACRO_RESOLUTION` Macro for the resolution for the label
`static java.lang.String`	`MACRO_SHORTNAME` Macro for the short parameter name for the label
`static java.lang.String`	`MACRO_STATION` Macro for station
`static java.lang.String`	`MACRO_TIMESTAMP` Macro for the display unit for the label
`static java.lang.String`	`MACRO_VALUE` Macro for the short parameter name for the label
`static java.lang.String`	`NEAREST_NEIGHBOR` String used the set the sampling to be nearest neighbor
`static java.lang.String`	`PREF_DISPLAYLIST_TEMPLATE` The preference id for the default label template for displays
`static java.lang.String`	`PREF_EXTRALABEL_TEMPLATE` The preference id for the default extra label template for displays
`static java.lang.String`	`PREF_LEGENDLABEL_TEMPLATE` The preference id for the default label template for displays
`static java.lang.String`	`PROP_REMOVED` Name of the property removed propert
`static java.lang.String`	`SETTINGS_GROUP_DISPLAY` display group setting
`static java.lang.String`	`SETTINGS_GROUP_FLAGS` group flags
`static java.lang.String`	`SHARE_CHOICES` data choices property
`static java.lang.String`	`SHARE_COLOR` Color property
`static java.lang.String`	`SHARE_COLORSCALE` Color scale property
`static java.lang.String`	`SHARE_COLORTABLE` Color table property
`static java.lang.String`	`SHARE_DISPLAYUNIT` Display unit property
`static java.lang.String`	`SHARE_POSITION` Probe position property
`static java.lang.String`	`SHARE_SELECTRANGE` select range property
`static java.lang.String`	`SHARE_SKIPVALUE` Probe position property
`static java.lang.String`	`SHARE_TRANSECT` Transect Line position property
`static java.lang.String`	`SHARE_VISIBILITY` Visiblity property
`static java.lang.String`	`WEIGHTED_AVERAGE` String used to set the sampling to be weighted average

Constructor Summary

Constructors
Constructor and Description

DisplayControlBase()
ctor

Constructors
Constructor and Description
`DisplayControlBase()` ctor

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`visad.georef.EarthLocation`	`boxToEarth(double[] boxCoords)` Map the visad box to an earth location
`visad.georef.EarthLocation`	`boxToEarth(double[] boxCoords, boolean setZToZeroIfOverhead)` Map the visad box to an earth location
`visad.georef.EarthLocation`	`boxToEarth(double x, double y, double z)` Map the visad box to an earth location
`visad.georef.EarthLocation`	`boxToEarth(double x, double y, double z, boolean setZToZeroIfOverhead)` Map the visad box to an earth location
`java.util.List`	`boxToEarth(java.util.List boxPoints)` Map the visad box points to earth locations
`int[]`	`boxToScreen(double[] xyz)` Map a visad box point to the screen coords.
`protected java.awt.geom.Rectangle2D`	`calculateRectangle()` Calculates the rectangle that is the bounds of the VisAD display.
`static TwoFacedObject`	`createStationTfo(java.lang.Object o)` A utility to wrap the given object (which should be a NamedStationImpl) in a TwoFacedObject, truncating the label to a fixed size.
`double[]`	`earthToBox(visad.georef.EarthLocation el)` Map an earth location to a visad box point
`java.util.List`	`earthToBox(java.util.List earthLocations)` Map the earth locations to box points
`visad.RealTuple`	`earthToBoxTuple(visad.georef.EarthLocation el)` Map an earth location to a visad box tuple
`int[]`	`earthToScreen(visad.georef.EarthLocation el)` Map earth to screen
`protected java.lang.Object[]`	`formatLevels(java.lang.Object[] levels)` Format the levels to make them look presentable
`protected TwoFacedObject`	`getLabeledReal(java.lang.Object level)` Get a labeled Real
`protected visad.Real`	`getLevelReal(java.lang.Object level)` Get the real value from a level object
`abstract NavigatedDisplay`	`getNavigatedDisplay()` We have this here so some of the utility methods can get the navigated display.
`double[]`	`getScreenCenter()` Return the x/y coordinate of the center of the display
`static NamedStationImpl`	`getSelectedStation(javax.swing.JComboBox box)` A utility to find and return the NamedStationImpl which is selected in the given combobox.
`java.lang.Object`	`getTmpProperty(java.lang.Object key)` Get the tmp property.
`static boolean`	`isLeftButtonDown(visad.DisplayEvent event)` Is the left button pressed
`static void`	`logException(java.lang.Exception exc)` Utility method for logging exceptions.
`static void`	`logException(java.lang.String desc, java.lang.Exception exc)` Utility method for logging exceptions with the given description.
`static visad.georef.EarthLocation`	`makeEarthLocation(double lat, double lon, double alt)` Make an earth location from the given lat,on and alt
`void`	`putTmpProperty(java.lang.Object key, java.lang.Object value)` put the tmp property.
`java.lang.Object`	`removeTmpProperty(java.lang.Object key)` remove the tmp property
`double[]`	`screenToBox(int screenX, int screenY)` Map the screen x/y to a visad box point
`double[]`	`screenToBox(int screenX, int screenY, double zPosition)` Map the screen x/y to a visad box point
`visad.georef.EarthLocation`	`screenToEarth(int screenX, int screenY)` Map screen position to earth location
`static void`	`setStations(java.util.List stationList, javax.swing.JComboBox box)` A utility that takes a list of NamedStationImpl-s, wraps each of them in a TwoFacedObject, truncates their label and adds them to the given combobox.
`static void`	`setStations(java.util.List stationList, javax.swing.JComboBox box, boolean addMessage)` A utility that takes a list of NamedStationImpl-s, wraps each of them in a TwoFacedObject, truncates their label and adds them to the given combobox.
`double[]`	`toBox(visad.DisplayEvent event)` Map the screen x/y to a visad box point
`visad.georef.EarthLocation`	`toEarth(visad.DisplayEvent event)` Map the screen x/y of the event to an earth location
`void`	`userErrorMessage(java.lang.String message)` A utility method to show an error message to the user.
`static void`	`userMessage(java.lang.String msg)` Utility method for creating user messages

Methods inherited from class ucar.unidata.collab.SharableImpl
applySharableProperties, doShare, doShare, doShareExternal, doShareInternal, getReceiveShareTime, getSharablePropertiesComponent, getShareGroup, getSharing, getUniqueId, initSharable, receiveShareData, removeSharable, setReceiveShareTime, setShareGroup, setSharing, setUniqueId, showSharableDialog

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - log_
```
public static LogUtil.LogCategory log_
```
    Use this member to log messages (through calls to LogUtil)
  - ICON_LOCK
```
protected static javax.swing.ImageIcon ICON_LOCK
```
    The icon used to show locked legend components
  - ICON_UNLOCK
```
protected static javax.swing.ImageIcon ICON_UNLOCK
```
    The icon used to show unlocked legend components
  - ICON_REMOVE
```
public static javax.swing.ImageIcon ICON_REMOVE
```
    Icon used to remove displays
  - PROP_REMOVED
```
public static final java.lang.String PROP_REMOVED
```
    Name of the property removed propert
    
    See Also:
    
    Constant Field Values
  - PREF_LEGENDLABEL_TEMPLATE
```
public static final java.lang.String PREF_LEGENDLABEL_TEMPLATE
```
    The preference id for the default label template for displays
    
    See Also:
    
    Constant Field Values
  - PREF_EXTRALABEL_TEMPLATE
```
public static final java.lang.String PREF_EXTRALABEL_TEMPLATE
```
    The preference id for the default extra label template for displays
    
    See Also:
    
    Constant Field Values
  - PREF_DISPLAYLIST_TEMPLATE
```
public static final java.lang.String PREF_DISPLAYLIST_TEMPLATE
```
    The preference id for the default label template for displays
    
    See Also:
    
    Constant Field Values
  - MACRO_SHORTNAME
```
public static final java.lang.String MACRO_SHORTNAME
```
    Macro for the short parameter name for the label
    
    See Also:
    
    Constant Field Values
  - MACRO_STATION
```
public static final java.lang.String MACRO_STATION
```
    Macro for station
    
    See Also:
    
    Constant Field Values
  - MACRO_RESOLUTION
```
public static final java.lang.String MACRO_RESOLUTION
```
    Macro for the resolution for the label
    
    See Also:
    
    Constant Field Values
  - MACRO_LONGNAME
```
public static final java.lang.String MACRO_LONGNAME
```
    Macro for the long parameter name for the label
    
    See Also:
    
    Constant Field Values
  - MACRO_VALUE
```
public static final java.lang.String MACRO_VALUE
```
    Macro for the short parameter name for the label
    
    See Also:
    
    Constant Field Values
  - MACRO_POSITION
```
public static final java.lang.String MACRO_POSITION
```
    Macro for the short parameter name for the label
    
    See Also:
    
    Constant Field Values
  - MACRO_DATASOURCENAME
```
public static final java.lang.String MACRO_DATASOURCENAME
```
    Macro for the data source name (or names) for the label
    
    See Also:
    
    Constant Field Values
  - MACRO_DISPLAYNAME
```
public static final java.lang.String MACRO_DISPLAYNAME
```
    Macro for the display name for the label
    
    See Also:
    
    Constant Field Values
  - MACRO_DISPLAYUNIT
```
public static final java.lang.String MACRO_DISPLAYUNIT
```
    Macro for the display unit for the label
    
    See Also:
    
    Constant Field Values
  - MACRO_TIMESTAMP
```
public static final java.lang.String MACRO_TIMESTAMP
```
    Macro for the display unit for the label
    
    See Also:
    
    Constant Field Values
  - MACRO_FHOUR
```
public static final java.lang.String MACRO_FHOUR
```
    forecast hour macro
    
    See Also:
    
    Constant Field Values
  - MACRO_FHOUR2
```
public static final java.lang.String MACRO_FHOUR2
```
    forecast hour macro without the 'H' -- user can format their own
    
    See Also:
    
    Constant Field Values
  - CMD_COLORS
```
public static final java.lang.String CMD_COLORS
```
    String used as the action command for the color setting button
    
    See Also:
    
    Constant Field Values
  - CMD_REMOVE
```
public static final java.lang.String CMD_REMOVE
```
    String used as the action command for removing this display control
    
    See Also:
    
    Constant Field Values
  - CMD_POPUP
```
public static final java.lang.String CMD_POPUP
```
    String used as the action command for showing the control window
    
    See Also:
    
    Constant Field Values
  - CMD_COLORTABLE
```
public static final java.lang.String CMD_COLORTABLE
```
    String used as the action command for setting the color table
    
    See Also:
    
    Constant Field Values
  - CMD_BARBSIZE
```
public static final java.lang.String CMD_BARBSIZE
```
    String used as the action command for setting the size of wind barbs
    
    See Also:
    
    Constant Field Values
  - CMD_INTERVAL
```
public static final java.lang.String CMD_INTERVAL
```
    String used as the action command for setting the wind barb interval
    
    See Also:
    
    Constant Field Values
  - CMD_LEVEL
```
public static final java.lang.String CMD_LEVEL
```
    String used as the action command for setting the level
    
    See Also:
    
    Constant Field Values
  - CMD_LINEWIDTH
```
public static final java.lang.String CMD_LINEWIDTH
```
    String used as the action command for setting the level
    
    See Also:
    
    Constant Field Values
  - WEIGHTED_AVERAGE
```
public static final java.lang.String WEIGHTED_AVERAGE
```
    String used to set the sampling to be weighted average
    
    See Also:
    
    Constant Field Values
  - NEAREST_NEIGHBOR
```
public static final java.lang.String NEAREST_NEIGHBOR
```
    String used the set the sampling to be nearest neighbor
    
    See Also:
    
    Constant Field Values
  - DEFAULT_SAMPLING_MODE
```
protected static java.lang.String DEFAULT_SAMPLING_MODE
```
    What is the default samppling mode
  - APPEARANCE_IDV
```
public static final java.lang.String APPEARANCE_IDV
```
    String used to set the appearance mode
    
    See Also:
    
    Constant Field Values
  - APPEARANCE_DARK
```
public static final java.lang.String APPEARANCE_DARK
```
    String used to set the appearance mode
    
    See Also:
    
    Constant Field Values
  - APPEARANCE_LIGHT
```
public static final java.lang.String APPEARANCE_LIGHT
```
    String used to set the appearance mode
    
    See Also:
    
    Constant Field Values
  - GRID_INSETS
```
protected static final java.awt.Insets GRID_INSETS
```
    Used for doing doLayout calls
  - SHARE_POSITION
```
public static final java.lang.String SHARE_POSITION
```
    Probe position property
    
    See Also:
    
    Constant Field Values
  - SHARE_TRANSECT
```
public static final java.lang.String SHARE_TRANSECT
```
    Transect Line position property
    
    See Also:
    
    Constant Field Values
  - SHARE_DISPLAYUNIT
```
public static final java.lang.String SHARE_DISPLAYUNIT
```
    Display unit property
    
    See Also:
    
    Constant Field Values
  - SHARE_VISIBILITY
```
public static final java.lang.String SHARE_VISIBILITY
```
    Visiblity property
    
    See Also:
    
    Constant Field Values
  - SHARE_COLORTABLE
```
public static final java.lang.String SHARE_COLORTABLE
```
    Color table property
    
    See Also:
    
    Constant Field Values
  - SHARE_COLORSCALE
```
public static final java.lang.String SHARE_COLORSCALE
```
    Color scale property
    
    See Also:
    
    Constant Field Values
  - SHARE_COLOR
```
public static final java.lang.String SHARE_COLOR
```
    Color property
    
    See Also:
    
    Constant Field Values
  - SHARE_SELECTRANGE
```
public static final java.lang.String SHARE_SELECTRANGE
```
    select range property
    
    See Also:
    
    Constant Field Values
  - SHARE_CHOICES
```
public static final java.lang.String SHARE_CHOICES
```
    data choices property
    
    See Also:
    
    Constant Field Values
  - SHARE_SKIPVALUE
```
public static final java.lang.String SHARE_SKIPVALUE
```
    Probe position property
    
    See Also:
    
    Constant Field Values
  - FLAG_CONTOUR
```
public static final int FLAG_CONTOUR
```
    Bitmask for controls that use contour interval information
    
    See Also:
    
    Constant Field Values
  - FLAG_COLOR
```
public static final int FLAG_COLOR
```
    Bitmask for controls that use colors
    
    See Also:
    
    Constant Field Values
  - FLAG_COLORTABLE
```
public static final int FLAG_COLORTABLE
```
    Bitmask for controls that use color tables
    
    See Also:
    
    Constant Field Values
  - FLAG_DATACONTROL
```
public static final int FLAG_DATACONTROL
```
    Bitmask for controls that have the "Set data" button capability enabled
    
    See Also:
    
    Constant Field Values
  - FLAG_DISPLAYUNIT
```
public static final int FLAG_DISPLAYUNIT
```
    Bitmask for controls that can change their display units
    
    See Also:
    
    Constant Field Values
  - FLAG_COLORUNIT
```
public static final int FLAG_COLORUNIT
```
    Bitmask for controls that can change their color units
    
    See Also:
    
    Constant Field Values
  - FLAG_ZPOSITION
```
public static final int FLAG_ZPOSITION
```
    Bitmask for controls that have a fixed z position
    
    See Also:
    
    Constant Field Values
  - FLAG_SELECTRANGE
```
public static final int FLAG_SELECTRANGE
```
    Bitmask for controls that allow selecting a data range
    
    See Also:
    
    Constant Field Values
  - FLAG_TIMERANGE
```
public static final int FLAG_TIMERANGE
```
    Bitmask for controls that allow selecting a time range
    
    See Also:
    
    Constant Field Values
  - FLAG_LINEWIDTH
```
public static final int FLAG_LINEWIDTH
```
    Bitmask for controls that allow line width setting
    
    See Also:
    
    Constant Field Values
  - FLAG_SKIPFACTOR
```
public static final int FLAG_SKIPFACTOR
```
    Bitmask for controls that allow skip factor setting
    
    See Also:
    
    Constant Field Values
  - FLAG_TEXTUREQUALITY
```
public static final int FLAG_TEXTUREQUALITY
```
    Bitmask for controls that allow texture quality setting
    
    See Also:
    
    Constant Field Values
  - FLAG_SMOOTHING
```
public static final int FLAG_SMOOTHING
```
    Bitmask for controls that allow grid smoothing setting
    
    See Also:
    
    Constant Field Values
  - FLAG_GRIDTRAJECTORY
```
public static final int FLAG_GRIDTRAJECTORY
```
    flag for the trackcontrol to add marker widget or not
    
    See Also:
    
    Constant Field Values
  - FLAG_NONE
```
public static final int FLAG_NONE
```
    No-op for attributeFlags
    
    See Also:
    
    Constant Field Values
  - DEFAULT_POINT_SIZE
```
public static final int DEFAULT_POINT_SIZE
```
    Default selector point size.
    
    See Also:
    
    Constant Field Values
  - LABEL_NONE
```
public static final java.lang.String LABEL_NONE
```
    A label for None
    
    See Also:
    
    Constant Field Values
  - FIND_THIS
```
public static final java.lang.String FIND_THIS
```
    search string for this
    
    See Also:
    
    Constant Field Values
  - FIND_ALL
```
public static final java.lang.String FIND_ALL
```
    search string for all
    
    See Also:
    
    Constant Field Values
  - FIND_CLASS
```
public static final java.lang.String FIND_CLASS
```
    search string for class:
    
    See Also:
    
    Constant Field Values
  - FIND_CATEGORY
```
public static final java.lang.String FIND_CATEGORY
```
    search string for category
    
    See Also:
    
    Constant Field Values
  - FIND_WITHDATA
```
public static final java.lang.String FIND_WITHDATA
```
    search string for displays with data
    
    See Also:
    
    Constant Field Values
  - FIND_WITHTHISDATA
```
public static final java.lang.String FIND_WITHTHISDATA
```
    search string for display like this with data
    
    See Also:
    
    Constant Field Values
  - FIND_WITHTHISFIELD
```
public static final java.lang.String FIND_WITHTHISFIELD
```
    search string for display with this data
    
    See Also:
    
    Constant Field Values
  - FIND_SPECIAL
```
public static final java.lang.String FIND_SPECIAL
```
    search string for special
    
    See Also:
    
    Constant Field Values
  - FIND_WITHTHISVIEW
```
public static final java.lang.String FIND_WITHTHISVIEW
```
    search string with displays in this view
    
    See Also:
    
    Constant Field Values
  - SETTINGS_GROUP_DISPLAY
```
public static final java.lang.String SETTINGS_GROUP_DISPLAY
```
    display group setting
    
    See Also:
    
    Constant Field Values
  - SETTINGS_GROUP_FLAGS
```
public static final java.lang.String SETTINGS_GROUP_FLAGS
```
    group flags
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - DisplayControlBase
```
public DisplayControlBase()
```
    ctor
- Method Detail
  - getTmpProperty
```
public java.lang.Object getTmpProperty(java.lang.Object key)
```
    Get the tmp property.
    
    Parameters:
    
    key - key
    
    Returns:
    
    property
  - putTmpProperty
```
public void putTmpProperty(java.lang.Object key,
                           java.lang.Object value)
```
    put the tmp property. These are not persisted off
    
    Parameters:
    
    key - key
    
    value - value
  - removeTmpProperty
```
public java.lang.Object removeTmpProperty(java.lang.Object key)
```
    remove the tmp property
    
    Parameters:
    
    key - key
    
    Returns:
    
    the value or null if not found
  - setStations
```
public static void setStations(java.util.List stationList,
                               javax.swing.JComboBox box)
```
    A utility that takes a list of NamedStationImpl-s, wraps each of them in a TwoFacedObject, truncates their label and adds them to the given combobox.
    
    Parameters:
    
    stationList - Station list
    
    box - Combo box to set
  - setStations
```
public static void setStations(java.util.List stationList,
                               javax.swing.JComboBox box,
                               boolean addMessage)
```
    A utility that takes a list of NamedStationImpl-s, wraps each of them in a TwoFacedObject, truncates their label and adds them to the given combobox.
    
    Parameters:
    
    stationList - Station list
    
    box - Combo box to set
    
    addMessage - true to add an entry message
  - createStationTfo
```
public static TwoFacedObject createStationTfo(java.lang.Object o)
```
    A utility to wrap the given object (which should be a NamedStationImpl) in a TwoFacedObject, truncating the label to a fixed size.
    
    Parameters:
    
    o - The station
    
    Returns:
    
    The tfo
  - getSelectedStation
```
public static NamedStationImpl getSelectedStation(javax.swing.JComboBox box)
```
    A utility to find and return the NamedStationImpl which is selected in the given combobox. May return null.
    
    Parameters:
    
    box - The box.
    
    Returns:
    
    The selected station or null.
  - isLeftButtonDown
```
public static boolean isLeftButtonDown(visad.DisplayEvent event)
```
    Is the left button pressed
    
    Parameters:
    
    event - The event
    
    Returns:
    
    Is the left button pressed
  - getNavigatedDisplay
```
public abstract NavigatedDisplay getNavigatedDisplay()
```
    We have this here so some of the utility methods can get the navigated display.
    
    Returns:
    
    The NavigatedDisplay this display control is in. My be null.
  - toEarth
```
public visad.georef.EarthLocation toEarth(visad.DisplayEvent event)
                                   throws visad.VisADException,
                                          java.rmi.RemoteException
```
    Map the screen x/y of the event to an earth location
    
    Parameters:
    
    event - The event
    
    Returns:
    
    The earth location
    
    Throws:
    
    java.rmi.RemoteException - When bad things happen
    
    visad.VisADException - When bad things happen
  - boxToEarth
```
public visad.georef.EarthLocation boxToEarth(double[] boxCoords)
                                      throws visad.VisADException,
                                             java.rmi.RemoteException
```
    Map the visad box to an earth location
    
    Parameters:
    
    boxCoords - The box point
    
    Returns:
    
    The earth location
    
    Throws:
    
    java.rmi.RemoteException - When bad things happen
    
    visad.VisADException - When bad things happen
  - boxToEarth
```
public visad.georef.EarthLocation boxToEarth(double[] boxCoords,
                                             boolean setZToZeroIfOverhead)
                                      throws visad.VisADException,
                                             java.rmi.RemoteException
```
    Map the visad box to an earth location
    
    Parameters:
    
    boxCoords - The box point
    
    setZToZeroIfOverhead - If in the overhead view then set Z to 0
    
    Returns:
    
    The earth location
    
    Throws:
    
    java.rmi.RemoteException - When bad things happen
    
    visad.VisADException - When bad things happen
  - boxToEarth
```
public visad.georef.EarthLocation boxToEarth(double x,
                                             double y,
                                             double z)
                                      throws visad.VisADException,
                                             java.rmi.RemoteException
```
    Map the visad box to an earth location
    
    Parameters:
    
    x - x
    
    y - y
    
    z - z
    
    Returns:
    
    The earth location
    
    Throws:
    
    java.rmi.RemoteException - When bad things happen
    
    visad.VisADException - When bad things happen
  - boxToEarth
```
public visad.georef.EarthLocation boxToEarth(double x,
                                             double y,
                                             double z,
                                             boolean setZToZeroIfOverhead)
                                      throws visad.VisADException,
                                             java.rmi.RemoteException
```
    Map the visad box to an earth location
    
    Parameters:
    
    x - x
    
    y - y
    
    z - z
    
    setZToZeroIfOverhead - If in the overhead view then set Z to 0
    
    Returns:
    
    The earth location
    
    Throws:
    
    java.rmi.RemoteException - When bad things happen
    
    visad.VisADException - When bad things happen
  - boxToEarth
```
public java.util.List boxToEarth(java.util.List boxPoints)
                          throws visad.VisADException,
                                 java.rmi.RemoteException
```
    Map the visad box points to earth locations
    
    Parameters:
    
    boxPoints - The box points
    
    Returns:
    
    The earth locations
    
    Throws:
    
    java.rmi.RemoteException - When bad things happen
    
    visad.VisADException - When bad things happen
  - earthToBox
```
public java.util.List earthToBox(java.util.List earthLocations)
                          throws visad.VisADException,
                                 java.rmi.RemoteException
```
    Map the earth locations to box points
    
    Parameters:
    
    earthLocations - list of earth locations
    
    Returns:
    
    The box points
    
    Throws:
    
    java.rmi.RemoteException - When bad things happen
    
    visad.VisADException - When bad things happen
  - earthToBox
```
public double[] earthToBox(visad.georef.EarthLocation el)
                    throws visad.VisADException,
                           java.rmi.RemoteException
```
    Map an earth location to a visad box point
    
    Parameters:
    
    el - The earth location
    
    Returns:
    
    The box point
    
    Throws:
    
    java.rmi.RemoteException - When bad things happen
    
    visad.VisADException - When bad things happen
  - earthToBoxTuple
```
public visad.RealTuple earthToBoxTuple(visad.georef.EarthLocation el)
                                throws visad.VisADException,
                                       java.rmi.RemoteException
```
    Map an earth location to a visad box tuple
    
    Parameters:
    
    el - The earth location
    
    Returns:
    
    The tuple
    
    Throws:
    
    java.rmi.RemoteException - When bad things happen
    
    visad.VisADException - When bad things happen
  - makeEarthLocation
```
public static visad.georef.EarthLocation makeEarthLocation(double lat,
                                                           double lon,
                                                           double alt)
                                                    throws visad.VisADException,
                                                           java.rmi.RemoteException
```
    Make an earth location from the given lat,on and alt
    
    Parameters:
    
    lat - the lat
    
    lon - the lon
    
    alt - the alt
    
    Returns:
    
    The earth location
    
    Throws:
    
    java.rmi.RemoteException - On badness
    
    visad.VisADException - On badness
  - toBox
```
public double[] toBox(visad.DisplayEvent event)
               throws visad.VisADException,
                      java.rmi.RemoteException
```
    Map the screen x/y to a visad box point
    
    Parameters:
    
    event - The event
    
    Returns:
    
    The box point
    
    Throws:
    
    java.rmi.RemoteException - When bad things happen
    
    visad.VisADException - When bad things happen
  - screenToBox
```
public double[] screenToBox(int screenX,
                            int screenY)
                     throws visad.VisADException,
                            java.rmi.RemoteException
```
    Map the screen x/y to a visad box point
    
    Parameters:
    
    screenX - x
    
    screenY - y
    
    Returns:
    
    The box point
    
    Throws:
    
    java.rmi.RemoteException - When bad things happen
    
    visad.VisADException - When bad things happen
  - screenToBox
```
public double[] screenToBox(int screenX,
                            int screenY,
                            double zPosition)
                     throws visad.VisADException,
                            java.rmi.RemoteException
```
    Map the screen x/y to a visad box point
    
    Parameters:
    
    screenX - screen x
    
    screenY - screen y
    
    zPosition - The visad Z position to use
    
    Returns:
    
    The box point
    
    Throws:
    
    java.rmi.RemoteException - When bad things happen
    
    visad.VisADException - When bad things happen
  - getScreenCenter
```
public double[] getScreenCenter()
                         throws visad.VisADException,
                                java.rmi.RemoteException
```
    Return the x/y coordinate of the center of the display
    
    Returns:
    
    The box point
    
    Throws:
    
    java.rmi.RemoteException - When bad things happen
    
    visad.VisADException - When bad things happen
  - boxToScreen
```
public int[] boxToScreen(double[] xyz)
                  throws visad.VisADException,
                         java.rmi.RemoteException
```
    Map a visad box point to the screen coords.
    
    Parameters:
    
    xyz - Visad box point
    
    Returns:
    
    Screen coords
    
    Throws:
    
    java.rmi.RemoteException - When bad things happen
    
    visad.VisADException - When bad things happen
  - screenToEarth
```
public visad.georef.EarthLocation screenToEarth(int screenX,
                                                int screenY)
                                         throws visad.VisADException,
                                                java.rmi.RemoteException
```
    Map screen position to earth location
    
    Parameters:
    
    screenX - x
    
    screenY - y
    
    Returns:
    
    The earth location
    
    Throws:
    
    java.rmi.RemoteException - When bad things happen
    
    visad.VisADException - When bad things happen
  - earthToScreen
```
public int[] earthToScreen(visad.georef.EarthLocation el)
                    throws visad.VisADException,
                           java.rmi.RemoteException
```
    Map earth to screen
    
    Parameters:
    
    el - Earth location
    
    Returns:
    
    Screen xy
    
    Throws:
    
    java.rmi.RemoteException - When bad things happen
    
    visad.VisADException - When bad things happen
  - calculateRectangle
```
protected java.awt.geom.Rectangle2D calculateRectangle()
```
    Calculates the rectangle that is the bounds of the VisAD display.
    
    Returns:
    
    bounds of the display
  - userMessage
```
public static void userMessage(java.lang.String msg)
```
    Utility method for creating user messages
    
    Parameters:
    
    msg - message to display
  - userErrorMessage
```
public void userErrorMessage(java.lang.String message)
```
    A utility method to show an error message to the user.
    
    Parameters:
    
    message - The message
  - logException
```
public static void logException(java.lang.Exception exc)
```
    Utility method for logging exceptions.
    
    Parameters:
    
    exc - Exception to handle
  - logException
```
public static void logException(java.lang.String desc,
                                java.lang.Exception exc)
```
    Utility method for logging exceptions with the given description. This is just a wrapper around the LogUtil call printException.
    
    Parameters:
    
    desc - description for exception
    
    exc - Exception to handle
  - formatLevels
```
protected java.lang.Object[] formatLevels(java.lang.Object[] levels)
```
    Format the levels to make them look presentable
    
    Parameters:
    
    levels - array of levels
    
    Returns:
    
    formatted levels. Currently an array of TwoFacedObjects with formatted values as the label.
  - getLabeledReal
```
protected TwoFacedObject getLabeledReal(java.lang.Object level)
```
    Get a labeled Real
    
    Parameters:
    
    level - the level object
    
    Returns:
    
    a labeled level as a TwoFacedObject
  - getLevelReal
```
protected visad.Real getLevelReal(java.lang.Object level)
```
    Get the real value from a level object
    
    Parameters:
    
    level - the level (TwoFacedObject, Real or number String);
    
    Returns:
    
    a corresponding Real or null

Class DisplayControlBase

Field Summary

Constructor Summary

Method Summary

Methods inherited from class ucar.unidata.collab.SharableImpl

Methods inherited from class java.lang.Object

Field Detail

log_

ICON_LOCK

ICON_UNLOCK

ICON_REMOVE

PROP_REMOVED

PREF_LEGENDLABEL_TEMPLATE

PREF_EXTRALABEL_TEMPLATE

PREF_DISPLAYLIST_TEMPLATE

MACRO_SHORTNAME

MACRO_STATION

MACRO_RESOLUTION

MACRO_LONGNAME

MACRO_VALUE

MACRO_POSITION

MACRO_DATASOURCENAME

MACRO_DISPLAYNAME

MACRO_DISPLAYUNIT

MACRO_TIMESTAMP

MACRO_FHOUR

MACRO_FHOUR2

CMD_COLORS

CMD_REMOVE

CMD_POPUP

CMD_COLORTABLE

CMD_BARBSIZE

CMD_INTERVAL

CMD_LEVEL

CMD_LINEWIDTH

WEIGHTED_AVERAGE

NEAREST_NEIGHBOR

DEFAULT_SAMPLING_MODE

APPEARANCE_IDV

APPEARANCE_DARK

APPEARANCE_LIGHT

GRID_INSETS

SHARE_POSITION

SHARE_TRANSECT

SHARE_DISPLAYUNIT

SHARE_VISIBILITY

SHARE_COLORTABLE

SHARE_COLORSCALE

SHARE_COLOR

SHARE_SELECTRANGE

SHARE_CHOICES

SHARE_SKIPVALUE

FLAG_CONTOUR

FLAG_COLOR

FLAG_COLORTABLE

FLAG_DATACONTROL

FLAG_DISPLAYUNIT

FLAG_COLORUNIT

FLAG_ZPOSITION

FLAG_SELECTRANGE

FLAG_TIMERANGE

FLAG_LINEWIDTH

FLAG_SKIPFACTOR

FLAG_TEXTUREQUALITY

FLAG_SMOOTHING

FLAG_GRIDTRAJECTORY

FLAG_NONE

DEFAULT_POINT_SIZE

LABEL_NONE

FIND_THIS

FIND_ALL

FIND_CLASS

FIND_CATEGORY

FIND_WITHDATA

FIND_WITHTHISDATA

FIND_WITHTHISFIELD

FIND_SPECIAL

FIND_WITHTHISVIEW

SETTINGS_GROUP_DISPLAY

SETTINGS_GROUP_FLAGS