8314968: Public InputMap (v3)

modules/javafx.controls/src/main/java/com/sun/javafx/scene/control/behavior/ColorPickerBehavior.java

@@ -27,7 +27,6 @@
 
 import javafx.scene.control.ColorPicker;
 import javafx.scene.control.PopupControl;
-
 import javafx.scene.paint.Color;
 
 public class ColorPickerBehavior extends ComboBoxBaseBehavior<Color> {
@@ -41,8 +40,8 @@ public class ColorPickerBehavior extends ComboBoxBaseBehavior<Color> {
     /**
      *
      */
-    public ColorPickerBehavior(final ColorPicker colorPicker) {
-        super(colorPicker);
+    public ColorPickerBehavior(ColorPicker c) {
+        super(c);
     }
 
      /**************************************************************************
@@ -54,14 +53,14 @@ public ColorPickerBehavior(final ColorPicker colorPicker) {
     @Override public void onAutoHide(PopupControl popup) {
         // when we click on some non  interactive part of the
         // Color Palette - we do not want to hide.
-        if (!popup.isShowing() && getNode().isShowing()) {
+        if (!popup.isShowing() && getControl().isShowing()) {
             // Popup was dismissed. Maybe user clicked outside or typed ESCAPE.
             // Make sure DatePicker button is in sync.
-            getNode().hide();
+            getControl().hide();
         }
         // if the ColorPicker is no longer showing, then invoke the super method
         // to keep its show/hide state in sync.
-        if (!getNode().isShowing()) {
+        if (!getControl().isShowing()) {
             super.onAutoHide(popup);
         }
     }

modules/javafx.controls/src/main/java/com/sun/javafx/scene/control/behavior/ComboBoxBaseBehavior.java

@@ -25,30 +25,25 @@
 
 package com.sun.javafx.scene.control.behavior;
 
-import com.sun.javafx.scene.control.inputmap.InputMap;
-
 import javafx.beans.InvalidationListener;
 import javafx.beans.Observable;
-import javafx.event.EventHandler;
 import javafx.event.EventTarget;
 import javafx.scene.Node;
 import javafx.scene.control.ComboBox;
 import javafx.scene.control.ComboBoxBase;
 import javafx.scene.control.DatePicker;
 import javafx.scene.control.PopupControl;
 import javafx.scene.control.TextField;
+import javafx.scene.control.input.BehaviorBase;
+import javafx.scene.control.input.KeyBinding;
+import javafx.scene.input.KeyCode;
+import javafx.scene.input.KeyEvent;
+import javafx.scene.input.MouseButton;
+import javafx.scene.input.MouseEvent;
 import com.sun.javafx.scene.control.skin.Utils;
-import javafx.scene.input.*;
-import com.sun.javafx.scene.control.inputmap.KeyBinding;
-
-import static javafx.scene.input.KeyCode.*;
-import static javafx.scene.input.KeyEvent.*;
-import static com.sun.javafx.scene.control.inputmap.InputMap.KeyMapping;
-import static com.sun.javafx.scene.control.inputmap.InputMap.MouseMapping;
 
 public class ComboBoxBaseBehavior<T> extends BehaviorBase<ComboBoxBase<T>> {
 
-    private final InputMap<ComboBoxBase<T>> inputMap;
     private InvalidationListener focusListener = this::focusChanged;
 
     /***************************************************************************
@@ -62,65 +57,47 @@ public class ComboBoxBaseBehavior<T> extends BehaviorBase<ComboBoxBase<T>> {
     /**
      *
      */
-    public ComboBoxBaseBehavior(final ComboBoxBase<T> comboBox) {
-        super(comboBox);
-
-        // create a map for comboBox-specific mappings (this reuses the default
-        // InputMap installed on the control, if it is non-null, allowing us to pick up any user-specified mappings)
-        inputMap = createInputMap();
-
-        final EventHandler<KeyEvent> togglePopup = e -> {
-            // If popup is shown, KeyEvent causes popup to close
-            showPopupOnMouseRelease = true;
-
-            if (getNode().isShowing()) hide();
-            else show();
-        };
+    public ComboBoxBaseBehavior(ComboBoxBase<T> c) {
+        super(c);
+    }
 
-        // comboBox-specific mappings for key and mouse input
-        KeyMapping enterPressed, enterReleased;
-        addDefaultMapping(inputMap,
-            new KeyMapping(F4, KEY_RELEASED, togglePopup),
-            new KeyMapping(new KeyBinding(UP).alt(), togglePopup),
-            new KeyMapping(new KeyBinding(DOWN).alt(), togglePopup),
+    @Override
+    protected void populateSkinInputMap() {
+        // ComboBoxBase also cares about focus
+        getControl().focusedProperty().addListener(focusListener);
 
-            new KeyMapping(SPACE, KEY_PRESSED, this::keyPressed),
-            new KeyMapping(SPACE, KEY_RELEASED, this::keyReleased),
+        // Only add this if we're on an embedded platform that supports 5-button navigation
+        if (Utils.isTwoLevelFocus()) {
+            tlFocus = new TwoLevelFocusComboBehavior(getControl()); // needs to be last.
+        }
 
-            enterPressed = new KeyMapping(ENTER, KEY_PRESSED, this::keyPressed),
-            enterReleased = new KeyMapping(ENTER, KEY_RELEASED, this::keyReleased),
+        registerFunction(ComboBoxBase.TOGGLE_POPUP, this::togglePopup);
 
-            // The following keys are forwarded to the parent container
-            new KeyMapping(ESCAPE, KEY_PRESSED, this::cancelEdit),
-            new KeyMapping(F10,    KEY_PRESSED, this::forwardToParent),
+        registerKey(KeyBinding.builder(KeyCode.F4).keyReleased().build(), ComboBoxBase.TOGGLE_POPUP);
+        registerKey(KeyBinding.alt(KeyCode.DOWN), ComboBoxBase.TOGGLE_POPUP);
+        registerKey(KeyBinding.alt(KeyCode.UP), ComboBoxBase.TOGGLE_POPUP);
 
-            new MouseMapping(MouseEvent.MOUSE_PRESSED, this::mousePressed),
-            new MouseMapping(MouseEvent.MOUSE_RELEASED, this::mouseReleased),
-            new MouseMapping(MouseEvent.MOUSE_ENTERED, this::mouseEntered),
-            new MouseMapping(MouseEvent.MOUSE_EXITED, this::mouseExited)
-        );
+        addHandler(KeyBinding.of(KeyCode.SPACE), (ev) -> keyPressed(ev, true));
+        addHandler(KeyBinding.builder(KeyCode.SPACE).keyReleased().build(), (ev) -> keyReleased(ev, true));
 
-        // we don't want to consume events on enter press - let them carry on through
-        enterPressed.setAutoConsume(false);
-        enterReleased.setAutoConsume(false);
+        // these two should not consume the event
+        addHandler(KeyBinding.of(KeyCode.ENTER), (ev) -> keyPressed(ev, false));
+        addHandler(KeyBinding.builder(KeyCode.ENTER).keyReleased().build(), (ev) -> keyReleased(ev, false));
 
-        // ComboBoxBase also cares about focus
-        comboBox.focusedProperty().addListener(focusListener);
+        addHandler(KeyBinding.of(KeyCode.ESCAPE), this::cancelEdit);
+        addHandler(KeyBinding.of(KeyCode.F10), this::forwardToParent);
 
-        // Only add this if we're on an embedded platform that supports 5-button navigation
-        if (Utils.isTwoLevelFocus()) {
-            tlFocus = new TwoLevelFocusComboBehavior(comboBox); // needs to be last.
-        }
+        addHandler(MouseEvent.MOUSE_PRESSED, this::mousePressed);
+        addHandler(MouseEvent.MOUSE_RELEASED, this::mouseReleased);
+        addHandler(MouseEvent.MOUSE_ENTERED, this::mouseEntered);
+        addHandler(MouseEvent.MOUSE_EXITED, this::mouseExited);
     }
 
-    @Override public void dispose() {
-        if (tlFocus != null) tlFocus.dispose();
-        getNode().focusedProperty().removeListener(focusListener);
-        super.dispose();
-    }
-
-    @Override public InputMap<ComboBoxBase<T>> getInputMap() {
-        return inputMap;
+    public void dispose() {
+        if (tlFocus != null) {
+            tlFocus.dispose();
+        }
+        getControl().focusedProperty().removeListener(focusListener);
     }
 
     /***************************************************************************
@@ -132,7 +109,7 @@ public ComboBoxBaseBehavior(final ComboBoxBase<T> comboBox) {
     protected void focusChanged(Observable o) {
         // If we did have the key down, but are now not focused, then we must
         // disarm the box.
-        final ComboBoxBase<T> box = getNode();
+        final ComboBoxBase<T> box = getControl();
         if (keyDown && !box.isFocused()) {
             keyDown = false;
             box.disarm();
@@ -158,7 +135,7 @@ protected void focusChanged(Observable o) {
      * causes this button to be armed if it is not already armed by a mouse
      * press.
      */
-    private void keyPressed(KeyEvent e) {
+    private void keyPressed(KeyEvent e, boolean consume) {
         // If popup is shown, KeyEvent causes popup to close
         showPopupOnMouseRelease = true;
 
@@ -169,34 +146,46 @@ private void keyPressed(KeyEvent e) {
             }
         }
         else {
-            if (! getNode().isPressed() && ! getNode().isArmed()) {
+            if (! getControl().isPressed() && ! getControl().isArmed()) {
                 keyDown = true;
-                getNode().arm();
+                getControl().arm();
             }
         }
+        if (consume) {
+            e.consume();
+        }
     }
 
     /**
      * Invoked when a valid keystroke release occurs which causes the button
      * to fire if it was armed by a keyPress.
      */
-    private void keyReleased(KeyEvent e) {
+    private void keyReleased(KeyEvent e, boolean consume) {
         // If popup is shown, KeyEvent causes popup to close
         showPopupOnMouseRelease = true;
 
         if (!Utils.isTwoLevelFocus()) {
             if (keyDown) {
                 keyDown = false;
-                if (getNode().isArmed()) {
-                    getNode().disarm();
+                if (getControl().isArmed()) {
+                    getControl().disarm();
                 }
             }
         }
+        if (consume) {
+            e.consume();
+        }
     }
 
     private void forwardToParent(KeyEvent event) {
-        if (getNode().getParent() != null) {
-            getNode().getParent().fireEvent(event);
+        try {
+            if (getControl().getParent() != null) {
+                getControl().getParent().fireEvent(event);
+            }
+        } finally {
+            // TODO original logic is to always consume the event.
+            // we may want to change that
+            event.consume();
         }
     }
 
@@ -205,7 +194,7 @@ private void cancelEdit(KeyEvent event) {
          * This can be cleaned up if the editor property is moved up
          * to ComboBoxBase.
          */
-        ComboBoxBase comboBoxBase = getNode();
+        ComboBoxBase comboBoxBase = getControl();
         TextField textField = null;
         if (comboBoxBase instanceof DatePicker) {
             textField = ((DatePicker)comboBoxBase).getEditor();
@@ -218,6 +207,7 @@ private void cancelEdit(KeyEvent event) {
         } else {
             forwardToParent(event);
         }
+        event.consume();
     }
 
 
@@ -229,6 +219,7 @@ private void cancelEdit(KeyEvent event) {
 
     public void mousePressed(MouseEvent e) {
         arm(e);
+        e.consume();
     }
 
     public void mouseReleased(MouseEvent e) {
@@ -245,22 +236,25 @@ public void mouseReleased(MouseEvent e) {
             showPopupOnMouseRelease = true;
             hide();
         }
+        e.consume();
     }
 
     public void mouseEntered(MouseEvent e) {
-        if (!getNode().isEditable()) {
+        if (!getControl().isEditable()) {
             mouseInsideButton = true;
         } else {
             // This is strongly tied to ComboBoxBaseSkin
             final EventTarget target = e.getTarget();
             mouseInsideButton = (target instanceof Node && "arrow-button".equals(((Node) target).getId()));
         }
         arm();
+        e.consume();
     }
 
     public void mouseExited(MouseEvent e) {
         mouseInsideButton = false;
         disarm();
+        e.consume();
     }
 
 //    private void getFocus() {
@@ -274,23 +268,23 @@ private void arm(MouseEvent e) {
             ! (e.isMiddleButtonDown() || e.isSecondaryButtonDown() ||
              e.isShiftDown() || e.isControlDown() || e.isAltDown() || e.isMetaDown()));
 
-        if (! getNode().isArmed() && valid) {
-            getNode().arm();
+        if (! getControl().isArmed() && valid) {
+            getControl().arm();
         }
     }
 
     public void show() {
-        if (! getNode().isShowing()) {
-            if (getNode().isFocusTraversable()) {
-                getNode().requestFocus();
+        if (! getControl().isShowing()) {
+            if (getControl().isFocusTraversable()) {
+                getControl().requestFocus();
             }
-            getNode().show();
+            getControl().show();
         }
     }
 
     public void hide() {
-        if (getNode().isShowing()) {
-            getNode().hide();
+        if (getControl().isShowing()) {
+            getControl().hide();
         }
     }
 
@@ -307,15 +301,25 @@ public void onAutoHide(PopupControl popup) {
     }
 
     public void arm() {
-        if (getNode().isPressed()) {
-            getNode().arm();
+        if (getControl().isPressed()) {
+            getControl().arm();
         }
     }
 
     public void disarm() {
-        if (! keyDown && getNode().isArmed()) {
-            getNode().disarm();
+        if (! keyDown && getControl().isArmed()) {
+            getControl().disarm();
         }
     }
 
+    private void togglePopup() {
+        // If popup is shown, KeyEvent causes popup to close
+        showPopupOnMouseRelease = true;
+
+        if (getControl().isShowing()) {
+            hide();
+        } else {
+            show();
+        }
+    }
 }