ucar.unidata.idv
Class NavigatedViewManager

java.lang.Object
  ucar.unidata.collab.SharableImpl
      ucar.unidata.idv.ViewManager
          ucar.unidata.idv.NavigatedViewManager

All Implemented Interfaces:

ActionListener, ItemListener, EventListener, Sharable, ControlListener, DisplayListener

Direct Known Subclasses:

MapViewManager, TransectViewManager

public abstract class NavigatedViewManager
extends ViewManager

Author:

IDV development team

Nested Class Summary

Nested classes/interfaces inherited from class ucar.unidata.idv.ViewManager

ViewManager.MatrixCommand

Field Summary

static String	CMD_NAV_DOWN Action command to pan down
static String	CMD_NAV_HOME Action command to reset zoom and pan
static String	CMD_NAV_LEFT Action command to pan left
static String	CMD_NAV_RIGHT Action command to pan right
static String	CMD_NAV_ROTATELEFT Action command to rotate
static String	CMD_NAV_ROTATERIGHT Action command to rotate
static String	CMD_NAV_SMALLDOWN Action command to pan down
static String	CMD_NAV_SMALLLEFT Action command to pan left
static String	CMD_NAV_SMALLRIGHT Action command to pan right
static String	CMD_NAV_SMALLROTATELEFT Action command to rotate
static String	CMD_NAV_SMALLROTATERIGHT Action command to rotate
static String	CMD_NAV_SMALLTILTDOWN Action command to tilt
static String	CMD_NAV_SMALLTILTUP Action command to tilt
static String	CMD_NAV_SMALLUP Action command to pan up
static String	CMD_NAV_SMALLZOOMIN Action command to zoom in
static String	CMD_NAV_SMALLZOOMOUT Action command to zoom out
static String	CMD_NAV_UP Action command to pan up
static String	CMD_NAV_ZOOMIN Action command to zoom in
static String	CMD_NAV_ZOOMOUT Action command to zoom out
protected CursorReadoutWindow	cursorReadoutWindow _more_
static String	PROP_VERTICALRANGE Vertical range property
static String	SHARE_MATRIX Defines the viewpoint matrix when sharing state
static double	TRANSLATE_FACTOR How far do we zoom on a zoom in or out
static double	ZOOM_FACTOR How far do we zoom on a zoom in or out

Fields inherited from class ucar.unidata.idv.ViewManager

animationHolder, animationMenu, borderHighlightColor, borderWidth, clickToFocus, displayBounds, fullScreenWindow, highlightBorder, innerContents, lastActive, lastTimeActivated, nameLabel, normalBorder, PREF_3DCLIP, PREF_ANIREADOUT, PREF_BGCOLOR, PREF_BORDERCOLOR, PREF_DIMENSION, PREF_DISPLAYLISTCOLOR, PREF_DISPLAYLISTFONT, PREF_FGCOLOR, PREF_PREFIX, PREF_SHAREVIEWS, PREF_SHOWANIMATIONBOXES, PREF_SHOWBOTTOMLEGEND, PREF_SHOWCURSOR, PREF_SHOWDISPLAYLIST, PREF_SHOWSCALES, PREF_SHOWSIDELEGEND, PREF_SHOWTOOLBAR, PREF_SHOWTRANSECTSCALES, PREF_TOOLBARSFLOATABLE, PREF_WAITMSG, PREF_WIREFRAME, showControlLegend, showControlMenu, TAG_COLORPAIR, TAG_COLORPAIRS, toolbarIds, toolbarNames, toolbars, windowBounds

Constructor Summary

NavigatedViewManager()
Default constructor

NavigatedViewManager(ViewContext viewContext)
Construct a NavigatedViewManager from an IDV

NavigatedViewManager(ViewContext viewContext, ViewDescriptor desc, String properties)
Construct a NavigatedViewManager with the specified params

Method Summary

