2 * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3 * Copyright (C) $$Year-Rel$$ The Jalview Authors
5 * This file is part of Jalview.
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.
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.
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.
21 package jalview.util.dialogrunner;
23 import java.util.ArrayList;
24 import java.util.List;
28 * daft gymnastics to allow Dialogs to extend from a Swing class and use this
29 * class to implement chained Response run() definition and execution.
31 * There is probably a better way of doing this.
36 * the actual dialog that will be shown - which will also initiate the
39 public class DialogRunner<T extends DialogRunnerI> implements DialogRunnerI
42 private Map<Response, List<RunResponse>> callbacks = new java.util.HashMap<>();
46 public DialogRunner(T ourDialog)
52 * clear all 'was ran' flags so responses can be called again, and firstRun will
53 * trigger response execution
55 public void resetResponses()
57 for (List<RunResponse> lr : callbacks.values())
59 for (RunResponse response : lr)
65 if (defaultResponse != null)
67 defaultResponse.reset();
69 firstRunWasCalled = false;
73 public T response(RunResponse action)
75 return addResponse(false, action);
79 * insert a response at the beginning of the chain for the action. Useful to add
80 * pre-action validations local to the Dialog class
85 public T firstResponse(RunResponse action)
87 return addResponse(true, action);
90 protected T addResponse(boolean prePend, RunResponse action)
92 List<RunResponse> laction = callbacks.get(action.ourTrigger);
95 laction = new ArrayList<>();
96 callbacks.put(action.ourTrigger, laction);
100 laction.add(0,action);
110 * @return true if action is a registered callback
112 public boolean isRegistered(RunResponse action)
114 List<RunResponse> resp = callbacks.get(action.ourTrigger);
117 for (RunResponse r : resp)
130 * @param responseCode
132 public void run(int responseCode)
134 run(new Response(responseCode));
137 public void run(String responseString)
139 run(new Response(responseString));
142 public void run(Object responseObj)
144 run(new Response(responseObj));
148 * start of response handling.
150 * @param responseCode
152 public void firstRun(int responseCode)
154 doFirstRun(new Response(responseCode));
157 public void firstRun(String responseString)
159 doFirstRun(new Response(responseString));
162 public void firstRun(Object responseObj)
164 if (responseObj != null && !responseObj.equals(responseObj))
166 // NaN is an object in Chrome - catch this weirdness
167 // this so we don't cause issues later
170 doFirstRun(new Response(responseObj));
174 boolean firstRunWasCalled = false;
176 private void doFirstRun(Response response)
178 if (firstRunWasCalled)
182 firstRunWasCalled = true;
186 private void run(Response response)
188 if (response.objresp != null
189 && !response.objresp.equals(response.objresp))
191 // NaN is an object in Chrome - catch this weirdness
192 // this so we don't cause issues later
195 responses.add(response);
197 List<RunResponse> laction = response.isNull() ? null : callbacks.get(response);
201 if (defaultResponse != null)
203 defaultResponse.ourTrigger = response;
204 defaultResponse.wasRun = true;
205 defaultResponse.run();
209 System.err.println("Doing nothing for " + response);
213 boolean wasRun = false;
215 for (RunResponse action : laction)
218 // find next action to execute
222 .println("Executing action (" + num + ") for " + response);
224 action.wasRun = true;
226 if (action.returned != null)
228 run(action.returned);
235 System.err.println("Did nothing for " + response);
239 List<Response> responses = new ArrayList<>();
241 RunResponse defaultResponse = null;
244 * Convenience wrapper for setting default response to a runnable
248 public void setDefaultResponse(Runnable runnable)
250 defaultResponse = new RunResponse(runnable)
261 * Default responses are called once, with ourTrigger set to the unHandled
266 public void setDefaultResponse(RunResponse runnable)
268 defaultResponse = runnable;