org.antlr.xjlib.appkit.app

Class XJApplication

java.lang.Object

org.antlr.xjlib.foundation.XJObject

org.antlr.xjlib.appkit.app.XJApplication

All Implemented Interfaces:

XJApplicationInterface, XJFrameDelegate

Direct Known Subclasses:

XJApplicationMacOS

public class XJApplication
extends XJObject
implements XJApplicationInterface, XJFrameDelegate

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XJApplication.AutoSaveTimer
protected static class	XJApplication.ScheduledTimer

Field Summary

Fields

Modifier and Type	Field and Description
protected XJFrame	about
protected static String	appName
protected static XJScheduledTimerDelegate	autoSaveTimer
protected static XJApplicationDelegate	delegate
protected static int	DOCUMENT_OFFSET_PIXELS
protected static int	documentAbsoluteCount
protected static int	documentAbsPositionCount
protected static List<XJDocumentFactory>	documentFactories
protected static List<String>	documentsToOpenAtStartup
protected static String[]	launchArguments
static int	MAX_RECENT_FILES
static boolean	NO
protected XJPanel	prefs
protected static String	propertiesPath
protected static List<String>	recentFiles
protected static long	SCHEDULED_TIMER_MINUTES
protected static List<XJScheduledTimer>	scheduledTimers
protected static XJApplicationInterface	shared
protected static boolean	startingUp
protected XJPreferences	userPrefs
protected static List<XJWindow>	windows
static String	XJ_PREFS_RECENT_FILES
static boolean	YES

Constructor Summary

Constructors

Constructor and Description
XJApplication()

Method Summary

Methods

Modifier and Type	Method and Description
static void	addDocumentFactory(Class documentClass, Class windowClass, Class dataClass, String ext, String description)
static void	addDocumentFactory(XJDocumentFactory factory)
protected void	addPreferencesMenuItem()
void	addRecentFile(String file)
static void	addScheduledTimer(XJScheduledTimerDelegate delegate, long minutes, boolean scheduleAtStartup)
void	addWindow(XJWindow window)
XJDocumentFactory	askForDocumentType()
void	clearRecentFiles()
void	closeFirstCreatedWindowIfNonDirty(XJWindow excludeWindow)
void	displayAbout()
void	displayHelp()
void	displayPrefs()
void	frameDidClose(XJFrame frame)
static Container	getActiveContainer()
XJWindow	getActiveWindow()
static XJApplicationDelegate	getAppDelegate()
String	getApplicationName()
static String	getAppVersionLong()
static String	getAppVersionShort()
List<String>	getDocumentDescriptions()
List	getDocumentExtensions()
XJDocumentFactory	getDocumentTypeForPath(String path)
int	getNumberOfNonAuxiliaryWindows()
XJPreferences	getPreferences()
Class	getPreferencesClass()
static String	getPropertiesPath()
XJWindow	getWindowContainingDocumentForPath(String path)
List<XJWindow>	getWindows()
List<XJWindow>	getWindowsInWindowMenu()
static boolean	handlesDocument(XJDocument doc)
boolean	hasPreferencesMenuItem()
boolean	loadDocument(String file, XJDocument doc)
XJDocument	newDocument()
XJDocument	newDocument(boolean visible, XJDocumentFactory docFactory)
boolean	openDocument()
boolean	openDocument(String file)
boolean	openDocuments(List<String> files)
boolean	openLastUsedDocument()
void	performPreferences()
void	performQuit()
List	recentFiles()
protected void	removePreferencesMenuItem()
void	removeRecentFile(String file)
static void	removeScheduledTimer(XJScheduledTimerDelegate delegate)
void	removeWindow(XJWindow window)
static void	run(XJApplicationDelegate delegate, String[] args)
static void	run(XJApplicationDelegate delegate, String[] args, String applicationName)
static void	setAutoSave(boolean enabled, int delayInMinutes)
static void	setDelegate(XJApplicationDelegate delegate)
static void	setPropertiesPath(String path)
static void	setShared(XJApplicationInterface shared)
static XJApplicationInterface	shared()
boolean	shouldQuitAfterLastWindowClosed()
protected void	shutdown()
protected void	startup()
boolean	supportsPersistence()
protected void	updateRecentFilesPrefs()
boolean	useDesktopMode()

