com.bric.window

Class WindowList

java.lang.Object

com.bric.window.WindowList

public class WindowList
extends Object

This keeps track of the origin and layering of windows and frames within this JVM.

By "origin" I mean: when that window was first activated. This serves as a running list of windows in the order they were used.

All windows are tracked by WeakReferences, just to make sure this static monitor doesn't accidentally let windows linger in memory that should otherwise be marked for garbage collection.

The layering is monitored by an AWTEventListener that listens for all WindowEvent.WINDOW_ACTIVATED events. Whenever a window is activated: it gets put on the top of the stack of windows.

When any change occurs to any of the lists in this class: the ChangeListeners are notified.

Field Summary

Fields

Modifier and Type	Field and Description
private static ArrayList<ChangeListener>	changeListeners
private static ArrayList<WeakReference<Window>>	windowLayerList References to every Window that has been activated, in order of when they were made active.
private static ArrayList<WeakReference<Window>>	windowList References to every Window that has been activated, in order of z-layering.
private static AWTEventListener	windowListener

Constructor Summary

Constructors

Modifier	Constructor and Description
private	WindowList()

Method Summary

Modifier and Type	Method and Description
static void	addChangeListener(ChangeListener l) Add a ChangeListener.
(package private) static void	fireChangeListeners()
static Frame[]	getFrames(boolean sortByLayer, boolean includeInvisible, boolean includeIconified) Returns a list of frames.
static Window[]	getWindows(boolean sortByLayer, boolean includeInvisible) Returns a list of windows.
static void	removeChangeListener(ChangeListener l) Remove a ChangeListener.

Methods inherited from class java.lang.Object

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

Field Detail

changeListeners

private static ArrayList<ChangeListener> changeListeners

windowListener

private static AWTEventListener windowListener

windowLayerList

private static ArrayList<WeakReference<Window>> windowLayerList

References to every Window that has been activated, in order of when they were made active.

windowList

private static ArrayList<WeakReference<Window>> windowList

References to every Window that has been activated, in order of z-layering.

Constructor Detail

WindowList

private WindowList()

Method Detail

getWindows

public static Window[] getWindows(boolean sortByLayer,
                                  boolean includeInvisible)

Returns a list of windows.

Parameters:

sortByLayer - whether to sort by layer or origin. If this is true, then the lowest index corresponds to the window farthest behind; the highest index represents the highest window. If this is false, then the lowest index corresponds to the first window activated, and the highest index is the most recently activated window.

includeInvisible - if this is false then only visible Windows will be returned. Otherwise all Windows will be returned.

getFrames

public static Frame[] getFrames(boolean sortByLayer,
                                boolean includeInvisible,
                                boolean includeIconified)

Returns a list of frames.

Parameters:

sortByLayer - whether to sort by layer or origin. If this is true, then the lowest index corresponds to the frame farthest behind; the highest index represents the highest frame. If this is false, then the lowest index corresponds to the first frame activated, and the highest index is the most recently activated frame.

includeInvisible - if this is false then visible Frames will be returned. If this is true then all Frames will be returned, so the next argument is meaningless.

includeIconified - if this is true then iconified Frames will be returned.

addChangeListener

public static void addChangeListener(ChangeListener l)

Add a ChangeListener.

This listener will be notified when new windows are activated, layering of windows changes, or windows close.

Parameters:

l - a new ChangeListener.

removeChangeListener

public static void removeChangeListener(ChangeListener l)

Remove a ChangeListener.

fireChangeListeners

static void fireChangeListeners()