WindowManager (LOCI Javadocs 0-SNAPSHOT API)

java.lang.Object
- loci.visbio.LogicManager
- - loci.visbio.WindowManager

All Implemented Interfaces:

WindowListener, EventListener, Saveable
```
public class WindowManager
extends LogicManager
implements WindowListener
```
WindowManager is the manager encapsulating VisBio's window logic, including docking, resizing, minimization and cursor control.

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`distributed` Whether to distribute the menu bar across all registered frames.
`protected Docker`	`docker` Object enabling docking between windows.
`protected boolean`	`docking` Whether window docking features are enabled.
`static String`	`DOCKING` String for window docking option.
`static String`	`HIDE_ALL` String for global minimization option.
`protected boolean`	`hideAll` Whether minimizing main VisBio window hides all other windows.
`protected Vector<Window>`	`visible` List of windows that were visible before VisBio was minimized.
`protected int`	`waiting` Number of queued wait cursors.
`protected Hashtable<Window,WindowInfo>`	`windows` Table for keeping track of registered windows.
`protected Hashtable<String,WindowState>`	`windowStates` Table of window states read during state restore.

Fields inherited from class loci.visbio.LogicManager
bio

Constructor Summary

Constructors
Constructor and Description

WindowManager(VisBioFrame bio)
Constructs a window manager.

Constructors
Constructor and Description
`WindowManager(VisBioFrame bio)` Constructs a window manager.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addWindow(Window w)` Registers a window with the window manager.
`void`	`addWindow(Window w, boolean pack)` Registers a window with the window manager.
`void`	`disposeWindow(Window w)` Removes the window from the window manager and disposes of it.
`void`	`disposeWindows()` Disposes all windows, prior to program exit.
`void`	`doEvent(VisBioEvent evt)` Called to notify the logic manager of a VisBio event.
`protected void`	`doGUI()` Adds window-related GUI components to VisBio.
`protected void`	`doMenuBars(JMenuBar master)` Propagates the given menu bar across all registered frames.
`int`	`getTasks()` Gets the number of tasks required to initialize this logic manager.
`protected WindowInfo`	`getWindowByTitle(String name)` Gets window information about the first window matching the specified window title.
`Window[]`	`getWindows()` Gets a list of windows being handled by the window manager.
`void`	`hideWindows()` Hides all windows.
`void`	`restoreState(Element el)` Restores the current state from the given DOM element ("VisBio").
`void`	`restoreWindows()` Restores all previously hidden windows.
`void`	`saveState(Element el)` Writes the current state to the given DOM element ("VisBio").
`void`	`setDistributedMenus(boolean dist)` Sets whether all registered frames should have a duplicate of the main VisBio menu bar.
`protected void`	`setDocking(boolean docking)` Sets whether window docking features are enabled.
`protected void`	`setHideAll(boolean hideAll)` Sets whether minimizing the main VisBio window hides the other VisBio windows.
`void`	`setWaitCursor(boolean wait)` Toggles the cursor between hourglass and normal pointer mode.
`void`	`showWindow(Window w)` Shows the given window.
`void`	`windowActivated(WindowEvent e)`
`void`	`windowClosed(WindowEvent e)`
`void`	`windowClosing(WindowEvent e)`
`void`	`windowDeactivated(WindowEvent e)`
`void`	`windowDeiconified(WindowEvent e)`
`void`	`windowIconified(WindowEvent e)`
`void`	`windowOpened(WindowEvent e)`

Methods inherited from class loci.visbio.LogicManager
getVisBio

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DOCKING
```
public static final String DOCKING
```
    String for window docking option.
    
    See Also:
    
    Constant Field Values
  - HIDE_ALL
```
public static final String HIDE_ALL
```
    String for global minimization option.
    
    See Also:
    
    Constant Field Values
  - windows
```
protected Hashtable<Window,WindowInfo> windows
```
    Table for keeping track of registered windows.
  - visible
```
protected Vector<Window> visible
```
    List of windows that were visible before VisBio was minimized.
  - waiting
```
protected int waiting
```
    Number of queued wait cursors.
  - docker
```
protected Docker docker
```
    Object enabling docking between windows.
  - docking
```
protected boolean docking
```
    Whether window docking features are enabled.
  - hideAll
```
protected boolean hideAll
```
    Whether minimizing main VisBio window hides all other windows.
  - distributed
```
protected boolean distributed
```
    Whether to distribute the menu bar across all registered frames.
  - windowStates
```
protected Hashtable<String,WindowState> windowStates
```
    Table of window states read during state restore.
- Constructor Detail
  - WindowManager
```
public WindowManager(VisBioFrame bio)
```
    Constructs a window manager.
- Method Detail
  - addWindow
```
public void addWindow(Window w)
```
    Registers a window with the window manager.
  - addWindow
```
public void addWindow(Window w,
                      boolean pack)
