X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fgui%2FIProgressIndicator.java;h=a39d5f2fd1058f49ac30be7440d24c702eb22878;hb=865a855a4ca87eadb3e5ff284ed32ed307d9c34b;hp=30953fe4d900c201ee0814f95796e7e9ae281a2b;hpb=2de8acfae59aced665e4c37ad0f7dcc2ed68818e;p=jalview.git diff --git a/src/jalview/gui/IProgressIndicator.java b/src/jalview/gui/IProgressIndicator.java index 30953fe..a39d5f2 100644 --- a/src/jalview/gui/IProgressIndicator.java +++ b/src/jalview/gui/IProgressIndicator.java @@ -1,48 +1,56 @@ -/* - * Jalview - A Sequence Alignment Editor and Viewer (Development Version 2.4.1) - * Copyright (C) 2009 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle - * - * This program 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 2 - * of the License, or (at your option) any later version. - * - * This program 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 this program; if not, write to the Free Software - * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA - */ -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); - - -} +/* + * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.0b1) + * 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(); + +}