KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > columba > api > command > IWorkerStatusController


1 //The contents of this file are subject to the Mozilla Public License Version 1.1
2 //(the "License"); you may not use this file except in compliance with the
3 //License. You may obtain a copy of the License at http://www.mozilla.org/MPL/
4 //
5 //Software distributed under the License is distributed on an "AS IS" basis,
6 //WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
7 //for the specific language governing rights and
8 //limitations under the License.
9 //
10 //The Original Code is "The Columba Project"
11 //
12 //The Initial Developers of the Original Code are Frederik Dietz and Timo Stich.
13 //Portions created by Frederik Dietz and Timo Stich are Copyright (C) 2003.
14 //
15 //All Rights Reserved.
16 package org.columba.api.command;
17
18
19
20 public interface IWorkerStatusController {
21     /**
22  * Set the text to be displayed in the status bar
23  * @param text Text to display in status bar
24  */
25     public void setDisplayText(String JavaDoc text);
26
27     /**
28  * Returns the text currently displayed in the status bar
29  */
30     public String JavaDoc getDisplayText();
31
32     /**
33  * Clears the text displayed in the status bar - without any delay
34  */
35     public void clearDisplayText();
36
37     /**
38  * Clears the text displayed in the status bar - with a given delay.
39  * The delay used is 500 ms.
40  * <br>
41  * If a new text is set within this delay, the text is not cleared.
42  */
43     public void clearDisplayTextWithDelay();
44
45     /**
46  * Sets the maximum value for the progress bar.
47  * @param max New max. value for progress bar
48  */
49     public void setProgressBarMaximum(int max);
50
51     /**
52  * Sets the current value of the progress bar.
53  * @param value New current value of progress bar
54  */
55     public void setProgressBarValue(int value);
56
57     /**
58  * Sets the progress bar value to zero, i.e. clears the progress bar.
59  * This is the same as calling setProgressBarValue(0)
60  */
61     public void resetProgressBar();
62
63     /**
64  * Returns the max. value for the progress bar
65  */
66     public int getProgessBarMaximum();
67
68     /**
69  * Returns the current value for the progress bar
70  */
71     public int getProgressBarValue();
72
73     public void cancel();
74
75     public boolean cancelled();
76
77     public void addWorkerStatusChangeListener(IWorkerStatusChangeListener l);
78
79     public int getTimeStamp();
80
81     /**
82      * @param listener
83      */
84     public void removeWorkerStatusChangeListener(IWorkerStatusChangeListener listener);
85 }
86
Popular Tags