xal.extension.application

Class AbstractApplicationAdaptor

java.lang.Object

xal.extension.application.AbstractApplicationAdaptor

All Implemented Interfaces:

ApplicationListener

Direct Known Subclasses:

ApplicationAdaptor, DesktopApplicationAdaptor

public abstract class AbstractApplicationAdaptor
extends java.lang.Object
implements ApplicationListener

AbstractApplicationAdaptor is the abstract superclass of the desktop and frame based application adaptors. It contains hooks for handling application events. It also provides application wide information about the application.

Field Summary

Fields

Modifier and Type	Field and Description
static java.net.URL[]	docURLs The URLs to open existing document(s) in the command-line.
static java.lang.String	GUI_BRICKS_RESOURCE name for the gui bricks resource which may or may not exist
static java.lang.String	WILDCARD_FILE_EXTENSION wildcard file extension

Constructor Summary

Constructors

Constructor and Description
AbstractApplicationAdaptor() Constructor

Method Summary

Modifier and Type	Method and Description
void	applicationFinishedLaunching() Subclasses may override this method to provide custom handling upon completion of the application having launched.
abstract java.lang.String	applicationName() Subclasses must implement this method to return the name of their application.
void	applicationWillOpenInitialDocuments() Event indicating that the application will open any initial documents.
void	applicationWillQuit() Implement ApplicationListener.
boolean	canOpenDocuments() Determine whether this application can open documents
void	customizeCommands(Commander commander) Override this method to register custom application commands.
void	documentClosed(xal.extension.application.XalAbstractDocument document) Implement ApplicationListener.
void	documentCreated(xal.extension.application.XalAbstractDocument document) Implement ApplicationListener.
abstract xal.extension.application.XalAbstractDocument	generateEmptyDocument(java.lang.String type) Generate a new empty document of the specified type.
WindowReference	getDefaultWindowReference(java.lang.String tag, java.lang.Object... parameters) Get the window reference from the resource if any
static java.net.URL[]	getDocURLs() Get the document URLs.
java.net.URL	getResourceURL(java.lang.String resourceSpec) Get the URL to the specified resource residing within the resources directory.
abstract java.lang.String[]	readableDocumentTypes() Subclasses should implement this method to return the array of file suffixes identifying the files that can be read by the application.
static void	setOptions(java.lang.String[] args) Define some flags for launching the application, such as pre-load a default accelerator.
void	setResourcesLocation(java.net.URL resourcesLocation) Subclasses can set the location of the resources directory.
void	setResourcesParentDirectory(java.io.File resourcesParentDirectory) Convenience method to set the location of the resources directory by specifying the parent directory of resources.
void	setResourcesParentDirectoryWithPath(java.lang.String resourcesParentDirectoryPath) Convenience method to set the location of the resources directory by specifying the parent directory of resources.
boolean	showsWelcomeDialogAtLaunch() Indicates whether the welcome dialog should be displayed at launch.
boolean	usesConsole() Identifies whether the application sends standard output and standard error to the application's console or whether it should simply go to the terminal from which the application was launched.
abstract java.lang.String[]	writableDocumentTypes() Subclasses should implement this method to return the array of file suffixes identifying the files that can be written by the application.

Methods inherited from class java.lang.Object

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

Field Detail

WILDCARD_FILE_EXTENSION

public static final java.lang.String WILDCARD_FILE_EXTENSION

wildcard file extension

See Also:

Constant Field Values

GUI_BRICKS_RESOURCE

public static final java.lang.String GUI_BRICKS_RESOURCE

name for the gui bricks resource which may or may not exist

See Also:

Constant Field Values

docURLs

public static java.net.URL[] docURLs

The URLs to open existing document(s) in the command-line.

Constructor Detail

AbstractApplicationAdaptor

public AbstractApplicationAdaptor()

Constructor

Method Detail

readableDocumentTypes

public abstract java.lang.String[] readableDocumentTypes()

Subclasses should implement this method to return the array of file suffixes identifying the files that can be read by the application.

Returns:

An array of file suffixes corresponding to readable files

writableDocumentTypes

public abstract java.lang.String[] writableDocumentTypes()

Subclasses should implement this method to return the array of file suffixes identifying the files that can be written by the application.

