01: //The contents of this file are subject to the Mozilla Public License Version 1.1
02: //(the "License"); you may not use this file except in compliance with the
03: //License. You may obtain a copy of the License at http://www.mozilla.org/MPL/
04: //
05: //Software distributed under the License is distributed on an "AS IS" basis,
06: //WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
07: //for the specific language governing rights and
08: //limitations under the License.
09: //
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: public interface IWorkerStatusController {
19: /**
20: * Set the text to be displayed in the status bar
21: * @param text Text to display in status bar
22: */
23: public void setDisplayText(String text);
24:
25: /**
26: * Returns the text currently displayed in the status bar
27: */
28: public String getDisplayText();
29:
30: /**
31: * Clears the text displayed in the status bar - without any delay
32: */
33: public void clearDisplayText();
34:
35: /**
36: * Clears the text displayed in the status bar - with a given delay.
37: * The delay used is 500 ms.
38: * <br>
39: * If a new text is set within this delay, the text is not cleared.
40: */
41: public void clearDisplayTextWithDelay();
42:
43: /**
44: * Sets the maximum value for the progress bar.
45: * @param max New max. value for progress bar
46: */
47: public void setProgressBarMaximum(int max);
48:
49: /**
50: * Sets the current value of the progress bar.
51: * @param value New current value of progress bar
52: */
53: public void setProgressBarValue(int value);
54:
55: /**
56: * Sets the progress bar value to zero, i.e. clears the progress bar.
57: * This is the same as calling setProgressBarValue(0)
58: */
59: public void resetProgressBar();
60:
61: /**
62: * Returns the max. value for the progress bar
63: */
64: public int getProgessBarMaximum();
65:
66: /**
67: * Returns the current value for the progress bar
68: */
69: public int getProgressBarValue();
70:
71: public void cancel();
72:
73: public boolean cancelled();
74:
75: public void addWorkerStatusChangeListener(
76: IWorkerStatusChangeListener l);
77:
78: public int getTimeStamp();
79:
80: /**
81: * @param listener
82: */
83: public void removeWorkerStatusChangeListener(
84: IWorkerStatusChangeListener listener);
85: }
|