| Class | Line # | Actions | |||
|---|---|---|---|---|---|
| DialogRunnerI | 32 | 0 | 1 |
| 1 | /* | |
| 2 | * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$) | |
| 3 | * Copyright (C) $$Year-Rel$$ The Jalview Authors | |
| 4 | * | |
| 5 | * This file is part of Jalview. | |
| 6 | * | |
| 7 | * Jalview is free software: you can redistribute it and/or | |
| 8 | * modify it under the terms of the GNU General Public License | |
| 9 | * as published by the Free Software Foundation, either version 3 | |
| 10 | * of the License, or (at your option) any later version. | |
| 11 | * | |
| 12 | * Jalview is distributed in the hope that it will be useful, but | |
| 13 | * WITHOUT ANY WARRANTY; without even the implied warranty | |
| 14 | * of MERCHANTABILITY or FITNESS FOR A PARTICULAR | |
| 15 | * PURPOSE. See the GNU General Public License for more details. | |
| 16 | * | |
| 17 | * You should have received a copy of the GNU General Public License | |
| 18 | * along with Jalview. If not, see <http://www.gnu.org/licenses/>. | |
| 19 | * The Jalview Authors are detailed in the 'AUTHORS' file. | |
| 20 | */ | |
| 21 | package jalview.util.dialogrunner; | |
| 22 | ||
| 23 | /** | |
| 24 | * An interface for blocking dialog response handling. This is motivated by | |
| 25 | * JalviewJS - when running as Javascript, there is only a single thread, and | |
| 26 | * blocking dialogs have to be responsible for performing any actions required | |
| 27 | * for user responses. | |
| 28 | * | |
| 29 | * @author jprocter | |
| 30 | * | |
| 31 | */ | |
| 32 | public interface DialogRunnerI | |
| 33 | { | |
| 34 | ||
| 35 | /** | |
| 36 | * Sets the action to be performed when the dialog returns the given response. | |
| 37 | * Note this also handles <code>int</code>-valued responses, which will be | |
| 38 | * converted to <code>Integer</code> when this method is invoked. | |
| 39 | * | |
| 40 | * @param response | |
| 41 | * @param action | |
| 42 | * @return | |
| 43 | */ | |
| 44 | DialogRunnerI setResponseHandler(Object response, Runnable action); | |
| 45 | ||
| 46 | // DialogRunnerI setResponseHandler(Object response, Runnable action); | |
| 47 | ||
| 48 | /** | |
| 49 | * Runs the registered handler (if any) for the given response. The default | |
| 50 | * action is to do nothing. Typically an action will be need on 'OK' or other | |
| 51 | * positive selection in the dialog. An action might in some cases also be | |
| 52 | * needed for a 'Cancel' response. | |
| 53 | * | |
| 54 | * @param response | |
| 55 | * @return | |
| 56 | */ | |
| 57 | 0 | default void handleResponse(Object response) |
| 58 | { | |
| 59 | } | |
| 60 | } |