src/jalview/gui/IProgressIndicator.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.gui;
  22
  23 import javax.swing.JProgressBar;
  24
  25 /**
  26  * Visual progress indicator interface.
  27  *
  28  * @author JimP
  29  *
  30  */
  31 public interface IProgressIndicator
  32 {
  33   /**
  34    * Visual indication of some operation taking place. On first call with a
  35    * particular ID an indicator with the given message is added. The indicator
  36    * is removed with a second call with same ID.
  37    *
  38    * @param message
  39    *          - displayed message for operation. Please ensure message is
  40    *          internationalised.
  41    * @param id
  42    *          - unique handle for this indicator
  43    */
  44   public abstract void setProgressBar(String message, long id);
  45
  46   /**
  47    * register a handler for the progress bar identified by id
  48    *
  49    * @param id
  50    * @param handler
  51    */
  52   public abstract void registerHandler(long id,
  53           IProgressIndicatorHandler handler);
  54
  55   /**
  56    *
  57    * @return true if any progress bars are still active
  58    */
  59   boolean operationInProgress();
  60
  61   /**
  62    *
  63    * @param id
  64    * @return progressbar mapped to id
  65    */
  66   public JProgressBar getProgressBar(long id);
  67
  68 }