ucar.unidata.idv.control
Class ValuePlanViewControl

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

All Implemented Interfaces:

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

public class ValuePlanViewControl
extends PlanViewControl

Class for controlling the display of plan view text plots of gridded data.

Version:

$Revision: 1.25 $

Author:

Unidata Development Team

Nested Class Summary

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

DisplayControlImpl.SideLegendLabel

Field Summary

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

currentLevel, currentLevels, currentSlice, datachoice, levelReadout, MACRO_LEVEL, SHARE_LEVEL

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

ValuePlanViewControl()
Default constructor.

Method Summary

protected LinearLatLonSet	calculateLatLonBounds(Rectangle2D screenBounds) Calculate the LatLonBounds based on the VisAD screen bound.
protected DisplayableData	createPlanDisplay() Method to create the particular DisplayableData that this this instance uses for data depictions.
void	editLayoutModel() Popup the station model editor
protected Rectangle2D	getBounds() Get the bounds for the visible portion of the screen.
void	getControlWidgets(List controlWidgets) Add into the given the widgets for the different attributes
boolean	getDeclutter() Get whether this DisplayControl should be decluttered or not.
float	getDeclutterFilter() Get whether this DisplayControl should be decluttered or not.
StationModel	getLayoutModel() Get the current layout model view.
float	getLayoutScale() Get the scale the user can enter
protected float	getScaleFromDisplayable() A utility to get the scale from the dislayable
protected FieldImpl	getSliceForDisplay(FieldImpl slice) Get the slice for the display
protected void	handleChangedStationModel(StationModel changedModel) The station model changed
void	handleDisplayChanged(DisplayEvent evt) Listen for DisplayEvents
void	initDone() Init is done
protected void	loadDataInThread() A utility method that sets the wait cursor and calls loadData in a separate thread .
protected JPanel	makeLayoutModelWidget() Make the gui widget for setting the layout model
void	projectionChanged() Method to call if projection changes.
void	propertyChange(PropertyChangeEvent evt) Property change method.
void	setDeclutter(boolean v) Set whether this DisplayControl should be decluttered or not.
void	setDeclutterFilter(float filter) Set whether the filtering for decluttering.
void	setLayoutModel(StationModel model) Set the current station model view.
void	setLayoutScale(float f) Set the scale the user can enter

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

addDisplaySettings, addLabelMacros, addTopographyMap, addToRangeMenu, applySkipFactor, canExportData, doMakeContents, doMakeDataInstance, formatLevel, getColorRangeIndex, getCursorReadoutData, getCursorReadoutInner, getDataProjectionLabel, getDisplayedData, getEditMenuItems, getGridDisplayable, getIgnoreVerticalDimension, getLegendLabels, getLevel, getLevelColorRange, getLevelsLabel, getMacroNames, getMultipleIsTopography, getPlanDisplay, haveLevels, haveMultipleFields, init, loadDataAtLevel, receiveShareData, setData, setDataSelectionLevel, setIgnoreVerticalDimension, setLevel, setLevelFromUser, setLevelReadoutLabel, setLevels, setMultipleIsTopography, setSettingsLevel, shouldShowLevelWidget, shouldShowZSelector, shouldUseZPosition

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

actionPerformed, addTopographyMap, convertColorRange, doMakeContourLevelControl, doMakeLevelControl, doMakeLevelControl, getColorParamName, getColorRangeFromData, getColorUnit, getContourInfo, getDataProjection, getDefaultContourInfo, getDisplayUnit, getGridDataInstance, getInitialColorTable, getInitialRange, getRawDataUnit, initializeDefaultContourInfo, isDisplayUnitAlsoColorUnit, setLevel

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

activateDisplays, addAttributedDisplayable, addAttributedDisplayable, addAttributedDisplayable, addAttributeFlags, addCheckBoxSettings, addDataChoice, addDisplayable, addDisplayable, addDisplayable, addDisplayable, addDisplayable, addDisplayable, addDisplayMaster, addNewData, addNoteText, addPropertiesComponents, addPropertyChangeListener, addSharable, addToRangeMenu, addToRangeMenu, addViewManager, appendDataChoices, applyAttributesToDisplayables, applyColor, applyColorScaleInfo, applyColorTable, applyColorUnit, applyContourInfo, applyDisplaySetting, applyDisplayUnit, applyLineWidth, applyPreferences, applyProperties, applyProperties, applyPropertyValues, applyRange, applySelectRange, applyTimeRange, applyZPosition, boundsClose, canBeDocked, 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, 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, getCursorReadout, getDataChoice, getDataChoices, getDataInstance, getDataInstance, getDataProjectionForMenu, getDataSelection, getDataSources, getDataTimeRange, getDataTimeRange, getDataTimeSet, getDebugDetails, getDefaultColorScaleInfo, getDefaultDistanceUnit, getDefaultFastRendering, getDefaultSamplingMode, getDefaultSamplingModeValue, getDefaultView, getDefaultViewDescriptor, getDefaultViewManager, getDetailsContents, getDisplayAltitudeType, getDisplayCategory, getDisplayCenter, getDisplayConventions, getDisplayId, getDisplayInfos, getDisplayListColor, getDisplayListData, getDisplayListDisplayable, getDisplayListTemplate, getDisplayMaster, getDisplayName, getDisplayScale, getDisplayUnit, getDisplayUnitName, getDisplayVisibility, getDoCursorReadout, getEditMenuItems, getExpandedInTabs, getExtraLabelTemplate, getExtraLegendComponent, getExtraMenus, getFileMenuItems, getFileMenuItems, getGraphicsConfiguration, getHadDataChoices, getHaveInitialized, getHelpIds, getHelpMenuItems, getId, getIdv, getImage, getImage, getInitDataChoices, getInitialZPosition, getLabel, getLastFileMenuItems, getLegendButtons, getLegendComponent, getLegendLabel, getLegendLabelTemplate, getLegendToolTip, getLineWidth, getLineWidthWidget, getLineWidthWidgetLabel, getLockVisibilityToggle, getLongParamName, 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, handleWindowClosing, hasMapProjection, haveDataTimes, haveParameterDefaults, hide, hyperlinkUpdate, init, init, init, initAfterUnPersistence, initAfterUnPersistence, initAsPrototype, initAsTemplate, initBasic, initializeWithNewData, initWindow, isDisplay3D, isGuiShown, isInitDone, isInTransectView, isInViewManager, itemStateChanged, makeChangeColorMenuItems, makeLegendLabel, makeLockButton, makeRemoveButton, moveTo, notifyViewManagersOfChange, parseProperties, popup, popupDataDialog, popupDataDialog, popupDataDialog, processRequestProperties, putTransientProperty, 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, 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

