Add help button to "Search for Objects by Preset"

[jidanni]

Search has a Help button, but "Search for Objects by Preset" doesn't.
Some people's first search is Search for Objects by Preset, not plain Search. So Help is needed.

[simon04]

The problem is: we do not yet have a help page for this action. The closest one is Help/Action/TaggingPresetSearch.

[Klumbumbus]

I wonder if the "Search for Objects by Preset" window is still needed since it was integrated in the default search window too.

[simon04]

Good point. The only argument I found after some testing is that "Search for Objects by Preset" can be operated quickly using the keyboard only:

• [Ctrl]+F3 – tree – [Enter]
• [Ctrl]+F – 6×[Tab] – tree – [Enter] – does not work (i.e., select everything) since a preset must be double-clicked in order to obtain the search phrase preset:"Geography/Nature/Tree"

We could try to address this issue (tabindex, respect selected preset items for empty search phrase) and then remove "Search for Objects by Preset".

[Don-vip]

In 14927/josm:

see #15051 - refactoring: extract SearchDialog from SearchAction

[Don-vip]

@team: I spent an hour trying to customize focus traversal without success, I think it's a lot simpler to put the preset list on the left side of the search dialog instead of on the right. This way the focus will work by itself. Any objection?

Below my (failed) attempt:

SearchDialog.java

@@ -3 +3 @@
 
 import static org.openstreetmap.josm.tools.I18n.tr;
 
+import java.awt.Component;
+import java.awt.Container;
 import java.awt.Cursor;
 import java.awt.Dimension;
 import java.awt.FlowLayout;
+import java.awt.FocusTraversalPolicy;
 import java.awt.GridBagLayout;
 import java.awt.event.ActionEvent;
 import java.awt.event.MouseAdapter;
 import java.awt.event.MouseEvent;
+import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collections;
 import java.util.List;
@@ -52 +56 @@
     private final SearchSetting searchSettings;
 
     private final HistoryComboBox hcbSearchString = new HistoryComboBox();
+    private final TaggingPresetSelector selector = new TaggingPresetSelector(false, false);
     private final JCheckBox addOnToolbar = new JCheckBox(tr("add toolbar button"), false);
 
     private JCheckBox caseSensitive;
@@ -83 +88 @@
         setContent(buildPanel(searchExpressionHistory, expertMode));
     }
 
+    private static void addFocusableComponents(List<Component> order, Component c) {
+        if (c.isFocusable()) {
+            order.add(c);
+        }
+        if (c instanceof Container) {
+            for (Component child : ((Container) c).getComponents()) {
+                addFocusableComponents(order, child);
+            }
+        }
+    }
+
+    private static void setFocusTraversalOrder(Container container, List<Component> components) {
+
+        List<Component> order = new ArrayList<>();
+        components.forEach(c -> addFocusableComponents(order, c));
+
+        container.setFocusCycleRoot(true);
+        container.setFocusTraversalPolicy(new FocusTraversalPolicy() {
+
+            @Override
+            public Component getFirstComponent(Container aContainer) {
+                return order.get(0);
+            }
+
+            @Override
+            public Component getLastComponent(Container aContainer) {
+                return order.get(order.size() - 1);
+            }
+
+            @Override
+            public Component getDefaultComponent(Container aContainer) {
+                return order.get(0);
+            }
+
+            @Override
+            public Component getComponentBefore(Container aContainer, Component aComponent) {
+                int idx = order.indexOf(aComponent) - 1;
+                return order.get(idx < 0 ? order.size() - 1 : idx);
+            }
+
+            @Override
+            public Component getComponentAfter(Container aContainer, Component aComponent) {
+                return order.get((order.indexOf(aComponent) + 1) % order.size());
+            }
+        });
+    }
+
     private JPanel buildPanel(List<String> searchExpressionHistory, boolean expertMode) {
 
         // prepare the combo box with the search expressions
@@ -194 +246 @@
          * selected preset by the user. Every query is of the form ' group/sub-group/.../presetName'
          * if the corresponding group of the preset exists, otherwise it is simply ' presetName'.
          */
-        TaggingPresetSelector selector = new TaggingPresetSelector(false, false);
         selector.setBorder(BorderFactory.createTitledBorder(tr("Search by preset")));
         selector.setDblClickListener(ev -> setPresetDblClickListener(selector, editorComponent));
 
@@ -204 +255 @@
         p.add(right, GBC.std().fill(GBC.BOTH).insets(0, 10, 0, 0));
         p.add(selector, GBC.eol().fill(GBC.BOTH).insets(0, 10, 0, 0));
 
+        setFocusTraversalOrder(p, Arrays.asList(top, selector, left, right));
+
         return p;
     }
 
