Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

org.mitre.cvw
Class WindowMgr  view WindowMgr download WindowMgr.java

java.lang.Object
  extended byorg.mitre.cvw.WindowMgr

public class WindowMgr
extends java.lang.Object

This singleton class manages any open window. There is a vector to manage the tool windows and the popup pages window. Currently not used is a vector to manage system windows. To manage windows that represent CVWObjects, a hashtable of hashtables is used, where the object number of the CVWObject is the key into the first hashtable and the value of this element is a hashtable. This second hashtable is contains the window class name as the key and the instance to the window as the value. There is also a pointer to the Whiteboard Manager which has the same functions. This class has the following functions: adding a window, seeing if a window already exists and bringing it to the front, closing a window.

Version:
1.0

Field Summary
(package private)  java.util.Vector allWindows
           
static int OBJECT
           
(package private)  java.util.Hashtable objWindows
           
static int PAGE
           
(package private)  java.util.Vector pageWindows
           
static int SYSTEM
           
(package private)  java.util.Vector sysWindows
           
static int TOOL
           
(package private)  java.util.Vector toolWindows
           
(package private)  WBMgr wbMgr
           
static int WHITEBOARD
           
private static WindowMgr windowMgr
           
 
Constructor Summary
(package private) WindowMgr()
          Constructor
 
Method Summary
 void addObjectWindow(int type, java.awt.Window win, CVWObjNum oNum)
          Adds a window which is representing an object.
 void addWBWindow(CVWWhiteboard wb)
          Adds a whiteboard window.
 void addWindow(int type, java.awt.Window win)
          Adds a window given a defined window type, except object and whiteboard windows.
 void clearAllWindows()
          Clears all window vectors and hashtables.
 void closeAllObjInRoom()
          Closes all object windows that were opened in the room.
 void closeAllObjWindows()
          Closes all object windows.
 void closeAllWBInRoom()
          Closes all opened whiteboards which are located in the room.
 void closeAllWindows()
          Closes all windows.
 void closeAllWindows(java.util.Enumeration e)
          Closes all windows given an enumeration of windows to be closed.
 int countAllPages()
          Returns the number of popup windows currently opened.
 java.awt.Window findObjectWindow(java.lang.String className, CVWObjNum objNum)
          Returns the instance of a window given the object number it represents and the class name desired.
 java.awt.Window findToolWindow(java.lang.String className)
          Returns the tool window if it has been registered.
static WindowMgr getInstance()
          Returns the current instance of the window manager.
 java.awt.Window getObjectWindow(java.lang.String className, CVWObjNum objNum)
          Returns the window if it is registered and currently visible.
static WindowMgr getWindowMgr()
          Deprecated. see getInstance()
 boolean objectWindowExists(java.lang.String className, CVWObjNum objNum)
          Returns whether the window requested is visible
 boolean removeObjectWindow(java.awt.Window win, CVWObjNum oNum)
          Removes a registered window from the list of windows associatied with an CVWObject.
 boolean removeToolWindow(java.awt.Frame win)
          Remove a tool window from the registered list.
 void removeWhiteboardWindow(CVWWhiteboard wb)
          Removes a whiteboard window given a whiteboard CVWObject
private static void setWindowMgr(WindowMgr winmgr)
          Sets the current instance of the window manager.
 void showAllObjWindows()
          Brings all object windows to the front, removing windows that are no longer visible that didnot unregister with the window manager.
 void showAllPages()
          Brings all popup page windows to the front.
 void showAllSystem()
          Brings all system windows to the front (CURRENTLY NOT USED).
 void showAllTools()
          Brings all tool windows to the front.
 void showAllWBWindows()
          Brings all whiteboard windows to the front.
 void showAllWindows()
          Brings all registered to the front.
 void showAllWindows(int type)
          Brings the specified windows to the front.
 void showAllWindows(java.util.Vector v)
          Given a vector of windows, it brings them all to the front, removing windows that are no longer visible that didnot unregister with the window manager.
 boolean toolWindowExists(java.lang.String className)
          Returns whether the window has been registered and is visible.
 boolean whiteboardWindowExists(CVWWhiteboard wbObject)
          Returns whether the whiteboard is currently open.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

PAGE

public static final int PAGE
See Also:
Constant Field Values

