ucar.unidata.idv.control
Class ProbeControl

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

All Implemented Interfaces:

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

public class ProbeControl
extends DisplayControlImpl
implements DisplayableData.DragAdapter

A widget to display data values at one point in the 2d or 3d data field. Can show several parameters' values at the point. Can choose method of field sampling - nearest grid point value or weighted average. Can change levels.

Version:

$Revision: 1.203 $

Author:

Unidata IDV developers

Nested Class Summary

class	ProbeControl.LevelEditor Class LevelEditor, used for selecting levels in table column
class	ProbeControl.SamplingEditor If user clicks on the "sampling" column, a popup menu appears with choices for the grid value sampling method.

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

DisplayControlImpl.SideLegendLabel

Field Summary

static int	COL_EXTRA Column value property
static int	COL_LEVEL Column level property
static int	COL_NAME Column name property
static int	COL_SAMPLING Column sampling property
static int	COL_VALUE Column value property
static int	NUM_COLS number of columns
static String	SHARE_CHOICES ID for sharing choices
static String	SHARE_LEVELS ID for sharing levels
static String	SHARE_METHODS ID for sharing sampling methods
static String	SHARE_POSITION ID for sharing position

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

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

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_SMOOTHING, FLAG_TEXTUREQUALITY, 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_STATION, MACRO_TIMESTAMP, MACRO_VALUE, NEAREST_NEIGHBOR, PREF_DISPLAYLIST_TEMPLATE, PREF_EXTRALABEL_TEMPLATE, PREF_LEGENDLABEL_TEMPLATE, PROP_REMOVED, SETTINGS_GROUP_DISPLAY, SETTINGS_GROUP_FLAGS, SHARE_COLOR, SHARE_COLORSCALE, SHARE_COLORTABLE, SHARE_DISPLAYUNIT, SHARE_SELECTRANGE, SHARE_SKIPVALUE, SHARE_TRANSECT, SHARE_VISIBILITY, WEIGHTED_AVERAGE

Fields inherited from interface ucar.unidata.idv.DisplayControl

BOTTOM_LEGEND, DEFAULT_PROBEFORMAT, DOTIMEDRIVER, 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

ProbeControl()
Cstr; sets flags; see init() for creation actions.

Method Summary

