Merge pull request #4138 from gchq/step-refresh-key-bind

Add ctrl-enter key bind for step refresh on code pane

Author: at055612

Diff for: stroom-core-client-widget/src/main/java/stroom/widget/util/client/KeyBinding.java

@@ -231,6 +231,10 @@ static void add(final Action action, final Shortcut... shortcuts) {
         }
     }
 
+
+    // --------------------------------------------------------------------------------
+
+
     private static class Binding {
 
         private final Shortcut shortcut;
@@ -271,6 +275,10 @@ public Binding build() {
         }
     }
 
+
+    // --------------------------------------------------------------------------------
+
+
     private static class Shortcut {
 
         private final int keyCode;
@@ -357,6 +365,10 @@ public boolean hasModifiers() {
         }
     }
 
+
+    // --------------------------------------------------------------------------------
+
+
     public static class Builder {
 
         private int keyCode;

Diff for: stroom-core-client/src/main/java/stroom/core/client/KeyboardInterceptor.java

@@ -61,6 +61,10 @@ private void handleKeyEvent(final NativeEvent event) {
         }
     }
 
+
+    // --------------------------------------------------------------------------------
+
+
     public interface KeyTest {
 
         boolean match(NativeEvent event);

Diff for: stroom-core-client/src/main/java/stroom/pipeline/stepping/client/presenter/ElementPresenter.java

@@ -34,6 +34,7 @@
 import stroom.pipeline.shared.data.PipelineElementType;
 import stroom.pipeline.shared.data.PipelineProperty;
 import stroom.pipeline.shared.stepping.FindElementDocRequest;
+import stroom.pipeline.shared.stepping.StepType;
 import stroom.pipeline.shared.stepping.SteppingResource;
 import stroom.pipeline.stepping.client.presenter.ElementPresenter.ElementView;
 import stroom.util.shared.ErrorType;
@@ -48,6 +49,8 @@
 
 import com.google.gwt.core.client.GWT;
 import com.google.gwt.core.client.Scheduler;
+import com.google.gwt.event.dom.client.KeyCodes;
+import com.google.gwt.event.dom.client.KeyDownEvent;
 import com.google.inject.Inject;
 import com.google.inject.Provider;
 import com.google.web.bindery.event.shared.EventBus;
@@ -60,6 +63,7 @@
 import java.util.EnumMap;
 import java.util.List;
 import java.util.Objects;
+import java.util.function.Consumer;
 import java.util.function.Function;
 import java.util.stream.Collectors;
 
@@ -97,6 +101,7 @@ public class ElementPresenter extends MyPresenterWidget<ElementView> implements
     private ClassificationWrapperView inputView;
     private ClassificationWrapperView outputView;
     private View logView;
+    private Consumer<StepType> stepRequestHandler = null;
 
     @Inject
     public ElementPresenter(final EventBus eventBus,
@@ -307,6 +312,17 @@ public void setCode(final String code) {
             codePresenter.getLiveAutoCompletionOption().setOff();
 
             codePresenter.setMode(getMode(element));
+
+
+            registerHandler(codePresenter.getView().asWidget().addDomHandler(e -> {
+                if (KeyCodes.KEY_ENTER == e.getNativeKeyCode() &&
+                        (e.isShiftKeyDown() || e.isControlKeyDown())) {
+                    e.preventDefault();
+                    if (stepRequestHandler != null) {
+                        stepRequestHandler.accept(StepType.REFRESH);
+                    }
+                }
+            }, KeyDownEvent.getType()));
         }
     }
 
@@ -611,6 +627,10 @@ private void setCommonEditorOptions(final EditorPresenter editorPresenter) {
         editorPresenter.getUseVimBindingsOption().setAvailable();
     }
 
+    public void setStepRequestHandler(final Consumer<StepType> onStepRefreshRequest) {
+        this.stepRequestHandler = onStepRefreshRequest;
+    }
+
 
     // --------------------------------------------------------------------------------
 

Diff for: stroom-core-client/src/main/java/stroom/pipeline/stepping/client/presenter/StepControlPresenter.java

@@ -73,6 +73,33 @@ public void stepRefresh() {
         StepControlEvent.fire(this, StepType.REFRESH);
     }
 
+    public void step(final StepType stepType) {
+        //noinspection EnhancedSwitchMigration // cos GWT
+        switch (stepType) {
+            case FIRST:
+                stepFirst();
+                break;
+            case BACKWARD:
+                stepBackward();
+                break;
+            case FORWARD:
+                stepForward();
+                break;
+            case LAST:
+                stepLast();
+                break;
+            case REFRESH:
+                stepRefresh();
+                break;
+            default:
+                throw new RuntimeException("Unknown type " + stepType);
+        }
+    }
+
+    public boolean isEnabled(final StepType stepType) {
+        return getView().isEnabled(stepType);
+    }
+
     public void setEnabledButtons(final boolean justStepped,
                                   final StepType stepType,
                                   final boolean showingData,
@@ -164,6 +191,10 @@ public HandlerRegistration addStepControlHandler(final StepControlHandler handle
         return addHandlerToSource(StepControlEvent.getType(), handler);
     }
 
+
+    // --------------------------------------------------------------------------------
+
+
     public interface StepControlView extends View, HasUiHandlers<StepControlUIHandlers> {
 
         void setStepFirstEnabled(boolean enabled);
@@ -175,5 +206,7 @@ public interface StepControlView extends View, HasUiHandlers<StepControlUIHandle
         void setStepLastEnabled(boolean enabled);
 
         void setStepRefreshEnabled(boolean enabled);
+
+        boolean isEnabled(final StepType stepType);
     }
 }

Diff for: stroom-core-client/src/main/java/stroom/pipeline/stepping/client/presenter/SteppingPresenter.java

@@ -367,6 +367,13 @@ private PresenterWidget<?> getContent(final PipelineElement element) {
                 elementPresenterMap.put(elementId, presenter);
                 presenter.addDirtyHandler(dirtyEditorHandler);
 
+                // Allow step refresh to be called from the editor
+                presenter.setStepRequestHandler(stepType -> {
+                    if (stepControlPresenter.isEnabled(stepType)) {
+                        stepControlPresenter.step(stepType);
+                    }
+                });
+
                 elementPresenter = presenter;
             }
             currentElementPresenter = elementPresenter;

Diff for: stroom-core-client/src/main/java/stroom/pipeline/stepping/client/view/StepControlViewImpl.java

@@ -16,6 +16,7 @@
 
 package stroom.pipeline.stepping.client.view;
 
+import stroom.pipeline.shared.stepping.StepType;
 import stroom.pipeline.stepping.client.presenter.StepControlPresenter.StepControlView;
 import stroom.pipeline.stepping.client.presenter.StepControlUIHandlers;
 import stroom.svg.shared.SvgImage;
@@ -103,6 +104,25 @@ public void setStepRefreshEnabled(boolean enabled) {
         refreshButton.setEnabled(enabled);
     }
 
+    @Override
+    public boolean isEnabled(final StepType stepType) {
+        //noinspection EnhancedSwitchMigration // cos GWT
+        switch (stepType) {
+            case FIRST:
+                return firstButton.isEnabled();
+            case BACKWARD:
+                return backwardButton.isEnabled();
+            case FORWARD:
+                return forwardButton.isEnabled();
+            case LAST:
+                return lastButton.isEnabled();
+            case REFRESH:
+                return refreshButton.isEnabled();
+            default:
+                return false;
+        }
+    }
+
     @UiHandler("filterButton")
     public void onFilterButtonClick(final ClickEvent event) {
         if (getUiHandlers() != null) {
@@ -145,6 +165,10 @@ public void onRefreshButtonClick(final ClickEvent event) {
         }
     }
 
+
+    // --------------------------------------------------------------------------------
+
+
     public interface Binder extends UiBinder<Widget, StepControlViewImpl> {
 
     }

Diff for: unreleased_changes/20240229_155848_398__0.md

@@ -0,0 +1,19 @@
+* Add the key bind `ctrl-enter` to do a step refresh on the code pane of the stepper.
+
+
+```sh
+# ONLY the top line will be included as a change entry in the CHANGELOG.
+# The entry should be in GitHub flavour markdown and should be written on a SINGLE
+# line with no hard breaks. You can have multiple change files for a single GitHub issue.
+# The  entry should be written in the imperative mood, i.e. 'Fix nasty bug' rather than
+# 'Fixed nasty bug'.
+#
+# Examples of acceptable entries are:
+#
+#
+# * Issue **123** : Fix bug with an associated GitHub issue in this repository
+#
+# * Issue **namespace/other-repo#456** : Fix bug with an associated GitHub issue in another repository
+#
+# * Fix bug with no associated GitHub issue.
+```