de.enflexit.common.swing

Class ProgressMonitor

java.lang.Object

de.enflexit.common.swing.ProgressMonitor

All Implemented Interfaces:

java.awt.event.ActionListener, java.util.EventListener

public class ProgressMonitor
extends java.lang.Object
implements java.awt.event.ActionListener

The Class ProgressMonitor can be used in order to display the progress of a time consuming process as for example a download or other.

Constructor Summary

Constructors

Constructor and Description
ProgressMonitor(java.lang.String windowTitle, java.lang.String headerText, java.lang.String progressText, javax.swing.ImageIcon iconImage, javax.swing.JDesktopPane parentDesktopPane, java.lang.String lookAndFeelClassName) Instantiates a new progress monitor.

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(java.awt.event.ActionEvent ae)
void	dispose() Dispose the progress monitor.
boolean	isCanceled() Checks if this dialog was canceled.
boolean	isSetModal() Checks if the progress monitor should be set modal.
boolean	isVisible() Checks if is visible.
void	repaint() Repaint the progress monitor.
void	setAllow2Cancel(boolean allow2Cancel) Sets the permission to cancel an action via the progress dialog.
void	setHeaderText(java.lang.String headerText) Sets the header text.
void	setModal(boolean isSetModal) Sets the progress monitor modal (or not) if possible (applies if a dialog is used as container for the progress monitor).
void	setOwner(java.awt.Dialog ownerDialog) Allows to set the owner frame of JDialog, if used.
void	setOwner(java.awt.Frame ownerFrame) Allows to set the owner frame of JDialog, if used.
void	setOwner(java.awt.Window owner) Allows to set the owner window .
void	setProgress(int progress) Can be used to set the progress in percent (0 - 100).
void	setProgressText(java.lang.String progressText) Sets the progress text.
void	setVisible(boolean visible) Sets the progress dialog visible.
void	setWindowTitle(java.lang.String windowTitle) Sets the window title.
void	validate() Validate the progress monitor.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ProgressMonitor

public ProgressMonitor(java.lang.String windowTitle,
                       java.lang.String headerText,
                       java.lang.String progressText,
                       javax.swing.ImageIcon iconImage,
                       javax.swing.JDesktopPane parentDesktopPane,
                       java.lang.String lookAndFeelClassName)

Instantiates a new progress monitor. In case that no parent desktop pane is specified, the class will use a JDialog to display the progress. Otherwise a JInternalFrame will be used.

Parameters:

windowTitle - the window title - may be null

headerText - the header text - may be null

progressText - the progress text - may be null

iconImage - the icon image - may be null

parentDesktopPane - the parent desktop pane - may be null

lookAndFeelClassName - the look and feel class reference - may be null

Method Detail

setOwner

public void setOwner(java.awt.Frame ownerFrame)

Allows to set the owner frame of JDialog, if used.

Parameters:

ownerFrame - the new owner

setOwner

public void setOwner(java.awt.Dialog ownerDialog)

Allows to set the owner frame of JDialog, if used.

Parameters:

ownerDialog - the new owner

setOwner

public void setOwner(java.awt.Window owner)

Allows to set the owner window .

Parameters:

owner - the new owner

setModal

public void setModal(boolean isSetModal)

Sets the progress monitor modal (or not) if possible (applies if a dialog is used as container for the progress monitor). Default is false.

Parameters:

isSetModal - the new modal

isSetModal

public boolean isSetModal()

Checks if the progress monitor should be set modal.

Returns:

true, if is sets the modal

setVisible

public void setVisible(boolean visible)

Sets the progress dialog visible.

Parameters:

visible - the new visible

isVisible

public boolean isVisible()

Checks if is visible.

Returns:

true, if is visible

validate

public void validate()

Validate the progress monitor.

repaint

public void repaint()

Repaint the progress monitor.

dispose

public void dispose()

Dispose the progress monitor.

setWindowTitle

public void setWindowTitle(java.lang.String windowTitle)

Sets the window title.

Parameters:

windowTitle - the new window title

setHeaderText

public void setHeaderText(java.lang.String headerText)

Sets the header text.

Parameters:

headerText - the new header text

setProgressText

public void setProgressText(java.lang.String progressText)

Sets the progress text.

Parameters:

progressText - the new progress text

setProgress

public void setProgress(int progress)

Can be used to set the progress in percent (0 - 100).

Parameters:

progress - the new progress in percent

setAllow2Cancel

public void setAllow2Cancel(boolean allow2Cancel)

Sets the permission to cancel an action via the progress dialog.

isCanceled

public boolean isCanceled()

Checks if this dialog was canceled.

Returns:

true, if is canceled

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent ae)

Specified by:

actionPerformed in interface java.awt.event.ActionListener