X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Futil%2Fdialogrunner%2FDialogRunnerI.java;h=0cb90c27b37373f58802ec6e7ed3c4240cfc69d8;hb=1c721468246c2aafd86fc52d954512374f576b11;hp=9df6d3369a33a5c055b56b628db9797660404f46;hpb=592c32d037225062c9a4d6caac19b4b556668d9c;p=jalview.git diff --git a/src/jalview/util/dialogrunner/DialogRunnerI.java b/src/jalview/util/dialogrunner/DialogRunnerI.java index 9df6d33..0cb90c2 100644 --- a/src/jalview/util/dialogrunner/DialogRunnerI.java +++ b/src/jalview/util/dialogrunner/DialogRunnerI.java @@ -21,22 +21,36 @@ package jalview.util.dialogrunner; /** - * 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 * */ -public interface DialogRunnerI -{ +public interface DialogRunnerI { - /** - * define a new response for this dialog. eg. dialog.response(new - * RunResponse(OK_PRessed) { run()...}).response(new RunResponse(CANCEL_PRESSED) - * { ... }); - * - * @param action - * @return the dialog - */ - T response(RunResponse action); + /** + * 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 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) { + } }