|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ProgressComponent
An interface for classes that are capable of displaying progression information to the user
Field Summary | |
---|---|
static int |
CANCELLED
|
static int |
DONE
|
static int |
FAILED
|
Method Summary | |
---|---|
void |
addCancelListener(java.awt.event.ActionListener l)
|
void |
displayError(java.lang.Exception e,
java.lang.String processName)
Asks the component to display an error dialog. |
void |
finishProgression(int result)
Asks the component to indicate that the progression is finished. |
java.awt.Component |
getComponent()
Gets the component responsible for displaying progression, such as a ProgressBar. |
void |
removeCancelListener(java.awt.event.ActionListener l)
|
void |
resetProgression()
Asks the component to reset progression to zero at the beginning of a process. |
void |
setProgression(float p)
Asks the component to update progression amount to the given value. |
void |
setProgressionText(java.lang.String text)
Asks the component to display a custom string describing the current process stage |
void |
showMessage(int type,
java.lang.String text)
Asks the component to display a message related to the process. |
Field Detail |
---|
static final int DONE
static final int FAILED
static final int CANCELLED
Method Detail |
---|
java.awt.Component getComponent()
void resetProgression()
void setProgression(float p)
p
- the new progression amount between 0 and 1void finishProgression(int result)
void setProgressionText(java.lang.String text)
text
- text to display in the progression componentvoid showMessage(int type, java.lang.String text)
type
- what type of message it is. Values are those
from JOptionPane : INFORMATION_MESSAGE, WARNING_MESSAGE
PLAIN_MESSAGE or ERROR_MESSAGEtext
- the message text to outputvoid displayError(java.lang.Exception e, java.lang.String processName)
e
- an Exception
describing the error
which occuredprocessName
- the name of the process in which the error
occured. this is usually used as a dialog's title stringvoid addCancelListener(java.awt.event.ActionListener l)
void removeCancelListener(java.awt.event.ActionListener l)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |