ucar.unidata.idv.control
Class RadarGridControl

java.lang.Object
  ucar.unidata.collab.SharableImpl
      ucar.unidata.idv.control.DisplayControlBase
          ucar.unidata.idv.control.DisplayControlImpl
              ucar.unidata.idv.control.RadarGridControl

All Implemented Interfaces:

ActionListener, ItemListener, PropertyChangeListener, EventListener, HyperlinkListener, Sharable, DataChangeListener, DisplayControl, Prototypable, ControlListener, DisplayListener

public class RadarGridControl
extends DisplayControlImpl
implements ActionListener

Display control for a "RadarGrid," radar range-rings plus radial lines.

Version:

$Revision: 1.103 $

Nested Class Summary

Nested classes/interfaces inherited from class ucar.unidata.idv.control.DisplayControlImpl

DisplayControlImpl.SideLegendLabel

Field Summary

Fields inherited from class ucar.unidata.idv.control.DisplayControlImpl

categories, colorScaleInfo, colorScales, contourInfo, contourInfoParams, controlContext, ctw, cw, dataSelection, defaultView, defaultViewManager, DISPLAY_LIST_NAME, displayListTable, displayMasters, displayUnit, helpUrl, initNoteText, instantiatedWithNoData, noteTextArea, noteWrapper, paramName, requestProperties, settingVisibility, sharables, showNoteText, skipSlider, srw, version, viewManagers

Fields inherited from class ucar.unidata.idv.control.DisplayControlBase

CMD_BARBSIZE, CMD_COLORS, CMD_COLORTABLE, CMD_INTERVAL, CMD_LEVEL, CMD_LINEWIDTH, CMD_POPUP, CMD_REMOVE, DEFAULT_POINT_SIZE, DEFAULT_SAMPLING_MODE, FIND_ALL, FIND_CATEGORY, FIND_CLASS, FIND_SPECIAL, FIND_THIS, FIND_WITHDATA, FIND_WITHTHISDATA, FIND_WITHTHISFIELD, FIND_WITHTHISVIEW, FLAG_COLOR, FLAG_COLORTABLE, FLAG_COLORUNIT, FLAG_CONTOUR, FLAG_DATACONTROL, FLAG_DISPLAYUNIT, FLAG_LINEWIDTH, FLAG_NONE, FLAG_SELECTRANGE, FLAG_SKIPFACTOR, FLAG_TIMERANGE, FLAG_ZPOSITION, GRID_INSETS, ICON_LOCK, ICON_REMOVE, ICON_UNLOCK, LABEL_NONE, log_, MACRO_DATASOURCENAME, MACRO_DISPLAYNAME, MACRO_DISPLAYUNIT, MACRO_FHOUR, MACRO_LONGNAME, MACRO_POSITION, MACRO_SHORTNAME, MACRO_TIMESTAMP, MACRO_VALUE, NEAREST_NEIGHBOR, PREF_DISPLAYLIST_TEMPLATE, PREF_EXTRALABEL_TEMPLATE, PREF_LEGENDLABEL_TEMPLATE, PROP_REMOVED, SETTINGS_GROUP_DISPLAY, SETTINGS_GROUP_FLAGS, SHARE_CHOICES, SHARE_COLOR, SHARE_COLORSCALE, SHARE_COLORTABLE, SHARE_DISPLAYUNIT, SHARE_POSITION, SHARE_SELECTRANGE, SHARE_SKIPVALUE, SHARE_TRANSECT, SHARE_VISIBILITY, WEIGHTED_AVERAGE

Fields inherited from interface ucar.unidata.idv.DisplayControl

BOTTOM_LEGEND, DEFAULT_PROBEFORMAT, PREF_PREFIX, PREF_PROBEFORMAT, PREF_REMOVEONWINDOWCLOSE, PREF_SAMPLING_MODE, PREF_STANDALONE_REMOVEONCLOSE, PREF_STANDALONE_REMOVEONCLOSE_ASK, PROP_LEGENDICON, RASTERMODE_SHOWALL, RASTERMODE_SHOWNONRASTER, RASTERMODE_SHOWRASTER, SIDE_LEGEND

Constructor Summary

RadarGridControl()
Default constructor; does nothing.

Method Summary

void	actionPerformed(ActionEvent event) Deal with action events from the controls made by this class.
Container	doMakeContents() Make the panel of controls in a vertical box.
void	doRemove() Remove the display control
protected void	getEditMenuItems(List items, boolean forMenuBar) Add the relevant edit menu items into the list
Font	getLabelFont() Get the LabelFont property.
double	getLat() Get the latitude (degrees) of the center point.
Color	getLblColor() Get the color of the labels.
double	getLblSpacing() Get the spacing of the labels.
boolean	getLblVisible() Get whether distance labels are visible.
int	getLblWidth() Get the width of the labels.
void	getLegendLabels(List labels, int legendType) Get the extra label used for the legend.
double	getLon() Get the longitude (degrees) of the center point.
double	getMaxRadius() Get the maximum radius value for the range rings.
RadarGrid	getRadarGrid() Return the RadarGrid displayable
Color	getRadColor() Get the color of the radials.
double	getRadSpacing() Get the spacing of the radials.
boolean	getRadVisible() Get whether radii are visible.
int	getRadWidth() Get the width of the radial lines.
Color	getRrColor() Get the color of the range rings.
double	getRrSpacing() Get the spacing of the range rings.
boolean	getRrVisible() Get whether range rings are visible.
int	getRrWidth() Get the width of the range rings.
int	getStationIdx() Get the station index in the list.
String	getStationTableName() Get the StationTableName property.
void	handleDisplayChanged(DisplayEvent event) Listen for DisplayEvents
boolean	init(DataChoice dataChoice) Called to make this kind of Display Control; also makes the Displayable.
protected boolean	setData(LatLonPoint llp) reposition center of radar grid.
void	setDisplayVisibility(boolean on) Override base class method (used for legend bar clicks) so we can control the visiblity of the three items - rings, radials, labels - according to user-clicked gui items
void	setInitStationLocation(String l) For setting the property when this object is created
void	setLabelFont(Font value) Set the LabelFont property.
void	setLat(double value) Set the latitude (degrees) of the center point.
void	setLblColor(Color value) Set the color of the labels.
void	setLblSpacing(double value) Set the spacing of the labels.
void	setLblVisible(boolean value) Set whether distance labels are visible.
void	setLblWidth(int width) Set the width of the labels.
void	setLon(double value) Set the longitude (degrees) of the center point.
void	setMaxRadius(double value) Set the maximum radius value for the range rings.
void	setRadColor(Color value) Set the color of the radials.
void	setRadSpacing(double value) Set the spacing of the radials.
void	setRadVisible(boolean value) Set whether radii are visible.
void	setRadWidth(int width) Set the width of the radial lines.
void	setRrColor(Color value) Set the color of the range rings.
void	setRrSpacing(double value) Set the spacing of the range rings.
void	setRrVisible(boolean value) Set whether range rings are visible.
void	setRrWidth(int width) Set the width of the range rings.
void	setStationIdx(int idx) Set the station index in the list.
void	setStationTableName(String value) Set the StationTableName property.
void	setVerticalValue(double value) Deprecated. Keep this around for legacy bundles.
protected boolean	shouldAddDisplayListener() Signal base class to add this as a display listener

Methods inherited from class ucar.unidata.idv.control.DisplayControlImpl