```
    Registers a window with the window manager. The pack flag indicates that the window should be packed prior to being shown for the first time.
  - disposeWindow
```
public void disposeWindow(Window w)
```
    Removes the window from the window manager and disposes of it.
  - getWindows
```
public Window[] getWindows()
```
    Gets a list of windows being handled by the window manager.
  - setWaitCursor
```
public void setWaitCursor(boolean wait)
```
    Toggles the cursor between hourglass and normal pointer mode.
  - showWindow
```
public void showWindow(Window w)
```
    Shows the given window. If this is the first time the window has been shown, or the current window position is off the screen, it is packed and placed in a cascading position.
  - hideWindows
```
public void hideWindows()
```
    Hides all windows.
  - restoreWindows
```
public void restoreWindows()
```
    Restores all previously hidden windows.
  - disposeWindows
```
public void disposeWindows()
```
    Disposes all windows, prior to program exit.
  - setDistributedMenus
```
public void setDistributedMenus(boolean dist)
```
    Sets whether all registered frames should have a duplicate of the main VisBio menu bar. This feature is only here to support the Macintosh screen menu bar.
  - doEvent
```
public void doEvent(VisBioEvent evt)
```
    Called to notify the logic manager of a VisBio event.
    
    Overrides:
    
    doEvent in class LogicManager
  - getTasks
```
public int getTasks()
```
    Gets the number of tasks required to initialize this logic manager.
    
    Overrides:
    
    getTasks in class LogicManager
  - windowDeiconified
```
public void windowDeiconified(WindowEvent e)
```
    Specified by:
    
    windowDeiconified in interface WindowListener
  - windowIconified
```
public void windowIconified(WindowEvent e)
```
    Specified by:
    
    windowIconified in interface WindowListener
  - windowActivated
```
public void windowActivated(WindowEvent e)
```
    Specified by:
    
    windowActivated in interface WindowListener
  - windowClosed
```
public void windowClosed(WindowEvent e)
```
    Specified by:
    
    windowClosed in interface WindowListener
  - windowClosing
```
public void windowClosing(WindowEvent e)
```
    Specified by:
    
    windowClosing in interface WindowListener
  - windowDeactivated
```
public void windowDeactivated(WindowEvent e)
```
    Specified by:
    
    windowDeactivated in interface WindowListener
  - windowOpened
```
public void windowOpened(WindowEvent e)
```
    Specified by:
    
    windowOpened in interface WindowListener
  - saveState
```
public void saveState(Element el)
               throws SaveException
```
    Writes the current state to the given DOM element ("VisBio").
    
    Specified by:
    
    saveState in interface Saveable
    
    Overrides:
    
    saveState in class LogicManager
    
    Throws:
    
    SaveException
  - restoreState
```
public void restoreState(Element el)
                  throws SaveException
```
    Restores the current state from the given DOM element ("VisBio").
    
    Specified by:
    
    restoreState in interface Saveable
    
    Overrides:
    
    restoreState in class LogicManager
    
    Throws:
    
    SaveException
  - doGUI
```
protected void doGUI()
```
    Adds window-related GUI components to VisBio.
  - setDocking
```
protected void setDocking(boolean docking)
```
    Sets whether window docking features are enabled.
  - setHideAll
```
protected void setHideAll(boolean hideAll)
```
    Sets whether minimizing the main VisBio window hides the other VisBio windows.
  - doMenuBars
```
protected void doMenuBars(JMenuBar master)
```
    Propagates the given menu bar across all registered frames.
  - getWindowByTitle
```
protected WindowInfo getWindowByTitle(String name)
```
    Gets window information about the first window matching the specified window title.

Class WindowManager

Field Summary

Fields inherited from class loci.visbio.LogicManager

Constructor Summary

Method Summary

Methods inherited from class loci.visbio.LogicManager

Methods inherited from class java.lang.Object

Field Detail

DOCKING

HIDE_ALL

windows

visible

waiting

docker

docking

hideAll

distributed

windowStates

Constructor Detail

WindowManager

Method Detail

addWindow

addWindow

disposeWindow

getWindows

setWaitCursor

showWindow

hideWindows

restoreWindows

disposeWindows

setDistributedMenus

doEvent

getTasks

windowDeiconified

windowIconified

windowActivated

windowClosed

windowClosing

windowDeactivated

windowOpened

saveState

restoreState

doGUI

setDocking

setHideAll

doMenuBars

getWindowByTitle