edu.wisc.ssec.mcidasv.control

Class Grid2DReadoutProbe

java.lang.Object

ucar.unidata.collab.SharableImpl

ucar.unidata.idv.control.DisplayControlBase

ucar.unidata.idv.control.DisplayControlImpl

ucar.unidata.idv.control.GridDisplayControl

edu.wisc.ssec.mcidasv.control.Grid2DReadoutProbe

All Implemented Interfaces:

java.awt.event.ActionListener, java.awt.event.ItemListener, java.beans.PropertyChangeListener, java.util.EventListener, javax.swing.event.HyperlinkListener, ucar.unidata.collab.Sharable, ucar.unidata.data.DataChangeListener, ucar.unidata.idv.DisplayControl, ucar.unidata.util.Prototypable, ControlListener, DisplayListener

public class Grid2DReadoutProbe
extends ucar.unidata.idv.control.GridDisplayControl

An abstract base class that manages a vertical probe To create a probe call doMakeProbe To be notified of changes override: void probePositionChanged (double x, double y);

Version:

$Revision$Date: 2011/03/24 16:06:32 $

Author:

IDV development team

Nested Class Summary

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

ucar.unidata.idv.control.DisplayControlImpl.SideLegendLabel

Field Summary

Fields

Modifier and Type	Field and Description
private java.awt.Color	currentColor
private RealTuple	currentPosition
private RealTupleType	earthTupleType
private FlatField	image
private RealTuple	initPosition the initial position
private boolean	isLonLat
private Tuple	locationValue
private java.lang.String	marker The shape for the probe point
private ucar.visad.display.DisplayMaster	master
private java.text.DecimalFormat	numFmt
private float	pointSize The point size
private DataReference	positionRef
protected java.lang.String	positionText Keep around for the label macros
protected ucar.visad.display.PointProbe	probe the line probe
static java.lang.String	SHARE_PROFILE profile sharing property
private static TupleType	TUPTYPE
private ucar.visad.display.TextDisplayable	valueDisplay

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

CMD_CONTOURDIALOG, CMD_SETLEVELS, gridDataInstance, INITIAL_PROBE_EARTHLOCATION, log_, settingLevel

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, isProgressiveResolution, matchDisplayRegion, noteTextArea, noteWrapper, paramName, reloadFromBounds, requestProperties, resolutionReadout, selectRangeWidget, settingVisibility, sharables, showNoteText, skipSlider, skipTextField, 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_GRIDTRAJECTORY, 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, MACRO_DATASOURCENAME, MACRO_DISPLAYNAME, MACRO_DISPLAYUNIT, MACRO_FHOUR, MACRO_FHOUR2, MACRO_LONGNAME, MACRO_POSITION, MACRO_RESOLUTION, 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_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

Constructors

Constructor and Description
Grid2DReadoutProbe(FlatField grid2d, ucar.visad.display.DisplayMaster master) Default Constructor.

Method Summary

Modifier and Type	Method and Description
protected void	addLabelMacros(java.lang.String template, java.util.List patterns, java.util.List values) Add any macro name/value pairs.
static RealTupleType	check2DEarthTuple(FlatField field)
private static ucar.visad.display.TextDisplayable	createValueDisplayer(java.awt.Color color)
void	decreaseProbeSize() Decrease the probe size
void	doMakeProbe() Default doMakeProbe method.
void	doMakeProbe(java.awt.Color c) Make the probe with the specific Color.
void	doMakeProbe(java.awt.Color probeColor, ucar.visad.display.DisplayMaster master) Make the probe with the specific Color and associate it with the given DisplayMaster.
void	doMakeProbe(ucar.unidata.idv.ViewDescriptor view) Make the probe with the specific ViewDescriptor.
javax.swing.JMenu	doMakeProbeMenu(javax.swing.JMenu probeMenu) Make a menu for controlling the probe size, shape and position.
protected void	doMoveProbe() Method called when probe is moved.
protected void	getEditMenuItems(java.util.List items, boolean forMenuBar) Get edit menu items
RealTuple	getGridCenterPosition() Get initial XY position from grid data.
RealTuple	getInitialLinePosition() Get initial XY position from the screen
RealTuple	getInitialPosition() Get the initial position of the probe set during unpersistence.
void	getLegendLabels(java.util.List labels, int legendType) Append any label information to the list of labels.
protected void	getMacroNames(java.util.List names, java.util.List labels) Add any macro name/label pairs
java.lang.String	getMarker() Get the Marker property.
ucar.unidata.view.geoloc.NavigatedDisplay	getNavigatedDisplay() A helper method for finding the NavigatedDisplay of this control's MapViewManager.
float	getPointSize() Get the PointSize property.
RealTuple	getPosition() Get the position of the probe.
void	increaseProbeSize() Increase the probe size
private static TupleType	makeTupleType()
protected void	probePositionChanged(RealTuple newPos) This gets called when either the user moves the probe point or when we get a sharable event to move the probe point.
void	projectionChanged() Respond to a change in the display's projection.
void	propertyChange(java.beans.PropertyChangeEvent evt) Handle changes
void	receiveShareData(ucar.unidata.collab.Sharable from, java.lang.Object dataId, java.lang.Object[] data) Method called when sharing is enabled.
void	resetProbePosition() Reset the position of the probe to the center.
void	setMarker(java.lang.String value) Set the Marker property.
void	setPointSize(float value) Set the PointSize property.
void	setPosition(RealTuple p) Set the initial position of the probe.
void	setProbePosition(double x, double y) Set the probe position from display x and y positions.
void	setProbePosition(RealTuple xy) Set the probe position.
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.
private void	updateLocationValue()
protected void	updatePosition(RealTuple position)

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