activateDisplays, addAttributedDisplayable, addAttributedDisplayable, addAttributedDisplayable, addAttributeFlags, addCheckBoxSettings, addDataChoice, addDisplayable, addDisplayable, addDisplayable, addDisplayable, addDisplayable, addDisplayable, addDisplayMaster, addDisplaySettings, addLabelMacros, addNewData, addNoteText, addPropertiesComponents, addPropertyChangeListener, addSharable, addTimeModeWidget, addToControlContext, addToRangeMenu, addToRangeMenu, addToRangeMenu, addViewManager, appendDataChoices, applyAttributesToDisplayables, applyColor, applyColorScaleInfo, applyColorTable, applyColorUnit, applyContourInfo, applyDisplaySetting, applyDisplayUnit, applyLineWidth, applyPreferences, applyProperties, applyProperties, applyPropertyValues, applyRange, applySelectRange, applySkipFactor, applyTimeRange, applyZPosition, boundsClose, canBeDocked, canExportData, canSaveDataInCache, captureWindow, changeColorUnit, changeDisplayUnit, checkFlag, checkIfDataOk, checkImageSize, clearDataInstance, clearPrototype, clearViewManagers, close, colorUnitChanged, controlChanged, convertColorRange, convertRange, createDisplayListDisplayable, createIdvWindow, dataChanged, deactivateDisplays, debug, displayableToFront, displayChanged, displayControlFailed, displayUnitChanged, doApplyProperties, doMakeBottomLegendComponent, doMakeChangeColorMenu, doMakeChangeColorMenu, doMakeChangeParameterMenuItem, doMakeColorControl, doMakeColorControl, doMakeColorScales, doMakeDataInstance, doMakeMenuBar, doMakeMenuBarMenus, doMakeRemoveControl, doMakeSideLegendComponent, doMakeSkipFactorSlider, doMakeVisibilityControl, doMakeWidgetComponent, doMakeWindow, doMakeZPositionSlider, exportDisplayedData, findDisplayInfo, findDisplays, findDisplays, firePropertyChangeEvent, firstFrameDone, formatForCursorReadout, getActive, getAnimation, getAnimation, getAnimation, getAnimation, getAnimationInfo, getAnimationWidget, getAttributeFlags, getCachedData, getCanDoRemoveAll, getCategories, getChangeParameterLabel, getCollapseLegend, getColor, getColorDimness, getColorScaleInfo, getColorTable, getColorTableForDisplayable, getColorTableToApply, getColorTableWidget, getColorUnit, getColorUnitName, getColorWidgetLabel, getComponentHolder, getContents, getContourInfo, getControlChangeSleepTime, getControlContext, getControlWidgets, getCursorReadout, getCursorReadoutInner, getDataChoice, getDataChoices, getDataForDisplayList, getDataInstance, getDataInstance, getDataProjection, getDataProjectionForMenu, getDataProjectionLabel, getDataSelection, getDataSources, getDataTimeRange, getDataTimeRange, getDataTimeSet, getDebugDetails, getDefaultColorScaleInfo, getDefaultDistanceUnit, getDefaultFastRendering, getDefaultSamplingMode, getDefaultSamplingModeValue, getDefaultView, getDefaultViewDescriptor, getDefaultViewManager, getDetailsContents, getDisplayAltitudeType, getDisplayCategory, getDisplayCenter, getDisplayConventions, getDisplayedData, getDisplayId, getDisplayInfos, getDisplayListColor, getDisplayListData, getDisplayListDisplayable, getDisplayListTemplate, getDisplayMaster, getDisplayName, getDisplayScale, getDisplayUnit, getDisplayUnit, getDisplayUnitName, getDisplayVisibility, getDoCursorReadout, getEditMenuItems, getExpandedInTabs, getExtraLabelTemplate, getExtraLegendComponent, getExtraMenus, getFileMenuItems, getFileMenuItems, getGraphicsConfiguration, getHadDataChoices, getHaveInitialized, getHelpIds, getHelpMenuItems, getId, getIdv, getImage, getImage, getInitDataChoices, getInitialColorTable, getInitialRange, getInitialZPosition, getIsRaster, getLabel, getLastFileMenuItems, getLegendButtons, getLegendComponent, getLegendLabel, getLegendLabelTemplate, getLegendToolTip, getLineWidth, getLineWidthWidget, getLineWidthWidgetLabel, getLockVisibilityToggle, getLongParamName, getMacroNames, getMainPanel, getMainPanelSize, getMakeWindow, getMapDisplay, getMapViewManager, getMapViewProjection, getMenuLabel, getMyDataChoices, getNavigatedDisplay, getNoteText, getObjectStore, getOkToFireEvents, getOldColorTableOrInitialColorTable, getOriginalDataChoicesLabel, getOuterContents, getProperty, getProperty, getPropertyDisplayName, getRange, getRangeForColorTable, getRangeToApply, getRawDataUnit, getRequestProperties, getSamplingModeName, getSamplingModeValue, getSamplingModeValue, getSaveMenuItems, getSelectRange, getSelectRangeEnabled, getSelectRangeWidget, getSettingsPanel, getShortParamName, getShowInDisplayList, getShowInLegend, getShowInTabs, getShowNoteText, getSkipValue, getSkipWidgetLabel, getStore, getTemplateName, getTimeSet, getTitle, getTransientProperty, getUnitForColor, getUseFastRendering, getUseTimesInAnimation, getVersion, getVerticalValue, getViewContext, getViewer, getViewManager, getViewManager, getViewManager, getViewManagerClassNames, getViewManagers, getViewMenuItems, getViewMenuItems, getWasUnPersisted, getWindow, getWindowSize, getWindowVisible, getWindowX, getWindowY, getZPosition, getZPositionSliderLabel, guiExported, guiImported, handleWindowClosing, hasMapProjection, hasTimeMacro, haveDataTimes, haveParameterDefaults, hide, hyperlinkUpdate, init, init, init, initAfterUnPersistence, initAfterUnPersistence, initAsPrototype, initAsTemplate, initBasic, initDone, initializeWithNewData, initWindow, isDisplay3D, isDisplayUnitAlsoColorUnit, isGuiShown, isInitDone, isInTransectView, isInViewManager, itemStateChanged, makeChangeColorMenuItems, makeLegendLabel, makeLockButton, makeRemoveButton, moveTo, notifyViewManagersOfChange, parseProperties, popup, popupDataDialog, popupDataDialog, popupDataDialog, processRequestProperties, projectionChanged, propertyChange, putTransientProperty, receiveShareData, redoGuiLayout, reloadDataSource, reloadDataSourceInThread, removeDataChoice, removeDisplayable, removeDisplayables, removeOnWindowClose, removePropertyChangeListener, resetData, resetDimness, resetViewManager, revertToDefaultColorTable, revertToDefaultColorTable, revertToDefaultRange, revertToDefaultRange, saveAsFavorite, saveAsParameterDefaults, saveAsPrototype, saveAsTemplate, saveDataChoiceInCache, saveImage, selectDataChoices, setAnimationInfo, setAnimationSet, setAttributeFlags, setCachedData, setCanDoRemoveAll, setCategories, setCollapseLegend, setColor, setColorBrighter, setColorDimmer, setColorDimness, setColorScaleInfo, setColorScaleVisible, setColorTable, setColorTable, setColorTableName, setColorUnit, setColorUnitName, setComponentHolder, setContents, setContourInfo, setContourInfoParams, setData, setData, setDataChoices, setDataInstance, setDataInstances, setDataSelection, setDataTimeRange, setDefaultSamplingMode, setDefaultView, setDisplayableVisibility, setDisplayableVisiblity, setDisplayActive, setDisplayCategory, setDisplayId, setDisplayInactive, setDisplayListColor, setDisplayListColor, setDisplayListProperties, setDisplayListTemplate, setDisplayName, setDisplayUnit, setDisplayUnitName, setDoCursorReadout, setExpandedInTabs, setExtraLabelTemplate, setHadDataChoices, setHelpUrl, setId, setInitDataChoices, setInitialSettings, setIsRaster, setLabelAsPreference, setLegendBackground, setLegendForeground, setLegendLabel, setLegendLabelTemplate, setLineWidth, setLockVisibilityToggle, setMainPanelDimensions, setMainPanelSize, setMakeWindow, setName, setNameFromUser, setNewColorUnit, setNewDisplayUnit, setNoteText, setOkToFireEvents, setOriginalDataChoicesLabel, setParamName, setPersistedVisadData, setProjectionInView, setProjectionInView, setProperty, setRange, setRange, setSelectRange, setSelectRangeEnabled, setSettingsDisplayUnit, setSharedColorScaleInfo, setShowInDisplayList, setShowInLegend, setShowInTabs, setShowNoteText, setSkipValue, setTemplateName, setTitle, setUnitForColor, setUseFastRendering, setUseTimesInAnimation, setVersion, setViewer, setViewManagerClassNames, setWindowSize, setWindowVisible, setWindowX, setWindowY, setZPosition, setZPosition, shouldAddAnimationListener, shouldAddControlListener, shouldApplyFastRendering, shouldBeDocked, shouldWindowBeVisible, show, showColorControlWidget, showColorDialog, showColorDialog, showColorScaleDialog, showColorScales, showColorSwatches, showContourPropertiesDialog, showDetails, showDisplaySettingsDialog, showHelp, showLegendMenu, showNormalCursor, showProperties, showTimeRangeDialog, showWaitCursor, timeChanged, toFront, toggleNoteTextArea, toggleVisibilityForVectorGraphicsRendering, toggleWindow, toString, transectChanged, updateAnimation, updateDisplayList, updateLegendAndList, updateLegendLabel, updateLockButton, useZPosition, viewManagerChanged, viewManagerDestroyed, viewpointChanged, writeTestArchive, xxxsetDisplayActive, zSliderChanged

