org.ka2ddo.yaac.gui

Class WindowPersister

java.lang.Object

org.ka2ddo.yaac.gui.WindowPersister

All Implemented Interfaces:

java.awt.event.ComponentListener, java.awt.event.WindowListener, java.lang.Iterable<java.util.Map.Entry<java.awt.Window,java.lang.String>>, java.util.EventListener

public class WindowPersister
extends java.lang.Object
implements java.awt.event.ComponentListener, java.awt.event.WindowListener, java.lang.Iterable<java.util.Map.Entry<java.awt.Window,java.lang.String>>

This class manages persisting the location and size of windows in the YAAC application.

Author:

Andrew Pavlin, KA2DDO

Method Summary

Modifier and Type	Method and Description
void	addWindowPersisterListener(WindowPersisterListener l) Register another listener for top-level window changes.
void	componentHidden(java.awt.event.ComponentEvent e) DO NOT CALL.
void	componentMoved(java.awt.event.ComponentEvent e) DO NOT CALL.
void	componentResized(java.awt.event.ComponentEvent e) DO NOT CALL.
void	componentShown(java.awt.event.ComponentEvent e) DO NOT CALL.
static WindowPersister	getInstance() Get the singleton WindowPersister object.
java.util.Iterator<java.util.Map.Entry<java.awt.Window,java.lang.String>>	iterator() Returns an iterator over the currently monitored set of Windows.
void	register(java.awt.Window window, java.lang.String name) Register a Window for having its position and sizing persisted (and restored, if previously persisted values are found).
void	removeWindowPersisterListener(WindowPersisterListener l) Deregister a listener for top-level window changes.
void	windowActivated(java.awt.event.WindowEvent e) DO NOT CALL.
void	windowClosed(java.awt.event.WindowEvent e) DO NOT CALL.
void	windowClosing(java.awt.event.WindowEvent e) DO NOT CALL.
void	windowDeactivated(java.awt.event.WindowEvent e) DO NOT CALL.
void	windowDeiconified(java.awt.event.WindowEvent e) DO NOT CALL.
void	windowIconified(java.awt.event.WindowEvent e) DO NOT CALL.
void	windowOpened(java.awt.event.WindowEvent e) DO NOT CALL.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

getInstance

public static WindowPersister getInstance()

Get the singleton WindowPersister object.

Returns:

the WindowPersister

register

public void register(java.awt.Window window,
                     java.lang.String name)

Register a Window for having its position and sizing persisted (and restored, if previously persisted values are found).

Parameters:

window - Window whose size and screen location should be preserved

name - unique identification String of the Window's content

addWindowPersisterListener

public void addWindowPersisterListener(WindowPersisterListener l)

Register another listener for top-level window changes.

Parameters:

l - WindowPersisterListener

removeWindowPersisterListener

public void removeWindowPersisterListener(WindowPersisterListener l)

Deregister a listener for top-level window changes.

Parameters:

l - WindowPersisterListener

iterator

public java.util.Iterator<java.util.Map.Entry<java.awt.Window,java.lang.String>> iterator()

Returns an iterator over the currently monitored set of Windows.

Specified by:

iterator in interface java.lang.Iterable<java.util.Map.Entry<java.awt.Window,java.lang.String>>

Returns:

an Iterator.

componentHidden

public void componentHidden(java.awt.event.ComponentEvent e)

DO NOT CALL.

Specified by:

componentHidden in interface java.awt.event.ComponentListener

Parameters:

e - ComponentEvent

componentMoved

public void componentMoved(java.awt.event.ComponentEvent e)

DO NOT CALL.

Specified by:

componentMoved in interface java.awt.event.ComponentListener

Parameters:

e - ComponentEvent

componentResized

public void componentResized(java.awt.event.ComponentEvent e)

DO NOT CALL.

Specified by:

componentResized in interface java.awt.event.ComponentListener

Parameters:

e - ComponentEvent

componentShown

public void componentShown(java.awt.event.ComponentEvent e)

DO NOT CALL.

Specified by:

componentShown in interface java.awt.event.ComponentListener

Parameters:

e - ComponentEvent

windowActivated

public void windowActivated(java.awt.event.WindowEvent e)

DO NOT CALL.

Specified by:

windowActivated in interface java.awt.event.WindowListener

Parameters:

e - WindowEvent

windowClosed

public void windowClosed(java.awt.event.WindowEvent e)

DO NOT CALL.

Specified by:

windowClosed in interface java.awt.event.WindowListener

Parameters:

e - WindowEvent

windowClosing

public void windowClosing(java.awt.event.WindowEvent e)

DO NOT CALL.

Specified by:

windowClosing in interface java.awt.event.WindowListener

Parameters:

e - WindowEvent

windowDeactivated

public void windowDeactivated(java.awt.event.WindowEvent e)

DO NOT CALL.

Specified by:

windowDeactivated in interface java.awt.event.WindowListener

Parameters:

e - WindowEvent

windowDeiconified

public void windowDeiconified(java.awt.event.WindowEvent e)

DO NOT CALL.

Specified by:

windowDeiconified in interface java.awt.event.WindowListener

Parameters:

e - WindowEvent

windowIconified

public void windowIconified(java.awt.event.WindowEvent e)

DO NOT CALL.

Specified by:

windowIconified in interface java.awt.event.WindowListener

Parameters:

e - WindowEvent

windowOpened

public void windowOpened(java.awt.event.WindowEvent e)

DO NOT CALL.

Specified by:

windowOpened in interface java.awt.event.WindowListener

Parameters:

e - WindowEvent