actionPerformed, addTopographyMap, applyForecastHourMacro, canDoProgressiveResolution, convertColorRange, doMakeContourLevelControl, doMakeDataInstance, doMakeLevelControl, doMakeLevelControl, exportDisplayedData, getColorParamName, getColorRangeFromData, getColorRangeIndex, getColorUnit, getContourInfo, getCursorReadoutData, getCursorReadoutInner, getDataProjection, getDataRangeInColorUnits, getDefaultContourInfo, getDisplayUnit, getGridDataInstance, getInitialColorTable, getInitialRange, getRawDataUnit, haveMultipleFields, initializeDefaultContourInfo, isDisplayUnitAlsoColorUnit, setLevel, setLevel, setLevelFromUser, shouldAddControlListener, shouldAddDisplayListener

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

activateDisplays, addAttributedDisplayable, addAttributedDisplayable, addAttributedDisplayable, addAttributeFlags, addCheckBoxSettings, addDataChoice, addDisplayable, addDisplayable, addDisplayable, addDisplayable, addDisplayable, addDisplayable, addDisplayMaster, addDisplaySettings, addNewData, addNoteText, addPropertiesComponents, addPropertyChangeListener, addRemovable, addSharable, addTimeModeWidget, addToControlContext, addToRangeMenu, addToRangeMenu, addToRangeMenu, addViewManager, appendDataChoices, applyAttributesToDisplayables, applyColor, applyColorScaleInfo, applyColorTable, applyColorUnit, applyContourInfo, applyDisplaySetting, applyDisplayUnit, applyLineWidth, applyPreferences, applyProperties, applyProperties, applyPropertyValues, applyRange, applySelectRange, applySkipFactor, applySmoothing, applyTextureQuality, applyTimeRange, applyZPosition, boundsClose, canBeDocked, canDataDoProgressiveResolution, canExportData, canSaveDataInCache, captureWindow, centerOnDisplay, changeColorUnit, changeDisplayUnit, checkBoundsChange, checkFlag, checkIfDataOk, checkImageSize, clearDataInstance, clearPrototype, clearViewManagers, close, colorUnitChanged, controlChanged, convertColorRange, convertRange, createDisplayListDisplayable, createIdvWindow, dataChanged, dataSelectionAdaptiveResolution, deactivateDisplays, debug, displayableToFront, displayChanged, displayControlFailed, displayUnitChanged, doApplyProperties, doExport, doInitialUpdateLegendAndList, doMakeBottomLegendComponent, doMakeChangeColorMenu, doMakeChangeColorMenu, doMakeChangeParameterMenuItem, doMakeColorControl, doMakeColorControl, doMakeColorScales, doMakeContents, doMakeMenuBar, doMakeMenuBarMenus, doMakePointSizeWidget, doMakeRemoveControl, doMakeSideLegendComponent, doMakeSkipFactorSlider, doMakeTextureSlider, doMakeVisibilityControl, doMakeWidgetComponent, doMakeWindow, doMakeZPositionSlider, doRemove, 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, getColorUnitName, getColorWidgetLabel, getComponentHolder, getContents, getControlChangeSleepTime, getControlContext, getControlMenus, getControlWidgets, getCursorReadout, getCursorReadoutInner, getData, getDataChoice, getDataChoices, getDataForDisplayList, getDataInstance, getDataInstance, getDataProjectionForMenu, getDataProjectionLabel, getDataSelection, getDataSources, getDataTimeRange, getDataTimeRange, getDataTimeSet, 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, getDisplayUnitName, getDisplayVisibility, getDoCursorReadout, getEditMenuItems, getExpandedInTabs, getExtraLabelTemplate, getExtraLegendComponent, getExtraMenus, getFileMenuItems, getFileMenuItems, getGraphicsConfiguration, getGrid, getGrid, getHadDataChoices, getHaveInitialized, getHelpIds, getHelpMenuItems, getId, getIdv, getImage, getImage, getInitDataChoices, getInitialFastRendering, getInitialZPosition, getInternalAnimation, getInternalAnimation, getIsProgressiveResolution, getIsRaster, getIsTimeDriver, getLabel, getLastFileMenuItems, getLatLonPoints, getLegendButtons, getLegendComponent, getLegendLabel, getLegendLabelTemplate, getLegendToolTip, getLineWidth, getLineWidthWidget, getLineWidthWidgetLabel, getLockVisibilityToggle, getLongParamName, getMainPanel, getMainPanelSize, getMakeWindow, getMapDisplay, getMapViewManager, getMapViewProjection, getMatchDisplayRegion, getMenuLabel, getMyDataChoices, getNoteText, getObjectStore, getOkToFireEvents, getOldColorTableOrInitialColorTable, getOriginalDataChoicesLabel, getOuterContents, getProperty, getProperty, getPropertyDisplayName, getRange, getRangeForColorTable, getRangeToApply, getRequestProperties, getSamplingModeName, getSamplingModeValue, getSamplingModeValue, getSaveMenuItems, getSelectRange, getSelectRangeEnabled, getSelectRangeWidget, getSettingsPanel, getShortParamName, getShoulDoProgressiveResolution, 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, getViewMenuItems, getVisbilityAnimationPause, getWasUnPersisted, getWindow, getWindowSize, getWindowVisible, getWindowX, getWindowY, getZPosition, getZPositionSliderLabel, guiExported, guiImported, handleDisplayChanged, handleWindowClosing, hasForecastHourMacro, hasMapProjection, hasTimeMacro, haveDataTimes, haveParameterDefaults, hide, hyperlinkUpdate, inGlobeDisplay, init, init, init, init, initAfterUnPersistence, initAfterUnPersistence, initAsPrototype, initAsTemplate, initBasic, initDone, initializeWithNewData, initWindow, isDisplay3D, isGuiShown, isInitDone, isInTransectView, isInViewManager, isRectBad, itemStateChanged, makeChangeColorMenuItems, makeLegendLabel, makeLockButton, makeMiscButton, makeRemoveButton, moveTo, notifyViewManagersOfChange, parseProperties, popup, popupDataDialog, popupDataDialog, popupDataDialog, processRequestProperties, putTransientProperty, reallySetAttributeFlags, redoGuiLayout, reloadDataSource, reloadDataSourceInThread, removeDataChoice, removeDisplayable, removeDisplayables, 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, setDisplayVisibility, setDoCursorReadout, setExpandedInTabs, setExtraLabelTemplate, setHadDataChoices, setHelpUrl, setId, setInitDataChoices, setInitialSettings, setInitialViewManager, setIsProgressiveResolution, setIsRaster, setIsTimeDriver, setLabelAsPreference, setLegendBackground, setLegendForeground, setLegendLabel, setLegendLabelTemplate, setLineWidth, setLockVisibilityToggle, setMainPanelDimensions, setMainPanelSize, setMakeWindow, setMatchDisplayRegion, 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, setViewManagerDisplayListColor, setVisbilityAnimationPause, setWindowSize, setWindowVisible, setWindowX, setWindowY, setZPosition, setZPosition, shouldAddAnimationListener, 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, updateDataInstance, updateDataSelection, updateDisplayList, updateGridDataInstance, updateLegendAndList, updateLockButton, updateMiscButton, 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_PROFILE

