src/jalview/gui/IProgressIndicator.java

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