Fix NEWT/AWT WindowClosing Unit Tests ; Review/Cleanup NEWT WindowClosing mechanism

Due to a NEWT WindowClosing event regression cause by NewtCanvasAWT changes
a review of our WindowClosing event mechanism was required.

Important cleanups are marked w/ '(*)' below.

I would have preferred to change the 'WindowListener.windowDestroyNotify(WindowEvent)'
method to pass a WindowCloseEvent object exposing more information like
toolkit or programmatic destruction and passing whether a 'closing' or 'nop' action
will be performed based on the WindowClosingMode.
For now I postponed this idea .. since it would change the API again,
but may reconsider it after merging the Android 'closing' patch.

- InputEvent.consumedTag -> NEWTEvent.consumedTag

- Window
  - (*) Promote setWindowDestroyNotifyAction(Runnable) to public,
        former WindowImpl.setHandleDestroyNotify(boolean).
    Using a Runnable action for WindowImpl.windowDestroyNotify(boolean)
    allows a setting defined alternative for destroy() and gets rid
    of [ab]using WindowListener.windowDestroyNotify(WindowEvent) for
    lifecycle actions. Used in:
      - GLWindow
      - GLAutoDrawableDelegate impl.

- WindowImpl
  - Respect NEWTEvent.consumedTag for WindowEvents as well

  - (*) Impl. setHandleDestroyNotify(boolean) (see above)

  - (*) destroy() simply sends out pre- and post- destruction Window events,
    where windowDestroyNotify(boolean) sends out the pre-destruction event if NOP.

  - (*) windowDestroyNotify(boolean) is public now, allowing other impl. details
    to follow proper destruction using handleDestroyNotify Runnable (-> NewtCanvasAWT).

- AWTWindowClosingProtocol:
  - addClosingListenerOneShot() -> addClosingListener()
    - calling addClosingListener() at addNotify()
    - calling removeClosingListener() at removeNotify()

  - AWTWindowClosingProtocol ctor taking NOP runnable,
    allowing to send WindowEvent.EVENT_WINDOW_DESTROY_NOTIFY at WindowClosingMode.DO_NOTHING_ON_CLOSE

  - add/remove listener on AWT-EDT

- AWTWindowAdapter
  - Add 'removeWindowClosingFrom(..)',
    allowing to remove window closing event fwd.

  - Also fwd windowClosed in window closing fwd'ing.

- NewtCanvasAWT
  - (*) Utilize AWTWindowClosingProtocol NOP runnable (see above)
    to fwd closing-NOP event to NEWT

  - (*) Unify remove/destroy code in destroyImpl(..)
    - !removeNotify -> destroy NEWT child programatic or as toolkit event
    - removeNotify || windowClosing -> destroy jawtWindow

  - (*) Remove AWTWindowAdapter/AWTParentWindowAdapter's windowClosingListener,
    since we utilize AWTWindowClosingProtocol

- DisplayImpl
  - Adding 'final void dispatchMessage(final NEWTEvent event)'
    allowing to remove the NEWTEventTask wrapping for no reason
    in enqueueEvent(..) if on EDT and waiting.

1 files changed, 48 insertions, 37 deletions

diff --git a/src/nativewindow/classes/com/jogamp/nativewindow/awt/AWTWindowClosingProtocol.java b/src/nativewindow/classes/com/jogamp/nativewindow/awt/AWTWindowClosingProtocol.java
index d78b4ac15..e3f85b948 100644
--- a/src/nativewindow/classes/com/jogamp/nativewindow/awt/AWTWindowClosingProtocol.java
+++ b/src/nativewindow/classes/com/jogamp/nativewindow/awt/AWTWindowClosingProtocol.java
@@ -33,22 +33,31 @@ import java.awt.Window;
 import java.awt.event.WindowAdapter;
 import java.awt.event.WindowEvent;
 import java.awt.event.WindowListener;
+
 import javax.media.nativewindow.WindowClosingProtocol;
 
