griffon.core.view

Interface WindowManager<W>

All Superinterfaces:

ShutdownHandler

All Known Subinterfaces:

JavaFXWindowManager, LanternaWindowManager, PivotWindowManager, SwingWindowManager

All Known Implementing Classes:

AbstractWindowManager, DefaultJavaFXWindowManager, DefaultLanternaWindowManager, DefaultPivotWindowManager, DefaultSwingWindowManager, NoopWindowManager

public interface WindowManager<W>
extends ShutdownHandler

Controls a set of windows that belong to the application.

Windows that are controlled by a WindowManager can be shown/hidden using a custom strategy (WindowDisplayHandler)

Since:

2.0.0

Author:

Andres Almiray

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.
W	findWindow(String name) Finds a Window by name.
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.
Collection<W>	getWindows() Returns the list of windows managed by this manager.
void	hide(String name) Hides the window.
void	hide(W window) Hides the window.
boolean	isAutoShutdown() Returns the value of the "application.autoShutdown" configuration flag.
void	onShutdown(GriffonApplication app) Hides all visible windows
void	show(String name) Shows the window.
void	show(W window) Shows the window.

Method Detail

findWindow

@Nullable
W findWindow(@Nonnull
                       String name)

Finds a Window by name.

Parameters:

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

Returns:

a Window if a match is found, null otherwise.

getAt

@Nullable
W getAt(int index)

Convenience method to get a managed Window by index.

Follows the Groovy conventions for overriding the [] operator.

Parameters:

index - the index of the Window to be retrieved

Returns:

the Window found at the specified index

Throws:

ArrayIndexOutOfBoundsException - if the index is invalid (below 0 or greater than the size of the managed windows list)

getStartingWindow

@Nullable
W getStartingWindow()

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.

Returns:

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

getWindows

@Nonnull
Collection<W> getWindows()

Returns the list of windows managed by this manager.

Returns:

a List of currently managed windows

attach

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

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

Parameters:

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

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

detach

void detach(@Nonnull
            String name)

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

Parameters:

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

show

void show(@Nonnull
          W window)

Shows the window.

This method is executed SYNCHRONOUSLY in the UI thread.

Parameters:

window - the window to show

show

void show(@Nonnull
          String name)

Shows the window.

This method is executed SYNCHRONOUSLY in the UI thread.

Parameters:

name - the name of window to show

hide

void hide(@Nonnull
          W window)

Hides the window.

This method is executed SYNCHRONOUSLY in the UI thread.

Parameters:

window - the window to hide

hide

void hide(@Nonnull
          String name)

Hides the window.

This method is executed SYNCHRONOUSLY in the UI thread.

Parameters:

name - the name of window to hide

canShutdown

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

Parameters:

app - the current running application

Returns:

true if the shutdown sequence can proceed, false otherwise

onShutdown

void onShutdown(@Nonnull
                GriffonApplication app)

Hides all visible windows

Specified by:

onShutdown in interface ShutdownHandler

Parameters:

app - the current running application

countVisibleWindows

int countVisibleWindows()

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

Returns:

the number of visible Windows

isAutoShutdown

boolean isAutoShutdown()

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

Returns:

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