src/jalview/gui/IProgressIndicator.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.0b1)
   3  * Copyright (C) 2014 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 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  * The Jalview Authors are detailed in the 'AUTHORS' file.
  18  */
  19 package jalview.gui;
  20
  21 /**
  22  * Visual progress indicator interface.
  23  *
  24  * @author JimP
  25  *
  26  */
  27 public interface IProgressIndicator
  28 {
  29   /**
  30    * Visual indication of some operation taking place. On first call with a
  31    * particular ID an indicator with the given message is added. The indicator
  32    * is removed with a second call with same ID.
  33    *
  34    * @param message
  35    *          - displayed message for operation
  36    * @param id
  37    *          - unique handle for this indicator
  38    */
  39   public abstract void setProgressBar(String message, long id);
  40
  41   /**
  42    * register a handler for the progress bar identified by id
  43    *
  44    * @param id
  45    * @param handler
  46    */
  47   public abstract void registerHandler(long id,
  48           IProgressIndicatorHandler handler);
  49
  50   /**
  51    *
  52    * @return true if any progress bars are still active
  53    */
  54   boolean operationInProgress();
  55
  56 }