Clover icon

Coverage Report

  1. Project Clover database Thu Aug 13 2020 12:04:21 BST
  2. Package jalview.util.dialogrunner

File DialogRunnerI.java

 

Coverage histogram

../../../img/srcFileCovDistChart0.png
56% of files have more coverage

Code metrics

0
0
1
1
56
6
1
-
0
1
1

Classes

Class Line # Actions
DialogRunnerI 32 0 1
0.00%
 

Contributing tests

No tests hitting this source file were found.

Source view

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    * Sets the action to be performed when the dialog returns the given response.
36    * Note this also handles <code>int</code>-valued responses, which will be
37    * converted to <code>Integer</code> when this method is invoked.
38    *
39    * @param response
40    * @param action
41    * @return
42    */
43    DialogRunnerI setResponseHandler(Object response, Runnable action);
44   
45    /**
46    * Runs the registered handler (if any) for the given response. The default
47    * action is to do nothing. Typically an action will be need on 'OK' or other
48    * positive selection in the dialog. An action might in some cases also be
49    * needed for a 'Cancel' response.
50    *
51    * @param response
52    * @return
53    */
 
54  0 toggle default void handleResponse(Object response) {
55    }
56    }