protected void	addDisplaySettings(DisplaySettingsDialog dsd) Add display settings for this control
protected void	addLabelMacros(String template, List patterns, List values) Add any macro name/value pairs.
protected void	addNewData(List newChoices) Override base class method which is called when the user has selected new data choices.
protected void	addPropertiesComponents(JTabbedPane jtp) _more_
void	applyPreferences() Apply the preferences.
void	changePointParameter(Object[] param) Change the parameter to use
boolean	constrainDragPoint(float[] position) _more_
void	decreaseProbeSize() Decrease the probe size
boolean	doApplyProperties() _more_
Container	doMakeContents() Make the UI for this display control.
void	doRemove() Remove this display.
void	exportCsv() Export the current time as csv
void	exportCsvAllTimes() Export all times as csv
void	exportToCsv(Real[] times) Export all times as csv
protected String	getChangeParameterLabel() Return the appropriate label text for the menu.
TimeSeriesChart	getChart() Get the chart
String	getColorWidgetLabel() Return the label that is to be used for the color widget This allows derived classes to override this and provide their own name,
protected List	getCursorReadoutInner(EarthLocation elt, Real animationValue, int animationStep, List<ReadoutInfo> samples) Return the list of html for doing the cursor readout
DataChoice	getDataChoiceAtRow(int row) Get the DataChoice associated with the parameter at a particular row.
String	getDataTemplate() Get the DataTemplate property.
protected Set	getDataTimeSet() Collect the time animation set from the displayables.
protected void	getEditMenuItems(List items, boolean forMenuBar) Get edit menu items
protected JComponent	getExtraLegendComponent(int legendType) Assume that any display controls that have a color table widget will want the color table to show up in the legend.
Image	getImage(String what) get the image for what
List<ProbeRowInfo>	getInfos() Get the Infos property.
boolean	getKeepProbeAtHeight() Get the KeepProbeAtHeight property.
void	getLegendLabels(List labels, int legendType) Append any label information to the list of labels.
Real[]	getLevelsAtRow(int row) Get the list of levels for a particular parameter (row)
protected String	getLongParamName() Override base class method to use the list of data choices to get the long parameter name
protected void	getMacroNames(List names, List labels) Add any macro name/label pairs
String	getMarker() Get the Marker property.
RealTuple	getPosition() Set the probe position property; used by XML persistence.
double	getProbeRadius() Get the ProbeRadius property.
protected void	getSaveMenuItems(List items, boolean forMenuBar) Add the relevant file menu items into the list
boolean	getShowSunriseSunset() Get the ShowSunriseSunset property.
boolean	getShowTable() Get the ShowTable property.
boolean	getShowTableInLegend() Get the ShowTableInLegend property.
TimeSeriesChart	getTimeSeries() Get the TimeSeries property.
protected void	getViewMenuItems(List items, boolean forMenuBar) Make the view menu items
boolean	getXFixed() Get the XFixed property.
boolean	getYFixed() Get the YFixed property.
boolean	getZFixed() Get the ZFixed property.
boolean	handleAddPoint(float[] x) _more_
boolean	handleDragDirect(VisADRay ray, boolean first, int mouseModifiers) _more_
boolean	haveLevelsAtRow(int row) see if there are levels assigned to this row (parameter); some data is 2d and has no levels.
void	increaseProbeSize() Increase the probe size
boolean	init(List choices) Set up new probe.
void	initDone() Called after init.
protected void	popupDataDialog(String dialogMessage, Component from, boolean multiples, List categories) Popup the data dialog; override superclass to allow multiple selections.
protected void	processNewData(List newChoices) Override base class method which is called when the user has selected new data choices.
void	projectionChanged() Respond to a change in the display's projection.
void	propertyChange(PropertyChangeEvent evt) Property change method.
void	receiveShareData(Sharable from, Object dataId, Object[] data) Method called by other classes that share the state
protected void	resetData() Override base class method to just trigger a redisplay of the data.
protected void	resetData(boolean clearCache) Reset the data.
void	resetProbePosition() Reset the position of the probe to the center.
void	resetProbePosition(double lat, double lon, double alt) Reset the position of the probe to the center.
void	setAltitudes(List l) Deprecated. Keep around for legacy bundles
void	setDataTemplate(String value) Set the DataTemplate property.
void	setEarthLocation(EarthLocation el) Set the earth location
void	setInfos(List<ProbeRowInfo> value) Set the Infos property.
void	setKeepProbeAtHeight(boolean value) Set the KeepProbeAtHeight property.
void	setLevels(List l) Deprecated. Keep around for legacy bundles
void	setMarker(String value) Set the Marker property.
void	setMethods(List l) Deprecated. Keep around for legacy bundles
void	setPointSize(float value) Set the PointSize property.
void	setPosition(RealTuple p) Set the probe position property; used by XML persistence.
void	setProbeRadius(double value) Set the ProbeRadius property.
void	setShowSunriseSunset(boolean value) Set the ShowSunriseSunset property.
void	setShowTable(boolean value) Set the ShowTable property.
void	setShowTableInLegend(boolean value) Set the ShowTableInLegend property.
void	setShowThumbNail(boolean value) Set the ShowThumbNail property.
void	setSounds(List l) Deprecated. Keep around for legacy bundles
void	setTimeSeries(TimeSeriesChart value) Set the TimeSeries property.
void	setUnits(List l) Deprecated. Keep around for legacy bundles
void	setXFixed(boolean value) Set the XFixed property.
void	setYFixed(boolean value) Set the YFixed property.
void	setZFixed(boolean value) Set the ZFixed property.
protected boolean	shouldAddAnimationListener() A hook to allow derived classes to tell us to add this as an animation listener
void	showLineProperties(ProbeRowInfo rowInfo) Show the properties dialog for the chart line
void	showSoundDialog(ProbeRowInfo info) Show the sound dialog for the row
protected void	timeChanged(Real time) Respond to a timeChange event
protected void	updateLegendLabel() This method is called to update the legend labels when some state has changed in this control that is reflected in the labels.
void	updatePosition() Make new values in data probe display (readout table) to match chages in location or sampling of data.

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

