View Javadoc

1   /*
2    *  XNap - A P2P framework and client.
3    *
4    *  See the file AUTHORS for copyright information.
5    *
6    *  This program is free software; you can redistribute it and/or modify
7    *  it under the terms of the GNU General Public License as published by
8    *  the Free Software Foundation.
9    *
10   *  This program is distributed in the hope that it will be useful,
11   *  but WITHOUT ANY WARRANTY; without even the implied warranty of
12   *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13   *  GNU General Public License for more details.
14   *
15   *  You should have received a copy of the GNU General Public License
16   *  along with this program; if not, write to the Free Software
17   *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18   */
19  
20  package org.xnap.gui.component;
21  
22  
23  /***
24   * Defines the requirements for classes that monitor operations
25   * to display user visible feedback.
26   */
27  public interface ProgressMonitor { 
28  
29      //--- Method(s) ---
30  
31  	/***
32  	 * Invoked when the operation has completed. This is always called last.
33  	 */
34  	void done();
35  
36  	/***
37  	 * Returns true, if the opertion has been cancelled by the user.
38  	 */
39  	boolean isCancelled();
40  	
41  	/***
42  	 * Enables the cancel button.
43  	 */
44  	void setCancelEnabled(boolean enabled);
45  	
46  	/***
47  	 * Sets the maximum value.
48  	 */
49  	void setMaximum(int max);
50  	
51  	/***
52  	 * Sets the minimum value.
53  	 */
54  	void setMinimum(int min);
55  
56  	/***
57  	 * Sets the percentage that has been completed.
58  	 */
59  	void setPercent(double percent);
60  
61  	/***
62  	 * Sets the current value.
63  	 *
64  	 * @param value min <= value <= max
65  	 */
66  	void setValue(int value);
67  
68  	/***
69  	 * Sets the message text.
70  	 */
71  	void setText(String text);
72  
73  	/***
74  	 * Associates a thread with the progress monitor. The monitor is
75  	 * supposed to call thread.interrupt() when the user cancels the
76  	 * operation.
77  	 */
78  	void setThread(Thread thread);
79  
80  }