WindowManager (Griffon 2.13.0)

All Superinterfaces:

ShutdownHandler

All Known Subinterfaces:

JavaFXWindowManager, LanternaWindowManager, PivotWindowManager, SwingWindowManager

All Known Implementing Classes:

AbstractWindowManager, DefaultJavaFXWindowManager, DefaultLanternaWindowManager, DefaultPivotWindowManager, DefaultSwingWindowManager, NoopWindowManager, TestJavaFXWindowManager
```
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

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`attach(java.lang.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(java.lang.String name)` Removes the window from the list of manages windows if and only if it is registered with this manager.
`W`	`findWindow(java.lang.String name)` Finds a Window by name.
`java.lang.String`	`findWindowName(W window)` Lookups a name related to a Window.
`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.
`java.util.Set<java.lang.String>`	`getWindowNames()` Returns a set of names related to all windows managed by this manager.
`java.util.Collection<W>`	`getWindows()` Returns the collection of windows managed by this manager.
`void`	`hide(java.lang.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.
`void`	`onShutdown(GriffonApplication app)` Hides all visible windows
`void`	`show(java.lang.String name)` Shows the window.
`void`	`show(W window)` Shows the window.

- Method Detail
  - findWindow
```
@Nullable
W findWindow(@Nonnull
                       java.lang.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:
    
    java.lang.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
java.util.Collection<W> getWindows()
```
    Returns the collection of windows managed by this manager.
    
    Returns:
    
    a Collection of currently managed windows
  - getWindowNames
```
@Nonnull
java.util.Set<java.lang.String> getWindowNames()
```
    Returns a set of names related to all windows managed by this manager.
    
    Returns:
    
    a Set of managed window names
    
    Since:
    
    2.3.0
  - findWindowName
```
@Nullable
java.lang.String findWindowName(@Nonnull
                                          W window)
```
    Lookups a name related to a Window.
    
    Parameters:
    
    window - the window to be looked up
    
    Returns:
    
    the name of the window if it's managed by this manager, null otherwise.
    
    Since:
    
    2.3.0
  - indexOf
```
int indexOf(@Nonnull
            W window)
```
    Lookups the index related to a Window.
    
    Parameters:
    
    window - the window to be looked up
    
    Returns:
    
    the index of the window if it's managed by this manager, -1 otherwise.
    
    Since:
    
    2.3.0
  - attach
```
void attach(@Nonnull
            java.lang.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
            java.lang.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
          java.lang.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
          java.lang.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.

Interface WindowManager<W>

Method Summary

Method Detail

findWindow

getAt

getStartingWindow

getWindows

getWindowNames

findWindowName

indexOf

attach

detach

show

show

hide

hide

canShutdown

onShutdown

countVisibleWindows

isAutoShutdown