Methods inherited from class ucar.unidata.idv.control.DisplayControlBase

boxToEarth, boxToEarth, boxToEarth, boxToEarth, boxToEarth, boxToScreen, calculateRectangle, createStationTfo, earthToBox, earthToBox, earthToBoxTuple, earthToScreen, formatLevels, getLabeledReal, getLevelReal, getScreenCenter, getSelectedStation, getTmpProperty, isLeftButtonDown, logException, logException, makeEarthLocation, putTmpProperty, removeTmpProperty, screenToBox, screenToBox, screenToEarth, setStations, setStations, toBox, toEarth, userErrorMessage, userMessage

Methods inherited from class ucar.unidata.collab.SharableImpl

applySharableProperties, doShare, doShare, doShareExternal, doShareInternal, getSharablePropertiesComponent, getShareGroup, getSharing, getUniqueId, initSharable, removeSharable, setShareGroup, setSharing, setUniqueId, showSharableDialog

Methods inherited from class java.lang.Object

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

Methods inherited from interface ucar.unidata.idv.DisplayControl

getTmpProperty, putTmpProperty, removeTmpProperty

Methods inherited from interface ucar.unidata.collab.Sharable

getShareGroup, getSharing, getUniqueId

Constructor Detail

RadarGridControl

public RadarGridControl()

