X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;ds=inline;f=src%2Fjalview%2Fgui%2FIProgressIndicator.java;h=35bd8710a6c7031cbc857141d6a16abc44cd6cdf;hb=48eba1af1959565659fae9f9e7f4e28d9726c28c;hp=5ce8daffc09864e6f7985a2aa7d2b492d51373dd;hpb=b57a02c25e335d033c97f8a6bacd6b54f62bd2b6;p=jalview.git
diff --git a/src/jalview/gui/IProgressIndicator.java b/src/jalview/gui/IProgressIndicator.java
index 5ce8daf..35bd871 100644
--- a/src/jalview/gui/IProgressIndicator.java
+++ b/src/jalview/gui/IProgressIndicator.java
@@ -1,55 +1,59 @@
-/*
- * Jalview - A Sequence Alignment Editor and Viewer (Version 2.7)
- * Copyright (C) 2011 J Procter, AM Waterhouse, J Engelhardt, LM Lui, 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);
-
- /**
- *
- * @return true if any progress bars are still active
- */
- boolean operationInProgress();
-
-}
+/*
+ * 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. Please ensure message is
+ * internationalised.
+ * @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();
+
+}