void	actionPerformed(ActionEvent event) Required interface for ActionEvents, to implement ActionListener for the UI objects such as JButton-s and MenuItem-s
protected void	addPropertiesComponents(JTabbedPane tabbedPane) Add components to the properties dialog
protected void	animationTimeChanged() The time changed
void	applyPreferences() Apply preferences
boolean	applyProperties() Apply properties.
protected void	checkHistoryMatrix() Check the matrix history.
void	destroy() Cleanup when destroying this object.
void	displayChanged(DisplayEvent de) An implementation of the the DisplayListener interface.
Component	doMakeViewPointToolBar(int orientation) Creates the Viewpoint Toolbar in the specified orientation.
protected Component	doMakeZoomPanToolBar(int orientation) Creates the Zoom/Pan Toolbar in the specified orientation.
boolean	getClipping() Get the 3d clipping flag
protected void	getInitialBooleanProperties(List props) Get the intial BooleanProperty-s
boolean	getLabelsVisible() Get the show vertical scale flag
NavigatedDisplay	getNavigatedDisplay() Get the NavigatedDisplay associated with this ViewManager
boolean	getShowCursor() Get the show cursor readout flag
boolean	getTransectLabelsVisible() Get the show vertical scale flag
double[]	getVerticalRange() Get the min/max used for the vertical range.
Unit	getVerticalRangeUnit() Get the Unit used for the vertical range.
protected ViewpointControl	getViewpointControl() Get the viewpoint control for this view manager.
protected void	handleBooleanPropertyChange(String id, boolean value) The BooleanProperty identified byt he given id has changed.
protected void	handleControlChanged(ControlEvent e) Respond to ControlEvents.
protected boolean	hasViewpointControl() Has a viewpoint control
protected void	init() Initialize this object.
protected void	initToolBars() Initialize the toolbars for the GUI
protected void	initWithInner(ViewManager that, boolean ignoreWindow) Initialize this object's state with the state from that.
protected JMenu	makeShowMenu() Create and return the show menu.
protected void	matrixChanged() Handle the change to the matrix
protected void	perspectiveViewChanged(boolean v) Handle a perspective view change
void	receiveShareData(Sharable from, Object dataId, Object[] data) Handle the receipt of shared data
void	setClipping(boolean value) Set the clipping flag
protected void	setDisplayMaster(DisplayMaster master) Set the DisplayMaster
void	setLabelsVisible(boolean value) Set the show vertical scale flag
protected void	setReadoutFormat() Set the format for the curso readout
void	setShowCursor(boolean value) Set the show cursor flag
void	setTransectLabelsVisible(boolean value) Set the show vertical scale flag
void	setVerticalRange(double[] r) Set the min/max used for the vertical range.
void	setVerticalRangeUnit(Unit u) Set the Unit used for the vertical range.
protected void	setVerticalRangeUnitPreference(NavigatedDisplay nd) Set the vertical range unit from the preference
void	setWindow(IdvWindow w) Set the window that this ViewManager is shown in.
protected void	verticalRangeChanged() Handle a change to the vertical range
protected void	verticalScaleChanged() handle a vertical scale change

Methods inherited from class ucar.unidata.idv.ViewManager

