src/jalview/gui/IProgressIndicator.java

   1 /*\r
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.4)\r
   3  * Copyright (C) 2008 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle\r
   4  * \r
   5  * This program is free software; you can redistribute it and/or\r
   6  * modify it under the terms of the GNU General Public License\r
   7  * as published by the Free Software Foundation; either version 2\r
   8  * of the License, or (at your option) any later version.\r
   9  * \r
  10  * This program is distributed in the hope that it will be useful,\r
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
  13  * GNU General Public License for more details.\r
  14  * \r
  15  * You should have received a copy of the GNU General Public License\r
  16  * along with this program; if not, write to the Free Software\r
  17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA\r
  18  */\r
  19 package jalview.gui;\r
  20 \r
  21 /**\r
  22  * Visual progress indicator interface.\r
  23  * \r
  24  * @author JimP\r
  25  * \r
  26  */\r
  27 public interface IProgressIndicator\r
  28 {\r
  29   /**\r
  30    * Visual indication of some operation taking place. On first call with a\r
  31    * particular ID an indicator with the given message is added. The indicator\r
  32    * is removed with a second call with same ID.\r
  33    * \r
  34    * @param message -\r
  35    *                displayed message for operation\r
  36    * @param id -\r
  37    *                unique handle for this indicator\r
  38    */\r
  39   public abstract void setProgressBar(String message, long id);\r
  40   /**\r
  41    * register a handler for the progress bar identified by id\r
  42    * @param id\r
  43    * @param handler\r
  44    */\r
  45   public abstract void registerHandler(long id, IProgressIndicatorHandler handler);\r
  46   \r
  47 \r
  48 }\r