UIEXT-3206: Add runFinishedProvider property to SimpleButtonWidget

This is a precursor to allowing frontend button to be disabled on click
until the action has finished.

UIEXT-3206 (WebUI-Migration SDF Reader)

Author: tcrundall-tng

org.knime.core.ui/src/eclipse/org/knime/core/webui/node/dialog/defaultdialog/internal/button/SimpleButtonWidget.java

@@ -54,6 +54,7 @@
 import java.lang.annotation.Retention;
 import java.lang.annotation.Target;
 
+import org.knime.core.webui.node.dialog.defaultdialog.widget.updates.NoopStringProvider;
 import org.knime.node.parameters.updates.ButtonReference;
 import org.knime.node.parameters.updates.StateProvider;
 
@@ -77,4 +78,13 @@
      */
     Icon icon() default Icon.NONE;
 
+    /**
+     * An optional provider that is to be used if a long-running action is triggered and the user should be prevented
+     * from clicking the button again until the action has finished. The button will be disabled whenever clicked and
+     * re-enabled once the provider provides a new uuid.
+     *
+     * @return provide a unique uuid once the button action has finished which lets frontend know the button can be
+     *         re-enabled
+     */
+    Class<? extends StateProvider<String>> runFinishedProvider() default NoopStringProvider.class;
 }

org.knime.core.ui/src/eclipse/org/knime/core/webui/node/dialog/defaultdialog/jsonforms/JsonFormsConsts.java

@@ -224,6 +224,11 @@ private UiSchema() {
          */
         public static final String TAG_MESSAGE = "message";
 
+        /**
+         * Used to re-activate a button after its action has been performed.
+         */
+        public static final String TAG_RUN_FINISHED = "runFinished";
+
         /**
          * Used for providing the possible formats of a {@link DateTimeFormatPickerWidget}
          */

org.knime.core.ui/src/eclipse/org/knime/core/webui/node/dialog/defaultdialog/jsonforms/uischema/UiSchemaOptionsGenerator.java

@@ -109,6 +109,7 @@
 import org.knime.core.webui.node.dialog.defaultdialog.internal.widget.WidgetInternal;
 import org.knime.core.webui.node.dialog.defaultdialog.jsonforms.DateTimeUtil;
 import org.knime.core.webui.node.dialog.defaultdialog.jsonforms.EnumUtil;
+import org.knime.core.webui.node.dialog.defaultdialog.jsonforms.JsonFormsConsts.UiSchema;
 import org.knime.core.webui.node.dialog.defaultdialog.jsonforms.JsonFormsConsts.UiSchema.Format;
 import org.knime.core.webui.node.dialog.defaultdialog.jsonforms.JsonFormsScopeUtil;
 import org.knime.core.webui.node.dialog.defaultdialog.jsonforms.renderers.RendererToJsonFormsUtil;
@@ -342,6 +343,10 @@ void addOptionsTo(final ObjectNode control) {
                     default -> throw new IllegalArgumentException("Unexpected value: " + simpleButtonWidget.icon());
                 });
             }
+            if (!NoopStringProvider.class.equals(simpleButtonWidget.runFinishedProvider())) {
+                getOrCreateProvidedOptions(control).add(UiSchema.TAG_RUN_FINISHED);
+            }
+
         }
 
         final var isValueSwitch = annotatedWidgets.contains(ValueSwitchWidget.class);

org.knime.core.ui/src/eclipse/org/knime/core/webui/node/dialog/defaultdialog/util/updates/WidgetTreesToRefsAndStateProviders.java

@@ -63,6 +63,7 @@
 import org.knime.core.data.DataType;
 import org.knime.core.node.util.CheckUtils;
 import org.knime.core.webui.node.dialog.defaultdialog.DefaultNodeDialog;
+import org.knime.core.webui.node.dialog.defaultdialog.internal.button.SimpleButtonWidget;
 import org.knime.core.webui.node.dialog.defaultdialog.internal.dynamic.DataAndDialog;
 import org.knime.core.webui.node.dialog.defaultdialog.internal.dynamic.DynamicParameters;
 import org.knime.core.webui.node.dialog.defaultdialog.internal.dynamic.DynamicParameters.DynamicParametersProvider;
@@ -348,6 +349,12 @@ public Optional<List<UiState>> getUiStateProviders(final TreeNode<WidgetGroup> n
                 TextMessage::value, //
                 null //
             ), //
+            new UiStateProviderAnnotationSpec<>(//
+                UiSchema.TAG_RUN_FINISHED, //
+                SimpleButtonWidget.class, //
+                SimpleButtonWidget::runFinishedProvider, //
+                NoopStringProvider.class //
+            ), //
             new UiStateProviderAnnotationSpec<>( //
                 UiSchema.TAG_ARRAY_LAYOUT_ELEMENT_TITLE, //
                 ArrayWidgetInternal.class, //