ucar.unidata.idv.control
Class GridDisplayControl

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

All Implemented Interfaces:

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

Direct Known Subclasses:

BaseImageControl, ColorRadarVolumeControl, CrossSectionControl, JythonControl, LineProbeControl, PlanViewControl, TemplateControl, ThreeDSurfaceControl, TopographyControl, TrackControl, VolumeRenderControl

public abstract class GridDisplayControl
extends DisplayControlImpl

Class with methods used by a DisplayControlImpl. For gridded data.

Version:

$Revision: 1.107 $

Author:

Unidata Development Team

Nested Class Summary

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

DisplayControlImpl.SideLegendLabel

Field Summary

static String	CMD_CONTOURDIALOG command for showing cont level dialog
static String	CMD_SETLEVELS flag for the set levels command
protected GridDataInstance	gridDataInstance Deprecated. Should use getGridDataInstance
static String	INITIAL_PROBE_EARTHLOCATION Key for setting intial probe position
protected static LogUtil.LogCategory	log_ logging category
protected boolean	settingLevel flag for setting levels

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, 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_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, SIDE_LEGEND

Constructor Summary

GridDisplayControl()
cstr does nothing yet; usually made from a subclass.

Method Summary

void	actionPerformed(ActionEvent event) Deal with action event commands from the levels and contours buttons made by this class.
protected void	addTopographyMap(int typeIndex) Add a topography map for the parameter at the specified index
Range	convertColorRange(Range rawRange) Utility to convert the given raw data range into the display units
JButton	doMakeContourLevelControl() Deprecated. Don't use this, rely on the
protected DataInstance	doMakeDataInstance(DataChoice dataChoice) Create the GridDataInstance from the dataChoice.
JComboBox	doMakeLevelControl() Make and return a JComboBox with all native raw grid levels to choose, from the current getGridDataInstance(), if any.
JComboBox	doMakeLevelControl(Real[] levels) Make and return a JComboBox with the supplied "levels" to choose from; see action commmand "levels".
protected String	getColorParamName() Get the parameter name for color.
Range	getColorRangeFromData() Return the range attribute of the colorTable (if non-null) else return null;
protected int	getColorRangeIndex() Returns the index to use in the GridDataInstance array of ranges for color ranges.
protected Unit	getColorUnit() By default we color by the second index (if it is defined)
ContourInfo	getContourInfo() Get the contour information for any contours
protected Data	getCursorReadoutData()
protected List	getCursorReadoutInner(EarthLocation el, Real animationValue, int animationStep) Get the list of items, subclasses should override
MapProjection	getDataProjection() Get MapProjection of data to display.
protected ContourInfo	getDefaultContourInfo() Get the default contour info to use
Unit	getDisplayUnit() Get the unit for the data display.
GridDataInstance	getGridDataInstance() A utility to cast the getDataInstance as a GridDataInstance
protected ColorTable	getInitialColorTable() Override superclass method to get the initial color table.
protected Range	getInitialRange() Return the default range
Unit	getRawDataUnit() Get the raw data unit.
protected boolean	haveMultipleFields() Return whether the Data held by this display control contains multiple fields (e.g., for the isosurface colored by another parameter
protected void	initializeDefaultContourInfo(ContourInfo contourInfo) A hook for derived classes to set any state.
protected boolean	isDisplayUnitAlsoColorUnit() See if the display unit is also the color unit
void	setLevel(Real r) Does nothing yet.
void	setLevel(Real l, JComboBox levelBox) Set the value "l" in the level combo box "levelBox."
protected void	setLevelFromUser(Real pl) The user has changed the level

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, 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, doMakeContents, doMakeMenuBar, doMakeMenuBarMenus, doMakeRemoveControl, doMakeSideLegendComponent, doMakeSkipFactorSlider, doMakeVisibilityControl, doMakeWidgetComponent, doMakeWindow, doMakeZPositionSlider, doRemove, 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, getColorUnitName, getColorWidgetLabel, getComponentHolder, getContents, getControlChangeSleepTime, getControlContext, getControlWidgets, getCursorReadout, getDataChoice, getDataChoices, getDataInstance, getDataInstance, 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, getDisplayUnitName, getDisplayVisibility, getDoCursorReadout, getEditMenuItems, getEditMenuItems, getExpandedInTabs, getExtraLabelTemplate, getExtraLegendComponent, getExtraMenus, getFileMenuItems, getFileMenuItems, getGraphicsConfiguration, getHadDataChoices, getHaveInitialized, getHelpIds, getHelpMenuItems, getId, getIdv, getImage, getImage, getInitDataChoices, getInitialZPosition, getLabel, getLastFileMenuItems, getLegendButtons, getLegendComponent, getLegendLabel, getLegendLabels, 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, getRequestProperties, getSamplingModeName, 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, handleDisplayChanged, handleWindowClosing, hasMapProjection, haveDataTimes, haveParameterDefaults, hide, hyperlinkUpdate, init, init, init, init, initAfterUnPersistence, initAfterUnPersistence, initAsPrototype, initAsTemplate, initBasic, initDone, initializeWithNewData, initWindow, isDisplay3D, 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, 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, shouldAddAnimationListener, shouldAddControlListener, shouldAddDisplayListener, shouldApplyFastRendering, shouldBeDocked, shouldWindowBeVisible, show, showColorControlWidget, showColorDialog, showColorDialog, showColorScaleDialog, showColorScales, showColorSwatches, showContourPropertiesDialog, showDetails, showDisplaySettingsDialog, showHelp, showLegendMenu, showNormalCursor, showProperties, showTimeRangeDialog, showWaitCursor, timeChanged, toFront, toggleNoteTextArea, 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, 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

CMD_SETLEVELS

public static final String CMD_SETLEVELS

flag for the set levels command

See Also:

Constant Field Values

CMD_CONTOURDIALOG

public static final String CMD_CONTOURDIALOG

command for showing cont level dialog

See Also:

Constant Field Values

log_

protected static LogUtil.LogCategory log_

logging category

settingLevel

protected boolean settingLevel

flag for setting levels

INITIAL_PROBE_EARTHLOCATION

public static final String INITIAL_PROBE_EARTHLOCATION

Key for setting intial probe position

See Also:

Constant Field Values

gridDataInstance

protected GridDataInstance gridDataInstance

Deprecated. Should use getGridDataInstance

For legacy code.

Constructor Detail

GridDisplayControl

public GridDisplayControl()

cstr does nothing yet; usually made from a subclass.

Method Detail

getGridDataInstance

public GridDataInstance getGridDataInstance()

A utility to cast the getDataInstance as a GridDataInstance

Returns:

the GridDataInstance

getCursorReadoutData

protected Data getCursorReadoutData()
                             throws Exception

Throws:

Exception

getCursorReadoutInner

protected List getCursorReadoutInner(EarthLocation el,
                                     Real animationValue,
                                     int animationStep)
                              throws Exception

Description copied from class: DisplayControlImpl

Get the list of items, subclasses should override

Overrides:

getCursorReadoutInner in class DisplayControlImpl

Parameters:

el - location of cursor

animationValue - animation value

animationStep - animation step

Returns:

list of strings for readout

Throws:

Exception - problem getting at the data

getInitialColorTable

protected ColorTable getInitialColorTable()

Override superclass method to get the initial color table.

Overrides:

getInitialColorTable in class DisplayControlImpl

Returns:

color table for the parameter

haveMultipleFields

protected boolean haveMultipleFields()

Return whether the Data held by this display control contains multiple fields (e.g., for the isosurface colored by another parameter

Returns:

true if there are multiple fields

isDisplayUnitAlsoColorUnit

protected boolean isDisplayUnitAlsoColorUnit()

See if the display unit is also the color unit

Overrides:

isDisplayUnitAlsoColorUnit in class DisplayControlImpl

Returns:

true if the units are the same

getColorParamName

protected String getColorParamName()

Get the parameter name for color.

Returns:

color parameter name

getInitialRange

protected Range getInitialRange()
                         throws RemoteException,
                                VisADException

Return the default range

Overrides:

getInitialRange in class DisplayControlImpl

Returns:

the default range.

Throws:

RemoteException - Java RMI error

VisADException - VisAD Error

doMakeDataInstance

protected DataInstance doMakeDataInstance(DataChoice dataChoice)
                                   throws RemoteException,
                                          VisADException

Create the GridDataInstance from the dataChoice. Set the dataInstance and its paramName in the superclass member data. Returns whether the dataInstance is ok.

Overrides:

doMakeDataInstance in class DisplayControlImpl

Parameters:

dataChoice - data choice defining the data

Returns:

the data instance

Throws:

RemoteException - Java RMI error

VisADException - VisAD Error

getColorRangeIndex

protected int getColorRangeIndex()

Returns the index to use in the GridDataInstance array of ranges for color ranges. The default is 1 though if there is not more than one field in the range then we end up with the 0th value.

Returns:

1

getRawDataUnit

public Unit getRawDataUnit()

Get the raw data unit.

Overrides:

getRawDataUnit in class DisplayControlImpl

Returns:

unit for the data values

getDefaultContourInfo

protected ContourInfo getDefaultContourInfo()

Get the default contour info to use

Returns:

default contour info to use

initializeDefaultContourInfo

protected void initializeDefaultContourInfo(ContourInfo contourInfo)

A hook for derived classes to set any state. ex: color filled contours turn off labels

Parameters:

contourInfo - The contour info to initialize

getContourInfo

public ContourInfo getContourInfo()

Get the contour information for any contours

Overrides:

getContourInfo in class DisplayControlImpl

Returns:

the contour information

getColorUnit

protected Unit getColorUnit()

By default we color by the second index (if it is defined)

Overrides:

getColorUnit in class DisplayControlImpl

Returns:

the unit for the color parameter

getDisplayUnit

public Unit getDisplayUnit()

Get the unit for the data display.

Overrides:

getDisplayUnit in class DisplayControlImpl

Returns:

unit to use for displaying the data

setLevel

public void setLevel(Real r)

Does nothing yet. Subclasses should override

Parameters:

r - level for data

setLevelFromUser

protected void setLevelFromUser(Real pl)
                         throws VisADException,
                                RemoteException

The user has changed the level

Parameters:

pl - The new level

Throws:

RemoteException - On badness

VisADException - On badness

getColorRangeFromData

public Range getColorRangeFromData()

Return the range attribute of the colorTable (if non-null) else return null;

Returns:

The range from the color table attribute

convertColorRange

public Range convertColorRange(Range rawRange)

Utility to convert the given raw data range into the display units

Parameters:

rawRange - Raw data range

Returns:

Converted range

setLevel

public void setLevel(Real l,
                     JComboBox levelBox)

Set the value "l" in the level combo box "levelBox."

Parameters:

l - the level

levelBox - the level box

doMakeContourLevelControl

public JButton doMakeContourLevelControl()

Deprecated. Don't use this, rely on the

Make and return a JButton which will summon a ContlevelDialog;

Returns:

the action button

doMakeLevelControl

public JComboBox doMakeLevelControl()

Make and return a JComboBox with all native raw grid levels to choose, from the current getGridDataInstance(), if any.

Returns:

the combobox

doMakeLevelControl

public JComboBox doMakeLevelControl(Real[] levels)

Make and return a JComboBox with the supplied "levels" to choose from; see action commmand "levels".

Parameters:

levels - the levels to populat the combo box with

Returns:

the combo box

addTopographyMap

protected void addTopographyMap(int typeIndex)
                         throws VisADException,
                                RemoteException

Add a topography map for the parameter at the specified index

Parameters:

typeIndex - index of the RealType to use

Throws:

RemoteException - Java RMI problem

VisADException - Unable to set the ScalarMap

actionPerformed

public void actionPerformed(ActionEvent event)

Deal with action event commands from the levels and contours buttons made by this class.

Specified by:

actionPerformed in interface ActionListener

Overrides:

actionPerformed in class DisplayControlImpl

Parameters:

event - event to handle

getDataProjection

public MapProjection getDataProjection()

Get MapProjection of data to display. Override the superclass method because we have more info for this type of data

Specified by:

getDataProjection in interface DisplayControl

Overrides:

getDataProjection in class DisplayControlImpl

Returns:

The native projection of the data