NoopWindowManager (Griffon 2.3.0)

java.lang.Object
- org.codehaus.griffon.runtime.core.view.NoopWindowManager

All Implemented Interfaces:

ShutdownHandler, WindowManager<Object>
```
public final class NoopWindowManager
extends Object
implements WindowManager<Object>
```
Since:

2.0.0

Author:

Andres Almiray

Constructor Summary

Constructors
Constructor and Description

NoopWindowManager(GriffonApplication application)

Constructors
Constructor and Description
`NoopWindowManager(GriffonApplication application)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`attach(String name, Object 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.
`Object`	`findWindow(String name)` Finds a Window by name.
`String`	`findWindowName(Object window)` Lookups a name related to a Window.
`Object`	`getAt(int index)` Convenience method to get a managed Window by index.
`Object`	`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<Object>`	`getWindows()` Returns the collection of windows managed by this manager.
`void`	`hide(Object window)` Hides the window.
`void`	`hide(String name)` Hides the window.
`int`	`indexOf(Object 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(Object window)` Shows the window.
`void`	`show(String name)` Shows the window.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - NoopWindowManager
```
@Inject
public NoopWindowManager(@Nonnull
                                 GriffonApplication application)
```
- Method Detail
  - findWindow
```
@Nullable
public Object findWindow(@Nonnull
                                   String name)
```
    Description copied from interface: WindowManager
    
    Finds a Window by name.
    
    Specified by:
    
    findWindow in interface WindowManager<Object>
    
    Parameters:
    
    name - the value of the of the Window's name
    
    Returns:
    
    a Window if a match is found, null otherwise.
  - getAt
```
@Nullable
public Object 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<Object>
    
    Parameters:
    
    index - the index of the Window to be retrieved
    
    Returns:
    
    the Window found at the specified index
  - getStartingWindow
```
@Nullable
public Object 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<Object>
    
    Returns:
    
    a Window that matches the given criteria or null if no match is found.
  - getWindows
```
@Nonnull
public Collection<Object> getWindows()
```
    Description copied from interface: WindowManager
    
    Returns the collection of windows managed by this manager.
    
    Specified by:
    
    getWindows in interface WindowManager<Object>
    
    Returns:
    
    a Collection of currently managed windows
  - 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<Object>
    
    Returns:
    
    a Set of managed window names
  - findWindowName
```
@Nullable
public String findWindowName(@Nonnull
                                       Object window)
```
    Description copied from interface: WindowManager
    
    Lookups a name related to a Window.
    
    Specified by:
    
    findWindowName in interface WindowManager<Object>
    
    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
                   Object window)
```
    Description copied from interface: WindowManager
    
    Lookups the index related to a Window.
    
    Specified by:
    
    indexOf in interface WindowManager<Object>
    
    Parameters:
    
    window - the window to be looked up
    
    Returns:
    
    the index of the window if it's managed by this manager, -1 otherwise.
  - attach
```
public void attach(@Nonnull
                   String name,
                   @Nonnull
                   Object 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<Object>
    
    Parameters:
    
    name - the value of the of the Window's name
    
    window - the window to be added to the list of managed windows
  - 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<Object>
    
    Parameters:
    
    name - the value of the of the Window's name
  - show
```
public void show(@Nonnull
                 Object window)
```
    Description copied from interface: WindowManager
    
    Shows the window.
    This method is executed SYNCHRONOUSLY in the UI thread.
    
    Specified by:
    
    show in interface WindowManager<Object>
    
    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<Object>
    
    Parameters:
    
    name - the name of window to show
  - hide
```
public void hide(@Nonnull
                 Object window)
```
    Description copied from interface: WindowManager
    
    Hides the window.
    This method is executed SYNCHRONOUSLY in the UI thread.
    
    Specified by:
    
    hide in interface WindowManager<Object>
    
    Parameters:
    
    window - the window to hide
  - 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<Object>
    
    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<Object>
    
    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<Object>
    
    Parameters:
    
    app - the current running application
  - 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<Object>
    
    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<Object>
    
    Returns:
    
    the value of the "application.autoShutdown" configuration flag.

Class NoopWindowManager

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

NoopWindowManager

Method Detail

findWindow

getAt

getStartingWindow

getWindows

getWindowNames

findWindowName

indexOf

attach

detach

show

show

hide

hide

canShutdown

onShutdown

countVisibleWindows

isAutoShutdown