Default constructor; does nothing. See init() for creation actions. Need to have a parameter-less constructor for the reflection-based object creation in the IDV to call.

Method Detail

init

public boolean init(DataChoice dataChoice)
             throws VisADException,
                    RemoteException

Called to make this kind of Display Control; also makes the Displayable. This method is called from inside DisplayControlImpl.init(several args). If the DataChoice arg is null, a default location is used.

Overrides:

init in class DisplayControlImpl

Parameters:

dataChoice - the DataChoice of the moment; may be null.

Returns:

true if successful

Throws:

RemoteException - Java RMI error

VisADException - VisAD Error

shouldAddDisplayListener

protected boolean shouldAddDisplayListener()

Signal base class to add this as a display listener

Overrides:

shouldAddDisplayListener in class DisplayControlImpl

Returns:

Add as display listener

doRemove

public void doRemove()
              throws VisADException,
                     RemoteException

Remove the display control

Specified by:

doRemove in interface DisplayControl

Overrides:

doRemove in class DisplayControlImpl

Throws:

RemoteException - Badness

VisADException - Badness

setData

protected boolean setData(LatLonPoint llp)
                   throws VisADException,
                          RemoteException

reposition center of radar grid.

Parameters:

llp - new center point

Returns:

true if okay

Throws:

RemoteException - Java RMI error

