Merge pull request ReactiveX#265 from jmhofer/swing

Swing - component event observables and minor cleanup

Author: benjchristensen

rxjava-contrib/rxjava-swing/src/main/java/rx/observables/SwingObservable.java

@@ -17,16 +17,19 @@
 
 import static rx.Observable.filter;
 
+import java.awt.Component;
+import java.awt.Dimension;
 import java.awt.event.ActionEvent;
+import java.awt.event.ComponentEvent;
 import java.awt.event.KeyEvent;
 import java.awt.event.MouseEvent;
 import java.util.Set;
 
 import javax.swing.AbstractButton;
-import javax.swing.JComponent;
 
 import rx.Observable;
 import rx.swing.sources.AbstractButtonSource;
+import rx.swing.sources.ComponentEventSource;
 import rx.swing.sources.KeyEventSource;
 import rx.swing.sources.MouseEventSource;
 import rx.util.functions.Func1;
@@ -54,7 +57,7 @@ public static Observable<ActionEvent> fromButtonAction(AbstractButton button) {
      *            The component to register the observable for.
      * @return Observable of key events.
      */
-    public static Observable<KeyEvent> fromKeyEvents(JComponent component) {
+    public static Observable<KeyEvent> fromKeyEvents(Component component) {
         return KeyEventSource.fromKeyEventsOf(component);
     }
 
@@ -65,7 +68,7 @@ public static Observable<KeyEvent> fromKeyEvents(JComponent component) {
      *            The component to register the observable for.
      * @return Observable of key events.
      */
-    public static Observable<KeyEvent> fromKeyEvents(JComponent component, final Set<Integer> keyCodes) {
+    public static Observable<KeyEvent> fromKeyEvents(Component component, final Set<Integer> keyCodes) {
         return filter(fromKeyEvents(component), new Func1<KeyEvent, Boolean>() {
             @Override
             public Boolean call(KeyEvent event) {
@@ -81,7 +84,7 @@ public Boolean call(KeyEvent event) {
      *            The component to register the observable for.
      * @return Observable of currently pressed keys.
      */
-    public static Observable<Set<Integer>> currentlyPressedKeys(JComponent component) {
+    public static Observable<Set<Integer>> fromPressedKeys(Component component) {
         return KeyEventSource.currentlyPressedKeysOf(component);
     }
 
@@ -92,7 +95,7 @@ public static Observable<Set<Integer>> currentlyPressedKeys(JComponent component
      *            The component to register the observable for.
      * @return Observable of mouse events.
      */
-    public static Observable<MouseEvent> fromMouseEvents(JComponent component) {
+    public static Observable<MouseEvent> fromMouseEvents(Component component) {
         return MouseEventSource.fromMouseEventsOf(component);
     }
 
@@ -103,7 +106,29 @@ public static Observable<MouseEvent> fromMouseEvents(JComponent component) {
      *            The component to register the observable for.
      * @return Observable of mouse motion events.
      */
-    public static Observable<MouseEvent> fromMouseMotionEvents(JComponent component) {
+    public static Observable<MouseEvent> fromMouseMotionEvents(Component component) {
         return MouseEventSource.fromMouseMotionEventsOf(component);
     }
+    
+    /**
+     * Creates an observable corresponding to raw component events.
+     * 
+     * @param component
+     *            The component to register the observable for.
+     * @return Observable of component events.
+     */
+    public static Observable<ComponentEvent> fromComponentEvents(Component component) {
+        return ComponentEventSource.fromComponentEventsOf(component);
+    }
+
+    /**
+     * Creates an observable corresponding to component resize events.
+     * 
+     * @param component
+     *            The component to register the observable for.
+     * @return Observable emitting the current size of the given component after each resize event.
+     */
+    public static Observable<Dimension> fromResizing(Component component) {
+        return ComponentEventSource.fromResizing(component);
+    }
 }

rxjava-contrib/rxjava-swing/src/main/java/rx/swing/sources/AbstractButtonSource.java

@@ -38,6 +38,9 @@
 
 public enum AbstractButtonSource { ; // no instances
 
+    /**
+     * @see SwingObservable.fromButtonAction
+     */
     public static Observable<ActionEvent> fromActionOf(final AbstractButton button) {
         return Observable.create(new Func1<Observer<ActionEvent>, Subscription>() {
             @Override

rxjava-contrib/rxjava-swing/src/main/java/rx/swing/sources/ComponentEventSource.java

@@ -0,0 +1,108 @@
+/**
+ * Copyright 2013 Netflix, Inc.
+ * 
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * 
+ * http://www.apache.org/licenses/LICENSE-2.0
+ * 
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package rx.swing.sources;
+
+import static rx.swing.sources.ComponentEventSource.Predicate.RESIZED;
+
+import java.awt.Component;
+import java.awt.Dimension;
+import java.awt.event.ComponentEvent;
+import java.awt.event.ComponentListener;
+
+import rx.Observable;
+import rx.Observer;
+import rx.Subscription;
+import rx.observables.SwingObservable;
+import rx.subscriptions.Subscriptions;
+import rx.util.functions.Action0;
+import rx.util.functions.Func1;
+
+public enum ComponentEventSource { ; // no instances
+
+    /**
+     * @see SwingObservable.fromComponentEvents
+     */
+    public static Observable<ComponentEvent> fromComponentEventsOf(final Component component) {
+        return Observable.create(new Func1<Observer<ComponentEvent>, Subscription>() {
+            @Override
+            public Subscription call(final Observer<ComponentEvent> observer) {
+                final ComponentListener listener = new ComponentListener() {
+                    @Override
+                    public void componentHidden(ComponentEvent event) {
+                        observer.onNext(event);
+                    }
+
+                    @Override
+                    public void componentMoved(ComponentEvent event) {
+                        observer.onNext(event);
+                    }
+
+                    @Override
+                    public void componentResized(ComponentEvent event) {
+                        observer.onNext(event);
+                    }
+
+                    @Override
+                    public void componentShown(ComponentEvent event) {
+                        observer.onNext(event);
+                    }
+                };
+                component.addComponentListener(listener);
+                
+                return Subscriptions.create(new Action0() {
+                    @Override
+                    public void call() {
+                        component.removeComponentListener(listener);
+                    }
+                });
+            }
+        });
+    }
+    
+    /**
+     * @see SwingObservable.fromResizing
+     */
+    public static Observable<Dimension> fromResizing(final Component component) {
+        return fromComponentEventsOf(component).filter(RESIZED).map(new Func1<ComponentEvent, Dimension>() {
+            @Override
+            public Dimension call(ComponentEvent event) {
+                return event.getComponent().getSize();
+            }
+        });
+    }
+    
+    /**
+     * Predicates that help with filtering observables for specific component events. 
+     */
+    public enum Predicate implements rx.util.functions.Func1<java.awt.event.ComponentEvent, Boolean> { 
+        RESIZED(ComponentEvent.COMPONENT_RESIZED),
+        HIDDEN(ComponentEvent.COMPONENT_HIDDEN),
+        MOVED(ComponentEvent.COMPONENT_MOVED),
+        SHOWN(ComponentEvent.COMPONENT_SHOWN);
+        
+        private final int id;
+        
+        private Predicate(int id) {
+            this.id = id;
+        }
+        
+        @Override
+        public Boolean call(ComponentEvent event) {
+            return event.getID() == id;
+        }
+        
+    }
+}

rxjava-contrib/rxjava-swing/src/main/java/rx/swing/sources/KeyEventSource.java

@@ -16,15 +16,19 @@
 package rx.swing.sources;
 
 import static java.util.Arrays.asList;
-import static org.mockito.Mockito.*;
+import static org.mockito.Mockito.inOrder;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.never;
+import static org.mockito.Mockito.times;
+import static org.mockito.Mockito.verify;
 
+import java.awt.Component;
 import java.awt.event.KeyEvent;
 import java.awt.event.KeyListener;
 import java.util.Collections;
 import java.util.HashSet;
 import java.util.Set;
 
-import javax.swing.JComponent;
 import javax.swing.JPanel;
 
 import org.junit.Test;
@@ -42,7 +46,10 @@
 
 public enum KeyEventSource { ; // no instances
 
-    public static Observable<KeyEvent> fromKeyEventsOf(final JComponent component) {
+    /**
+     * @see SwingObservable.fromKeyEvents(Component)
+     */
+    public static Observable<KeyEvent> fromKeyEventsOf(final Component component) {
         return Observable.create(new Func1<Observer<KeyEvent>, Subscription>() {
             @Override
             public Subscription call(final Observer<KeyEvent> observer) {
@@ -74,7 +81,10 @@ public void call() {
         });
     }
 
-    public static Observable<Set<Integer>> currentlyPressedKeysOf(JComponent component) {
+    /**
+     * @see SwingObservable.fromKeyEvents(Component, Set)
+     */
+    public static Observable<Set<Integer>> currentlyPressedKeysOf(Component component) {
         return Observable.<KeyEvent, Set<Integer>>scan(fromKeyEventsOf(component), new HashSet<Integer>(), new Func2<Set<Integer>, KeyEvent, Set<Integer>>() {
             @Override
             public Set<Integer> call(Set<Integer> pressedKeys, KeyEvent event) {
@@ -96,7 +106,7 @@ public Set<Integer> call(Set<Integer> pressedKeys, KeyEvent event) {
     }
 
     public static class UnitTest {
-        private JComponent comp = new JPanel();
+        private Component comp = new JPanel();
 
         @Test
         public void testObservingKeyEvents() {

rxjava-contrib/rxjava-swing/src/main/java/rx/swing/sources/MouseEventSource.java

@@ -15,12 +15,11 @@
  */
 package rx.swing.sources;
 
+import java.awt.Component;
 import java.awt.event.MouseEvent;
 import java.awt.event.MouseListener;
 import java.awt.event.MouseMotionListener;
 
-import javax.swing.JComponent;
-
 import rx.Observable;
 import rx.Observer;
 import rx.Subscription;
@@ -30,7 +29,10 @@
 
 public enum MouseEventSource { ; // no instances
 
-    public static Observable<MouseEvent> fromMouseEventsOf(final JComponent component) {
+    /**
+     * @see SwingObservable.fromMouseEvents
+     */
+    public static Observable<MouseEvent> fromMouseEventsOf(final Component component) {
         return Observable.create(new Func1<Observer<MouseEvent>, Subscription>() {
             @Override
             public Subscription call(final Observer<MouseEvent> observer) {
@@ -72,7 +74,10 @@ public void call() {
         });
     }
 
-    public static Observable<MouseEvent> fromMouseMotionEventsOf(final JComponent component) {
+    /**
+     * @see SwingObservable.fromMouseMotionEvents
+     */
+    public static Observable<MouseEvent> fromMouseMotionEventsOf(final Component component) {
         return Observable.create(new Func1<Observer<MouseEvent>, Subscription>() {
             @Override
             public Subscription call(final Observer<MouseEvent> observer) {