NEWT Add: add<type>Listener(int index, <type>Listener l) ; get<type>Listener(int index) ; NEWTEvent attachments

NEWT Add:
    add<type>Listener(int index, <type>Listener l) ;
    get<type>Listener(int index) ;

    NEWTEvent attachments for listener to listener communication
    via object passing. This methodology is similar to the 'Atom'
    attachment of native systems.
    It is preferred to a 'consume()/isConsumed()' pattern,
    since it is less flexible and would 'endanger' system events.

TODO: <type>Listener[] get<type>Listeners() doesn't work and was always buggy.

3 files changed, 208 insertions, 22 deletions

diff --git a/src/newt/classes/com/jogamp/newt/Window.java b/src/newt/classes/com/jogamp/newt/Window.java
index 89c1bd146..9e338c94b 100755
--- a/src/newt/classes/com/jogamp/newt/Window.java
+++ b/src/newt/classes/com/jogamp/newt/Window.java
@@ -42,6 +42,7 @@ import javax.media.nativewindow.*;
 import com.jogamp.nativewindow.impl.RecursiveToolkitLock;
 
 import java.util.ArrayList;
+import java.util.List;
 import java.util.Iterator;
 import java.lang.reflect.Method;
 
@@ -974,13 +975,36 @@ public abstract class Window implements NativeWindow
 
     private ArrayList surfaceUpdatedListeners = new ArrayList();
 
+    /** 
+     * Appends the given {@link com.jogamp.newt.event.SurfaceUpdatedListener} to the end of 
+     * the list.
+     */
     public void addSurfaceUpdatedListener(SurfaceUpdatedListener l) {
+        getInnerWindow().addSurfaceUpdatedListener(-1, l);
+    }
+
+    /** 
+     * Inserts the given {@link com.jogamp.newt.event.SurfaceUpdatedListener} at the 
+     * specified position in the list.<br>
+
+     * @param index Position where the listener will be inserted. 
+     *              Should be within (0 <= index && index <= size()).
+     *              An index value of -1 is interpreted as the end of the list, size().
+     * @param l The listener object to be inserted
+     * @throws IndexOutOfBoundsException If the index is not within (0 <= index && index <= size()), or -1
+     */
+    public void addSurfaceUpdatedListener(int index, SurfaceUpdatedListener l) 
+        throws IndexOutOfBoundsException
+    {
         if(l == null) {
             return;
         }
         synchronized(surfaceUpdatedListeners) {
+            if(0>index) { 
+                index = surfaceUpdatedListeners.size(); 
+            }
             ArrayList newSurfaceUpdatedListeners = (ArrayList) surfaceUpdatedListeners.clone();
-            newSurfaceUpdatedListeners.add(l);
+            newSurfaceUpdatedListeners.add(index, l);
             surfaceUpdatedListeners = newSurfaceUpdatedListeners;
         }
     }
@@ -1002,7 +1026,16 @@ public abstract class Window implements NativeWindow
         }
     }
 
-    public SurfaceUpdatedListener[] getSurfaceUpdatedListener() {
+    public SurfaceUpdatedListener getSurfaceUpdatedListener(int index) {
+        synchronized(surfaceUpdatedListeners) {
+            if(0>index) { 
+                index = surfaceUpdatedListeners.size()-1; 
+            }
+            return (SurfaceUpdatedListener) surfaceUpdatedListeners.get(index);
+        }
+    }
+
+    public SurfaceUpdatedListener[] getSurfaceUpdatedListeners() {
         synchronized(surfaceUpdatedListeners) {
             return (SurfaceUpdatedListener[]) surfaceUpdatedListeners.toArray();
         }
@@ -1088,13 +1121,34 @@ public abstract class Window implements NativeWindow
     }
 
 
+    /** 
+     * Appends the given {@link com.jogamp.newt.event.MouseListener} to the end of 
+     * the list.
+     */
     public void addMouseListener(MouseListener l) {
+        getInnerWindow().addMouseListener(-1, l);
+    }
+
+    /** 
+     * Inserts the given {@link com.jogamp.newt.event.MouseListener} at the 
+     * specified position in the list.<br>
+
+     * @param index Position where the listener will be inserted. 
+     *              Should be within (0 <= index && index <= size()).
+     *              An index value of -1 is interpreted as the end of the list, size().
+     * @param l The listener object to be inserted
+     * @throws IndexOutOfBoundsException If the index is not within (0 <= index && index <= size()), or -1
+     */
+    public void addMouseListener(int index, MouseListener l) {
         if(l == null) {
             return;
         }
         synchronized(mouseListeners) {
+            if(0>index) { 
+                index = mouseListeners.size(); 
+            }
             ArrayList newMouseListeners = (ArrayList) mouseListeners.clone();
-            newMouseListeners.add(l);
+            newMouseListeners.add(index, l);
             mouseListeners = newMouseListeners;
         }
     }
@@ -1110,6 +1164,15 @@ public abstract class Window implements NativeWindow
         }
     }
 