Returns:

An array of file suffixes corresponding to writable files

canOpenDocuments

public final boolean canOpenDocuments()

Determine whether this application can open documents

showsWelcomeDialogAtLaunch

public boolean showsWelcomeDialogAtLaunch()

Indicates whether the welcome dialog should be displayed at launch. By default, this returns true if the application can open documents.

generateEmptyDocument

public abstract xal.extension.application.XalAbstractDocument generateEmptyDocument(java.lang.String type)

Generate a new empty document of the specified type.

Parameters:

type - the type of document to create.

Returns:

an instance of the custom subclass of XalAbstractDocument

applicationName

public abstract java.lang.String applicationName()

Subclasses must implement this method to return the name of their application.

Returns:

The name of the application

usesConsole

public boolean usesConsole()

Identifies whether the application sends standard output and standard error to the application's console or whether it should simply go to the terminal from which the application was launched. The default is to return true thus indicating that the console should be used.

Returns:

Whether the application's console should capture standard output and error

customizeCommands

public void customizeCommands(Commander commander)

Override this method to register custom application commands.

Parameters:

commander - The commander with which to register commands.

See Also:

Commander.registerAction(Action)

setOptions

public static void setOptions(java.lang.String[] args)

Define some flags for launching the application, such as pre-load a default accelerator. todo: this code needs to be reviewed to determine its value and logic

getDocURLs

public static java.net.URL[] getDocURLs()

Get the document URLs.

Returns:

document URLs

getDefaultWindowReference

public WindowReference getDefaultWindowReference(java.lang.String tag,
                                                 java.lang.Object... parameters)

Get the window reference from the resource if any

applicationWillOpenInitialDocuments

public void applicationWillOpenInitialDocuments()

Event indicating that the application will open any initial documents. These documents may include a new empty document if appropriate or any documents passed at the command line. Subclasses may override this method to handle this event if needed.

Specified by:

applicationWillOpenInitialDocuments in interface ApplicationListener

applicationFinishedLaunching

public void applicationFinishedLaunching()

Subclasses may override this method to provide custom handling upon completion of the application having launched. The default implementation does nothing.

documentClosed

public void documentClosed(xal.extension.application.XalAbstractDocument document)

Implement ApplicationListener. Subclasses may implement this method to handle a document closed event at the application level. The default implementation does nothing.

Specified by:

documentClosed in interface ApplicationListener

Parameters:

document - The document that has closed.

documentCreated

public void documentCreated(xal.extension.application.XalAbstractDocument document)

Implement ApplicationListener. Subclasses may implement this method to handle a document created event at the application level. The default implementation does nothing.

Specified by:

documentCreated in interface ApplicationListener

Parameters:

document - The document that has been created.

applicationWillQuit

public void applicationWillQuit()

Implement ApplicationListener. Subclasses may implement this method to handle an "application will quit" event at the application level. The default implementation does nothing.

Specified by:

applicationWillQuit in interface ApplicationListener

setResourcesParentDirectory

public void setResourcesParentDirectory(java.io.File resourcesParentDirectory)

Convenience method to set the location of the resources directory by specifying the parent directory of resources. The resources directory is assumed to be named "resources". This is really used for script based applications that don't reside in a jar file.

Parameters:

resourcesParentDirectory - normal file system directory specifying the location of the parent directory of the resources

setResourcesParentDirectoryWithPath

public void setResourcesParentDirectoryWithPath(java.lang.String resourcesParentDirectoryPath)

Convenience method to set the location of the resources directory by specifying the parent directory of resources. The resources directory is assumed to be named "resources". This is really used for script based applications that don't reside in a jar file.

Parameters:

resourcesParentDirectoryPath - full file system directory path specifying the location of the parent directory of the resources

setResourcesLocation

public void setResourcesLocation(java.net.URL resourcesLocation)

Subclasses can set the location of the resources directory. Setting it to null will use the default resource manager.

getResourceURL

public java.net.URL getResourceURL(java.lang.String resourceSpec)

Get the URL to the specified resource residing within the resources directory.

Parameters:

resourceSpec - specification of the resource relative to the resources URL

Returns:

the full URL to the specified resource