VisADException - VisAD Error

getRadarGrid

public RadarGrid getRadarGrid()

Return the RadarGrid displayable

Returns:

the RadarGrid displayable

getEditMenuItems

protected void getEditMenuItems(List items,
                                boolean forMenuBar)

Add the relevant edit menu items into the list

Overrides:

getEditMenuItems in class DisplayControlImpl

Parameters:

items - List of menu items

forMenuBar - Is this for the menu in the window's menu bar or for a popup menu in the legend

doMakeContents

public Container doMakeContents()

Make the panel of controls in a vertical box.

Overrides:

doMakeContents in class DisplayControlImpl

Returns:

Container that holds the widgets for this control

setDisplayVisibility

public void setDisplayVisibility(boolean on)

Override base class method (used for legend bar clicks) so we can control the visiblity of the three items - rings, radials, labels - according to user-clicked gui items

Specified by:

setDisplayVisibility in interface DisplayControl

Overrides:

setDisplayVisibility in class DisplayControlImpl

Parameters:

on - true to display

getLegendLabels

public void getLegendLabels(List labels,
                            int legendType)

Get the extra label used for the legend.

Overrides:

getLegendLabels in class DisplayControlImpl

Parameters:

labels - labels for legend

legendType - The type of legend, BOTTOM_LEGEND or SIDE_LEGEND

actionPerformed

public void actionPerformed(ActionEvent event)

Deal with action events from the controls made by this class.

Specified by:

actionPerformed in interface ActionListener

Overrides:

actionPerformed in class DisplayControlImpl

Parameters:

event - event to check

handleDisplayChanged

public void handleDisplayChanged(DisplayEvent event)

Listen for DisplayEvents

Overrides:

handleDisplayChanged in class DisplayControlImpl

Parameters:

event - The event

setRadColor

public void setRadColor(Color value)

Set the color of the radials. (used by persistence)

Parameters:

value - Color of radials

getRadColor

public Color getRadColor()

Get the color of the radials. (used by persistence)

Returns:

Color of radials

setRrColor

public void setRrColor(Color value)

Set the color of the range rings. (used by persistence)

Parameters:

value - Color of range rings

getRrColor

public Color getRrColor()

Get the color of the range rings. (used by persistence)

Returns:

Color of range rings

setLblColor

public void setLblColor(Color value)

Set the color of the labels. (used by persistence)

Parameters:

value - Color of labels

getLblColor

public Color getLblColor()

Get the color of the labels. (used by persistence)

Returns:

Color of labels

setRrSpacing

public void setRrSpacing(double value)

Set the spacing of the range rings. (used by persistence)

Parameters:

value - spacing (km)

getRrSpacing

public double getRrSpacing()

Get the spacing of the range rings. (used by persistence)

Returns:

spacing (km)

setLblSpacing

public void setLblSpacing(double value)

Set the spacing of the labels. (used by persistence)

Parameters:

value - spacing (degrees)

getLblSpacing

public double getLblSpacing()

Get the spacing of the labels. (used by persistence)

Returns:

spacing (degrees)

setRadSpacing

public void setRadSpacing(double value)

Set the spacing of the radials. (used by persistence)

Parameters:

value - spacing (degrees)

getRadSpacing

public double getRadSpacing()

Get the spacing of the radials. (used by persistence)

Returns:

spacing (degrees)

setRrVisible

public void setRrVisible(boolean value)

Set whether range rings are visible. (used by persistence)

Parameters:

value - true if visible

getRrVisible

public boolean getRrVisible()

Get whether range rings are visible. (used by persistence)

Returns:

true if visible

setLblVisible

public void setLblVisible(boolean value)

Set whether distance labels are visible. (used by persistence)

Parameters:

value - true if visible

getLblVisible

public boolean getLblVisible()

Get whether distance labels are visible. (used by persistence)

Returns:

true if visible

setRadVisible

public void setRadVisible(boolean value)

Set whether radii are visible. (used by persistence)

Parameters:

value - true if visible

getRadVisible

pu