+    public MouseListener getWindowListener(int index) {
+        synchronized(mouseListeners) {
+            if(0>index) { 
+                index = mouseListeners.size()-1; 
+            }
+            return (MouseListener) mouseListeners.get(index);
+        }
+    }
+
     public MouseListener[] getMouseListeners() {
         synchronized(mouseListeners) {
             return (MouseListener[]) mouseListeners.toArray();
@@ -1168,13 +1231,34 @@ public abstract class Window implements NativeWindow
                          modifiers, keyCode, keyChar) );
     }
 
+    /** 
+     * Appends the given {@link com.jogamp.newt.event.KeyListener} to the end of 
+     * the list.
+     */
     public void addKeyListener(KeyListener l) {
+        getInnerWindow().addKeyListener(-1, l);
+    }
+
+    /** 
+     * Inserts the given {@link com.jogamp.newt.event.KeyListener} at the 
+     * specified position in the list.<br>
+
+     * @param index Position where the listener will be inserted. 
+     *              Should be within (0 <= index && index <= size()).
+     *              An index value of -1 is interpreted as the end of the list, size().
+     * @param l The listener object to be inserted
+     * @throws IndexOutOfBoundsException If the index is not within (0 <= index && index <= size()), or -1
+     */
+    public void addKeyListener(int index, KeyListener l) {
         if(l == null) {
             return;
         }
         synchronized(keyListeners) {
+            if(0>index) { 
+                index = keyListeners.size(); 
+            }
             ArrayList newKeyListeners = (ArrayList) keyListeners.clone();
-            newKeyListeners.add(l);
+            newKeyListeners.add(index, l);
             keyListeners = newKeyListeners;
         }
     }
@@ -1190,6 +1274,15 @@ public abstract class Window implements NativeWindow
         }
     }
 
+    public KeyListener getKeyListener(int index) {
+        synchronized(keyListeners) {
+            if(0>index) { 
+                index = keyListeners.size()-1; 
+            }
+            return (KeyListener) keyListeners.get(index);
+        }
+    }
+
     public KeyListener[] getKeyListeners() {
         synchronized(keyListeners) {
             return (KeyListener[]) keyListeners.toArray();
@@ -1235,13 +1328,36 @@ public abstract class Window implements NativeWindow
 
     private ArrayList windowListeners = new ArrayList();
 
+    /** 
+     * Appends the given {@link com.jogamp.newt.event.WindowListener} to the end of 
+     * the list.
+     */
     public void addWindowListener(WindowListener l) {
+        getInnerWindow().addWindowListener(-1, l);
+    }
+
+    /** 
+     * Inserts the given {@link com.jogamp.newt.event.WindowListener} at the 
+     * specified position in the list.<br>
+
+     * @param index Position where the listener will be inserted. 
+     *              Should be within (0 <= index && index <= size()).
+     *              An index value of -1 is interpreted as the end of the list, size().
+     * @param l The listener object to be inserted
+     * @throws IndexOutOfBoundsException If the index is not within (0 <= index && index <= size()), or -1
+     */
+    public void addWindowListener(int index, WindowListener l) 
+        throws IndexOutOfBoundsException
+    {
         if(l == null) {
             return;
         }
         synchronized(windowListeners) {
+            if(0>index) { 
+                index = windowListeners.size(); 
+            }
             ArrayList newWindowListeners = (ArrayList) windowListeners.clone();
-            newWindowListeners.add(l);
+            newWindowListeners.add(index, l);
             windowListeners = newWindowListeners;
         }
     }
@@ -1257,6 +1373,15 @@ public abstract class Window implements NativeWindow
         }
     }
 
