X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fgui%2FIProgressIndicator.java;h=83e266f7a0bea2b398a18198688e7a704266358a;hb=a8f483d04205bb8273ee311c12968b7e86d205fa;hp=4acaba93fe0a5533743b428eb95f207291f3ac04;hpb=b9d84d8a7aa2557c51307addf9e80139f07bb14b;p=jalview.git diff --git a/src/jalview/gui/IProgressIndicator.java b/src/jalview/gui/IProgressIndicator.java index 4acaba9..83e266f 100644 --- a/src/jalview/gui/IProgressIndicator.java +++ b/src/jalview/gui/IProgressIndicator.java @@ -1,18 +1,56 @@ -package jalview.gui; - -/** - * Visual progress indicator interface. - * @author JimP - * - */ -public interface IProgressIndicator -{ - /** - * Visual indication of some operation taking place. - * On first call with a particular ID an indicator with the given message is added. The indicator is removed with a second call with same ID. - * @param message - displayed message for operation - * @param id - unique handle for this indicator - */ - public abstract void setProgressBar(String message, long id); - -} \ No newline at end of file +/* + * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2) + * Copyright (C) 2014 The Jalview Authors + * + * This file is part of Jalview. + * + * Jalview is free software: you can redistribute it and/or + * modify it under the terms of the GNU General Public License + * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. + * + * Jalview is distributed in the hope that it will be useful, but + * WITHOUT ANY WARRANTY; without even the implied warranty + * of MERCHANTABILITY or FITNESS FOR A PARTICULAR + * PURPOSE. See the GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License along with Jalview. If not, see . + * The Jalview Authors are detailed in the 'AUTHORS' file. + */ +package jalview.gui; + +/** + * Visual progress indicator interface. + * + * @author JimP + * + */ +public interface IProgressIndicator +{ + /** + * Visual indication of some operation taking place. On first call with a + * particular ID an indicator with the given message is added. The indicator + * is removed with a second call with same ID. + * + * @param message + * - displayed message for operation + * @param id + * - unique handle for this indicator + */ + public abstract void setProgressBar(String message, long id); + + /** + * register a handler for the progress bar identified by id + * + * @param id + * @param handler + */ + public abstract void registerHandler(long id, + IProgressIndicatorHandler handler); + + /** + * + * @return true if any progress bars are still active + */ + boolean operationInProgress(); + +}