chemaxon.marvin.util
Interface MProgressMonitor

public interface MProgressMonitor

Progress monitor interface. Supports multiple-level progress monitors.

Since:

Marvin 4.0, 07/12/2005

Version:

4.1, 06/19/2006

Author:

Peter Csizmadia

Method Summary

MProgressMonitor	getChild() Gets the child of this progress monitor.
int	getLevel() Gets the level of this progress monitor.
int	getMaximum() Gets the maximum value.
void	initProgressMonitor(java.lang.String note, int min, int max) Create a progress monitor.
boolean	isCanceled() Tests whether the user canceled the dialog.
boolean	isDialogVisible() Tests whether the dialog is visible.
MProgressMonitor	newInstance() Creates new monitor with same parent, message, levels.
void	setMaximum(int v) Gets the maximum value.
boolean	setProgressValue(int x) Set progress.

Method Detail

initProgressMonitor

void initProgressMonitor(java.lang.String note,
                         int min,
                         int max)

Create a progress monitor.

Parameters:

note - text to appear in the dialog

min - initial progress value

max - final progress value

setProgressValue

boolean setProgressValue(int x)

Set progress.

Parameters:

x - the current progress value

Returns:

true if progressing fine, false if canceled

getMaximum

int getMaximum()

Gets the maximum value.

Returns:

the maximum value

setMaximum

void setMaximum(int v)

Gets the maximum value.

Parameters:

v - the maximum value

isCanceled

boolean isCanceled()

Tests whether the user canceled the dialog.

Returns:

true if the progress dialog is canceled, false otherwise

getChild

MProgressMonitor getChild()

Gets the child of this progress monitor.

Returns:

the child or null

getLevel

int getLevel()

Gets the level of this progress monitor.

Returns:

the level

isDialogVisible

boolean isDialogVisible()

Tests whether the dialog is visible.

Returns:

true if the progress dialog is visible, false otherwise

newInstance

MProgressMonitor newInstance()

Creates new monitor with same parent, message, levels.

Returns:

the new progress monitor