actionPerformed, activateDisplays, addAttributedDisplayable, addAttributedDisplayable, addAttributedDisplayable, addAttributeFlags, addCheckBoxSettings, addDataChoice, addDisplayable, addDisplayable, addDisplayable, addDisplayable, addDisplayable, addDisplayable, addDisplayMaster, addNoteText, addPropertyChangeListener, addRemovable, addSharable, addTimeModeWidget, addToControlContext, addToRangeMenu, addToRangeMenu, addToRangeMenu, addViewManager, appendDataChoices, applyAttributesToDisplayables, applyColor, applyColorScaleInfo, applyColorTable, applyColorUnit, applyContourInfo, applyDisplaySetting, applyDisplayUnit, applyLineWidth, applyProperties, applyProperties, applyPropertyValues, applyRange, applySelectRange, applySkipFactor, applySmoothing, applyTextureQuality, applyTimeRange, applyZPosition, boundsClose, canBeDocked, canExportData, canSaveDataInCache, captureWindow, centerOnDisplay, changeColorUnit, changeDisplayUnit, checkFlag, checkIfDataOk, checkImageSize, clearDataInstance, clearPrototype, clearViewManagers, close, colorUnitChanged, controlChanged, convertColorRange, convertRange, createDisplayListDisplayable, createIdvWindow, dataChanged, deactivateDisplays, debug, displayableToFront, displayChanged, displayControlFailed, displayUnitChanged, doInitialUpdateLegendAndList, doMakeBottomLegendComponent, doMakeChangeColorMenu, doMakeChangeColorMenu, doMakeChangeParameterMenuItem, doMakeColorControl, doMakeColorControl, doMakeColorScales, doMakeDataInstance, doMakeMenuBar, doMakeMenuBarMenus, doMakePointSizeWidget, doMakeRemoveControl, doMakeSideLegendComponent, doMakeSkipFactorSlider, doMakeTextureSlider, doMakeVisibilityControl, doMakeWidgetComponent, doMakeWindow, doMakeZPositionSlider, exportDisplayedData, findDisplayInfo, findDisplays, findDisplays, firePropertyChangeEvent, firstFrameDone, formatForCursorReadout, getActive, getAnimation, getAnimation, getAnimation, getAnimation, getAnimationInfo, getAnimationWidget, getAttributeFlags, getCachedData, getCanDoRemoveAll, getCategories, getCollapseLegend, getColor, getColorDimness, getColorScaleInfo, getColorTable, getColorTableForDisplayable, getColorTableToApply, getColorTableWidget, getColorUnit, getColorUnitName, getComponentHolder, getContents, getContourInfo, getControlChangeSleepTime, getControlContext, getControlMenus, getControlWidgets, getCursorReadout, getCursorReadoutInner, getData, getDataChoice, getDataChoices, getDataForDisplayList, getDataInstance, getDataInstance, getDataProjection, getDataProjectionForMenu, getDataProjectionLabel, getDataSelection, getDataSources, getDataTimeRange, getDataTimeRange, getDebugDetails, getDefaultColorScaleInfo, getDefaultDisplayListTemplate, 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, getExtraMenus, getFileMenuItems, getFileMenuItems, getGraphicsConfiguration, getGrid, getGrid, getHadDataChoices, getHaveInitialized, getHelpIds, getHelpMenuItems, getId, getIdv, getImage, getInitDataChoices, getInitialColorTable, getInitialFastRendering, getInitialRange, getInitialZPosition, getInternalAnimation, getInternalAnimation, getIsRaster, getIsTimeDriver, getLabel, getLastFileMenuItems, getLegendButtons, getLegendComponent, getLegendLabel, getLegendLabelTemplate, getLegendToolTip, getLineWidth, getLineWidthWidget, getLineWidthWidgetLabel, getLockVisibilityToggle, getMainPanel, getMainPanelSize, getMakeWindow, getMapDisplay, getMapViewManager, getMapViewProjection, getMenuLabel, getMyDataChoices, getNavigatedDisplay, getNoteText, getObjectStore, getOkToFireEvents, getOldColorTableOrInitialColorTable, getOriginalDataChoicesLabel, getOuterContents, getPointSize, getProperty, getProperty, getPropertyDisplayName, getRange, getRangeForColorTable, getRangeToApply, getRawDataUnit, getRequestProperties, getSamplingModeName, getSamplingModeValue, getSamplingModeValue, getSelectRange, getSelectRangeEnabled, getSelectRangeWidget, getSettingsPanel, getShortParamName, getShowInDisplayList, getShowInLegend, getShowInTabs, getShowNoteText, getSkipValue, getSkipWidgetLabel, getSmoothingFactor, getSmoothingType, getSomeAnimation, getStore, getTemplateName, getTextureQuality, getTextureQualityLabel, getTimeSet, getTitle, getTransientProperty, getUnitForColor, getUseFastRendering, getUsesTimeDriver, getUseTimesInAnimation, getVersion, getVerticalValue, getViewAnimation, getViewContext, getViewer, getViewManager, getViewManager, getViewManager, getViewManagerClassNames, getViewManagerForCapture, getViewManagers, getViewMenuItems, getVisbilityAnimationPause, getWasUnPersisted, getWindow, getWindowSize, getWindowVisible, getWindowX, getWindowY, getZPosition, getZPositionSliderLabel, guiExported, guiImported, handleDisplayChanged, handleWindowClosing, hasMapProjection, hasTimeMacro, haveDataTimes, haveParameterDefaults, hide, hyperlinkUpdate, inGlobeDisplay, init, init, init, initAfterUnPersistence, initAfterUnPersistence, initAsPrototype, initAsTemplate, initBasic, initializeWithNewData, initWindow, isDisplay3D, isDisplayUnitAlsoColorUnit, isGuiShown, isInitDone, isInTransectView, isInViewManager, itemStateChanged, makeChangeColorMenuItems, makeLegendLabel, makeLockButton, makeRemoveButton, moveTo, notifyViewManagersOfChange, parseProperties, popup, popupDataDialog, popupDataDialog, processRequestProperties, putTransientProperty, reallySetAttributeFlags, redoGuiLayout, reloadDataSource, reloadDataSourceInThread, removeDataChoice, removeDisplayable, removeDisplayables, removeDisplayables, removeOnWindowClose, removePropertyChangeListener, 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, setDisplayVisibility, setDoCursorReadout, setExpandedInTabs, setExtraLabelTemplate, setHadDataChoices, setHelpUrl, setId, setInitDataChoices, setInitialSettings, setInitialViewManager, setIsRaster, setIsTimeDriver, 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, setSmoothingFactor, setSmoothingType, setTemplateName, setTextureQuality, setTitle, setUnitForColor, setUseFastRendering, setUsesTimeDriver, setUseTimesInAnimation, setVersion, setViewer, setViewManagerClassNames, setVisbilityAnimationPause, setWindowSize, setWindowVisible, setWindowX, setWindowY, setZPosition, setZPosition, shouldAddControlListener, shouldAddDisplayListener, shouldApplyFastRendering, shouldBeDocked, shouldWindowBeVisible, show, showColorControlWidget, showColorDialog, showColorDialog, showColorScaleDialog, showColorScales, showColorSwatches, showContourPropertiesDialog, showDetails, showDisplaySettingsDialog, showHelp, showLegendMenu, showNormalCursor, showProperties, showTimeRangeDialog, showWaitCursor, toFront, toggleNoteTextArea, toggleVisibilityForVectorGraphicsRendering, toggleWindow, toString, transectChanged, updateAnimation, updateDataInstance, updateDataSelection, updateDisplayList, updateGridDataInstance, updateLegendAndList, updateLockButton, useSmoothingFactor, 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, getReceiveShareTime, getSharablePropertiesComponent, getShareGroup, getSharing, getUniqueId, initSharable, removeSharable, setReceiveShareTime, 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

