X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Futil%2Fdialogrunner%2FDialogRunnerI.java;fp=src%2Fjalview%2Futil%2Fdialogrunner%2FDialogRunnerI.java;h=0cb90c27b37373f58802ec6e7ed3c4240cfc69d8;hb=ec8f3cedf60fb1feed6d34de6b49f6bfa78b9dd8;hp=0000000000000000000000000000000000000000;hpb=056dad85a910551cc95e44d451a61f6b8c4dd35d;p=jalview.git

diff --git a/src/jalview/util/dialogrunner/DialogRunnerI.java b/src/jalview/util/dialogrunner/DialogRunnerI.java
new file mode 100644
index 0000000..0cb90c2
--- /dev/null
+++ b/src/jalview/util/dialogrunner/DialogRunnerI.java
@@ -0,0 +1,56 @@
+/*
+ * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
+ * Copyright (C) $$Year-Rel$$ The Jalview Authors
+ *
+ * This file is part of Jalview.
+ *
+ * Jalview is free software: you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation, either version 3
+ * of the License, or (at your option) any later version.
+ *
+ * Jalview is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty
+ * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
+ * PURPOSE.  See the GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
+ */
+package jalview.util.dialogrunner;
+
+/**
+ * An interface for blocking dialog response handling. This is motivated by
+ * JalviewJS - when running as Javascript, there is only a single thread, and
+ * blocking dialogs have to be responsible for performing any actions required
+ * for user responses.
+ * 
+ * @author jprocter
+ *
+ */
+public interface DialogRunnerI {
+
+	/**
+	 * Sets the action to be performed when the dialog returns the given response.
+	 * Note this also handles <code>int</code>-valued responses, which will be
+	 * converted to <code>Integer</code> when this method is invoked.
+	 * 
+	 * @param response
+	 * @param action
+	 * @return
+	 */
+	DialogRunnerI setResponseHandler(Object response, Runnable action);
+
+	/**
+	 * Runs the registered handler (if any) for the given response. The default
+	 * action is to do nothing. Typically an action will be need on 'OK' or other
+	 * positive selection in the dialog. An action might in some cases also be
+	 * needed for a 'Cancel' response.
+	 * 
+	 * @param response
+	 * @return
+	 */
+	default void handleResponse(Object response) {
+	}
+}