net.lucidviews.util.gui.swing
Class WindowUtils

java.lang.Object
  net.lucidviews.util.gui.swing.WindowUtils

All Implemented Interfaces:

java.util.EventListener, java.awt.event.WindowListener

public class WindowUtils

extends java.lang.Object

implements java.awt.event.WindowListener

Utilities for setting window properties.

Since:

1.0

Version:

$Revision: 1.2 $

Author:

Stephen Battey

Field Summary

private Properties	_appnProperties The properties for the window.
private java.lang.String	_appnPropertyPrefix The prefix for all property names (should include the name of the application).
private javax.swing.JFrame	_targetWindow A reference to the window that the properties are applicable to.
private static java.lang.String	WINDOW_HEIGHT_PROPERTY_NAME Suffix for window height property name.
private static java.lang.String	WINDOW_WIDTH_PROPERTY_NAME Suffix for window width property name.
private static java.lang.String	WINDOW_XPOS_PROPERTY_NAME Suffix for window x-position property name.
private static java.lang.String	WINDOW_YPOS_PROPERTY_NAME Suffix for window y-position property name.

Constructor Summary

WindowUtils(javax.swing.JFrame target)
Create a utility suite for a given application window.

WindowUtils(javax.swing.JFrame target, Properties properties, java.lang.String propertyPrefix)
Create a utility suite for a given application window.

WindowUtils(javax.swing.JFrame target, java.lang.String propertiesFileRef, java.lang.String propertyPrefix)
Create a utility suite for a given application window.

Method Summary

void	autoStoreWindowProperties() Automatically store the properties of this window when the window is closed.
void	setIcon(java.lang.String iconImageURL) Set the icon for this window.
void	setWindowLocation() Set the position of the window.
void	setWindowSize() Set the size of the window.
void	storeWindowLocation() Store the position of the window.
private void	storeWindowLocation0()
void	storeWindowProperties() Store the size and position of the window.
void	storeWindowSize() Store the size of the window.
private void	storeWindowSize0()
void	windowActivated(java.awt.event.WindowEvent e)
void	windowClosed(java.awt.event.WindowEvent e)
void	windowClosing(java.awt.event.WindowEvent e)
void	windowDeactivated(java.awt.event.WindowEvent e)
void	windowDeiconified(java.awt.event.WindowEvent e)
void	windowIconified(java.awt.event.WindowEvent e)
void	windowOpened(java.awt.event.WindowEvent e)

Methods inherited from class java.lang.Object

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

Field Detail

WINDOW_WIDTH_PROPERTY_NAME

private static final java.lang.String WINDOW_WIDTH_PROPERTY_NAME

Suffix for window width property name.

See Also:

Constant Field Values

WINDOW_HEIGHT_PROPERTY_NAME

private static final java.lang.String WINDOW_HEIGHT_PROPERTY_NAME

Suffix for window height property name.

See Also:

Constant Field Values

WINDOW_XPOS_PROPERTY_NAME

private static final java.lang.String WINDOW_XPOS_PROPERTY_NAME

Suffix for window x-position property name.

See Also:

Constant Field Values

WINDOW_YPOS_PROPERTY_NAME

private static final java.lang.String WINDOW_YPOS_PROPERTY_NAME

Suffix for window y-position property name.

See Also:

Constant Field Values

_targetWindow

private javax.swing.JFrame _targetWindow

A reference to the window that the properties are applicable to.

_appnProperties

private Properties _appnProperties

The properties for the window.

_appnPropertyPrefix

private java.lang.String _appnPropertyPrefix

The prefix for all property names (should include the name of the application).

Constructor Detail

WindowUtils

public WindowUtils(javax.swing.JFrame target)

Create a utility suite for a given application window.

Parameters:

target - the window to be controlled

WindowUtils

public WindowUtils(javax.swing.JFrame target,
                   Properties properties,
                   java.lang.String propertyPrefix)

Create a utility suite for a given application window.

Parameters:

target - the window to be controlled

properties - data model containing the window's properties

propertyPrefix - the prefix to the names of all the window's properties

WindowUtils

public WindowUtils(javax.swing.JFrame target,
                   java.lang.String propertiesFileRef,
                   java.lang.String propertyPrefix)
            throws java.io.FileNotFoundException,
                   java.io.IOException

Create a utility suite for a given application window.

Parameters:

target - the window to be controlled

propertiesFileRef - URL of a file that stores the window's properties

propertyPrefix - the prefix to the names of all the window's properties

Throws:

java.io.FileNotFoundException - the file location specified by propertiesFileRef does not exist

java.io.IOException - the file at the specified location could not be read

Method Detail

storeWindowSize0

private void storeWindowSize0()
                       throws java.io.IOException

Throws:

java.io.IOException

storeWindowLocation0

private void storeWindowLocation0()
                           throws java.io.IOException

Throws:

java.io.IOException

setIcon

public void setIcon(java.lang.String iconImageURL)

Set the icon for this window.
The icon will be displayed in the top left corner of the window.
This method will automatically load the image from the URL, waiting for the image data to load before returning. This ensure the icon is ready for display before you go on to make the window visible by calling setVisible.

Parameters:

iconImageURL - the URL to the image file

setWindowSize

public void setWindowSize()

Set the size of the window.
The size will be first taken from the application properties table. If there is no properties table or the properties do not contain a width and height, the window will take on the preferred size of the internal components of the window.

setWindowLocation

public void setWindowLocation()

Set the position of the window.
The (x and y) position will be first taken from the application properties table. If there is no properties table or the properties do not contain an x and y co-ordinate, the window will be placed in the centre of the screen.

storeWindowSize

public void storeWindowSize()
                     throws java.io.IOException

Store the size of the window.
If there is no properties table this operation is ignored. Otherwise, the current width and height of the window are saved to the file where the properties were originally read from.

Throws:

java.io.IOException - error writing the size properties to the properties file

storeWindowLocation

public void storeWindowLocation()
                         throws java.io.IOException

Store the position of the window.
If there is no properties table this operation is ignored. Otherwise, the current x and y co-ordinates of the window are saved to the file where the properties were originally read from.

Throws:

java.io.IOException - error writing the location properties to the properties file

storeWindowProperties

public void storeWindowProperties()
                           throws java.io.IOException

Store the size and position of the window.
If there is no properties table this operation is ignored. Otherwise, the current width, height, x co-ordinate and y co-ordinate of the window are saved to the file where the properties were originally read from.

Throws:

java.io.IOException - error writing the window properties to the properties file

autoStoreWindowProperties

public void autoStoreWindowProperties()

Automatically store the properties of this window when the window is closed.
The utils object will listen for the close-window event and save the window properties, ready for the next time the application is run.

windowOpened

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

Specified by:

windowOpened in interface java.awt.event.WindowListener

windowClosing

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

Specified by:

windowClosing in interface java.awt.event.WindowListener

windowClosed

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

Specified by:

windowClosed in interface java.awt.event.WindowListener

windowIconified

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

Specified by:

windowIconified in interface java.awt.event.WindowListener

windowDeiconified

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

Specified by:

windowDeiconified in interface java.awt.event.WindowListener

windowActivated

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

Specified by:

windowActivated in interface java.awt.event.WindowListener

windowDeactivated

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

Specified by:

windowDeactivated in interface java.awt.event.WindowListener