Constructor Detail

ValuePlanViewControl

public ValuePlanViewControl()

Default constructor. Sets the attribute flags used by this particular PlanViewControl

Method Detail

createPlanDisplay

protected DisplayableData createPlanDisplay()
                                     throws VisADException,
                                            RemoteException

Method to create the particular DisplayableData that this this instance uses for data depictions.

Specified by:

createPlanDisplay in class PlanViewControl

Returns:

Contour2DDisplayable for this instance.

Throws:

RemoteException - Java RMI error

VisADException - VisAD Error

initDone

public void initDone()

Init is done

Overrides:

initDone in class DisplayControlImpl

propertyChange

public void propertyChange(PropertyChangeEvent evt)

Property change method.

Specified by:

propertyChange in interface PropertyChangeListener

Overrides:

propertyChange in class PlanViewControl

Parameters:

evt - event to act on

handleChangedStationModel

protected void handleChangedStationModel(StationModel changedModel)

The station model changed

Parameters:

changedModel - The changed station model_

handleDisplayChanged

public void handleDisplayChanged(DisplayEvent evt)

Listen for DisplayEvents

Overrides:

handleDisplayChanged in class DisplayControlImpl

Parameters:

evt - The event

projectionChanged

public void projectionChanged()

Method to call if projection changes. This will reset the viewScape, bounds and llBounds held by this object and then load data

Specified by:

projectionChanged in interface DisplayControl

Overrides:

projectionChanged in class PlanViewControl

getControlWidgets

public void getControlWidgets(List controlWidgets)
                       throws VisADException,
                              RemoteException

Add into the given the widgets for the different attributes

Overrides:

getControlWidgets in class PlanViewControl

Parameters:

controlWidgets - List of ControlWidgets to add into

Throws:

RemoteException

VisADException

loadDataInThread

protected void loadDataInThread()

A utility method that sets the wait cursor and calls loadData in a separate thread .

getSliceForDisplay

protected FieldImpl getSliceForDisplay(FieldImpl slice)
                                throws VisADException

Get the slice for the display

Overrides:

getSliceForDisplay in class PlanViewControl

Parameters:

slice - slice to use

Returns:

slice with skip value applied

Throws:

VisADException - problem subsetting the slice

setLayoutModel

public void setLayoutModel(StationModel model)

Set the current station model view.

Parameters:

model - station model layout

getLayoutModel

public StationModel getLayoutModel()

Get the current layout model view.

Returns:

station model layout

getLayoutScale

public float getLayoutScale()

Get the scale the user can enter

Returns:

The scale

setLayoutScale

public void setLayoutScale(float f)

Set the scale the user can enter

Parameters:

f - The scale

setDeclutter

public void setDeclutter(boolean v)

Set whether this DisplayControl should be decluttered or not. Used by XML persistence.

Parameters:

v - true to declutter

getDeclutter

public boolean getDeclutter()

Get whether this DisplayControl should be decluttered or not.

Returns:

true if set to declutter

setDeclutterFilter

public void setDeclutterFilter(float filter)

Set whether the filtering for decluttering. Used by XML persistence.

Parameters:

filter - value of 1 (default) for no overlap (default). 0 < filter < 1 allows some data overlap. filter > 1 causes data to be more widely spaced.

getDeclutterFilter

public float getDeclutterFilter()

Get whether this DisplayControl should be decluttered or not.

Returns:

weighting for decluttering.

editLayoutModel

public void editLayoutModel()

Popup the station model editor

getScaleFromDisplayable

protected float getScaleFromDisplayable()

A utility to get the scale from the dislayable

Returns:

The scale

makeLayoutModelWidget

protected JPanel makeLayoutModelWidget()

Make the gui widget for setting the layout model

Returns:

the widget

getBounds

protected Rectangle2D getBounds()

Get the bounds for the visible portion of the screen.

Returns:

bounds in VisAD screen coordinates.

calculateLatLonBounds

protected LinearLatLonSet calculateLatLonBounds(Rectangle2D screenBounds)

Calculate the LatLonBounds based on the VisAD screen bound. This uses the projection for the navigated display and the screen bounds

Parameters:

screenBounds - VisAD screen bounds.

Returns:

LinearLatLonSet of screen bounds in lat/lon coordinates.