01: package net.suberic.util.swing;
02:
03: /**
04: * An interface for any UI component which displays the progress for a
05: * particular action, along with an optional way to cancel the action.
06: */
07: public interface ProgressDialog {
08:
09: /**
10: * Sets the minimum value for the progress dialog.
11: */
12: public void setMinimumValue(int minimum);
13:
14: /**
15: * Gets the minimum value for the progress dialog.
16: */
17: public int getMinimumValue();
18:
19: /**
20: * Sets the maximum value for the progress dialog.
21: */
22: public void setMaximumValue(int maximum);
23:
24: /**
25: * Gets the maximum value for the progress dialog.
26: */
27: public int getMaximumValue();
28:
29: /**
30: * Sets the current value for the progress dialog.
31: */
32: public void setValue(int value);
33:
34: /**
35: * Gets the current value for the progress dialog.
36: */
37: public int getValue();
38:
39: /**
40: * Gets the title for the progress dialog.
41: */
42: public String getTitle();
43:
44: /**
45: * Gets the display message for the progress dialog.
46: */
47: public String getMessage();
48:
49: /**
50: * Cancels the current action.
51: */
52: public void cancelAction();
53:
54: /**
55: * Adds a cancel action listener.
56: */
57: public void addCancelListener(ProgressDialogListener listener);
58:
59: /**
60: * Returns whether or not this action has been cancelled.
61: */
62: public boolean isCancelled();
63:
64: /**
65: * Shows the dialog.
66: */
67: public void show();
68:
69: /**
70: * Disposed of the dialog.
71: */
72: public void dispose();
73:
74: }
|