ucar.unidata.idv
Class DisplayInfo

java.lang.Object
  extended by ucar.unidata.idv.DisplayInfo

public class DisplayInfo
extends 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
DisplayInfo(DisplayControl displayControl, ViewManager viewManager, Displayable displayable)
          Create this display info.
 
Method Summary
 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 setUltimateVisible(boolean v)
          Set the ultimate visible property
 void setViewManager(ViewManager viewManager)
          Set the view manager
 String toString()
          to string
 
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 RemoteException,
                           VisADException
Add this displayInfo to the ViewManager.

Throws:
RemoteException
VisADException

getDisplayableAdded

public boolean getDisplayableAdded()
Has the displayable that this DisplayInfo holds been added to the viewmanager

Returns:
Has the displayable been added.

moveTo

public void moveTo(ViewManager newViewManager)
            throws RemoteException,
                   VisADException
Move the displayable to the newViewManager

Parameters:
newViewManager - The new view manager
Throws:
RemoteException
VisADException

activateDisplay

public void activateDisplay()
                     throws RemoteException,
                            VisADException
Tells the ViewManager to set the display master active

Throws:
RemoteException
VisADException

deactivateDisplay

public void deactivateDisplay()
                       throws RemoteException,
                              VisADException
Tells the ViewManager to set the display master inactive

Throws:
RemoteException
VisADException

removeDisplayable

public void removeDisplayable()
                       throws RemoteException,
                              VisADException
Remove the displayable from the view manager

Throws:
RemoteException
VisADException

toString

public String toString()
to string

Overrides:
toString in class Object
Returns:
to string