Merge pull request JMRI#13744 from CGMRC/immediate_feedback

Highlight cursor position on layout editor panels: for touchscreens

Author: danielb987

help/en/package/jmri/jmrit/display/LayoutEditor.shtml

@@ -597,6 +597,17 @@
         the drawn panel, but it does take longer to refresh the panel. Check antialiasing for a
         better looking panel. Uncheck antialiasing for faster refresh.</li>
 
+        <li><strong>Toggle Track labels in Edit mode</strong> - If this item is selected, the
+        panel is displayed with the internal names for track items such as anchor points,
+        track sengments, turnouts, etc.</li>
+
+        <li><strong>Highlight Cursor Position</strong> <span class="since">since 5.11.3</span>
+        - If this item is selected, the cursor will have a colored box drawn around the mouse
+        pointer when the mouse has been clicked and held. This option is not active when the
+        panel is in edit mode. The primary purpose is to provide an enhanced mouse pointer on touch
+        screens. For turnouts, the turnout control circle will also flash a couple of times
+        while the turnout is moving.</li>
+
         <li><strong>New Title...</strong> - Selecting this item brings up a small window that
         allows a new panel window title to be entered.</li>
 

help/en/releasenotes/current-draft-note.shtml

@@ -425,6 +425,9 @@
         <ul>
             <li></li>
         </ul>
+        <ul>
+            <li>Added "Highlight cursor position" option to enable drawing of a square around finger/mouse press/drag area. Useful for touchscreens.
+        </ul>
 
         <h4>NX - Entry/Exit Tool</h4>
             <ul>

java/src/jmri/jmrit/display/layoutEditor/LayoutEditor.java