addBooleanProperty, addCommand, addContextMenuItems, addDisplayInfo, addDisplayListener, addToolBar, addViewDescriptor, adjustSplitPane, animationOk, aspectSliderChanged, canBe, checkToolBarVisibility, clearDisplays, clearImageGrabber, controlChanged, createCBMI, displayControlChanged, displayControlVisibilityChanged, doClose, doDrop, doMakeContents, doMakeDisplayMaster, doMakeMenuBar, doMakeMenuList, doneFirstFrame, doPrintImage, doPublishImage, doPublishImage, doSaveImage, doSaveImage, doSaveImageInThread, doSaveState, fillLegends, fillLegendsInner, fillLegendsLater, firstInitializeViewMenu, getAliases, getAnimation, getAnimationInfo, getAnimationStringVisible, getAnimationTimes, getAnimationWidget, getAniReadout, getAspectPropertiesComponent, getAspectRatio, getBackground, getBooleanPropertiesForPersistence, getBooleanProperty, getBp, getClickToFocus, getCommandManager, getComponent, getContents, getContentsBorder, getControls, getControlsForLegend, getDefaultBackground, getDefaultForeground, getDisplayBounds, getDisplayConventions, getDisplayInfos, getDisplayListColor, getDisplayListFont, getDisplayMatrix, getDisplayRenderer, getDisplayWindow, getExternalAnimation, getExternalAnimationWidget, getForeground, getFullScreenHeight, getFullScreenWidth, getHasWindow, getHaveInitialized, getHighlightBorder, getIdv, getIdvUIManager, getInitDone, getInnerContents, getIsActive, getIsDestroyed, getIsShared, getLastFrameDoneTime, getLastTimeActivated, getLegendOnLeft, getLegendState, getMainPropertiesComponent, getMaster, getMySize, getName, getNormalBorder, getPerspectiveView, getProjectionControl, getProjectionList, getProperties, getPropertiesComponent, getProperty, getPublishManager, getReallyHasWindow, getResourceManager, getShareViews, getShowAnimationBoxes, getShowBottomLegend, getShowControlLegend, getShowDisplayList, getShowSideLegend, getSideComponent, getSideDividerLocation, getSideLegend, getSideLegendContainer, getSkinProperties, getSkinProperty, getStateManager, getStore, getTimelineComponent, getToolbarsFloatable, getTypeName, getUniqueId, getUseFastRendering, getViewDescriptor, getViewManager, getVisibleGeoBounds, getVMManager, getWaitMessageVisible, getWireframe, guiInitializationDone, hasBooleanProperty, hasDisplayMaster, initAfterUnPersistence, initBooleanProperties, initColorMenu, initDisplayMenu, initFromSkin, initializeViewMenu, initPreferences, initUI, initViewStateMenu, initWith, initWith, insertSideLegend, isClassOk, isDefinedBy, isFullScreen, isInteractive, itemStateChanged, keyWasTyped, logException, makeColorMenu, makeDropPanel, makeFrames, makeSavedViewsMenu, makeViewMenu, makeViewStateMenu, notifyDisplayControls, okToImportDisplay, parseProperties, putProperty, reallyFillLegends, removeColorPair, removeDisplayInfo, resetAspectSliders, resetFullScreen, resetProjectionControl, setAliases, setAnimatedVisibility, setAnimationInfo, setAnimationStringVisible, setAniReadout, setAspectRatio, setBackground, setBooleanProperties, setBooleanPropertiesForPersistence, setBp, setClickToFocus, setColors, setContentsBorder, setCursorInDisplay, setDisplayBounds, setDisplayListColor, setDisplayListFont, setDisplayMatrix, setExternalAnimation, setForeground, setFullScreen, setFullScreenHeight, setFullScreenWidth, setHasWindow, setHighlightBorder, setIdv, setInitialSplitPaneLocation, setIsShared, setLastActive, setLegendOnLeft, setLegendState, setLegendState, setMasterActive, setMasterActive, setMasterInactive, setName, setProperties, setShareViews, setShowControlLegend, setShowDisplayList, setShowToolBars, setSideDividerLocation, setSideLegend, setSideLegendPosition, setSize, setSkinProperties, setViewDescriptor, setWaitMessageVisible, setWindowBounds, setWireframe, showColorPairDialog, showHighlight, showLegend, showPropertiesDialog, showTimeline, showWindow, startImageCapture, toFront, toggleFullScreen, toString, turnOnOffAllDisplays, updateDisplayIfNeeded, updateDisplayList, updateNameLabel, useDisplay, useImages, useImages, writeImage, writeImage, writeImage, writeImage, writeImage, writeImage, writeImage, writeTestArchive

Methods inherited from class ucar.unidata.collab.SharableImpl