Methods inherited from class org.antlr.xjlib.foundation.XJObject

addObserver, addObserverForKey, awake, bindObserverForKey, keyValueChanged, observeValueForKey, removeObserver, removeObserverForKey

Methods inherited from class java.lang.Object

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

Field Detail

YES

public static final boolean YES

See Also:

Constant Field Values

NO

public static final boolean NO

See Also:

Constant Field Values

XJ_PREFS_RECENT_FILES

public static final String XJ_PREFS_RECENT_FILES

See Also:

Constant Field Values

shared

protected static XJApplicationInterface shared

delegate

protected static XJApplicationDelegate delegate

scheduledTimers

protected static List<XJScheduledTimer> scheduledTimers

SCHEDULED_TIMER_MINUTES

protected static final long SCHEDULED_TIMER_MINUTES

See Also:

Constant Field Values

windows

protected static List<XJWindow> windows

MAX_RECENT_FILES

public static final int MAX_RECENT_FILES

See Also:

Constant Field Values

recentFiles

protected static List<String> recentFiles

documentAbsoluteCount

protected static int documentAbsoluteCount

documentAbsPositionCount

protected static int documentAbsPositionCount

DOCUMENT_OFFSET_PIXELS

protected static final int DOCUMENT_OFFSET_PIXELS

See Also:

Constant Field Values

documentFactories

protected static List<XJDocumentFactory> documentFactories

propertiesPath

protected static String propertiesPath

startingUp

protected static boolean startingUp

launchArguments

protected static String[] launchArguments

documentsToOpenAtStartup

protected static List<String> documentsToOpenAtStartup

appName

protected static String appName

userPrefs

protected XJPreferences userPrefs

about

protected XJFrame about

prefs

protected XJPanel prefs

autoSaveTimer

protected static XJScheduledTimerDelegate autoSaveTimer

Constructor Detail

XJApplication

public XJApplication()

Method Detail

setShared

public static void setShared(XJApplicationInterface shared)

shared

public static XJApplicationInterface shared()

getAppVersionShort

public static String getAppVersionShort()

getAppVersionLong

public static String getAppVersionLong()

getAppDelegate

public static XJApplicationDelegate getAppDelegate()

getActiveContainer

public static Container getActiveContainer()

run

public static void run(XJApplicationDelegate delegate,
       String[] args,
       String applicationName)

run

public static void run(XJApplicationDelegate delegate,
       String[] args)

startup

protected void startup()

updateRecentFilesPrefs

protected void updateRecentFilesPrefs()

shutdown

protected void shutdown()

setDelegate

public static void setDelegate(XJApplicationDelegate delegate)

addScheduledTimer

public static void addScheduledTimer(XJScheduledTimerDelegate delegate,
                     long minutes,
                     boolean scheduleAtStartup)

removeScheduledTimer

public static void removeScheduledTimer(XJScheduledTimerDelegate delegate)

setPropertiesPath

public static void setPropertiesPath(String path)

getPropertiesPath

public static String getPropertiesPath()

getApplicationName

public String getApplicationName()

Specified by:

getApplicationName in interface XJApplicationInterface

getPreferences

public XJPreferences getPreferences()

Specified by:

getPreferences in interface XJApplicationInterface

displayAbout

public void displayAbout()

Specified by:

displayAbout in interface XJApplicationInterface

displayPrefs

public void displayPrefs()

Specified by:

displayPrefs in interface XJApplicationInterface

displayHelp

public void displayHelp()

Specified by:

displayHelp in interface XJApplicationInterface

frameDidClose

public void frameDidClose(XJFrame frame)

Specified by:

frameDidClose in interface XJFrameDelegate

addRecentFile

public void addRecentFile(String file)

Specified by:

addRecentFile in interface XJApplicationInterface

removeRecentFile

public void removeRecentFile(String file)

Specified by:

removeRecentFile in interface XJApplicationInterface

clearRecentFiles

public void clearRecentFiles()

Specified by:

clearRecentFiles in interface XJApplicationInterface

recentFiles

public List recentFiles()

Specified by:

recentFiles in interface XJApplicationInterface

addPreferencesMenuItem

protected void addPreferencesMenuItem()

removePreferencesMenuItem

protected void removePreferencesMenuItem()

addDocumentFactory

public static void addDocumentFactory(Class documentClass,
                      Class windowClass,
                      Class dataClass,
                      String ext,
                      String description)

addDocumentFactory

public static void addDocumentFactory(XJDocumentFactory factory)

handlesDocument

public static boolean handlesDocument(XJDocument doc)

getDocumentTypeForPath

public XJDocumentFactory getDocumentTypeForPath(String path)

getDocumentExtensions

public List getDocumentExtensions()

Specified by:

getDocumentExtensions in interface XJApplicationInterface

getDocumentDescriptions

public List<String> getDocumentDescriptions()

askForDocumentType

public XJDocumentFactory askForDocumentType()

newDocument

public XJDocument newDocument(boolean visible,
                     XJDocumentFactory docFactory)

newDocument

public XJDocument newDocument()

Specified by:

newDocument in interface XJApplicationInterface

openDocuments

public boolean openDocuments(List<String> files)

Specified by:

openDocuments in interface XJApplicationInterface

openDocument

public boolean openDocument(String file)

Specified by:

openDocument in interface XJApplicationInterface

loadDocument

public boolean loadDocument(String file,
                   XJDocument doc)

openDocument

public boolean openDocument()

Specified by:

openDocument in interface XJApplicationInterface

openLastUsedDocument

public boolean openLastUsedDocument()

Specified by:

openLastUsedDocument in interface XJApplicationInterface

closeFirstCreatedWindowIfNonDirty

public void closeFirstCreatedWindowIfNonDirty(XJWindow excludeWindow)

getWindowContainingDocumentForPath

public XJWindow getWindowContainingDocumentForPath(String path)

Specified by:

getWindowContainingDocumentForPath in interface XJApplicationInterface

getActiveWindow

public XJWindow getActiveWindow()

Specified by:

getActiveWindow in interface XJApplicationInterface

addWindow

public void addWindow(XJWindow window)

Specified by:

addWindow in interface XJApplicationInterface

getNumberOfNonAuxiliaryWindows

public int getNumberOfNonAuxiliaryWindows()

removeWindow

public void removeWindow(XJWindow window)

Specified by:

removeWindow in interface XJApplicationInterface

getWindows

public List<XJWindow> getWindows()

Specified by:

getWindows in interface XJApplicationInterface

getWindowsInWindowMenu

public List<XJWindow> getWindowsInWindowMenu()

Specified by:

getWindowsInWindowMenu in interface XJApplicationInterface

setAutoSave

public static void setAutoSave(boolean enabled,
               int delayInMinutes)

performPreferences

public void performPreferences()

performQuit

public void performQuit()

Specified by:

performQuit in interface XJApplicationInterface

supportsPersistence

public boolean supportsPersistence()

Specified by:

supportsPersistence in interface XJApplicationInterface

hasPreferencesMenuItem

public boolean hasPreferencesMenuItem()

Specified by:

hasPreferencesMenuItem in interface XJApplicationInterface

shouldQuitAfterLastWindowClosed

public boolean shouldQuitAfterLastWindowClosed()

useDesktopMode

public boolean useDesktopMode()

Specified by:

useDesktopMode in interface XJApplicationInterface

getPreferencesClass

public Class getPreferencesClass()