+    public WindowListener getWindowListener(int index) {
+        synchronized(windowListeners) {
+            if(0>index) { 
+                index = windowListeners.size()-1; 
+            }
+            return (WindowListener) windowListeners.get(index);
+        }
+    }
+
     public WindowListener[] getWindowListeners() {
         synchronized(windowListeners) {
             return (WindowListener[]) windowListeners.toArray();
@@ -1304,13 +1429,34 @@ public abstract class Window implements NativeWindow
 
     private ArrayList paintListeners = new ArrayList();
 
+    /** 
+     * Appends the given {@link com.jogamp.newt.event.PaintListener} to the end of 
+     * the list.
+     */
     public void addPaintListener(PaintListener l) {
+        getInnerWindow().addPaintListener(-1, l);
+    }
+
+    /** 
+     * Inserts the given {@link com.jogamp.newt.event.PaintListener} at the 
+     * specified position in the list.<br>
+
+     * @param index Position where the listener will be inserted. 
+     *              Should be within (0 <= index && index <= size()).
+     *              An index value of -1 is interpreted as the end of the list, size().
+     * @param l The listener object to be inserted
+     * @throws IndexOutOfBoundsException If the index is not within (0 <= index && index <= size()), or -1
+     */
+    public void addPaintListener(int index, PaintListener l) {
         if(l == null) {
             return;
         }
         synchronized(paintListeners) {
+            if(0>index) { 
+                index = paintListeners.size(); 
+            }
             ArrayList newPaintListeners = (ArrayList) paintListeners.clone();
-            newPaintListeners.add(l);
+            newPaintListeners.add(index, l);
             paintListeners = newPaintListeners;
         }
     }
@@ -1326,6 +1472,15 @@ public abstract class Window implements NativeWindow
         }
     }
 
+    public PaintListener getPaintListener(int index) {
+        synchronized(paintListeners) {
+            if(0>index) { 
+                index = paintListeners.size()-1; 
+            }
+            return (PaintListener) paintListeners.get(index);
+        }
+    }
+
     protected void sendPaintEvent(int eventType, int x, int y, int w, int h) {
         sendPaintEvent( new PaintEvent(eventType, this, System.currentTimeMillis(), x, y, w, h) );
     }
