ucar.unidata.idv

Class DisplayInfo

java.lang.Object

ucar.unidata.idv.DisplayInfo

public class DisplayInfo
extends java.lang.Object

This class contains the triple: DisplayControl, Displayable and ViewManager. It is held by the ViewManager to know which DisplayControls are displaying in the ViewManager. It is held by the control/DisplayControlImpl to known which Displayable is displayed in which ViewManager.

Author:

IDV development team

Constructor Summary

Constructors

Constructor and Description
DisplayInfo(DisplayControl displayControl, ViewManager viewManager, Displayable displayable) Create this display info.

Method Summary

Modifier and Type	Method and Description
void	activateDisplay() Tells the ViewManager to set the display master active.
void	addDisplayable() Add this displayInfo to the ViewManager.
void	deactivateDisplay() Tells the ViewManager to set the display master inactive
Displayable	getDisplayable() Get the Displayable.
boolean	getDisplayableAdded() Has the displayable that this DisplayInfo holds been added to the viewmanager
DisplayControl	getDisplayControl() Return the DisplayControl
DisplayMaster	getDisplayMaster() Get the DisplayMaster.
boolean	getUltimateVisible() Get the ultimate visible property
ViewManager	getViewManager() Return the ViewManager
void	moveTo(ViewManager newViewManager) Move the displayable to the newViewManager
void	removeDisplayable() Remove the displayable from the view manager
void	setDisplayableAdded(boolean v) Sets the displayable added.
void	setUltimateVisible(boolean v) Set the ultimate visible property
void	setViewManager(ViewManager viewManager) Set the view manager
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DisplayInfo

public DisplayInfo(DisplayControl displayControl,
                   ViewManager viewManager,
                   Displayable displayable)

Create this display info.

Parameters:

displayControl - The display control

viewManager - The view manager

displayable - The displayable

Method Detail

getUltimateVisible

public boolean getUltimateVisible()

Get the ultimate visible property

Returns:

Is displayable visible

setUltimateVisible

public void setUltimateVisible(boolean v)

Set the ultimate visible property

Parameters:

v - Is displayable visible

getDisplayControl

public DisplayControl getDisplayControl()

Return the DisplayControl

Returns:

The display control

getViewManager

public ViewManager getViewManager()

Return the ViewManager

Returns:

The view manager

setViewManager

public void setViewManager(ViewManager viewManager)

Set the view manager

Parameters:

viewManager - The view manager

getDisplayMaster

public DisplayMaster getDisplayMaster()

Get the DisplayMaster. This just gets the display master from the view manager.

Returns:

The display master

getDisplayable

public Displayable getDisplayable()

Get the Displayable.

Returns:

The displayable

addDisplayable

public void addDisplayable()
                    throws java.rmi.RemoteException,
                           visad.VisADException

Add this displayInfo to the ViewManager.

Throws:

java.rmi.RemoteException - the remote exception

visad.VisADException - the VisAD exception

getDisplayableAdded

public boolean getDisplayableAdded()

Has the displayable that this DisplayInfo holds been added to the viewmanager

Returns:

Has the displayable been added.

setDisplayableAdded

public void setDisplayableAdded(boolean v)

Sets the displayable added.

Parameters:

v - the new displayable added

moveTo

public void moveTo(ViewManager newViewManager)
            throws java.rmi.RemoteException,
                   visad.VisADException

Move the displayable to the newViewManager

Parameters:

newViewManager - The new view manager

Throws:

java.rmi.RemoteException - the remote exception

visad.VisADException - the VisAD exception

activateDisplay

public void activateDisplay()
                     throws java.rmi.RemoteException,
                            visad.VisADException

Tells the ViewManager to set the display master active.

Throws:

java.rmi.RemoteException - the remote exception

visad.VisADException - the VisAD exception

deactivateDisplay

public void deactivateDisplay()
                       throws java.rmi.RemoteException,
                              visad.VisADException

Tells the ViewManager to set the display master inactive

Throws:

java.rmi.RemoteException - the remote exception

visad.VisADException - the VisAD exception

removeDisplayable

public void removeDisplayable()
                       throws java.rmi.RemoteException,
                              visad.VisADException

Remove the displayable from the view manager

Throws:

java.rmi.RemoteException - the remote exception

visad.VisADException - the VisAD exception

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object