+import jogamp.common.awt.AWTEDTExecutor;
 import jogamp.nativewindow.awt.AWTMisc;
 
 public class AWTWindowClosingProtocol implements WindowClosingProtocol {
 
   private Component comp;
-  private Runnable closingOperation;
-  private volatile boolean closingListenerSet = false;
+  private Runnable closingOperationClose;
+  private Runnable closingOperationNOP;
+  private boolean closingListenerSet = false;
   private Object closingListenerLock = new Object();
   private WindowClosingMode defaultCloseOperation = WindowClosingMode.DISPOSE_ON_CLOSE;
   private boolean defaultCloseOperationSetByUser = false;
 
-  public AWTWindowClosingProtocol(Component comp, Runnable closingOperation) {
+  /**
+   * @param comp mandatory AWT component which AWT Window is being queried by parent traversal
+   * @param closingOperationClose mandatory closing operation, triggered if windowClosing and {@link WindowClosingMode#DISPOSE_ON_CLOSE}
+   * @param closingOperationNOP optional closing operation, triggered if windowClosing and {@link WindowClosingMode#DO_NOTHING_ON_CLOSE}
+   */
+  public AWTWindowClosingProtocol(Component comp, Runnable closingOperationClose, Runnable closingOperationNOP) {
       this.comp = comp;
-      this.closingOperation = closingOperation;
+      this.closingOperationClose = closingOperationClose;
+      this.closingOperationNOP = closingOperationNOP;
   }
 
   class WindowClosingAdapter extends WindowAdapter {
@@ -59,54 +68,56 @@ public class AWTWindowClosingProtocol implements WindowClosingProtocol {
       if( WindowClosingMode.DISPOSE_ON_CLOSE == op ) {
           // we have to issue this call right away,
           // otherwise the window gets destroyed
-          closingOperation.run();
+          closingOperationClose.run();
+      } else if( null != closingOperationNOP ){
+          closingOperationNOP.run();
       }
     }
   }
   WindowListener windowClosingAdapter = new WindowClosingAdapter();
 
-  final boolean addClosingListenerImpl() {
-    Window w = AWTMisc.getWindow(comp);
-    if(null!=w) {
-        w.addWindowListener(windowClosingAdapter);
-        return true;
-    }
-    return false;
-  }
-
   /**
-   * Adds this closing listener to the components Window if exist and only one time.<br>
-   * Hence you may call this method every time to ensure it has been set,
-   * ie in case the Window parent is not available yet.
+   * Adds this closing listener to the components Window if exist and only one time.
+   * <p>
+   * If the closing listener is already added, and {@link IllegalStateException} is thrown. 
+   * </p>
    *
-   * @return
+   * @return true if added, otherwise false.
+   * @throws IllegalStateException
    */
-  public final boolean addClosingListenerOneShot() {
-    if(!closingListenerSet) { // volatile: ok
+  public final boolean addClosingListener() throws IllegalStateException {
       synchronized(closingListenerLock) {
-        if(!closingListenerSet) {
-            closingListenerSet=addClosingListenerImpl();
-            return closingListenerSet;
-        }
+          if(closingListenerSet) {
+              throw new IllegalStateException("WindowClosingListener already set");
+          }
+          final Window w = AWTMisc.getWindow(comp);
+          if(null!=w) {
+              AWTEDTExecutor.singleton.invoke(true, new Runnable() {
+                public void run() {
+                    w.addWindowListener(windowClosingAdapter);
+                } } );
+              closingListenerSet = true;
+              return true;
+          }
       }
-    }
-    return false;
+      return false;
   }
 
   public final boolean removeClosingListener() {
-    if(closingListenerSet) { // volatile: ok
       synchronized(closingListenerLock) {
-        if(closingListenerSet) {
-            Window w = AWTMisc.getWindow(comp);
-            if(null!=w) {
-                w.removeWindowListener(windowClosingAdapter);
-                closingListenerSet = false;
-                return true;
-            }
-        }
+          if(closingListenerSet) {
+              final Window w = AWTMisc.getWindow(comp);
+              if(null!=w) {
+                  AWTEDTExecutor.singleton.invoke(true, new Runnable() {
+                    public void run() {
+                        w.removeWindowListener(windowClosingAdapter);
+                    } } );
+                  closingListenerSet = false;
+                  return true;
+              }
+          }
       }
-    }
-    return false;
+      return false;
   }
 
   /**