SYSTEM

public static final int SYSTEM
See Also:
Constant Field Values

OBJECT

public static final int OBJECT
See Also:
Constant Field Values

TOOL

public static final int TOOL
See Also:
Constant Field Values

WHITEBOARD

public static final int WHITEBOARD
See Also:
Constant Field Values

windowMgr

private static WindowMgr windowMgr

pageWindows

java.util.Vector pageWindows

sysWindows

java.util.Vector sysWindows

toolWindows

java.util.Vector toolWindows

objWindows

java.util.Hashtable objWindows

wbMgr

WBMgr wbMgr

allWindows

java.util.Vector allWindows
Constructor Detail

WindowMgr

WindowMgr()
Constructor

Method Detail

getInstance

public static WindowMgr getInstance()
Returns the current instance of the window manager.


getWindowMgr

public static WindowMgr getWindowMgr()
Deprecated. see getInstance()

Returns the current instance of the window manager. Should be getInstance().


setWindowMgr

private static void setWindowMgr(WindowMgr winmgr)
Sets the current instance of the window manager.


addWindow

public void addWindow(int type,
                      java.awt.Window win)
Adds a window given a defined window type, except object and whiteboard windows.


addObjectWindow

public void addObjectWindow(int type,
                            java.awt.Window win,
                            CVWObjNum oNum)
Adds a window which is representing an object.


addWBWindow

public void addWBWindow(CVWWhiteboard wb)
Adds a whiteboard window.


showAllPages

public void showAllPages()
Brings all popup page windows to the front.


showAllSystem

public void showAllSystem()
Brings all system windows to the front (CURRENTLY NOT USED).


showAllTools

public void showAllTools()
Brings all tool windows to the front.


showAllWindows

public void showAllWindows()
Brings all registered to the front.


showAllWindows

public void showAllWindows(int type)
Brings the specified windows to the front.


showAllWindows

public void showAllWindows(java.util.Vector v)
Given a vector of windows, it brings them all to the front, removing windows that are no longer visible that didnot unregister with the window manager.


showAllObjWindows

public void showAllObjWindows()
Brings all object windows to the front, removing windows that are no longer visible that didnot unregister with the window manager.


showAllWBWindows

public void showAllWBWindows()
Brings all whiteboard windows to the front.


clearAllWindows

public void clearAllWindows()
Clears all window vectors and hashtables.


closeAllWindows

public void closeAllWindows()
Closes all windows.


closeAllWindows

public void closeAllWindows(java.util.Enumeration e)
Closes all windows given an enumeration of windows to be closed.


closeAllObjWindows

public void closeAllObjWindows()
Closes all object windows.


closeAllObjInRoom

public void closeAllObjInRoom()
Closes all object windows that were opened in the room.


findObjectWindow

public java.awt.Window findObjectWindow(java.lang.String className,
                                        CVWObjNum objNum)
Returns the instance of a window given the object number it represents and the class name desired.


objectWindowExists

public boolean objectWindowExists(java.lang.String className,
                                  CVWObjNum objNum)
Returns whether the window requested is visible


getObjectWindow

public java.awt.Window getObjectWindow(java.lang.String className,
                                       CVWObjNum objNum)
Returns the window if it is registered and currently visible.


whiteboardWindowExists

public boolean whiteboardWindowExists(CVWWhiteboard wbObject)
Returns whether the whiteboard is currently open.


findToolWindow

public java.awt.Window findToolWindow(java.lang.String className)
Returns the tool window if it has been registered.


toolWindowExists

public boolean toolWindowExists(java.lang.String className)
Returns whether the window has been registered and is visible.


removeToolWindow

public boolean removeToolWindow(java.awt.Frame win)
Remove a tool window from the registered list.


removeObjectWindow

public boolean removeObjectWindow(java.awt.Window win,
                                  CVWObjNum oNum)
Removes a registered window from the list of windows associatied with an CVWObject.


closeAllWBInRoom

public void closeAllWBInRoom()
Closes all opened whiteboards which are located in the room.


removeWhiteboardWindow

public void removeWhiteboardWindow(CVWWhiteboard wb)
Removes a whiteboard window given a whiteboard CVWObject


countAllPages

public int countAllPages()
Returns the number of popup windows currently opened.