jahuwaldt.swing

Class MDIApplication

java.lang.Object

Application

jahuwaldt.swing.MDIApplication

Direct Known Subclasses:

GeomSSGUI

public class MDIApplication
extends Application

This is a wrapper for an application instance. It is an extension of Steve Roy's excellent MRJ Adapter package "Application" that adds Window Menu support and other features used by Multi-Document-Interface (MDI) applications. Under MacOS X, an application instance will automatically call "handleNew()" method if the user brings the application forward and there are no open window's registered. On non-Mac platforms, the application will quit once the last document window has been closed.

Modified by: Joseph A. Huwaldt

Version:

October 13, 2015

Author:

Joseph A. Huwaldt, Date: April 25, 2004

Constructor Summary

Constructors

Constructor and Description
MDIApplication() Constructor a new MDIApplication instance with no name.
MDIApplication(java.lang.String name) Constructor a new MDIApplication instance that has the specified name.

Method Summary

Modifier and Type	Method and Description
void	addQuitListener(QuitListener listener) Register an object to receive notification that the application is going to quit soon.
void	addWindow(java.awt.Window window) Register the supplied window with the list of windows managed by this MDIApplication.
java.util.List<java.awt.Window>	allOpenWindows() Get an unmodifiable list of all the currently open windows in the application.
AboutJMenuItem	createAboutMenuItem() Method used to create an about menu item for use in this application.
java.io.FilenameFilter	getFilenameFilter() Return a reference to this application's default file name filter or null if a filename filter has not been stored.
static MDIApplication	getInstance() Return the unique instance of this application.
Preferences	getPreferences()
boolean	getQuitOnClose() Returns a flag indicating if the application should quit when the last window is closed (true) or stay open (false; allowing the user to select "New" from the file menu for instance).
java.util.ResourceBundle	getResourceBundle() Returns the resource bundle stored with this application.
java.awt.Window	getTopWindow() Returns a reference to the top-most window in the list of all open windows registered with this application.
void	handleClose(java.awt.event.ActionEvent event) Handle the user choosing "Close" from the File menu.
java.awt.Frame	handleNew(java.awt.event.ActionEvent event) Handle the user requesting a new document window.
void	handleQuit(java.awt.event.ActionEvent event) Handle the user choosing "Quit" from the File menu.
javax.swing.JMenu	newWindowsMenu(java.lang.String title) Get a new JMenu instance that can be used as a Windows menu using the specified title (typically "Windows").
void	removeQuitListener(QuitListener listener) Method to remove a quit listener from the list of quit listeners for this application.
void	setFilenameFilter(java.io.FilenameFilter filter) Used to set the filename filter for this application.
void	setPreferences(Preferences prefs) Used to set the user preferences for this application.
void	setQuitOnClose(boolean flag) Sets a flag indicating if the application should quit when the last window is closed (true) or stay open (false; allowing the user to select "New" from the file menu for instance).
void	setResourceBundle(java.util.ResourceBundle bundle) Used to set the resource bundle for this application.
void	windowTitleChanged(java.awt.Window window) Call this method when a window being shown in a Windows menu has changed it's title.

Methods inherited from class java.lang.Object

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

Constructor Detail

MDIApplication

public MDIApplication()

Constructor a new MDIApplication instance with no name. Note that only one can ever be created. Attempting to instantiate more will result in an IllegalStateException being thrown.

MDIApplication

public MDIApplication(java.lang.String name)

Constructor a new MDIApplication instance that has the specified name. Note that only one can ever be created. Attempting to instantiate more will result in an IllegalStateException being thrown.

Parameters:

name - The name of the application.

Method Detail

getInstance

public static MDIApplication getInstance()

Return the unique instance of this application.

Returns:

The unique instance of this application.

setResourceBundle

public void setResourceBundle(java.util.ResourceBundle bundle)

Used to set the resource bundle for this application. This is provided as a convenience for storing the resource bundle so that it is accessible throughout an application.

Parameters:

bundle - The resource bundle to be stored with this application.

getResourceBundle

public java.util.ResourceBundle getResourceBundle()

Returns the resource bundle stored with this application. If no resource bundle has been stored, then null is returned.

Returns:

The resource bundle stored with this application.

