public class WaitingDialog extends JDialog implements WaitingHandler
JDialog.AccessibleJDialog
Dialog.AccessibleAWTDialog, Dialog.ModalExclusionType, Dialog.ModalityType
Window.AccessibleAWTWindow, Window.Type
Container.AccessibleAWTContainer
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy
accessibleContext, rootPane, rootPaneCheckingEnabled
DEFAULT_MODALITY_TYPE
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
SIMPLE_DATA_FORMAT, TAB_HTML, TAB_NON_HTML
DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
Constructor and Description |
---|
WaitingDialog(Frame waitingHandlerParent,
Image normalIcon,
Image waitingIcon,
boolean shakeWhenFinished,
ArrayList<String> tips,
String processName,
String toolName,
String toolVersion,
boolean modal)
Creates a new WaitingDialog.
|
WaitingDialog(Frame waitingHandlerParent,
Image normalIcon,
Image waitingIcon,
boolean shakeWhenFinished,
String processName,
String toolName,
String toolVersion,
boolean modal)
Creates a new WaitingDialog.
|
Modifier and Type | Method and Description |
---|---|
void |
addWaitingActionListener(WaitingActionListener waitingActionListener)
Adds a waiting action listener.
|
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 tabs to the report.
|
void |
closeWhenComplete(boolean close)
Set if the dialog is to be closed when the process is complete.
|
boolean |
getDisplayProgress()
Returns if the waiting handler is to show the progress for the current
process or not.
|
String |
getLastSelectedFolder()
Returns the last selected folder.
|
int |
getMaxPrimaryProgressCounter()
Returns the max primary progress counter.
|
int |
getMaxSecondaryProgressCounter()
Returns the max secondary progress counter.
|
int |
getPrimaryProgressCounter()
Returns the primary progress counter.
|
String |
getReport(File aFile)
Returns the report.
|
JProgressBar |
getSecondaryProgressBar()
Returns the secondary progress bar for updates from external processes.
|
int |
getSecondaryProgressCounter()
Returns the secondary progress counter.
|
void |
increasePrimaryProgressCounter()
Increase the progress bar value by one "counter".
|
void |
increasePrimaryProgressCounter(int amount)
Increase the progress bar value by the given amount.
|
void |
increaseSecondaryProgressCounter()
Increase the secondary progress bar value by one "counter".
|
void |
increaseSecondaryProgressCounter(int amount)
Increase the secondary progress bar value by the given amount.
|
boolean |
isReport()
Indicates whether this waiting handler supports reports.
|
boolean |
isRunCanceled()
Returns true if the run is canceled.
|
boolean |
isRunFinished()
Returns true if the process is finished.
|
void |
resetPrimaryProgressCounter()
Reset the primary progress bar value to 0.
|
void |
resetSecondaryProgressCounter()
Reset the secondary progress bar value to 0.
|
void |
setCloseDialogWhenImportCompletes(boolean closeWhenComplete,
boolean enabled)
Set if the value for if the dialog is to be closed when completed and if
the option is enabled or not.
|
void |
setDisplayProgress(boolean displayProgress)
Set if the waiting handler is to show the progress for the current
process or not.
|
void |
setLastSelectedFolder(String lastSelectedFolder)
Sets the last selected folder.
|
void |
setMaxPrimaryProgressCounter(int maxProgressValue)
Set the maximum value of the progress bar.
|
void |
setMaxSecondaryProgressCounter(int maxProgressValue)
Set the maximum value of the secondary progress bar.
|
void |
setPrimaryProgressCounter(int value)
Sets the primary progress bar to the given value.
|
void |
setPrimaryProgressCounterIndeterminate(boolean indeterminate)
Sets whether the primary progress counter is indeterminate or not.
|
void |
setRunCanceled()
Set the process as canceled.
|
void |
setRunFinished()
Set the process as finished.
|
void |
setRunNotFinished()
Set the run to not finished.
|
void |
setSecondaryProgressCounter(int value)
Sets the secondary progress bar to the given value.
|
void |
setSecondaryProgressCounterIndeterminate(boolean indeterminate)
Sets the secondary progress bar to indeterminate or not.
|
void |
setSecondaryProgressText(String text)
Set the secondary progress counter text.
|
void |
setVisible(boolean b) |
void |
setWaitingText(String text)
Sets the text describing what is currently being waited for.
|
void |
startShake()
Make the dialog shake when the process has completed.
|
addImpl, createRootPane, dialogInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update
addNotify, getModalityType, getTitle, hide, isModal, isResizable, isUndecorated, setBackground, setModal, setModalityType, setOpacity, setResizable, setShape, setTitle, setUndecorated, show, toBack
addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeNotify, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImage, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, toFront
add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusDownCycle, validate, validateTree
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
public WaitingDialog(Frame waitingHandlerParent, Image normalIcon, Image waitingIcon, boolean shakeWhenFinished, String processName, String toolName, String toolVersion, boolean modal)
waitingHandlerParent
- a reference to the handler parentwaitingIcon
- the dialog/frame icon to use when waitingnormalIcon
- the dialog/frame icon to use when doneshakeWhenFinished
- shake when completed, mainly a PeptideShaker
featureprocessName
- the name of the process we are waiting for, e.g.,
'Import Data' or 'Search'toolName
- the name of the tool, need for the reporttoolVersion
- the version number of the tool, needed for the reportmodal
- if the dialog is to be modal or notpublic WaitingDialog(Frame waitingHandlerParent, Image normalIcon, Image waitingIcon, boolean shakeWhenFinished, ArrayList<String> tips, String processName, String toolName, String toolVersion, boolean modal)
waitingHandlerParent
- a reference to the handler parentwaitingIcon
- the dialog/frame icon to use when waitingnormalIcon
- the dialog/frame icon to use when doneshakeWhenFinished
- shake when completed, mainly a PeptideShaker
featureprocessName
- the name of the process we are waiting formodal
- if the dialog is to be modal or nottoolName
- the name of the tool, need for the reporttoolVersion
- the version number of the tool, needed for the reporttips
- the list of Tip of the daypublic void closeWhenComplete(boolean close)
close
- if the dialog is to be closed when the process is completepublic void setPrimaryProgressCounter(int value)
setPrimaryProgressCounter
in interface WaitingHandler
value
- the progress valuepublic void setMaxPrimaryProgressCounter(int maxProgressValue)
setMaxPrimaryProgressCounter
in interface WaitingHandler
maxProgressValue
- the max valuepublic void increasePrimaryProgressCounter()
increasePrimaryProgressCounter
in interface WaitingHandler
public void increasePrimaryProgressCounter(int amount)
increasePrimaryProgressCounter
in interface WaitingHandler
amount
- the amount to increase the value bypublic void setMaxSecondaryProgressCounter(int maxProgressValue)
setMaxSecondaryProgressCounter
in interface WaitingHandler
maxProgressValue
- the max valuepublic void resetSecondaryProgressCounter()
resetSecondaryProgressCounter
in interface WaitingHandler
public void resetPrimaryProgressCounter()
resetPrimaryProgressCounter
in interface WaitingHandler
public void increaseSecondaryProgressCounter()
increaseSecondaryProgressCounter
in interface WaitingHandler
public void setSecondaryProgressCounter(int value)
setSecondaryProgressCounter
in interface WaitingHandler
value
- the progress valuepublic void increaseSecondaryProgressCounter(int amount)
increaseSecondaryProgressCounter
in interface WaitingHandler
amount
- the amount to increase the value bypublic void setSecondaryProgressCounterIndeterminate(boolean indeterminate)
setSecondaryProgressCounterIndeterminate
in interface WaitingHandler
indeterminate
- if true, set to indeterminatepublic String getLastSelectedFolder()
public void setLastSelectedFolder(String lastSelectedFolder)
lastSelectedFolder
- the last selected folder as stringpublic void setRunFinished()
setRunFinished
in interface WaitingHandler
public void setRunCanceled()
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()
appendReportNewLineNoDate
in interface WaitingHandler
public void appendReportEndLine()
appendReportEndLine
in interface WaitingHandler
public boolean isRunCanceled()
isRunCanceled
in interface WaitingHandler
public void startShake()
public JProgressBar getSecondaryProgressBar()
public void setWaitingText(String text)
WaitingHandler
setWaitingText
in interface WaitingHandler
text
- a text describing what is currently waited forpublic boolean isRunFinished()
WaitingHandler
isRunFinished
in interface WaitingHandler
public String getReport(File aFile)
aFile
- The file to send the report to. Note that only the name is
used her and included in the report, the report is not sent to the
file. Can be null.public void setPrimaryProgressCounterIndeterminate(boolean indeterminate)
WaitingHandler
setPrimaryProgressCounterIndeterminate
in interface WaitingHandler
indeterminate
- a boolean indicating whether the primary progress
counter is indeterminate or notpublic void setCloseDialogWhenImportCompletes(boolean closeWhenComplete, boolean enabled)
closeWhenComplete
- if true, the dialog closes when completedenabled
- enable or disable the check boxpublic void setRunNotFinished()
public boolean isReport()
WaitingHandler
isReport
in interface WaitingHandler
public void addWaitingActionListener(WaitingActionListener waitingActionListener)
waitingActionListener
- the waiting action listenerpublic void setSecondaryProgressText(String text)
WaitingHandler
setSecondaryProgressText
in interface WaitingHandler
text
- the text to setpublic int getPrimaryProgressCounter()
WaitingHandler
getPrimaryProgressCounter
in interface WaitingHandler
public int getMaxPrimaryProgressCounter()
WaitingHandler
getMaxPrimaryProgressCounter
in interface WaitingHandler
public int getSecondaryProgressCounter()
WaitingHandler
getSecondaryProgressCounter
in interface WaitingHandler
public int getMaxSecondaryProgressCounter()
WaitingHandler
getMaxSecondaryProgressCounter
in interface WaitingHandler
public void setVisible(boolean b)
setVisible
in class Dialog
public void setDisplayProgress(boolean displayProgress)
WaitingHandler
setDisplayProgress
in interface WaitingHandler
displayProgress
- if the waiting handler is to show the progress for
the current process or notpublic boolean getDisplayProgress()
WaitingHandler
getDisplayProgress
in interface WaitingHandler
Copyright © 2016. All rights reserved.