src/jalview/util/dialogrunner/DialogRunnerI.java

   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  * functional pattern for blocking dialog response handling
  25  *
  26  * @author jprocter
  27  *
  28  */
  29 public interface DialogRunnerI<T extends DialogRunnerI>
  30 {
  31
  32   /**
  33    * define a new response for this dialog. eg. dialog.response(new
  34    * RunResponse(OK_PRessed) { run()...}).response(new RunResponse(CANCEL_PRESSED)
  35    * { ... });
  36    *
  37    * @param action
  38    * @return the dialog
  39    */
  40   T response(RunResponse action);
  41
  42 }