setPreferences

public void setPreferences(Preferences prefs)

Used to set the user preferences for this application. This is provided as a convenience for storing the preferences so that it is accessible throughout an application.

Parameters:

prefs - The user preferences for this application.

getPreferences

public final Preferences getPreferences()

Returns:

a reference to the user preferences for this application.

setFilenameFilter

public void setFilenameFilter(java.io.FilenameFilter filter)

Used to set the filename filter for this application. This is provided as a convenience for storing the filename filter so that it is accessible throughout an application.

Parameters:

filter - The filename filter to be stored with this application.

getFilenameFilter

public java.io.FilenameFilter getFilenameFilter()

Return a reference to this application's default file name filter or null if a filename filter has not been stored.

Returns:

The default filename filter for this application.

setQuitOnClose

public void setQuitOnClose(boolean flag)

Sets a flag indicating if the application should quit when the last window is closed (true) or stay open (false; allowing the user to select "New" from the file menu for instance). The default value is true except on MacOS X where the default value if false.

Parameters:

flag - Set to true to have the application automatically quit when all the windows close.

getQuitOnClose

public boolean getQuitOnClose()

Returns a flag indicating if the application should quit when the last window is closed (true) or stay open (false; allowing the user to select "New" from the file menu for instance). The default value is true except on MacOS X where the default value if false.

Returns:

A flag indicating if the application should quit when the last window is closed.

addWindow

public void addWindow(java.awt.Window window)

Register the supplied window with the list of windows managed by this MDIApplication. When the window is made visible, it will be added to the "Windows" menu. The window will be removed from the "Windows" menu when it is closed.

Parameters:

window - The window to be added to the list of open windows.

addQuitListener

public void addQuitListener(QuitListener listener)

Register an object to receive notification that the application is going to quit soon.

Parameters:

listener - The listener to register.

removeQuitListener

public void removeQuitListener(QuitListener listener)

Method to remove a quit listener from the list of quit listeners for this application.

Parameters:

listener - The listener to remove.

getTopWindow

public java.awt.Window getTopWindow()

Returns a reference to the top-most window in the list of all open windows registered with this application. If there are no open windows, null is returned.

Returns:

The top-most window in the list of all open windows.

allOpenWindows

public java.util.List<java.awt.Window> allOpenWindows()

Get an unmodifiable list of all the currently open windows in the application.

Returns:

An unmodifiable list of all the currently open windows.

newWindowsMenu

public javax.swing.JMenu newWindowsMenu(java.lang.String title)

Get a new JMenu instance that can be used as a Windows menu using the specified title (typically "Windows"). The menu that is returned is maintained by this class and should not be modified by the user.

Parameters:

title - The title for the Windows menu.

Returns:

A JMenu that represents the application's Windows menu.

windowTitleChanged

public void windowTitleChanged(java.awt.Window window)

Call this method when a window being shown in a Windows menu has changed it's title. This method will update the titles shown in the Windows menu.

Parameters:

window - The window that has changed titles.

createAboutMenuItem

public AboutJMenuItem createAboutMenuItem()

Method used to create an about menu item for use in this application.

Returns:

A reference to the newly created about menu item or null if an item was not created.

handleNew

public java.awt.Frame handleNew(java.awt.event.ActionEvent event)

Handle the user requesting a new document window. If it is inappropriate for the application to create a new document window, then this method should do nothing. The default implementation does nothing and returns null.

Parameters:

event - The event that caused this method to be called. May be "null" if this method is called by MDIApplication or one of it's subclasses.

Returns:

A reference to the newly created window frame or null if a window was not created.

handleClose

public void handleClose(java.awt.event.ActionEvent event)

Handle the user choosing "Close" from the File menu. This implementation dispatches a "Window Closing" event on the top most window.

Parameters:

event - The event that caused this method to be called.

handleQuit

public void handleQuit(java.awt.event.ActionEvent event)

Handle the user choosing "Quit" from the File menu. This implementation safely works around a bug in Java on early versions of MacOS X that could cause a hang when displaying dialogs after choosing quit. This implementation dispatches a separate "window closing" event to each window. This gives each window an opportunity to cancel the quit process.

Parameters:

event - The event that caused this method to be called.