getReceiveShareTime, getShareGroup, getSharing, getUniqueId, setReceiveShareTime

Field Detail

SHARE_POSITION

public static final String SHARE_POSITION

ID for sharing position

See Also:

Constant Field Values

SHARE_CHOICES

public static final String SHARE_CHOICES

ID for sharing choices

See Also:

Constant Field Values

SHARE_METHODS

public static final String SHARE_METHODS

ID for sharing sampling methods

See Also:

Constant Field Values

SHARE_LEVELS

public static final String SHARE_LEVELS

ID for sharing levels

See Also:

Constant Field Values

COL_NAME

public static final int COL_NAME

Column name property

See Also:

Constant Field Values

COL_VALUE

public static final int COL_VALUE

Column value property

See Also:

Constant Field Values

COL_EXTRA

public static final int COL_EXTRA

Column value property

See Also:

Constant Field Values

COL_LEVEL

public static final int COL_LEVEL

Column level property

See Also:

Constant Field Values

COL_SAMPLING

public static final int COL_SAMPLING

Column sampling property

See Also:

Constant Field Values

NUM_COLS

public static final int NUM_COLS

number of columns

See Also:

Constant Field Values

Constructor Detail

ProbeControl

public ProbeControl()

Cstr; sets flags; see init() for creation actions. needed for bean persistence