public static final java.lang.String SHARE_PROFILE

profile sharing property

See Also:

Constant Field Values

probe

protected ucar.visad.display.PointProbe probe

the line probe

initPosition

private RealTuple initPosition

the initial position

marker

private java.lang.String marker

The shape for the probe point

pointSize

private float pointSize

The point size

positionText

protected java.lang.String positionText

Keep around for the label macros

TUPTYPE

private static final TupleType TUPTYPE

positionRef

private DataReference positionRef

currentColor

private java.awt.Color currentColor

currentPosition

private RealTuple currentPosition

locationValue

private Tuple locationValue

valueDisplay

private ucar.visad.display.TextDisplayable valueDisplay

image

private FlatField image

earthTupleType

private RealTupleType earthTupleType

isLonLat

private boolean isLonLat

master

private ucar.visad.display.DisplayMaster master

numFmt

private java.text.DecimalFormat numFmt

Constructor Detail

Grid2DReadoutProbe

public Grid2DReadoutProbe(FlatField grid2d,
                          ucar.visad.display.DisplayMaster master)
                   throws VisADException,
                          java.rmi.RemoteException

Default Constructor.

Throws:

VisADException

java.rmi.RemoteException

Method Detail

doMakeProbe

public void doMakeProbe()
                 throws VisADException,
                        java.rmi.RemoteException

