X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Futil%2Fdialogrunner%2FDialogRunnerI.java;h=1fc41e7c60cec166e33f913e096b9350b364d942;hb=09be4c7dd6a31d9a39e5317cc8dc9eb21e8e6ebf;hp=691465625e0ac746d6a0215b6a72d88f8cf276e4;hpb=a4aa14220a6a53391ca8e171bc774cef908057a3;p=jalview.git diff --git a/src/jalview/util/dialogrunner/DialogRunnerI.java b/src/jalview/util/dialogrunner/DialogRunnerI.java index 6914656..1fc41e7 100644 --- a/src/jalview/util/dialogrunner/DialogRunnerI.java +++ b/src/jalview/util/dialogrunner/DialogRunnerI.java @@ -20,10 +20,13 @@ */ package jalview.util.dialogrunner; -import java.util.List; +import java.util.concurrent.Callable; /** - * functional pattern for blocking dialog response handling + * 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 * @@ -32,26 +35,28 @@ public interface DialogRunnerI { /** - * Adds a new response for this dialog, and returns the dialog (this), to allow chaining, eg. - *
-   * dialog.addResponse(newRunResponse(OK_PRessed) { run()...})
-   *     .addResponse(new RunResponse(CANCEL_PRESSED);
-   * 
+ * Sets the action to be performed when the dialog returns the given response. + * Note this also handles int-valued responses, which will be + * converted to Integer when this method is invoked. * + * @param response * @param action * @return */ - DialogRunnerI addResponse(RunResponse action); + DialogRunnerI setResponseHandler(Object response, Callable action); + + // DialogRunnerI setResponseHandler(Object response, Runnable action); /** - * Runs any registered handlers for the given response, and answers the list - * of responses run (if any) in order run + * 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 List handleResponse(Object response) + default void handleResponse(Object response) { - return null; } }