@@ -244 +297 @@
         searchSettings.regexSearch = regexSearch.isSelected();
         searchSettings.mapCSSSearch = mapCSSSearch.isSelected();
 
+        if (searchSettings.text.isEmpty()) {
+            searchSettings.text = presetSearchQuery(selector.getSelectedPreset());
+        }
+
         if (inSelection.isSelected()) {
             searchSettings.mode = SearchMode.in_selection;
         } else if (replace.isSelected()) {
@@ -364 +421 @@
     }
 
     /**
-     *
+     * Sets the preset list double-click handler that generates the associated search query
      * @param selector Selector component that the user interacts with
      * @param searchEditor Editor for search queries
      */
@@ -384 +441 @@
         // invokeLater allows us to defer the selection until waiting for focus.
         SwingUtilities.invokeLater(() -> {
             int textOffset = searchEditor.getCaretPosition();
-            String presetSearchQuery = " preset:" +
-                    "\"" + selectedPreset.getRawName() + "\"";
             try {
-                searchEditor.getDocument().insertString(textOffset, presetSearchQuery, null);
+                searchEditor.getDocument().insertString(textOffset, presetSearchQuery(selectedPreset), null);
             } catch (BadLocationException e1) {
                 throw new JosmRuntimeException(e1.getMessage(), e1);
             }
         });
     }
 
+    private static String presetSearchQuery(TaggingPreset selectedPreset) {
+        return selectedPreset != null ? " preset:\"" + selectedPreset.getRawName() + "\"" : "";
+    }
+
     private static class SearchKeywordRow extends JPanel {
 
         private final HistoryComboBox hcb;

[GerdP]

I think I don't like the idea to reorder this often used dialog. Up to now I did not even recognize the "search by preset" stuff.
With
[Ctrl]+F – 6×[Tab] – tree - [Down] – [Enter]
you get into the list. Would it be possible to bind a hotkey - e.g. [Tab]or [Space] - so that it creates the corresponding search entry?

[Don-vip]

In 14932/josm:

see #15051, fix #17522 - crash in filter dialog caused by r14927 (patch by taylor.smock)

[Don-vip]

In 14976/josm:

see #15051 - add a new method to get search text from SearchTextResultListPanel

[simon04]

In 16279/josm:

fix #15051 - Add help button to "Search for Objects by Preset"

[simon04]

→ Help/Action/TaggingPresetSearchPrimitiveDialog

[skyper]

Replying to simon04:

→ Help/Action/TaggingPresetSearchPrimitiveDialog

Think this should be moved to Help/Dialog/TaggingPresetSearchPrimitiveDialog

[skyper]

Replying to skyper:

Replying to simon04:

→ Help/Action/TaggingPresetSearchPrimitiveDialog

Think this should be moved to Help/Dialog/TaggingPresetSearchPrimitiveDialog

Should dialogs not be under Help/Dialog?
Is there any reason, to have it under wiki:Help/Action?

I would move it but I have no user rights to do it and the code needs to be changed anyway.

[simon04]

• Help/Action/TaggingPresetSearch
• Help/Action/TaggingPresetSearchPrimitiveDialog

… should be documented analogously since they are both placed in the presets menu and use the same dialog structure

[skyper]

So, what should be under Help/Dialog and what under wiki:Help/Action ?

[simon04]

In 16320/josm:

fix #15051 - Add help button to "Search for Objects by Preset"

[skyper]

Thanks

[Klumbumbus]

Milestone renamed