ucar.unidata.idv.control
Class ProbeControl

java.lang.Object
  extended by ucar.unidata.collab.SharableImpl
      extended by ucar.unidata.idv.control.DisplayControlBase
          extended by ucar.unidata.idv.control.DisplayControlImpl
              extended by ucar.unidata.idv.control.ProbeControl
All Implemented Interfaces:
ActionListener, ItemListener, PropertyChangeListener, EventListener, HyperlinkListener, Sharable, DataChangeListener, DisplayControl, Prototypable, ControlListener, DisplayListener

public class ProbeControl
extends DisplayControlImpl

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, 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_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_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, PREF_PREFIX, PREF_PROBEFORMAT, PREF_REMOVEONWINDOWCLOSE, PREF_SAMPLING_MODE, PREF_STANDALONE_REMOVEONCLOSE, PREF_STANDALONE_REMOVEONCLOSE_ASK, PROP_LEGENDICON, 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.
 void applyPreferences()
          Apply the preferences.
 void changePointParameter(Object[] param)
          _more_
 void decreaseProbeSize()
          Decrease the probe size
 Container doMakeContents()
          Make the UI for this display control.
 void doRemove()
          Remove this display.
 void exportCsv()
          Export the current time as csv
 void exportCsvAllTimes()
          _more_
 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)
          _more_
 DataChoice getDataChoiceAtRow(int row)
          Get the DataChoice associated with the parameter at a particular row.
 String getDataTemplate()
          Get the DataTemplate property.
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.
 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.
 float getPointSize()
          Get the PointSize property.
 RealTuple getPosition()
          Set the probe position property; used by XML persistence.
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 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.
 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 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 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, addPropertiesComponents, addPropertyChangeListener, addSharable, addToRangeMenu, addToRangeMenu, addToRangeMenu, addViewManager, appendDataChoices, applyAttributesToDisplayables, applyColor, applyColorScaleInfo, applyColorTable, applyColorUnit, applyContourInfo, applyDisplaySetting, applyDisplayUnit, applyLineWidth, 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, getCollapseLegend, getColor, getColorDimness, getColorScaleInfo, getColorTable, getColorTableForDisplayable, getColorTableToApply, getColorTableWidget, getColorUnit, getColorUnitName, getComponentHolder, getContents, getContourInfo, getControlChangeSleepTime, getControlContext, getControlWidgets, getCursorReadout, getDataChoice, getDataChoices, 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, getExtraMenus, getFileMenuItems, getFileMenuItems, getGraphicsConfiguration, getHadDataChoices, getHaveInitialized, getHelpIds, getHelpMenuItems, getId, getIdv, getImage, getInitDataChoices, getInitialColorTable, getInitialRange, getInitialZPosition, 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, getProperty, getProperty, getPropertyDisplayName, getRange, getRangeForColorTable, getRangeToApply, getRawDataUnit, getRequestProperties, getSamplingModeName, getSamplingModeValue, 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, getWasUnPersisted, getWindow, getWindowSize, getWindowVisible, getWindowX, getWindowY, getZPosition, getZPositionSliderLabel, guiExported, guiImported, handleDisplayChanged, handleWindowClosing, hasMapProjection, haveDataTimes, haveParameterDefaults, hide, hyperlinkUpdate, 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, redoGuiLayout, reloadDataSource, reloadDataSourceInThread, removeDataChoice, removeDisplayable, removeDisplayables, removeOnWindowClose, removePropertyChangeListener, resetDimness, resetViewManager, revertToDefaultColorTable, revertToDefaultColorTable, revertToDefaultRange, revertToDefaultRange, saveAsFavorite, saveAsParameterDefaults, saveAsPrototype, saveAsTemplate, saveDataChoiceInCache, saveImage, 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, setDisplayListProperties, setDisplayListTemplate, setDisplayName, setDisplayUnit, setDisplayUnitName, setDisplayVisibility, setDoCursorReadout, setExpandedInTabs, setExtraLabelTemplate, setHadDataChoices, setHelpUrl, setId, setInitDataChoices, setInitialSettings, 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, shouldAddControlListener, shouldAddDisplayListener, shouldApplyFastRendering, shouldBeDocked, shouldWindowBeVisible, show, showColorControlWidget, showColorDialog, showColorDialog, showColorScaleDialog, showColorScales, showColorSwatches, showContourPropertiesDialog, showDetails, showDisplaySettingsDialog, showHelp, showLegendMenu, showNormalCursor, showProperties, showTimeRangeDialog, showWaitCursor, toFront, toggleNoteTextArea, toggleWindow, toString, transectChanged, updateAnimation, updateDisplayList, updateLegendAndList, 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, getScreenCenter, getSelectedStation, isLeftButtonDown, logException, logException, makeEarthLocation, 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.collab.Sharable
getShareGroup, getSharing, getUniqueId
 

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: