src/jalview/gui/IProgressIndicator.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8)
   3  * Copyright (C) 2012 J Procter, AM Waterhouse, LM Lui, J Engelhardt, G Barton, M Clamp, S Searle
   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 of the License, or (at your option) any later version.
  10  *
  11  * Jalview is distributed in the hope that it will be useful, but
  12  * WITHOUT ANY WARRANTY; without even the implied warranty
  13  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  14  * PURPOSE.  See the GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  17  */
  18 package jalview.gui;
  19
  20 /**
  21  * Visual progress indicator interface.
  22  *
  23  * @author JimP
  24  *
  25  */
  26 public interface IProgressIndicator
  27 {
  28   /**
  29    * Visual indication of some operation taking place. On first call with a
  30    * particular ID an indicator with the given message is added. The indicator
  31    * is removed with a second call with same ID.
  32    *
  33    * @param message
  34    *          - displayed message for operation
  35    * @param id
  36    *          - unique handle for this indicator
  37    */
  38   public abstract void setProgressBar(String message, long id);
  39
  40   /**
  41    * register a handler for the progress bar identified by id
  42    *
  43    * @param id
  44    * @param handler
  45    */
  46   public abstract void registerHandler(long id,
  47           IProgressIndicatorHandler handler);
  48
  49   /**
  50    *
  51    * @return true if any progress bars are still active
  52    */
  53   boolean operationInProgress();
  54
  55 }