applySharableProperties, doShare, doShare, doShareExternal, doShareInternal, getSharablePropertiesComponent, getShareGroup, getSharing, initSharable, removeSharable, setShareGroup, setSharing, setUniqueId, showSharableDialog

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

PROP_VERTICALRANGE

public static final String PROP_VERTICALRANGE

Vertical range property

See Also:

Constant Field Values

ZOOM_FACTOR

public static final double ZOOM_FACTOR

How far do we zoom on a zoom in or out

See Also:

Constant Field Values

TRANSLATE_FACTOR

public static final double TRANSLATE_FACTOR

How far do we zoom on a zoom in or out

See Also:

Constant Field Values

CMD_NAV_ZOOMIN

public static final String CMD_NAV_ZOOMIN

Action command to zoom in

See Also:

Constant Field Values

CMD_NAV_ROTATELEFT

public static final String CMD_NAV_ROTATELEFT

Action command to rotate

See Also:

Constant Field Values

CMD_NAV_ROTATERIGHT

public static final String CMD_NAV_ROTATERIGHT

Action command to rotate

See Also:

Constant Field Values

CMD_NAV_ZOOMOUT

public static final String CMD_NAV_ZOOMOUT

Action command to zoom out

See Also:

Constant Field Values

CMD_NAV_HOME

public static final String CMD_NAV_HOME

Action command to reset zoom and pan

See Also:

Constant Field Values

CMD_NAV_RIGHT

public static final String CMD_NAV_RIGHT

Action command to pan right

See Also:

Constant Field Values

CMD_NAV_LEFT

public static final String CMD_NAV_LEFT

Action command to pan left

See Also:

Constant Field Values

CMD_NAV_UP

public static final String CMD_NAV_UP

Action command to pan up

See Also:

Constant Field Values

CMD_NAV_DOWN

public static final String CMD_NAV_DOWN

Action command to pan down

See Also:

Constant Field Values

CMD_NAV_SMALLZOOMIN

public static final String CMD_NAV_SMALLZOOMIN

Action command to zoom in

See Also:

Constant Field Values

CMD_NAV_SMALLROTATELEFT

public static final String CMD_NAV_SMALLROTATELEFT

Action command to rotate

See Also:

Constant Field Values

CMD_NAV_SMALLROTATERIGHT

public static final String CMD_NAV_SMALLROTATERIGHT

Action command to rotate

See Also:

Constant Field Values

CMD_NAV_SMALLTILTUP

public static final String CMD_NAV_SMALLTILTUP

Action command to tilt

See Also:

Constant Field Values

CMD_NAV_SMALLTILTDOWN

public static final String CMD_NAV_SMALLTILTDOWN

Action command to tilt

See Also:

Constant Field Values

CMD_NAV_SMALLZOOMOUT

public static final String CMD_NAV_SMALLZOOMOUT

Action command to zoom out

See Also:

Constant Field Values

CMD_NAV_SMALLRIGHT

public static final String CMD_NAV_SMALLRIGHT

Action command to pan right

See Also:

Constant Field Values

CMD_NAV_SMALLLEFT

public static final String CMD_NAV_SMALLLEFT

Action command to pan left

See Also:

Constant Field Values

CMD_NAV_SMALLUP

public static final String CMD_NAV_SMALLUP

Action command to pan up

See Also:

Constant Field Values

CMD_NAV_SMALLDOWN

public static final String CMD_NAV_SMALLDOWN

Action command to pan down

See Also:

Constant Field Values

SHARE_MATRIX

public static final String SHARE_MATRIX

Defines the viewpoint matrix when sharing state

See Also:

Constant Field Values

cursorReadoutWindow

protected CursorReadoutWindow cursorReadoutWindow

_more_

Constructor Detail

NavigatedViewManager

public NavigatedViewManager()

Default constructor

NavigatedViewManager

public NavigatedViewManager(ViewContext viewContext)

Construct a NavigatedViewManager from an IDV