Method Detail

init

public boolean init(List choices)
             throws VisADException,
                    RemoteException

Set up new probe.

Overrides:

init in class DisplayControlImpl

Parameters:

choices - a list of DataChoices

Returns:

boolean true if succeeded

Throws:

RemoteException - Java RMI error

VisADException - VisAD Error

initDone

public void initDone()

Called after init.

Overrides:

initDone in class DisplayControlImpl

addPropertiesComponents

protected void addPropertiesComponents(JTabbedPane jtp)

_more_

Overrides:

addPropertiesComponents in class DisplayControlImpl

Parameters:

jtp - _more_

doApplyProperties

public boolean doApplyProperties()

_more_

Overrides:

doApplyProperties in class DisplayControlImpl

Returns:

_more_

getColorWidgetLabel

public String getColorWidgetLabel()

Return the label that is to be used for the color widget This allows derived classes to override this and provide their own name,

Overrides:

getColorWidgetLabel in class DisplayControlImpl

Returns:

Label used for the color widget

getViewMenuItems

protected void getViewMenuItems(List items,
                                boolean forMenuBar)

Make the view menu items

Overrides:

getViewMenuItems in class DisplayControlImpl

Parameters:

items - List of menu items

forMenuBar - forMenuBar

shouldAddAnimationListener

protected boolean shouldAddAnimationListener()

A hook to allow derived classes to tell us to add this as an animation listener

Overrides:

shouldAddAnimationListener in class DisplayControlImpl

Returns:

Add as animation listener

setEarthLocation

public void setEarthLocation(EarthLocation el)

Set the earth location

Parameters:

el - the earth location

addDisplaySettings

protected void addDisplaySettings(DisplaySettingsDialog dsd)

Add display settings for this control

Overrides:

addDisplaySettings in class DisplayControlImpl

Parameters:

dsd - dialog to add to

resetProbePosition

public void resetProbePosition()

Reset the position of the probe to the center.

resetProbePosition

public void resetProbePosition(double lat,
                               double lon,
                               double alt)

Reset the position of the probe to the center.

Parameters:

lat - lat

lon - lon

alt - alt

getEditMenuItems

protected void getEditMenuItems(List items,
                                boolean forMenuBar)

Get edit menu items

Overrides:

getEditMenuItems in class DisplayControlImpl

Parameters:

items - list of menu items

forMenuBar - true if for the menu bar

receiveShareData

public void receiveShareData(Sharable from,
                             Object dataId,
                             Object[] data)

Method called by other classes that share the state

Specified by:

receiveShareData in interface Sharable

Overrides:

receiveShareData in class DisplayControlImpl

Parameters:

from - other class.

dataId - type of sharing

data - Array of data being shared. In this case, the first (and only?) object in the array is the level

getLongParamName

protected String getLongParamName()

Override base class method to use the list of data choices to get the long parameter name

Overrides:

getLongParamName in class DisplayControlImpl

Returns:

The String to be used for the long parameter name

projectionChanged

public void projectionChanged()

Respond to a change in the display's projection. In this case we resample at the new location. (move probe)