diff --git a/src/newt/classes/com/jogamp/newt/event/NEWTEvent.java b/src/newt/classes/com/jogamp/newt/event/NEWTEvent.java
index 1be3dcb3f..2cb2c5177 100644
--- a/src/newt/classes/com/jogamp/newt/event/NEWTEvent.java
+++ b/src/newt/classes/com/jogamp/newt/event/NEWTEvent.java
@@ -45,6 +45,7 @@ public class NEWTEvent extends java.util.EventObject {
     private boolean isSystemEvent;
     private int eventType;
     private long when;
+    private Object attachment;
 
     static final boolean DEBUG = false;
 
@@ -105,6 +106,7 @@ public class NEWTEvent extends java.util.EventObject {
         this.isSystemEvent = evaluateIsSystemEvent(this, new Throwable());
         this.eventType = eventType;
         this.when = when;
+        this.attachment=null;
     }
 
     /** Indicates whether this event was produced by the system or
@@ -123,6 +125,25 @@ public class NEWTEvent extends java.util.EventObject {
         return when;
     }
 
+    /** 
+     * Attach the passed object to this event.<br>
+     * If an object was previously attached, it will replaced.<br>
+     * Attachments to NEWT events allow users to pass on information
+     * from one custom listener to another, ie custom listener to listener 
+     * communication.
+     * @param attachment User application specific object
+     */
+    public final void setAttachment(Object attachment) {
+        this.attachment=attachment;
+    }
+
+    /** 
+     * @return The user application specific attachment, or null
+     */
+    public final Object getAttachment() {
+        return attachment;
+    }
+
     public String toString() {
         return "NEWTEvent[sys:"+isSystemEvent()+", source:"+getSource().getClass().getName()+", when:"+getWhen()+" d "+(System.currentTimeMillis()-getWhen())+"ms]";
     }
diff --git a/src/newt/classes/com/jogamp/newt/opengl/GLWindow.java b/src/newt/classes/com/jogamp/newt/opengl/GLWindow.java
index 7a223026e..1807201a4 100644
--- a/src/newt/classes/com/jogamp/newt/opengl/GLWindow.java
+++ b/src/newt/classes/com/jogamp/newt/opengl/GLWindow.java
@@ -373,8 +373,8 @@ public class GLWindow extends Window implements GLAutoDrawable {
         window.sendEvent(e);
     }
 
-    public void addSurfaceUpdatedListener(SurfaceUpdatedListener l) {
-        window.addSurfaceUpdatedListener(l);
+    public void addSurfaceUpdatedListener(int index, SurfaceUpdatedListener l) {
+        window.addSurfaceUpdatedListener(index, l);
     }
     public void removeSurfaceUpdatedListener(SurfaceUpdatedListener l) {
         window.removeSurfaceUpdatedListener(l);
@@ -382,45 +382,51 @@ public class GLWindow extends Window implements GLAutoDrawable {
     public void removeAllSurfaceUpdatedListener() {
         window.removeAllSurfaceUpdatedListener();
     }
-    public SurfaceUpdatedListener[] getSurfaceUpdatedListener() {
-        return window.getSurfaceUpdatedListener();
+    public SurfaceUpdatedListener getSurfaceUpdatedListener(int index) {
+        return window.getSurfaceUpdatedListener(index);
+    }
+    public SurfaceUpdatedListener[] getSurfaceUpdatedListeners() {
+        return window.getSurfaceUpdatedListeners();
     }
     public void surfaceUpdated(Object updater, NativeWindow window0, long when) { 
         window.surfaceUpdated(updater, window, when);
     }
 
-    public void addMouseListener(MouseListener l) {
-        window.addMouseListener(l);
+    public void addMouseListener(int index, MouseListener l) {
+        window.addMouseListener(index, l);
     }
-
     public void removeMouseListener(MouseListener l) {
         window.removeMouseListener(l);
     }
-
+    public MouseListener getMouseListener(int index) {
+        return window.getMouseListener(index);
+    }
     public MouseListener[] getMouseListeners() {
         return window.getMouseListeners();
     }
 
-    public void addKeyListener(KeyListener l) {
-        window.addKeyListener(l);
+    public void addKeyListener(int index, KeyListener l) {
+        window.addKeyListener(index, l);
     }
-
     public void removeKeyListener(KeyListener l) {
         window.removeKeyListener(l);
     }
-
+    public KeyListener getKeyListener(int index) {
+        return window.getKeyListener(index);
+    }
     public KeyListener[] getKeyListeners() {
         return window.getKeyListeners();
     }
 
-    public void addWindowListener(WindowListener l) {
-        window.addWindowListener(l);
+    public void addWindowListener(int index, WindowListener l) {
+        window.addWindowListener(index, l);
     }
-
     public void removeWindowListener(WindowListener l) {
         window.removeWindowListener(l);
     }
-
+    public WindowListener getWindowListener(int index) {
+        return window.getWindowListener(index);
+    }
     public WindowListener[] getWindowListeners() {
         return window.getWindowListeners();
     }
@@ -473,6 +479,10 @@ public class GLWindow extends Window implements GLAutoDrawable {
         helper.addGLEventListener(listener);
     }
 
+    public void addGLEventListener(int index, GLEventListener listener) {
+        helper.addGLEventListener(index, listener);
+    }
+
     public void removeGLEventListener(GLEventListener listener) {
         helper.removeGLEventListener(listener);
     }