Parameters:

viewContext - Really the IDV

NavigatedViewManager

public NavigatedViewManager(ViewContext viewContext,
                            ViewDescriptor desc,
                            String properties)
                     throws VisADException,
                            RemoteException

Construct a NavigatedViewManager with the specified params

Parameters:

viewContext - context in which this MVM exists

desc - ViewDescriptor

properties - semicolon separated list of properties (can be null)

Throws:

RemoteException

VisADException

Method Detail

getNavigatedDisplay

public NavigatedDisplay getNavigatedDisplay()

Get the NavigatedDisplay associated with this ViewManager

Returns:

the NavigatedDisplay associated with this ViewManager

setDisplayMaster

protected void setDisplayMaster(DisplayMaster master)

Set the DisplayMaster

Overrides:

setDisplayMaster in class ViewManager

Parameters:

master - The display master

init

protected void init()
             throws VisADException,
                    RemoteException

Initialize this object.

Overrides:

init in class ViewManager

Throws:

RemoteException

VisADException

initWithInner

protected void initWithInner(ViewManager that,
                             boolean ignoreWindow)
                      throws VisADException,
                             RemoteException

Initialize this object's state with the state from that.

Overrides:

initWithInner in class ViewManager

Parameters:

that - The other obejct to get state from

ignoreWindow - If true then don't set the window size and location

Throws:

RemoteException - On badness

VisADException - On badness

applyProperties

public boolean applyProperties()

Apply properties. Override super class to set class specific props.

Overrides:

applyProperties in class ViewManager

Returns:

true if successful

addPropertiesComponents

protected void addPropertiesComponents(JTabbedPane tabbedPane)

Add components to the properties dialog

Overrides:

addPropertiesComponents in class ViewManager

Parameters:

tabbedPane - the tabbed pane to add to

initToolBars

protected void initToolBars()

Initialize the toolbars for the GUI

Overrides:

initToolBars in class ViewManager

hasViewpointControl

protected boolean hasViewpointControl()

Has a viewpoint control

Returns:

true if it does.

getViewpointControl

protected ViewpointControl getViewpointControl()

Get the viewpoint control for this view manager.

Returns:

the ViewpointControl

perspectiveViewChanged

protected void perspectiveViewChanged(boolean v)

Handle a perspective view change

Parameters:

v - true to set to perspective view

verticalScaleChanged

protected void verticalScaleChanged()

handle a vertical scale change

destroy

public void destroy()

Cleanup when destroying this object.

Overrides:

destroy in class ViewManager

receiveShareData

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

Handle the receipt of shared data

Specified by:

receiveShareData in interface Sharable

Overrides:

receiveShareData in class SharableImpl

Parameters:

from - Who is it from

dataId - What is it

data - Here it is

handleControlChanged

protected void handleControlChanged(ControlEvent e)

Respond to ControlEvents.

Overrides:

handleControlChanged in class ViewManager

Parameters:

e - ControlEvent to respond to

displayChanged

public void displayChanged(DisplayEvent de)
                    throws VisADException,
                           RemoteException

An implementation of the the DisplayListener interface. This method turns on/off the wait cursor when it gets a WAIT_ON or WAIT_OFF event. It also, when it receives a FRAME_DONE event for the fist time, calls firstFrameDone on the DisplayControls

Specified by:

displayChanged in interface DisplayListener

Overrides:

displayChanged in class ViewManager

Parameters:

de - The DisplayEvent

Throws:

RemoteException

VisADException

animationTimeChanged

protected void animationTimeChanged()

Description copied from class: ViewManager

The time changed

Overrides:

animationTimeChanged in class ViewManager

matrixChanged

protected void matrixChanged()

Handle the change to the matrix

verticalRangeChanged

protected void verticalRangeChanged()

Handle a change to the vertical range

setReadoutFormat

protected void setReadoutFormat()

Set the format for the curso readout

applyPreferences

public void applyPreferences()