Specified by:

projectionChanged in interface DisplayControl

Overrides:

projectionChanged in class DisplayControlImpl

getMacroNames

protected void getMacroNames(List names,
                             List labels)

Add any macro name/label pairs

Overrides:

getMacroNames in class DisplayControlImpl

Parameters:

names - List of macro names

labels - List of macro labels

addLabelMacros

protected void addLabelMacros(String template,
                              List patterns,
                              List values)

Add any macro name/value pairs.

Overrides:

addLabelMacros in class DisplayControlImpl

Parameters:

template - template

patterns - The macro names

values - The macro values

getDataTimeSet

protected Set getDataTimeSet()
                      throws RemoteException,
                             VisADException

Collect the time animation set from the displayables. If none found then return null.

Overrides:

getDataTimeSet in class DisplayControlImpl

Returns:

Animation set

Throws:

RemoteException - On badness

VisADException - On badness

resetData

protected void resetData()
                  throws VisADException,
                         RemoteException

Override base class method to just trigger a redisplay of the data.

Overrides:

resetData in class DisplayControlImpl

Throws:

RemoteException - Java RMI error

VisADException - VisAD Error

resetData

protected void resetData(boolean clearCache)
                  throws VisADException,
                         RemoteException

Reset the data.

Parameters:

clearCache - If true then clear the cached data in the rows

Throws:

RemoteException - Java RMI error

VisADException - VisAD Error

addNewData

protected void addNewData(List newChoices)
                   throws VisADException,
                          RemoteException

Override base class method which is called when the user has selected new data choices.

Overrides:

addNewData in class DisplayControlImpl

Parameters:

newChoices - new list of choices

Throws:

RemoteException - Java RMI error

VisADException - VisAD Error

processNewData

protected void processNewData(List newChoices)
                       throws VisADException,
                              RemoteException

Override base class method which is called when the user has selected new data choices.

Parameters:

newChoices - new list of choices

Throws:

RemoteException - Java RMI error

VisADException - VisAD Error

getExtraLegendComponent

protected JComponent getExtraLegendComponent(int legendType)

Assume that any display controls that have a color table widget will want the color table to show up in the legend.

Overrides:

getExtraLegendComponent in class DisplayControlImpl

Parameters:

legendType - type of legend

Returns:

The extra JComponent to use in legend

getLegendLabels

public void getLegendLabels(List labels,
                            int legendType)

Append any label information to the list of labels.

Overrides:

getLegendLabels in class DisplayControlImpl

Parameters:

labels - in/out list of labels

legendType - The type of legend, BOTTOM_LEGEND or SIDE_LEGEND

setPosition

public void setPosition(RealTuple p)

Set the probe position property; used by XML persistence.

Parameters:

p - probe position

getPosition

public RealTuple getPosition()
                      throws VisADException,
                             RemoteException

Set the probe position property; used by XML persistence.

Returns:

probe position - may be null.

Throws:

RemoteException - Java RMI error

VisADException - VisAD Error

doRemove

public void doRemove()
              throws RemoteException,
                     VisADException

Remove this display.

Specified by:

doRemove in interface DisplayControl

Overrides:

doRemove in class DisplayControlImpl

Throws:

RemoteException - Java RMI error

VisADException - VisAD Error

timeChanged

protected void timeChanged(Real time)

Respond to a timeChange event

Overrides:

timeChanged in class DisplayControlImpl

Parameters:

time - new time

getImage

public Image getImage(String what)
               throws Exception

get the image for what

Overrides:

getImage in class DisplayControlImpl

Parameters:

what - the thing to get

Returns:

an image

Throws:

Exception - problem (can this be more specific?)

handleDragDirect

public boolean handleDragDirect(VisADRay ray,
                                boolean first,
                                int mouseModifiers)

_more_

Specified by:

handleDragDirect in interface DisplayableData.DragAdapter

Parameters:

ray - _more_

first - _more_

mouseModifiers - _more_

Returns:

_more_

handleAddPoint

public boolean handleAddPoint(float[] x)

_more_

Specified by:

handleAddPoint in interface DisplayableData.DragAdapter

Parameters:

x - _more_

Returns:

_more_

constrainDragPoint

public boolean constrainDragPoint(float[] position)

_more_

Specified by:

constrainDragPoint in interface DisplayableData.DragAdapter

Parameters:

position - _more_

Returns:

_more_

propertyChange

public void propertyChange(PropertyChangeEvent evt)

Property change method.

Specified by:

propertyChange in interface PropertyChangeListener

Overrides:

propertyChange in class DisplayControlImpl

Parameters:

evt - event to act on

getLevelsAtRow

public Real[] getLevelsAtRow(int row)

Get the list of levels for a particular parameter (row)

Parameters:

row - row for parameter

Returns:

list of levels

haveLevelsAtRow

public boolean haveLevelsAtRow(int row)

see if there are levels assigned to this row (parameter); some data is 2d and has no levels.

Parameters:

row - row to check

Returns:

true if there are levels assigned to this row (parameter)

changePointParameter

public void changePointParameter(Object[] param)

Change the parameter to use

Parameters:

param - The parameter

doMakeContents

public Container doMakeContents()

Make the UI for this display control.

Overrides:

doMakeContents in class DisplayControlImpl

Returns:

UI contents.

popupDataDialog

protected void popupDataDialog(String dialogMessage,
                               Component from,
                               boolean multiples,
                               List categories)

Popup the data dialog; override superclass to allow multiple selections.

Overrides:

popupDataDialog in class DisplayControlImpl

Parameters:

dialogMessage - the dialog message

from - component to latch on to

multiples - true to support multiple selections

categories - data categories of params to show

showLineProperties

public void showLineProperties(ProbeRowInfo rowInfo)

Show the properties dialog for the chart line

Parameters:

rowInfo - The chrt entry to show properties for

showSoundDialog

public void showSoundDialog(ProbeRowInfo info)

Show the sound dialog for the row

Parameters:

info - the row

getDataChoiceAtRow

public DataChoice getDataChoiceAtRow(int row)

Get the DataChoice associated with the parameter at a particular row.

Parameters:

row - row index

Returns:

the associated DataChoice

getChangeParameterLabel

protected String getChangeParameterLabel()

Return the appropriate label text for the menu.

Overrides:

getChangeParameterLabel in class DisplayControlImpl

Returns:

the label text

updatePosition

public void updatePosition()
                    throws VisADException,
                           RemoteException

Make new values in data probe display (readout table) to match chages in location or sampling of data.

Throws:

RemoteException - Java RMI error

VisADException - VisAD Error

applyPreferences

public void applyPreferences()

Apply the preferences. Used to pick up the date format changes.

Specified by:

applyPreferences in interface DisplayControl

Overrides:

applyPreferences in class DisplayControlImpl

updateLegendLabel

protected void updateLegendLabel()

This method is called to update the legend labels when some state has changed in this control that is reflected in the labels.

Overrides:

updateLegendLabel in class DisplayControlImpl

getCursorReadoutInner

protected List getCursorReadoutInner(EarthLocation elt,
                                     Real animationValue,
                                     int animationStep,
                                     List<ReadoutInfo> samples)
                              throws Exception

Return the list of html for doing the cursor readout

Overrides:

getCursorReadoutInner in class DisplayControlImpl

Parameters:

elt - The location

animationValue - The time animation

animationStep - Which step in the animation

samples - _more_

Returns:

List of html to display

Throws:

Exception - On badness

getSaveMenuItems

protected void getSaveMenuItems(List items,
                                boolean forMenuBar)

Add the relevant file menu items into the list

Overrides:

getSaveMenuItems 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

exportCsv

public void exportCsv()

Export the current time as csv

exportCsvAllTimes

public void exportCsvAllTimes()

Export all times as csv

exportToCsv

public void exportToCsv(Real[] times)

Export all times as csv

Parameters:

times - export given times as csv

setDataTemplate

public void setDataTemplate(String value)

Set the DataTemplate property.

Parameters:

value - The new value for DataTemplate

getDataTemplate

public String getDataTemplate()

Get the DataTemplate property.

Returns:

The DataTemplate

setXFixed

public void setXFixed(boolean value)

Set the XFixed property.

Parameters:

value - The new value for XFixed

getXFixed

public boolean getXFixed()

Get the XFixed property.

Returns:

The XFixed

setYFixed

public void setYFixed(boolean value)

Set the YFixed property.

Parameters:

value - The new value for YFixed

getYFixed

public boolean getYFixed()

Get the YFixed property.

Returns:

The YFixed

setZFixed

public void setZFixed(boolean value)

Set the ZFixed property.

Parameters:

value - The new value for ZFixed

getZFixed

public boolean getZFixed()

Get the ZFixed property.

Returns:

The ZFixed

setInfos

public void setInfos(List<ProbeRowInfo> value)

Set the Infos property.

Parameters:

value - The new value for Infos

getInfos

public List<ProbeRowInfo> getInfos()

Get the Infos property.

Returns:

The Infos

setAltitudes

public void setAltitudes(List l)

Deprecated. Keep around for legacy bundles

Set the altitudes property, use for persistence

Parameters:

l - list of altitudes

setLevels

public void setLevels(List l)

Deprecated. Keep around for legacy bundles

Get the list of levels; use by persistence

Parameters:

l - list of levels for parameters

setMethods

public void setMethods(List l)

Deprecated. Keep around for legacy bundles

Get the list of sampling methods for each of the parameters. Used for persistence

Parameters:

l - list of sampling methods

setUnits

public void setUnits(List l)

Deprecated. Keep around for legacy bundles

Set the list of display units for each parameter. Used by persistence

Parameters:

l - list of units

setSounds

public void setSounds(List l)

Deprecated. Keep around for legacy bundles

Set the list of display sounds for each parameter. Used by persistence

Parameters:

l - list of sounds

increaseProbeSize

public void increaseProbeSize()

Increase the probe size

decreaseProbeSize

public void decreaseProbeSize()

Decrease the probe size

setPointSize

public void setPointSize(float value)

Set the PointSize property.

Overrides:

setPointSize in class DisplayControlImpl

Parameters:

value - The new value for PointSize

setMarker

public void setMarker(String value)

Set the Marker property.

Parameters:

value - The new value for Marker

getMarker

public String getMarker()

Get the Marker property.

Returns:

The Marker

setTimeSeries

public void setTimeSeries(TimeSeriesChart value)

Set the TimeSeries property.

Parameters:

value - The new value for TimeSeries

getTimeSeries

public TimeSeriesChart getTimeSeries()

Get the TimeSeries property.

Returns:

The TimeSeries

getChart

public TimeSeriesChart getChart()

Get the chart

Returns:

The chart_

setShowThumbNail

public void setShowThumbNail(boolean value)

Set the ShowThumbNail property.

Parameters:

value - The new value for ShowThumbNail

setShowTable

public void setShowTable(boolean value)

Set the ShowTable property.

Parameters:

value - The new value for ShowTable

getShowTable

public boolean getShowTable()

Get the ShowTable property.

Returns:

The ShowTable

setShowTableInLegend

public void setShowTableInLegend(boolean value)

Set the ShowTableInLegend property.

Parameters:

value - The new value for ShowTable

getShowTableInLegend

public boolean getShowTableInLegend()

Get the ShowTableInLegend property.

Returns:

The ShowTableInLegend

setShowSunriseSunset

public void setShowSunriseSunset(boolean value)

Set the ShowSunriseSunset property.

Parameters:

value - The new value for ShowSunriseSunset

getShowSunriseSunset

public boolean getShowSunriseSunset()

Get the ShowSunriseSunset property.

Returns:

The ShowSunriseSunset

setKeepProbeAtHeight

public void setKeepProbeAtHeight(boolean value)

Set the KeepProbeAtHeight property.

Parameters:

value - The new value for KeepProbeAtHeight

getKeepProbeAtHeight

public boolean getKeepProbeAtHeight()

Get the KeepProbeAtHeight property.

Returns:

The KeepProbeAtHeight

setProbeRadius

public void setProbeRadius(double value)

Set the ProbeRadius property.

Parameters:

value - The new value for ProbeRadius

getProbeRadius

public double getProbeRadius()

Get the ProbeRadius property.

Returns:

The ProbeRadius