Default doMakeProbe method.

Throws:

java.rmi.RemoteException - Java RMI error

VisADException - VisAD Error

doMakeProbe

public void doMakeProbe(java.awt.Color c)
                 throws VisADException,
                        java.rmi.RemoteException

Make the probe with the specific Color.

Parameters:

c - color for probe.

Throws:

java.rmi.RemoteException - Java RMI error

VisADException - VisAD Error

doMakeProbe

public void doMakeProbe(ucar.unidata.idv.ViewDescriptor view)
                 throws VisADException,
                        java.rmi.RemoteException

Make the probe with the specific ViewDescriptor.

Parameters:

view - view descriptor

Throws:

java.rmi.RemoteException - Java RMI error

VisADException - VisAD Error

doMakeProbe

public void doMakeProbe(java.awt.Color probeColor,
                        ucar.visad.display.DisplayMaster master)
                 throws VisADException,
                        java.rmi.RemoteException

Make the probe with the specific Color and associate it with the given DisplayMaster.

Parameters:

probeColor - Color of the probe.

master - DisplayMaster of the display we will be probing.

Throws:

java.rmi.RemoteException - Java RMI error

VisADException - VisAD Error

propertyChange

public void propertyChange(java.beans.PropertyChangeEvent evt)

Handle changes

Specified by:

propertyChange in interface java.beans.PropertyChangeListener

Overrides:

propertyChange in class ucar.unidata.idv.control.DisplayControlImpl

Parameters:

evt - The event

resetProbePosition

public void resetProbePosition()

Reset the position of the probe to the center.

getEditMenuItems

protected void getEditMenuItems(java.util.List items,
                                boolean forMenuBar)

Get edit menu items

Overrides:

getEditMenuItems in class ucar.unidata.idv.control.DisplayControlImpl

Parameters:

items - list of menu items

forMenuBar - true if for the menu bar

setProbePosition

public void setProbePosition(RealTuple xy)
                      throws VisADException,
                             java.rmi.RemoteException

Set the probe position. Probes are set in XY space.

Parameters:

xy - X and Y position of the probe.

Throws:

VisADException - problem setting probe position

java.rmi.RemoteException - problem setting probe position on remote display

setProbePosition

public void setProbePosition(double x,
                             double y)
                      throws VisADException,
                             java.rmi.RemoteException

Set the probe position from display x and y positions.

Parameters:

x - X position of the probe.

y - Y position of the probe.

Throws:

VisADException - problem setting probe position

java.rmi.RemoteException - problem setting probe position on remote display

setPosition

public void setPosition(RealTuple p)

Set the initial position of the probe. This is used by the XML persistense.

Parameters:

p - position

getPosition

public RealTuple getPosition()
                      throws VisADException,
                             java.rmi.RemoteException

Get the position of the probe. This is used by the XML persistense.

Returns:

current probe position or null if probe has not been created.

Throws:

java.rmi.RemoteException - Java RMI error

VisADException - VisAD Error

getInitialPosition

public RealTuple getInitialPosition()

Get the initial position of the probe set during unpersistence.

Returns:

initial position or null if not set during initialization.

receiveShareData

public void receiveShareData(ucar.unidata.collab.Sharable from,
                             java.lang.Object dataId,
                             java.lang.Object[] data)

