org.codehaus.griffon.runtime.core.view

Class ConfigurableWindowDisplayHandler<W>

java.lang.Object

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

All Implemented Interfaces:

WindowDisplayHandler<W>

Direct Known Subclasses:

ConfigurableJavaFXWindowDisplayHandler, ConfigurableLanternaWindowDisplayHandler, ConfigurablePivotWindowDisplayHandler, ConfigurableSwingWindowDisplayHandler

public class ConfigurableWindowDisplayHandler<W>
extends java.lang.Object
implements WindowDisplayHandler<W>

Implementation of a per window WindowDisplayHandler that can be configured via a DSL.

This is the default WindowDisplayHandler used by SwingApplication. It expects a configuration entry in griffon-app/conf/Config.groovy that looks like the following one

     windowManager {
         myWindowName = [
             show: {name, window -> ... },
             hide: {name, window -> ... }
         ]
         myOtherWindowName = [
             show: {name, window -> ... }
         ]
     }
 

For these settings to work you must specify a name: property on the Window/Frame instance. This WindowDisplayHandler is smart enough to use the default show/hide behavior should any or both are not specified or if a window name does not have a matching configuration. The default behavior will also be used if the Window/Frame does not have a value for its name: property.

There's a third option that can be set for each configured window, and that is a delegate WindowDisplayHandler that will be used for that window alone. The following example shows how it can be configured

     windowManager {
         myWindowName = [
             handler: new MyCustomWindowDisplayHandler()
         ]
         myOtherWindowName = [
             show: {name, window -> ... }
         ]
     }
 

Lastly, a global handler can be specified for all windows that have not been configured. If specified, this handler will override the usage of the default one. It can be configured as follows

     windowManager {
         defaultHandler = new MyCustomWindowDisplayHandler()
         myOtherWindowName = [
             show: {name, window -> ... }
         ]
     }
 

Fine grained control for default show and hide is also possible, by specifying defaultShow and/or defaultHide properties at the global level. These properties take precedence over defaultHandler .

     windowManager {
         defaultHide = {name, window -> ... }
         myOtherWindowName = [
             show: {name, window -> ... }
         ]
     }
 

Note: the value for show and hide can be either a Closure or a RunnableWithArgs.

Since:

2.0.0

Author:

Andres Almiray

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	ERROR_NAME_BLANK
protected static java.lang.String	ERROR_WINDOW_NULL

Constructor Summary

Constructors

Constructor and Description
ConfigurableWindowDisplayHandler(GriffonApplication application, WindowDisplayHandler<W> delegateWindowsDisplayHandler)

Method Summary

Modifier and Type	Method and Description
protected boolean	canBeRun(java.lang.Object obj)
protected WindowDisplayHandler<W>	fetchDefaultWindowDisplayHandler()
protected GriffonApplication	getApplication()
WindowDisplayHandler<W>	getDelegateWindowsDisplayHandler()
protected boolean	handleHideByInjectedHandler(java.lang.String name, W window)
protected boolean	handleShowByInjectedHandler(java.lang.String name, W window)
void	hide(java.lang.String name, W window) Callback for hiding a window.
protected void	run(java.lang.Object handler, java.lang.String name, W window)
void	show(java.lang.String name, W window) Callback for displaying a window.
protected java.util.Map<java.lang.String,java.lang.Object>	windowBlock(java.lang.String windowName)
protected java.util.Map<java.lang.String,java.lang.Object>	windowManagerBlock()

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 java.lang.String ERROR_NAME_BLANK

See Also:

Constant Field Values

ERROR_WINDOW_NULL

protected static final java.lang.String ERROR_WINDOW_NULL

See Also:

Constant Field Values

Constructor Detail

ConfigurableWindowDisplayHandler

@Inject
public ConfigurableWindowDisplayHandler(@Nonnull
                                                GriffonApplication application,
                                                @Nonnull @Named(value="defaultWindowDisplayHandler")
                                                WindowDisplayHandler<W> delegateWindowsDisplayHandler)

Method Detail

show

public void show(@Nonnull
                 java.lang.String name,
                 @Nonnull
                 W window)

Description copied from interface: WindowDisplayHandler

Callback for displaying a window.

Specified by:

show in interface WindowDisplayHandler<W>

window - the window to be displayed

hide

public void hide(@Nonnull
                 java.lang.String name,
                 @Nonnull
                 W window)

Description copied from interface: WindowDisplayHandler

Callback for hiding a window.

Specified by:

hide in interface WindowDisplayHandler<W>

window - the window to hide

handleShowByInjectedHandler

protected boolean handleShowByInjectedHandler(@Nonnull
                                              java.lang.String name,
                                              @Nonnull
                                              W window)

handleHideByInjectedHandler

protected boolean handleHideByInjectedHandler(@Nonnull
                                              java.lang.String name,
                                              @Nonnull
                                              W window)

getDelegateWindowsDisplayHandler

public WindowDisplayHandler<W> getDelegateWindowsDisplayHandler()

canBeRun

protected boolean canBeRun(@Nullable
                           java.lang.Object obj)

run

protected void run(@Nonnull
                   java.lang.Object handler,
                   @Nonnull
                   java.lang.String name,
                   @Nonnull
                   W window)

windowManagerBlock

protected java.util.Map<java.lang.String,java.lang.Object> windowManagerBlock()

windowBlock

protected java.util.Map<java.lang.String,java.lang.Object> windowBlock(java.lang.String windowName)

getApplication

protected GriffonApplication getApplication()

fetchDefaultWindowDisplayHandler

@Nonnull
protected WindowDisplayHandler<W> fetchDefaultWindowDisplayHandler()