|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.awt.Component
java.awt.Container
java.awt.Window
java.awt.Dialog
javax.swing.JDialog
com.compomics.util.gui.waiting.waitinghandlers.ProgressDialogX
public class ProgressDialogX
A dialog for displaying information about progress.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class javax.swing.JDialog |
---|
JDialog.AccessibleJDialog |
Nested classes/interfaces inherited from class java.awt.Dialog |
---|
Dialog.AccessibleAWTDialog, Dialog.ModalExclusionType, Dialog.ModalityType |
Nested classes/interfaces inherited from class java.awt.Window |
---|
Window.AccessibleAWTWindow |
Nested classes/interfaces inherited from class java.awt.Container |
---|
Container.AccessibleAWTContainer |
Nested classes/interfaces inherited from class java.awt.Component |
---|
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy |
Field Summary |
---|
Fields inherited from class javax.swing.JDialog |
---|
accessibleContext, rootPane, rootPaneCheckingEnabled |
Fields inherited from class java.awt.Dialog |
---|
DEFAULT_MODALITY_TYPE |
Fields inherited from class java.awt.Component |
---|
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT |
Fields inherited from interface javax.swing.WindowConstants |
---|
DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE |
Fields inherited from interface java.awt.image.ImageObserver |
---|
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH |
Constructor Summary | |
---|---|
ProgressDialogX(boolean modal)
Opens a new ProgressDialog. |
|
ProgressDialogX(Frame waitingHandlerParent,
Image normalIcon,
Image waitingIcon,
boolean modal)
Opens a new ProgressDialogX with a Frame as a parent. |
|
ProgressDialogX(JDialog waitingHandlerParent,
Frame waitingHandlerParentFrame,
Image normalIcon,
Image waitingIcon,
boolean modal)
Opens a new ProgressDialog with a JDialog as a parent. |
Method Summary | |
---|---|
void |
appendReport(String report,
boolean includeDate,
boolean addNewLine)
Append text to the report. |
void |
appendReportEndLine()
Append a new line to the report. |
void |
appendReportNewLineNoDate()
Append two tabs to the report. |
void |
displayHtmlMessage(JEditorPane messagePane,
String title,
int messageType)
Display a given html containing message to the user separatly from the main output. |
void |
displayMessage(String message,
String title,
int messageType)
Display a given message to the user separatly from the main output. |
void |
doNothingOnClose()
Deprecated. replace by setUnstoppable |
JProgressBar |
getPrimaryProgressBar()
Returns the primary progress bar for updates from external processes. |
JProgressBar |
getProgressBar()
Returns the progress bar for updates from external processes. |
JProgressBar |
getSecondaryProgressBar()
Returns the secondary progress bar for updates from external processes. |
void |
increaseProgressValue()
Increase the progress bar value by one "counter". |
void |
increaseProgressValue(int increment)
Increase the progress bar value by the given amount. |
void |
increaseSecondaryProgressValue()
Increases the progress bar. |
void |
increaseSecondaryProgressValue(int number)
Increases the value of the progress bar. |
void |
incrementValue()
Deprecated. use waiting handler method instead |
void |
incrementValue(int increment)
Deprecated. use waiting handler method instead |
boolean |
isRunCanceled()
Returns true if the run is canceled. |
void |
resetSecondaryProgressBar()
resets the value of the progress bar. |
void |
setIndeterminate(boolean indeterminate)
Makes the dialog indeterminate or not indeterminate. |
void |
setIntermidiate(boolean intermidiate)
Deprecated. Replaced by setIndeterminate, from utilities 3.1.17. |
void |
setMax(int value)
Deprecated. use waiting handler method instead |
void |
setMaxProgressValue(int maxProgressValue)
Set the maximum value of the progress bar. |
void |
setMaxSecondaryProgressValue(int maxProgressValue)
Sets the maximal value of the progress bar. |
void |
setRunCanceled()
Set the analysis as canceled. |
void |
setRunFinished()
Set the analysis as finished. |
void |
setSecondaryProgressDialogIndeterminate(boolean indeterminate)
Makes the dialog indeterminate or not indeterminate. |
void |
setSecondaryProgressValue(int value)
Sets the value of the progress bar. |
void |
setString(String currentFileName)
Sets the string to display in the progrss bar. |
void |
setUnstoppable(boolean unstoppable)
Set this to true of the process the progress bar is used for is not possible to stop, or not possble to stop nicely. |
void |
setValue(int value)
Sets the progress bar value. |
void |
setWaitingText(String text)
Sets the text describing what is currently waited for. |
Methods inherited from class java.awt.Dialog |
---|
addNotify, getModalityType, getTitle, hide, isModal, isResizable, isUndecorated, setModal, setModalityType, setResizable, setTitle, setUndecorated, setVisible, show, toBack |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public ProgressDialogX(Frame waitingHandlerParent, Image normalIcon, Image waitingIcon, boolean modal)
waitingHandlerParent
- waitingIcon
- the frame icon to use when waitingnormalIcon
- the frame icon to use when donemodal
- public ProgressDialogX(JDialog waitingHandlerParent, Frame waitingHandlerParentFrame, Image normalIcon, Image waitingIcon, boolean modal)
waitingHandlerParent
- waitingHandlerParentFrame
- the dialog's parent frame (needed to set
the frame icons)waitingIcon
- the frame icon to use when waitingnormalIcon
- the frame icon to use when donemodal
- public ProgressDialogX(boolean modal)
modal
- Method Detail |
---|
public void setValue(int value)
value
- the progress bar valuepublic void incrementValue()
public void incrementValue(int increment)
increment
- the value to increment bypublic void setMax(int value)
value
- the maximum valuepublic void setIntermidiate(boolean intermidiate)
intermidiate
- setIndeterminate(boolean)
public void setIndeterminate(boolean indeterminate)
indeterminate
- public void setString(String currentFileName)
currentFileName
- public void doNothingOnClose()
public void setUnstoppable(boolean unstoppable)
unstoppable
- public JProgressBar getProgressBar()
public void setMaxProgressValue(int maxProgressValue)
WaitingHandler
setMaxProgressValue
in interface WaitingHandler
maxProgressValue
- the max valuepublic void increaseProgressValue()
WaitingHandler
increaseProgressValue
in interface WaitingHandler
public void increaseProgressValue(int increment)
WaitingHandler
increaseProgressValue
in interface WaitingHandler
increment
- the increment to increase the value bypublic void setMaxSecondaryProgressValue(int maxProgressValue)
setMaxSecondaryProgressValue
in interface WaitingHandler
maxProgressValue
- the maximal progress valuepublic void resetSecondaryProgressBar()
resetSecondaryProgressBar
in interface WaitingHandler
public void increaseSecondaryProgressValue()
increaseSecondaryProgressValue
in interface WaitingHandler
public void setSecondaryProgressValue(int value)
setSecondaryProgressValue
in interface WaitingHandler
value
- the progress valuepublic void increaseSecondaryProgressValue(int number)
increaseSecondaryProgressValue
in interface WaitingHandler
number
- the increment numberpublic void setSecondaryProgressDialogIndeterminate(boolean indeterminate)
setSecondaryProgressDialogIndeterminate
in interface WaitingHandler
indeterminate
- public void setRunFinished()
WaitingHandler
setRunFinished
in interface WaitingHandler
public void setRunCanceled()
WaitingHandler
setRunCanceled
in interface WaitingHandler
public void appendReport(String report, boolean includeDate, boolean addNewLine)
WaitingHandler
appendReport
in interface WaitingHandler
report
- the text to appendincludeDate
- if the date and time is to be added to the front of the textaddNewLine
- add a new line after the text?public void appendReportNewLineNoDate()
WaitingHandler
appendReportNewLineNoDate
in interface WaitingHandler
public void appendReportEndLine()
WaitingHandler
appendReportEndLine
in interface WaitingHandler
public boolean isRunCanceled()
WaitingHandler
isRunCanceled
in interface WaitingHandler
public JProgressBar getSecondaryProgressBar()
WaitingHandler
getSecondaryProgressBar
in interface WaitingHandler
public void displayMessage(String message, String title, int messageType)
WaitingHandler
displayMessage
in interface WaitingHandler
message
- the message to displaytitle
- the title of the messagemessageType
- the message type in the, e.g.,
JOptionPane.INFORMATION_MESSAGEpublic void displayHtmlMessage(JEditorPane messagePane, String title, int messageType)
WaitingHandler
displayHtmlMessage
in interface WaitingHandler
public void setWaitingText(String text)
WaitingHandler
setWaitingText
in interface WaitingHandler
text
- a text describing what is currently waited forpublic JProgressBar getPrimaryProgressBar()
WaitingHandler
getPrimaryProgressBar
in interface WaitingHandler
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |