org.codehaus.griffon.runtime.core.view

Class AbstractWindowManager<W>

java.lang.Object

org.codehaus.griffon.runtime.core.view.AbstractWindowManager<W>

All Implemented Interfaces:

ShutdownHandler, WindowManager<W>

Direct Known Subclasses:

DefaultJavaFXWindowManager, DefaultLanternaWindowManager, DefaultPivotWindowManager, DefaultSwingWindowManager

public abstract class AbstractWindowManager<W>
extends Object
implements WindowManager<W>

Since:

2.0.0

Author:

Andres Almiray

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	ERROR_NAME_BLANK
protected static String	ERROR_WINDOW_NULL

Constructor Summary

Constructors

Constructor and Description
AbstractWindowManager(GriffonApplication application, WindowDisplayHandler<W> windowDisplayHandler)

Method Summary

Modifier and Type	Method and Description
void	attach(String name, W window) Registers a window on this manager if an only if the window is not null and it's not registered already.
boolean	canShutdown(GriffonApplication app) Asks this handler if the application's shutdown sequence can proceed or not.
int	countVisibleWindows() Counts how many Windows are visible regardless of their attached status to this WindowManager.
void	detach(String name) Removes the window from the list of manages windows if and only if it is registered with this manager.
protected abstract void	doAttach(W window)
protected abstract void	doDetach(W window)
protected void	event(ApplicationEvent evt, List<?> args)
protected void	event(String evt, List<?> args)
W	findWindow(String name) Finds a Window by name.
String	findWindowName(W window) Lookups a name related to a Window.
protected GriffonApplication	getApplication()
W	getAt(int index) Convenience method to get a managed Window by index.
W	getStartingWindow() Finds the Window that should be displayed during the Ready phase of an application.
Set<String>	getWindowNames() Returns a set of names related to all windows managed by this manager.
Collection<W>	getWindows() Returns the collection of windows managed by this manager.
void	hide(String name) Hides the window.
void	hide(W window) Hides the window.
int	indexOf(W window) Lookups the index related to a Window.
boolean	isAutoShutdown() Returns the value of the "application.autoShutdown" configuration flag.
protected abstract boolean	isWindowVisible(W window)
void	onShutdown(GriffonApplication app) Hides all visible windows
protected Object	resolveStartingWindowFromConfiguration()
protected WindowDisplayHandler<W>	resolveWindowDisplayHandler()
void	show(String name) Shows the window.
void	show(W window) Shows the window.

Methods inherited from class java.lang.Object

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

Field Detail

ERROR_NAME_BLANK

protected static final String ERROR_NAME_BLANK

See Also:

Constant Field Values

ERROR_WINDOW_NULL

protected static final String ERROR_WINDOW_NULL

See Also:

Constant Field Values

Constructor Detail

AbstractWindowManager

@Inject
public AbstractWindowManager(@Nonnull
                                     GriffonApplication application,
                                     @Nonnull
                                     WindowDisplayHandler<W> windowDisplayHandler)

Method Detail

getApplication

protected GriffonApplication getApplication()

getWindowNames

@Nonnull
public Set<String> getWindowNames()

Description copied from interface: WindowManager

Returns a set of names related to all windows managed by this manager.

Specified by:

getWindowNames in interface WindowManager<W>

Returns:

a Set of managed window names

findWindowName

@Nullable
public String findWindowName(@Nonnull
                                       W window)

Description copied from interface: WindowManager

Lookups a name related to a Window.

Specified by:

findWindowName in interface WindowManager<W>

Parameters:

window - the window to be looked up

Returns:

the name of the window if it's managed by this manager, null otherwise.

indexOf

public int indexOf(@Nonnull
                   W window)

Description copied from interface: WindowManager

Lookups the index related to a Window.

Specified by:

indexOf in interface WindowManager<W>

Parameters:

window - the window to be looked up

Returns:

the index of the window if it's managed by this manager, -1 otherwise.

findWindow

@Nullable
public W findWindow(@Nonnull
                              String name)

Description copied from interface: WindowManager

Finds a Window by name.

Specified by:

findWindow in interface WindowManager<W>

Parameters:

name - the value of the of the Window's name

Returns:

a Window if a match is found, null otherwise.

getAt

@Nullable
public W getAt(int index)

Description copied from interface: WindowManager

Convenience method to get a managed Window by index.

Follows the Groovy conventions for overriding the [] operator.

Specified by:

getAt in interface WindowManager<W>

Parameters:

index - the index of the Window to be retrieved

Returns:

the Window found at the specified index

getStartingWindow

@Nullable
public W getStartingWindow()

Description copied from interface: WindowManager

Finds the Window that should be displayed during the Ready phase of an application.

The WindowManager expects a configuration flag windowManager.startingWindow to be present in order to determine which Window will be displayed during the Ready phase. If no configuration is found the WindowManager will pick the first Window found in the list of managed windows.

The configuration flag accepts two value types:

• a String that defines the name of the Window. You must make sure the Window has a matching name property.
• a Number that defines the index of the Window in the list of managed windows.

Specified by:

getStartingWindow in interface WindowManager<W>

Returns:

a Window that matches the given criteria or null if no match is found.

resolveStartingWindowFromConfiguration

@Nullable
protected Object resolveStartingWindowFromConfiguration()

getWindows

@Nonnull
public Collection<W> getWindows()

Description copied from interface: WindowManager

Returns the collection of windows managed by this manager.

Specified by:

getWindows in interface WindowManager<W>

Returns:

a Collection of currently managed windows

attach

public void attach(@Nonnull
                   String name,
                   @Nonnull
                   W window)

Description copied from interface: WindowManager

Registers a window on this manager if an only if the window is not null and it's not registered already.

Specified by:

attach in interface WindowManager<W>

Parameters:

name - the value of the of the Window's name

window - the window to be added to the list of managed windows

doAttach

protected abstract void doAttach(@Nonnull
                                 W window)

detach

public void detach(@Nonnull
                   String name)

Description copied from interface: WindowManager

Removes the window from the list of manages windows if and only if it is registered with this manager.

Specified by:

detach in interface WindowManager<W>

Parameters:

name - the value of the of the Window's name

doDetach

protected abstract void doDetach(@Nonnull
                                 W window)

show

public void show(@Nonnull
                 W window)

Description copied from interface: WindowManager

Shows the window.

This method is executed SYNCHRONOUSLY in the UI thread.

Specified by:

show in interface WindowManager<W>

Parameters:

window - the window to show

show

public void show(@Nonnull
                 String name)

Description copied from interface: WindowManager

Shows the window.

This method is executed SYNCHRONOUSLY in the UI thread.

Specified by:

show in interface WindowManager<W>

Parameters:

name - the name of window to show

hide

public void hide(@Nonnull
                 W window)

Description copied from interface: WindowManager

Hides the window.

This method is executed SYNCHRONOUSLY in the UI thread.

Specified by:

hide in interface WindowManager<W>

Parameters:

window - the window to hide

resolveWindowDisplayHandler

@Nonnull
protected WindowDisplayHandler<W> resolveWindowDisplayHandler()

hide

public void hide(@Nonnull
                 String name)

Description copied from interface: WindowManager

Hides the window.

This method is executed SYNCHRONOUSLY in the UI thread.

Specified by:

hide in interface WindowManager<W>

Parameters:

name - the name of window to hide

canShutdown

public boolean canShutdown(@Nonnull
                           GriffonApplication app)

Description copied from interface: ShutdownHandler

Asks this handler if the application's shutdown sequence can proceed or not.

Return false if the shutdown sequence must be aborted.

Specified by:

canShutdown in interface ShutdownHandler

Specified by:

canShutdown in interface WindowManager<W>

Parameters:

app - the current running application

Returns:

true if the shutdown sequence can proceed, false otherwise

onShutdown

public void onShutdown(@Nonnull
                       GriffonApplication app)

Description copied from interface: WindowManager

Hides all visible windows

Specified by:

onShutdown in interface ShutdownHandler

Specified by:

onShutdown in interface WindowManager<W>

Parameters:

app - the current running application

isWindowVisible

protected abstract boolean isWindowVisible(@Nonnull
                                           W window)

countVisibleWindows

public int countVisibleWindows()

Description copied from interface: WindowManager

Counts how many Windows are visible regardless of their attached status to this WindowManager.

Specified by:

countVisibleWindows in interface WindowManager<W>

Returns:

the number of visible Windows

isAutoShutdown

public boolean isAutoShutdown()

Description copied from interface: WindowManager

Returns the value of the "application.autoShutdown" configuration flag.

Specified by:

isAutoShutdown in interface WindowManager<W>

Returns:

the value of the "application.autoShutdown" configuration flag.

event

protected void event(@Nonnull
                     ApplicationEvent evt,
                     @Nonnull
                     List<?> args)

event

protected void event(@Nonnull
                     String evt,
                     @Nonnull
                     List<?> args)