@@ -161,6 +161,7 @@ public LayoutEditorToolBarPanel getLayoutEditorToolBarPanel() {
     private JCheckBoxMenuItem turnoutFillControlCirclesCheckBoxMenuItem = null;
     private JCheckBoxMenuItem hideTrackSegmentConstructionLinesCheckBoxMenuItem = null;
     private JCheckBoxMenuItem useDirectTurnoutControlCheckBoxMenuItem = null;
+    private JCheckBoxMenuItem highlightCursorCheckBoxMenuItem = null;
     private ButtonGroup turnoutCircleSizeButtonGroup = null;
 
     private boolean turnoutDrawUnselectedLeg = true;
@@ -308,6 +309,7 @@ public LayoutEditorFindItems getFinder() {
     private double xOverHWid = LayoutTurnout.xOverHWidDefault;
     private double xOverShort = LayoutTurnout.xOverShortDefault;
     private boolean useDirectTurnoutControl = false; // Uses Left click for closing points, Right click for throwing.
+    private boolean highlightCursor = false; // Highlight finger/mouse press/drag area, good for touchscreens
 
     // saved state of options when panel was loaded or created
     private boolean savedEditMode = true;
@@ -1104,6 +1106,15 @@ private JMenu setupOptionMenu(@Nonnull JMenuBar menuBar) {
         });
         drawLayoutTracksLabelCheckBoxMenuItem.setSelected(drawLayoutTracksLabel);
 
+        // add "Highlight cursor position" - useful for touchscreens
+        highlightCursorCheckBoxMenuItem = new JCheckBoxMenuItem(Bundle.getMessage("HighlightCursor"));
+        optionMenu.add(highlightCursorCheckBoxMenuItem);
+        highlightCursorCheckBoxMenuItem.addActionListener((ActionEvent event) -> {
+            highlightCursor = highlightCursorCheckBoxMenuItem.isSelected();
+            redrawPanel();
+        });
+        highlightCursorCheckBoxMenuItem.setSelected(highlightCursor);
+
         //
         // edit title
         //
@@ -1958,11 +1969,8 @@ private void setupZoomMenu(@Nonnull JMenuBar menuBar) {
             // get the window specific saved zoom user preference
             InstanceManager.getOptionalDefault(UserPreferencesManager.class).ifPresent((prefsMgr) -> {
                 Object zoomProp = prefsMgr.getProperty(getWindowFrameRef(), "zoom");
-
                 log.debug("{} zoom is {}", getWindowFrameRef(), zoomProp);
-
-                if (zoomProp
-                        != null) {
+                if (zoomProp != null) {
                     setZoom((Double) zoomProp);
                 }
             }
@@ -2172,7 +2180,6 @@ public void mouseWheelMoved(@Nonnull MouseWheelEvent event) {
      * @param zoomFactor eg. 0.5 ( 1/2 zoom ), 1.0 ( no zoom ), 2.0 ( 2x zoom )
      */
     private void selectZoomMenuItem(double zoomFactor) {
-
         double zoom = zoomFactor * 100;
 
         // put zoomFactor on 100% increments
@@ -2957,6 +2964,29 @@ private Point2D calcLocation(JmriMouseEvent event) {
         return calcLocation(event, 0, 0);
     }
 
+    /**
+     * Check for highlighting of cursor position.
+     *
+     * If in "highlight" mode, draw a square at the location of the
+     * event. If there was already a square, just move its location.
+     * In either case, redraw the panel so the previous square will
+     * disappear and the new one will appear immediately.
+     */
+    private void checkHighlightCursor() {
+        if (!isEditable() && highlightCursor) {
+            // rectangle size based on turnout circle size: rectangle should
+            // be bigger so it can more easily surround turnout on screen
+            int halfSize = (int)(circleRadius) + 8;
+            if (_highlightcomponent == null) {
+                _highlightcomponent = new Rectangle(
+                        xLoc - halfSize, yLoc - halfSize, halfSize * 2, halfSize * 2);
+            } else {
+                _highlightcomponent.setLocation(xLoc - halfSize, yLoc - halfSize);
+            }
+            redrawPanel();
+        }
+    }
+
     /**
      * Handle a mouse pressed event
      * <p>
@@ -2974,6 +3004,8 @@ public void mousePressed(JmriMouseEvent event) {
         _lastY = _anchorY;
         calcLocation(event);
 
+        checkHighlightCursor();
+
         // TODO: Add command-click on nothing to pan view?
         if (isEditable()) {
             boolean prevSelectionActive = selectionActive;
@@ -3505,6 +3537,13 @@ public void mouseReleased(JmriMouseEvent event) {
         // initialize mouse position
         calcLocation(event);
 
+        if (!isEditable() && _highlightcomponent != null && highlightCursor) {
+            _highlightcomponent = null;
+            // see if we moused up on an object
+            checkControls(true);
+            redrawPanel();
+        }
+
         // if alt modifier is down invert the snap to grid behaviour
         snapToGridInvert = event.isAltDown();
 
@@ -3654,6 +3693,19 @@ && allControlling() && !event.isMetaDown() && !event.isAltDown() && !event.isPop
                 t.setState(Turnout.CLOSED);
             } else {
                 t.toggleTurnout();
+                if (highlightCursor && !t.isDisabled()) {
+                    // flash the turnout circle a few times so the user knows it's being toggled
+                    javax.swing.Timer timer = new javax.swing.Timer(150, null);
+                    timer.addActionListener(new ActionListener(){
+                        int count = 1;
+                        public void actionPerformed(ActionEvent ae){
+                          if(count % 2 != 0) t.setDisabled(true);
+                          else t.setDisabled(false);
+                          if(++count > 8) timer.stop();
+                        }
+                    });
+                    timer.start();
+                }
             }
         } else if ((selectedObject != null) && ((selectedHitPointType == HitPointType.SLIP_LEFT)
                 || (selectedHitPointType == HitPointType.SLIP_RIGHT))
@@ -3997,6 +4049,11 @@ public void mouseClicked(@Nonnull JmriMouseEvent event) {
         // initialize mouse position
         calcLocation(event);
 
+        if (!isEditable() && _highlightcomponent != null && highlightCursor) {
+            _highlightcomponent = null;
+            redrawPanel();
+        }
+
         // if alt modifier is down invert the snap to grid behaviour
         snapToGridInvert = event.isAltDown();
 
@@ -4837,6 +4894,8 @@ public void mouseDragged(@Nonnull JmriMouseEvent event) {
         // initialize mouse position
         calcLocation(event);
 
+        checkHighlightCursor();
+
         // ignore this event if still at the original point
         if ((!isDragging) && (xLoc == getAnchorX()) && (yLoc == getAnchorY())) {
             return;
@@ -7477,6 +7536,10 @@ public boolean isTurnoutDrawUnselectedLeg() {
         return turnoutDrawUnselectedLeg;
     }
 
+    public boolean isHighlightCursor() {
+        return highlightCursor;
+    }
+
     public String getLayoutName() {
         return layoutName;
     }
@@ -7690,6 +7753,19 @@ public void setTurnoutDrawUnselectedLeg(boolean state) {
         }
     }
 
+    /**
+     * Should only be invoked on the GUI (Swing) thread.
+     *
+     * @param state true to enable highlighting the cursor (mouse/finger press/drag)
+     */
+    @InvokeOnGuiThread
+    public void setHighlightCursor(boolean state) {
+        if (highlightCursor != state) {
+            highlightCursor = state;
+            highlightCursorCheckBoxMenuItem.setSelected(highlightCursor);
+        }
+    }
+
     /**
      * @param color value to set the default text color to.
      */

java/src/jmri/jmrit/display/layoutEditor/LayoutEditorBundle.properties

@@ -406,6 +406,7 @@ AntialiasingOn = Enable antialiasing (Smoother lines)
 DrawLayoutTracksLabel = Toggle Track labels in Edit mode
 DrawLayoutTracksMnemonic = T
 DrawLayoutTracksAccelerator = T
+HighlightCursor = Highlight Cursor Position
 NewTitle = New Title
 EditTitle = Edit Title
 

java/src/jmri/jmrit/display/layoutEditor/LayoutEditorViewContext.java

@@ -272,6 +272,7 @@ final public void setYScale(double scale) {
 
       <xs:attribute name="openDispatcher" type="yesNoType" default="no"/>
       <xs:attribute name="useDirectTurnoutControl" type="yesNoType" default="no"/>
+      <xs:attribute name="highlightCursor" type="yesNoType" default="no"/>
 
  */
 

java/src/jmri/jmrit/display/layoutEditor/configurexml/LayoutEditorXml.java

@@ -115,6 +115,9 @@ public Element store(Object o) {
         p.resetDirty();
         panel.setAttribute("openDispatcher", p.getOpenDispatcherOnLoad() ? "yes" : "no");
         panel.setAttribute("useDirectTurnoutControl", p.getDirectTurnoutControl() ? "yes" : "no");
+        if (p.isHighlightCursor()) {
+            panel.setAttribute("highlightCursor", "yes");
+        }
 
         // store layout track drawing options
         try {
@@ -590,7 +593,7 @@ public boolean load(Element shared, Element perNode) {
         } catch (DataConversionException e) {
             log.warn("Could not parse color attributes!");
         } catch (NullPointerException e) {  // considered normal if the attributes are not present
-            log.debug("missing backbround color attributes");
+            log.debug("missing background color attributes");
         }
 
         try {
@@ -601,6 +604,15 @@ public boolean load(Element shared, Element perNode) {
             log.debug("missing useDirectTurnoutControl attribute");
         }
 
+        try {
+            panel.setHighlightCursor(shared.getAttribute("highlightCursor").getBooleanValue());
+        } catch (DataConversionException e) {
+            log.warn("unable to convert highlightCursor attribute");
+        } catch (NullPointerException e) {  // considered normal if the attribute is not present
+            log.debug("missing highlightCursor attribute");
+        }
+
+
         // Set editor's option flags, load content after
         // this so that individual item flags are set as saved
         panel.initView();

java/test/jmri/jmrit/display/layoutEditor/LayoutEditorTest.java

@@ -804,7 +804,7 @@ public void testSetHighlightSelectedBlockFalse() {
     public void checkOptionsMenuExists() {
         JMenuOperator jmo = new JMenuOperator(jfo, Bundle.getMessage("MenuOptions"));
         Assert.assertNotNull("Options Menu Exists", jmo);
-        Assert.assertEquals("Menu Item Count", 19, jmo.getItemCount());
+        Assert.assertEquals("Menu Item Count", 20, jmo.getItemCount());
     }
 
     @Test

xml/schema/types/layouteditor.xsd

@@ -129,6 +129,7 @@
       <xs:attribute name="gridSize2nd" type="xs:integer"/>
       <xs:attribute name="openDispatcher" type="yesNoType" default="no"/>
       <xs:attribute name="useDirectTurnoutControl" type="yesNoType" default="no"/>
+      <xs:attribute name="highlightCursor" type="yesNoType" default="no"/>
       <xs:attribute name="zoom" type="xs:float" default="1.0"/>
     </xs:complexType>