Apply preferences

Overrides:

applyPreferences in class ViewManager

handleBooleanPropertyChange

protected void handleBooleanPropertyChange(String id,
                                           boolean value)
                                    throws Exception

The BooleanProperty identified byt he given id has changed. Apply the change to the display.

Overrides:

handleBooleanPropertyChange in class ViewManager

Parameters:

id - Id of the changed BooleanProperty

value - Its new value

Throws:

Exception - problem handeling the change

getInitialBooleanProperties

protected void getInitialBooleanProperties(List props)

Get the intial BooleanProperty-s

Overrides:

getInitialBooleanProperties in class ViewManager

Parameters:

props - list to add them to.

checkHistoryMatrix

protected void checkHistoryMatrix()

Check the matrix history.

setWindow

public void setWindow(IdvWindow w)

Set the window that this ViewManager is shown in. This adds this object as a WindowListener and sets the bounds of the window if the windowBounds is non-null.

Overrides:

setWindow in class ViewManager

Parameters:

w - The window

doMakeViewPointToolBar

public Component doMakeViewPointToolBar(int orientation)

Creates the Viewpoint Toolbar in the specified orientation.

Parameters:

orientation - orientation of the toolbar (JToolBar.VERTICAL or JToolBar.HORIZONTAL)

Returns:

the toolbar component

doMakeZoomPanToolBar

protected Component doMakeZoomPanToolBar(int orientation)

Creates the Zoom/Pan Toolbar in the specified orientation.

Parameters:

orientation - orientation of the toolbar (JToolBar.VERTICAL or JToolBar.HORIZONTAL)

Returns:

the toolbar component

actionPerformed

public void actionPerformed(ActionEvent event)

Required interface for ActionEvents, to implement ActionListener for the UI objects such as JButton-s and MenuItem-s

Specified by:

actionPerformed in interface ActionListener

Overrides:

actionPerformed in class ViewManager

Parameters:

event - an ActionEvent

makeShowMenu

protected JMenu makeShowMenu()

Create and return the show menu.

Overrides:

makeShowMenu in class ViewManager

Returns:

The Show menu

setShowCursor

public void setShowCursor(boolean value)

Set the show cursor flag

Parameters:

value - The value

getShowCursor

public boolean getShowCursor()

Get the show cursor readout flag

Returns:

The flag value

setLabelsVisible

public void setLabelsVisible(boolean value)

Set the show vertical scale flag

Parameters:

value - The value

getLabelsVisible

public boolean getLabelsVisible()

Get the show vertical scale flag

Returns:

The flag value

setTransectLabelsVisible

public void setTransectLabelsVisible(boolean value)

Set the show vertical scale flag

Parameters:

value - The value

getTransectLabelsVisible

public boolean getTransectLabelsVisible()

Get the show vertical scale flag

Returns:

The flag value

setClipping

public void setClipping(boolean value)

Set the clipping flag

Parameters:

value - The value

getClipping

public boolean getClipping()

Get the 3d clipping flag

Returns:

The flag value

setVerticalRangeUnit

public void setVerticalRangeUnit(Unit u)

Set the Unit used for the vertical range.

Parameters:

u - new unit

getVerticalRangeUnit

public Unit getVerticalRangeUnit()

Get the Unit used for the vertical range.

Returns:

unit of vertical range values

getVerticalRange

public double[] getVerticalRange()

Get the min/max used for the vertical range.

Returns:

array of vertical range values (double[] {min, max})

setVerticalRange

public void setVerticalRange(double[] r)

Set the min/max used for the vertical range.

Parameters:

r - array of vertical range values (double[] {min, max})

setVerticalRangeUnitPreference

protected void setVerticalRangeUnitPreference(NavigatedDisplay nd)
                                       throws VisADException,
                                              RemoteException

Set the vertical range unit from the preference

Parameters:

nd - navigated display to set the unit on

Throws:

RemoteException - problem with remote display

VisADException - problem with local display