griffon.core

Interface GriffonApplication

All Superinterfaces:

Observable

All Known Implementing Classes:

AbstractGriffonApplet, AbstractGriffonApplication, AbstractJavaFXGriffonApplication, AbstractPivotGriffonApplication, DefaultGriffonApplication, DesktopPivotGriffonApplication, JavaFXGriffonApplication, LanternaGriffonApplication, SwingGriffonApplet, SwingGriffonApplication

public interface GriffonApplication
extends Observable

Defines the basic contract of a Griffon application.

Since:

0.0.0

Author:

Danno Ferrin, Andres Almiray

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROPERTY_LOCALE
static String	PROPERTY_PHASE

Method Summary

Methods

Modifier and Type	Method and Description
void	addShutdownHandler(ShutdownHandler handler) Registers a ShutdownHandler on this application
boolean	canShutdown() Queries any available ShutdownHandlers.
Object	createApplicationContainer(Map<String,Object> attributes)
ActionManager	getActionManager()
AddonManager	getAddonManager()
ApplicationClassLoader	getApplicationClassLoader()
ArtifactManager	getArtifactManager()
Configuration	getConfiguration()
EventRouter	getEventRouter()
Injector<?>	getInjector()
Locale	getLocale() Gets the application locale.
Logger	getLog() Returns a Logger instance suitable for this application.
MessageSource	getMessageSource()
MVCGroupManager	getMvcGroupManager()
ApplicationPhase	getPhase() Returns the current phase.
ResourceHandler	getResourceHandler()
ResourceInjector	getResourceInjector()
ResourceResolver	getResourceResolver()
String[]	getStartupArgs() Returns the arguments set on the command line (if any).
UIThreadManager	getUIThreadManager()
<W> WindowManager<W>	getWindowManager()
void	initialize() Executes the 'Initialize' life cycle phase.
void	ready() Executes the 'Ready' life cycle phase.
void	removeShutdownHandler(ShutdownHandler handler) Removes a ShutdownHandler from this application
void	setLocale(Locale locale) Sets the application locale.
void	setLocaleAsString(String locale) Sets the application locale.
boolean	shutdown() Executes the 'Shutdown' life cycle phase.
void	startup() Executes the 'Startup' life cycle phase.

Methods inherited from interface griffon.core.Observable

addPropertyChangeListener, addPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener

Field Detail

PROPERTY_LOCALE

static final String PROPERTY_LOCALE

See Also:

Constant Field Values

PROPERTY_PHASE

static final String PROPERTY_PHASE

See Also:

Constant Field Values

Method Detail

createApplicationContainer

@Nonnull
Object createApplicationContainer(@Nonnull
                                        Map<String,Object> attributes)

getApplicationClassLoader

@Nonnull
ApplicationClassLoader getApplicationClassLoader()

getConfiguration

@Nonnull
Configuration getConfiguration()

getUIThreadManager

@Nonnull
UIThreadManager getUIThreadManager()

getEventRouter

@Nonnull
EventRouter getEventRouter()

getArtifactManager

@Nonnull
ArtifactManager getArtifactManager()

getActionManager

@Nonnull
ActionManager getActionManager()

getAddonManager

@Nonnull
AddonManager getAddonManager()

getMvcGroupManager

@Nonnull
MVCGroupManager getMvcGroupManager()

getMessageSource

@Nonnull
MessageSource getMessageSource()

getResourceResolver

@Nonnull
ResourceResolver getResourceResolver()

getResourceHandler

@Nonnull
ResourceHandler getResourceHandler()

getResourceInjector

@Nonnull
ResourceInjector getResourceInjector()

getInjector

@Nonnull
Injector<?> getInjector()

getWindowManager

@Nonnull
<W> WindowManager<W> getWindowManager()

initialize

void initialize()

Executes the 'Initialize' life cycle phase.

startup

void startup()

Executes the 'Startup' life cycle phase.

ready

void ready()

Executes the 'Ready' life cycle phase.

shutdown

boolean shutdown()

Executes the 'Shutdown' life cycle phase.

Returns:

false if the shutdown sequence was aborted

canShutdown

boolean canShutdown()

Queries any available ShutdownHandlers.

Returns:

true if the shutdown sequence can proceed, false otherwise

addShutdownHandler

void addShutdownHandler(@Nonnull
                      ShutdownHandler handler)

Registers a ShutdownHandler on this application

Parameters:

handler - the shutdown handler to be registered; null and/or duplicated values should be ignored

removeShutdownHandler

void removeShutdownHandler(@Nonnull
                         ShutdownHandler handler)

Removes a ShutdownHandler from this application

Parameters:

handler - the shutdown handler to be removed; null and/or duplicated values should be ignored

getLocale

@Nonnull
Locale getLocale()

Gets the application locale.

Returns:

the current Locale used by the application. Never returns null.

setLocale

void setLocale(@Nonnull
             Locale locale)

Sets the application locale.

This is a bound property.

Parameters:

locale - the Locale value to use

setLocaleAsString

void setLocaleAsString(@Nullable
                     String locale)

Sets the application locale.

This is a bound property.

Parameters:

locale - a literal representation of a Locale

getPhase

@Nonnull
ApplicationPhase getPhase()

Returns the current phase.

Returns:

returns the current ApplicationPhase. Never returns null.

getStartupArgs

@Nonnull
String[] getStartupArgs()

Returns the arguments set on the command line (if any).

Returns:

an array of command line arguments. Never returns null.

getLog

@Nonnull
Logger getLog()

Returns a Logger instance suitable for this application.

Returns:

a Logger instance.