Method called when sharing is enabled.

Specified by:

receiveShareData in interface ucar.unidata.collab.Sharable

Overrides:

receiveShareData in class ucar.unidata.idv.control.DisplayControlImpl

Parameters:

from - Sharable that send the data.

dataId - identifier for data to be shared

data - data to be shared.

doMoveProbe

protected void doMoveProbe()

Method called when probe is moved.

probePositionChanged

protected void probePositionChanged(RealTuple newPos)

This gets called when either the user moves the probe point or when we get a sharable event to move the probe point. Subclasses need to implement this.

Parameters:

newPos - New position for the probe.

updatePosition

protected void updatePosition(RealTuple position)

updateLocationValue

private void updateLocationValue()

getNavigatedDisplay

public ucar.unidata.view.geoloc.NavigatedDisplay getNavigatedDisplay()

Description copied from class: ucar.unidata.idv.control.DisplayControlImpl

A helper method for finding the NavigatedDisplay of this control's MapViewManager. This iterates through the list of DisplayInfo-s, finding the first one that holds an instance of a MapViewManager. If not found this uses the default MapViewManager

Overrides:

getNavigatedDisplay in class ucar.unidata.idv.control.DisplayControlImpl

Returns:

The NavigatedDisplay that this control displays in.

check2DEarthTuple

public static RealTupleType check2DEarthTuple(FlatField field)

createValueDisplayer

private static ucar.visad.display.TextDisplayable createValueDisplayer(java.awt.Color color)
                                                                throws VisADException,
                                                                       java.rmi.RemoteException

Throws:

VisADException

java.rmi.RemoteException

makeTupleType

private static TupleType makeTupleType()

projectionChanged

public void projectionChanged()

Respond to a change in the display's projection. In this case we fire the probePositionChanged() method with the probe's position.

Specified by:

projectionChanged in interface ucar.unidata.idv.DisplayControl

Overrides:

projectionChanged in class ucar.unidata.idv.control.DisplayControlImpl

doMakeProbeMenu

public javax.swing.JMenu doMakeProbeMenu(javax.swing.JMenu probeMenu)

Make a menu for controlling the probe size, shape and position.

Parameters:

probeMenu - The menu to add to

Returns:

The menu

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 ucar.unidata.idv.control.DisplayControlImpl

Parameters:

value - The new value for PointSize

getPointSize

public float getPointSize()

Get the PointSize property.

Overrides:

getPointSize in class ucar.unidata.idv.control.DisplayControlImpl

Returns:

The PointSize

getGridCenterPosition

public RealTuple getGridCenterPosition()
                                throws VisADException,
                                       java.rmi.RemoteException

Get initial XY position from grid data.

Returns:

initial XY position of grid center point in VisAD space

Throws:

java.rmi.RemoteException - Java RMI problem

VisADException - VisAD problem

getInitialLinePosition

public RealTuple getInitialLinePosition()
                                 throws VisADException,
                                        java.rmi.RemoteException

Get initial XY position from the screen

Returns:

initial XY position in VisAD space

Throws:

java.rmi.RemoteException - Java RMI problem

VisADException - VisAD problem

setMarker

public void setMarker(java.lang.String value)

Set the Marker property.

Parameters:

value - The new value for Marker

getMarker

public java.lang.String getMarker()

Get the Marker property.

Returns:

The Marker

getMacroNames

protected void getMacroNames(java.util.List names,
                             java.util.List labels)

Add any macro name/label pairs

Overrides:

getMacroNames in class ucar.unidata.idv.control.DisplayControlImpl

Parameters:

names - List of macro names

labels - List of macro labels

addLabelMacros

protected void addLabelMacros(java.lang.String template,
                              java.util.List patterns,
                              java.util.List values)

Add any macro name/value pairs.

Overrides:

addLabelMacros in class ucar.unidata.idv.control.DisplayControlImpl

Parameters:

template - template

patterns - The macro names

values - The macro values

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 ucar.unidata.idv.control.DisplayControlImpl

getLegendLabels

public void getLegendLabels(java.util.List labels,
                            int legendType)

Append any label information to the list of labels.

Overrides:

getLegendLabels in class ucar.unidata.idv.control.DisplayControlImpl

Parameters:

labels - in/out list of labels

legendType - The type of legend, BOTTOM_LEGEND or SIDE_LEGEND