X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fgui%2FIProgressIndicator.java;h=981e94c24a16fd06539e8b7758f873bdadcd69d1;hb=refs%2Fheads%2Freleases%2FRelease_2_10_0_Branch;hp=cff39779e2be7627a538315e21e82e5808bbc904;hpb=d423f22792e47dbc800ae220a58677f988971d06;p=jalview.git diff --git a/src/jalview/gui/IProgressIndicator.java b/src/jalview/gui/IProgressIndicator.java index cff3977..981e94c 100644 --- a/src/jalview/gui/IProgressIndicator.java +++ b/src/jalview/gui/IProgressIndicator.java @@ -1,49 +1,58 @@ -/* - * Jalview - A Sequence Alignment Editor and Viewer (Version 2.5) - * Copyright (C) 2010 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle - * - * 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 . - */ -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-Rel$$) + * Copyright (C) $$Year-Rel$$ 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(); + +}