Classes

Class	Line #	Total Statements	Complexity	Uncovered Elements	TOTAL Coverage	Actions
IProgressIndicator	29	0	0	0	-1.0 -	Show methods

Class IProgressIndicator

Class IProgressIndicator	Line # 29	Total Statements 0	Complexity 0	Uncovered Elements 0	TOTAL Coverage -1.0 -

 

Contributing tests

Source view

1		/*
2		* Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3		* Copyright (C) $$Year-Rel$$ 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
10		* of the License, or (at your option) any later version.
11		*
12		* Jalview is distributed in the hope that it will be useful, but
13		* WITHOUT ANY WARRANTY; without even the implied warranty
14		* of MERCHANTABILITY or FITNESS FOR A PARTICULAR
15		* PURPOSE. See the GNU General Public License for more details.
16		*
17		* You should have received a copy of the GNU General Public License
18		* along with Jalview. If not, see <http://www.gnu.org/licenses/>.
19		* The Jalview Authors are detailed in the 'AUTHORS' file.
20		*/
21		package jalview.gui;
22
23		/**
24		* Visual progress indicator interface.
25		*
26		* @author JimP
27		*
28		*/
		- Uncovered Elements: 0 (0) Complexity: 0 Complexity Density: -
29		public interface IProgressIndicator
30		{
31		/**
32		* Visual indication of some operation taking place. On first call with a
33		* particular ID an indicator with the given message is added. The indicator
34		* is removed with a second call with same ID.
35		*
36		* @param message
37		* - displayed message for operation. Please ensure message is
38		* internationalised.
39		* @param id
40		* - unique handle for this indicator
41		*/
42		public abstract void setProgressBar(String message, long id);
43
44		/**
45		* register a handler for the progress bar identified by id
46		*
47		* @param id
48		* @param handler
49		*/
50		public abstract void registerHandler(long id,
51		IProgressIndicatorHandler handler);
52
53		/**
54		*
55		* @return true if any progress bars are still active
56		*/
57		boolean operationInProgress();
58
59		}