org.agentgui.gui.swing.dialogs

Class ProgressMonitor

java.lang.Object

org.agentgui.gui.swing.dialogs.ProgressMonitor

All Implemented Interfaces:

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

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

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

Field Summary

Fields inherited from interface org.eclipse.core.runtime.IProgressMonitor

UNKNOWN

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	beginTask(java.lang.String name, int totalWork)
void	dispose() Dispose the progress monitor.
void	done()
void	internalWorked(double work)
boolean	isCanceled() Checks if this dialog was canceled.
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	setCanceled(boolean value)
void	setHeaderText(java.lang.String headerText) Sets the header text.
void	setOwner(java.awt.Window ownerWindow) Allows to set the owner window of JDialog, if used.
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	setTaskName(java.lang.String name)
void	setVisible(boolean visible) Sets the progress dialog visible.
void	setWindowTitle(java.lang.String windowTitle) Sets the window title.
void	subTask(java.lang.String name)
void	validate() Validate the progress monitor.
void	worked(int work)

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.Window ownerWindow)

Description copied from interface: AwbProgressMonitor

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

Specified by:

setOwner in interface AwbProgressMonitor

Parameters:

ownerWindow - the new owner

setVisible

public void setVisible(boolean visible)

Sets the progress dialog visible.

Specified by:

setVisible in interface AwbProgressMonitor

Parameters:

visible - the new visible

isVisible

public boolean isVisible()

Checks if is visible.

Specified by:

isVisible in interface AwbProgressMonitor

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.

Specified by:

dispose in interface AwbProgressMonitor

setWindowTitle

public void setWindowTitle(java.lang.String windowTitle)

Sets the window title.

Specified by:

setWindowTitle in interface AwbProgressMonitor

Parameters:

windowTitle - the new window title

setHeaderText

public void setHeaderText(java.lang.String headerText)

Sets the header text.

Specified by:

setHeaderText in interface AwbProgressMonitor

Parameters:

headerText - the new header text

setProgressText

public void setProgressText(java.lang.String progressText)

Sets the progress text.

Specified by:

setProgressText in interface AwbProgressMonitor

Parameters:

progressText - the new progress text

setProgress

public void setProgress(int progress)

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

Specified by:

setProgress in interface AwbProgressMonitor

Parameters:

progress - the new progress in percent

setAllow2Cancel

public void setAllow2Cancel(boolean allow2Cancel)

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

Specified by:

setAllow2Cancel in interface AwbProgressMonitor

Parameters:

allow2Cancel - the new allow to cancel

isCanceled

public boolean isCanceled()

Checks if this dialog was canceled.

Specified by:

isCanceled in interface AwbProgressMonitor

Specified by:

isCanceled in interface IProgressMonitor

Returns:

true, if is canceled

actionPerformed

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

Specified by:

actionPerformed in interface java.awt.event.ActionListener

beginTask

public void beginTask(java.lang.String name,
                      int totalWork)

Specified by:

beginTask in interface IProgressMonitor

done

public void done()

Specified by:

done in interface IProgressMonitor

setCanceled

public void setCanceled(boolean value)

Specified by:

setCanceled in interface IProgressMonitor

setTaskName

public void setTaskName(java.lang.String name)

Specified by:

setTaskName in interface IProgressMonitor

subTask

public void subTask(java.lang.String name)

Specified by:

subTask in interface IProgressMonitor

worked

public void worked(int work)

Specified by:

worked in interface IProgressMonitor

internalWorked

public void internalWorked(double work)

Specified by:

internalWorked in interface IProgressMonitor