xal.extension.application

Class ApplicationAdaptor

java.lang.Object

xal.extension.application.AbstractApplicationAdaptor

xal.extension.application.ApplicationAdaptor

All Implemented Interfaces:

ApplicationListener

public abstract class ApplicationAdaptor
extends AbstractApplicationAdaptor

ApplicationAdaptor is the abstract superclass of the custom applicaton adaptors each of which acts as a delegate for its corresponding application. 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.lang.String	WILDCARD_FILE_EXTENSION wildcard file extension

Fields inherited from class xal.extension.application.AbstractApplicationAdaptor

docURLs, GUI_BRICKS_RESOURCE

Constructor Summary

Constructors

Constructor and Description
ApplicationAdaptor()

Method Summary

Modifier and Type	Method and Description
void	editPreferences(XalDocument document) Override this method to show your application's preference panel.
xal.extension.application.XalAbstractDocument	generateEmptyDocument(java.lang.String type) Generate a new empty document.
abstract XalDocument	newDocument(java.net.URL url) Subclasses should implement this method to return an instance of their custom subclass of XalDocument loaded from the specified URL.
abstract XalDocument	newEmptyDocument() Subclasses should implement this method to return an instance of their custom subclass of XalDocument.
XalDocument	newEmptyDocument(java.lang.String type) Subclasses should implement this method to return an instance of their custom subclass of XalDocument.

Methods inherited from class xal.extension.application.AbstractApplicationAdaptor

applicationFinishedLaunching, applicationName, applicationWillOpenInitialDocuments, applicationWillQuit, canOpenDocuments, customizeCommands, documentClosed, documentCreated, getDefaultWindowReference, getDocURLs, getResourceURL, readableDocumentTypes, setOptions, setResourcesLocation, setResourcesParentDirectory, setResourcesParentDirectoryWithPath, showsWelcomeDialogAtLaunch, usesConsole, writableDocumentTypes

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

Constructor Detail

ApplicationAdaptor

public ApplicationAdaptor()

Method Detail

newEmptyDocument

public abstract XalDocument newEmptyDocument()

Subclasses should implement this method to return an instance of their custom subclass of XalDocument.

Returns:

An instance of the custom subclass of XalDocument

newEmptyDocument

public XalDocument newEmptyDocument(java.lang.String type)

Subclasses should implement this method to return an instance of their custom subclass of XalDocument.

Returns:

An instance of the custom subclass of XalDocument

newDocument

public abstract XalDocument newDocument(java.net.URL url)

Subclasses should implement this method to return an instance of their custom subclass of XalDocument loaded from the specified URL.

Returns:

An instance of the custom subclass of XalDocument

generateEmptyDocument

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

Generate a new empty document.

Specified by:

generateEmptyDocument in class AbstractApplicationAdaptor

Parameters:

type - the type of document to create.

Returns:

an instance of the custom subclass of XalAbstractDocument

editPreferences

public void editPreferences(XalDocument document)

Override this method to show your application's preference panel. The preference panel may optionally be document specific or application wide depending on the application's specific implementation. The default implementaion displays a warning dialog box that now preference panel exists.

Parameters:

document - The document whose preferences are being changed. Subclass may ignore.