Adding NativeWindowHolder extends NativeSurfaceHolder; API Doc for NEWTDemoListener

NativeWindowHolder abstracts access to is-a or has-a parent component's NativeWindow
like NewtCanvasAWT, NewtCanvasJFX and NewtCanvasSWT

Adding API Doc for NEWTDemoListener.

3 files changed, 238 insertions, 22 deletions

diff --git a/src/test/com/jogamp/opengl/test/junit/newt/parenting/NewtAWTReparentingKeyAdapter.java b/src/test/com/jogamp/opengl/test/junit/newt/parenting/NewtAWTReparentingKeyAdapter.java
index 4fdee82c3..276c4ccb9 100644
--- a/src/test/com/jogamp/opengl/test/junit/newt/parenting/NewtAWTReparentingKeyAdapter.java
+++ b/src/test/com/jogamp/opengl/test/junit/newt/parenting/NewtAWTReparentingKeyAdapter.java
@@ -1,5 +1,5 @@
 /**
- * Copyright 2011 JogAmp Community. All rights reserved.
+ * Copyright 2011, 2019 JogAmp Community. All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without modification, are
  * permitted provided that the following conditions are met:
@@ -30,21 +30,23 @@ package com.jogamp.opengl.test.junit.newt.parenting;
 import java.awt.Frame;
 
 import com.jogamp.nativewindow.CapabilitiesImmutable;
+import com.jogamp.nativewindow.NativeWindow;
+import com.jogamp.nativewindow.NativeWindowHolder;
 import com.jogamp.nativewindow.util.InsetsImmutable;
 import com.jogamp.newt.Window;
-import com.jogamp.newt.awt.NewtCanvasAWT;
 import com.jogamp.newt.event.KeyEvent;
 import com.jogamp.newt.opengl.GLWindow;
 import com.jogamp.newt.opengl.util.NEWTDemoListener;
 
-public class NewtAWTReparentingKeyAdapter extends NEWTDemoListener {
+/**
+ * AWT specializing demo functionality of {@link NewtReparentingKeyAdapter}, includes {@link NEWTDemoListener}.
+ */
+public class NewtAWTReparentingKeyAdapter extends NewtReparentingKeyAdapter {
     final Frame frame;
-    final NewtCanvasAWT newtCanvasAWT;
 
-    public NewtAWTReparentingKeyAdapter(final Frame frame, final NewtCanvasAWT newtCanvasAWT, final GLWindow glWindow) {
-        super(glWindow, null);
+    public NewtAWTReparentingKeyAdapter(final Frame frame, final NativeWindowHolder winHolder, final GLWindow glWindow) {
+        super(winHolder, glWindow);
         this.frame = frame;
-        this.newtCanvasAWT = newtCanvasAWT;
     }
 
     public void keyPressed(final KeyEvent e) {
@@ -54,12 +56,6 @@ public class NewtAWTReparentingKeyAdapter extends NEWTDemoListener {
         if( 0 == e.getModifiers() ) { // all modifiers go to super class ..
           final int keySymbol = e.getKeySymbol();
           switch (keySymbol) {
-            case KeyEvent.VK_L:
-                e.setConsumed(true);
-                final com.jogamp.nativewindow.util.Point p0 = newtCanvasAWT.getNativeWindow().getLocationOnScreen(null);
-                final com.jogamp.nativewindow.util.Point p1 = glWindow.getLocationOnScreen(null);
-                printlnState("[location]", "AWT "+p0+", NEWT "+p1);
-                break;
             case KeyEvent.VK_R:
                 e.setConsumed(true);
                 quitAdapterOff();
@@ -68,7 +64,7 @@ public class NewtAWTReparentingKeyAdapter extends NEWTDemoListener {
                         final java.lang.Thread t = glWindow.setExclusiveContextThread(null);
                         if(glWindow.getParent()==null) {
                             printlnState("[reparent pre - glWin to HOME]");
-                            glWindow.reparentWindow(newtCanvasAWT.getNativeWindow(), -1, -1, 0 /* hints */);
+                            glWindow.reparentWindow(winHolder.getNativeWindow(), -1, -1, 0 /* hints */);
                         } else {
                             if( null != frame ) {
                                 final InsetsImmutable nInsets = glWindow.getInsets();
@@ -103,20 +99,16 @@ public class NewtAWTReparentingKeyAdapter extends NEWTDemoListener {
 
     @Override
     public void setTitle() {
-        setTitle(frame, newtCanvasAWT, glWindow);
+        setTitle(frame, winHolder.getNativeWindow(), glWindow);
     }
-    public static void setTitle(final Frame frame, final NewtCanvasAWT glc, final Window win) {
+    public void setTitle(final Frame frame, final NativeWindow nw, final Window win) {
         final CapabilitiesImmutable chosenCaps = win.getChosenCapabilities();
         final CapabilitiesImmutable reqCaps = win.getRequestedCapabilities();
         final CapabilitiesImmutable caps = null != chosenCaps ? chosenCaps : reqCaps;
         final String capsA = caps.isBackgroundOpaque() ? "opaque" : "transl";
         {
-            final java.awt.Rectangle b = glc.getBounds();
-            frame.setTitle("NewtCanvasAWT["+capsA+"], win: ["+b.x+"/"+b.y+" "+b.width+"x"+b.height+"], pix: "+glc.getNativeWindow().getSurfaceWidth()+"x"+glc.getNativeWindow().getSurfaceHeight());
+            frame.setTitle("Frame["+capsA+"], win: "+getNativeWinTitle(nw));
         }
-        final float[] sDPI = win.getPixelsPerMM(new float[2]);
-        sDPI[0] *= 25.4f;
-        sDPI[1] *= 25.4f;
-        win.setTitle("GLWindow["+capsA+"], win: "+win.getBounds()+", pix: "+win.getSurfaceWidth()+"x"+win.getSurfaceHeight()+", sDPI "+sDPI[0]+" x "+sDPI[1]);
+        super.setTitle(nw, win);
     }
 }
diff --git a/src/test/com/jogamp/opengl/test/junit/newt/parenting/NewtJFXReparentingKeyAdapter.java b/src/test/com/jogamp/opengl/test/junit/newt/parenting/NewtJFXReparentingKeyAdapter.java
new file mode 100644
index 000000000..253cbbce0
--- /dev/null
+++ b/src/test/com/jogamp/opengl/test/junit/newt/parenting/NewtJFXReparentingKeyAdapter.java
@@ -0,0 +1,116 @@
+/**
+ * Copyright 2019 JogAmp Community. All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without modification, are
+ * permitted provided that the following conditions are met:
+ *
+ *    1. Redistributions of source code must retain the above copyright notice, this list of
+ *       conditions and the following disclaimer.
+ *
+ *    2. Redistributions in binary form must reproduce the above copyright notice, this list
+ *       of conditions and the following disclaimer in the documentation and/or other materials
+ *       provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY JogAmp Community ``AS IS'' AND ANY EXPRESS OR IMPLIED
+ * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
+ * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL JogAmp Community OR
+ * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+ * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+ * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * The views and conclusions contained in the software and documentation are those of the
+ * authors and should not be interpreted as representing official policies, either expressed
+ * or implied, of JogAmp Community.
+ */
+package com.jogamp.opengl.test.junit.newt.parenting;
+
+import com.jogamp.nativewindow.CapabilitiesImmutable;
+import com.jogamp.nativewindow.NativeWindow;
+import com.jogamp.nativewindow.NativeWindowHolder;
+import com.jogamp.nativewindow.util.Insets;
+import com.jogamp.nativewindow.util.InsetsImmutable;
+import com.jogamp.newt.Window;
+import com.jogamp.newt.event.KeyEvent;
+import com.jogamp.newt.opengl.GLWindow;
+import com.jogamp.newt.opengl.util.NEWTDemoListener;
+
+import javafx.geometry.Bounds;
+
+/**
+ * JavaFX specializing demo functionality of {@link NewtReparentingKeyAdapter}, includes {@link NEWTDemoListener}.
+ */
+public class NewtJFXReparentingKeyAdapter extends NewtReparentingKeyAdapter {
+    final javafx.stage.Stage frame;
+
+    public NewtJFXReparentingKeyAdapter(final javafx.stage.Stage frame, final NativeWindowHolder winHolder, final GLWindow glWindow) {
+        super(winHolder, glWindow);
+        this.frame = frame;
+    }
+
+    public void keyPressed(final KeyEvent e) {
+        if( e.isAutoRepeat() || e.isConsumed() ) {
+            return;
+        }
+        if( 0 == e.getModifiers() ) { // all modifiers go to super class ..
+          final int keySymbol = e.getKeySymbol();
+          switch (keySymbol) {
+            case KeyEvent.VK_R:
+                e.setConsumed(true);
+                quitAdapterOff();
+                glWindow.invokeOnNewThread(null, false, new Runnable() {
+                    public void run() {
+                        final java.lang.Thread t = glWindow.setExclusiveContextThread(null);
+                        if(glWindow.getParent()==null) {
+                            printlnState("[reparent pre - glWin to HOME]");
+                            glWindow.reparentWindow(winHolder.getNativeWindow(), -1, -1, 0 /* hints */);
+                        } else {
+                            if( null != frame ) {
+                                final InsetsImmutable nInsets = glWindow.getInsets();
+                                final InsetsImmutable aInsets;
+                                {
+                                    final int aILeft = (int)frame.getScene().getX();
+                                    final int aITop = (int)frame.getScene().getY();
+                                    final int aIRight = (int)(frame.getWidth()-frame.getScene().getWidth())-aILeft;
+                                    final int aIBottom = (int)(frame.getHeight()-frame.getScene().getHeight())-aITop;
+                                    aInsets = new Insets(aILeft, aIRight, aITop, aIBottom);
+                                }
+                                final Bounds bL = frame.getScene().getRoot().getBoundsInLocal();
+                                final Bounds bs = frame.getScene().getRoot().localToScreen(bL);
+                                final int topLevelX = (int)bs.getMinX();
+                                final int topLevelY = (int)bs.getMinY();
+                                printlnState("[reparent pre - glWin to TOP.1]", topLevelX+"/"+topLevelY+" - insets " + nInsets + ", " + aInsets);
+                                glWindow.reparentWindow(null, topLevelX, topLevelY, 0 /* hint */);
+                            } else {
+                                printlnState("[reparent pre - glWin to TOP.0]");
+                                glWindow.reparentWindow(null, -1, -1, 0 /* hints */);
+                            }
+                        }
+                        printlnState("[reparent post]");
+                        glWindow.requestFocus();
+                        glWindow.setExclusiveContextThread(t);
+                        quitAdapterOn();
+                } } );
+                break;
+          }
+        }
+        super.keyPressed(e);
+    }
+
+    @Override
+    public void setTitle() {
+        setTitle(frame, winHolder.getNativeWindow(), glWindow);
+    }
+    public void setTitle(final javafx.stage.Stage frame, final NativeWindow nw, final Window win) {
+        final CapabilitiesImmutable chosenCaps = win.getChosenCapabilities();
+        final CapabilitiesImmutable reqCaps = win.getRequestedCapabilities();
+        final CapabilitiesImmutable caps = null != chosenCaps ? chosenCaps : reqCaps;
+        final String capsA = caps.isBackgroundOpaque() ? "opaque" : "transl";
+        {
+            frame.setTitle("Frame["+capsA+"], win: "+getNativeWinTitle(nw));
+        }
+        super.setTitle(nw, win);
+    }
+}
diff --git a/src/test/com/jogamp/opengl/test/junit/newt/parenting/NewtReparentingKeyAdapter.java b/src/test/com/jogamp/opengl/test/junit/newt/parenting/NewtReparentingKeyAdapter.java
new file mode 100644
index 000000000..969e2adb0
--- /dev/null
+++ b/src/test/com/jogamp/opengl/test/junit/newt/parenting/NewtReparentingKeyAdapter.java
@@ -0,0 +1,108 @@
+/**
+ * Copyright 2011, 2019 JogAmp Community. All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without modification, are
+ * permitted provided that the following conditions are met:
+ *
+ *    1. Redistributions of source code must retain the above copyright notice, this list of
+ *       conditions and the following disclaimer.
+ *
+ *    2. Redistributions in binary form must reproduce the above copyright notice, this list
+ *       of conditions and the following disclaimer in the documentation and/or other materials
+ *       provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY JogAmp Community ``AS IS'' AND ANY EXPRESS OR IMPLIED
+ * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
+ * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL JogAmp Community OR
+ * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+ * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+ * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * The views and conclusions contained in the software and documentation are those of the
+ * authors and should not be interpreted as representing official policies, either expressed
+ * or implied, of JogAmp Community.
+ */
+package com.jogamp.opengl.test.junit.newt.parenting;
+
+import com.jogamp.nativewindow.CapabilitiesImmutable;
+import com.jogamp.nativewindow.NativeWindow;
+import com.jogamp.nativewindow.NativeWindowHolder;
+import com.jogamp.newt.Window;
+import com.jogamp.newt.event.KeyEvent;
+import com.jogamp.newt.opengl.GLWindow;
+import com.jogamp.newt.opengl.util.NEWTDemoListener;
+import com.jogamp.opengl.GLAnimatorControl;
+
+/**
+ * Extending demo functionality of {@link NEWTDemoListener}
+ * <ul>
+ *   <li>L: Print parent and (child) {@link GLWindow} location</li>
+ *   <li>R: Toggel parenting (top-level/child)</li>
+ * </ul>
+ */
+public class NewtReparentingKeyAdapter extends NEWTDemoListener {
+    final NativeWindowHolder winHolder;
+
+    public NewtReparentingKeyAdapter(final NativeWindowHolder winHolder, final GLWindow glWindow) {
+        super(glWindow, null);
+        this.winHolder = winHolder;
+    }
+
+    public void keyPressed(final KeyEvent e) {
+        if( e.isAutoRepeat() || e.isConsumed() ) {
+            return;
+        }
+        if( 0 == e.getModifiers() ) { // all modifiers go to super class ..
+          final int keySymbol = e.getKeySymbol();
+          switch (keySymbol) {
+            case KeyEvent.VK_L:
+                e.setConsumed(true);
+                final com.jogamp.nativewindow.util.Point p0 = winHolder.getNativeWindow().getLocationOnScreen(null);
+                final com.jogamp.nativewindow.util.Point p1 = glWindow.getLocationOnScreen(null);
+                printlnState("[location]", "Parent "+p0+", NEWT "+p1);
+                break;
+            case KeyEvent.VK_R:
+                e.setConsumed(true);
+                quitAdapterOff();
+                glWindow.invokeOnNewThread(null, false, new Runnable() {
+                    public void run() {
+                        final java.lang.Thread t = glWindow.setExclusiveContextThread(null);
+                        if(glWindow.getParent()==null) {
+                            printlnState("[reparent pre - glWin to HOME]");
+                            glWindow.reparentWindow(winHolder.getNativeWindow(), -1, -1, 0 /* hints */);
+                        } else {
+                            printlnState("[reparent pre - glWin to TOP.0]");
+                            glWindow.reparentWindow(null, -1, -1, 0 /* hints */);
+                        }
+                        printlnState("[reparent post]");
+                        glWindow.requestFocus();
+                        glWindow.setExclusiveContextThread(t);
+                        quitAdapterOn();
+                } } );
+                break;
+          }
+        }
+        super.keyPressed(e);
+    }
+
+    @Override
+    public void setTitle() {
+        setTitle(winHolder.getNativeWindow(), glWindow);
+    }
+    String getNativeWinTitle(final NativeWindow nw) {
+        return "["+nw.getX()+"/"+nw.getY()+" "+nw.getWidth()+"x"+nw.getHeight()+"], pix: "+nw.getSurfaceWidth()+"x"+nw.getSurfaceHeight();
+    }
+    public void setTitle(final NativeWindow nw, final Window win) {
+        final CapabilitiesImmutable chosenCaps = win.getChosenCapabilities();
+        final CapabilitiesImmutable reqCaps = win.getRequestedCapabilities();
+        final CapabilitiesImmutable caps = null != chosenCaps ? chosenCaps : reqCaps;
+        final String capsA = caps.isBackgroundOpaque() ? "opaque" : "transl";
+        final float[] sDPI = win.getPixelsPerMM(new float[2]);
+        sDPI[0] *= 25.4f;
+        sDPI[1] *= 25.4f;
+        win.setTitle("GLWindow["+capsA+"], win: "+win.getBounds()+", pix: "+win.getSurfaceWidth()+"x"+win.getSurfaceHeight()+", sDPI "+sDPI[0]+" x "+sDPI[1]);
+    }
+}