ilog.views.appframe.util

Class IlvProgressMonitor

java.lang.Object

javax.swing.ProgressMonitor

ilog.views.appframe.util.IlvProgressMonitor

All Implemented Interfaces:

Accessible

public class IlvProgressMonitor
extends ProgressMonitor

Defines objects responsible for monitoring the progression of a task within an application. The progress monitor notifies its application of the progression of the task by sending the messages:

• START_PROGRESS_MESSAGE
• NEW_PROGRESS_VALUE_MESSAGE
• END_PROGRESS_MESSAGE

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.ProgressMonitor

ProgressMonitor.AccessibleProgressMonitor

Field Summary

Fields

Modifier and Type	Field and Description
static String	END_PROGRESS_MESSAGE Message sent to the application to notify that a task has ended.
static String	NEW_PROGRESS_VALUE_MESSAGE Message sent to the application to notify a new progression value of the task.
static String	START_PROGRESS_MESSAGE Message sent to the application to notify that a task has started.

Fields inherited from class javax.swing.ProgressMonitor

accessibleContext

Constructor Summary

Constructors

Constructor and Description
IlvProgressMonitor(Action action, IlvApplication application, Object message, String note, int min, int max) Constructs a new progress monitor associated with the processing of the specified action in a separate thread.
IlvProgressMonitor(IlvApplication application, Object message, String note, int min, int max) Constructs a new progress monitor.

Method Summary

Modifier and Type	Method and Description
void	close() Indicates that the task monitored by this object is complete.
IlvApplication	getApplication() Returns the application of the monitor.
String	getMessage() Returns the message describing the task monitored by this object.
String	getName() Returns the name that identifies the task that this monitor is associated with.
void	incrementProgressValue(int value) Increments the progression value to the specified value.
boolean	isCanceled() Returns true if the user clicks the Cancel button in the progress dialog.
boolean	isInProgress() Determines whether the task that this monitor is associated with is in progress.
void	setApplication(IlvApplication application) Sets the application of the monitor.
void	setName(String name) Sets a new name for identifying the task that this monitor is associated with.
void	setProgress(int newValue) Sets a new progression value.

Methods inherited from class javax.swing.ProgressMonitor

getAccessibleContext, getMaximum, getMillisToDecideToPopup, getMillisToPopup, getMinimum, getNote, setMaximum, setMillisToDecideToPopup, setMillisToPopup, setMinimum, setNote

Methods inherited from class java.lang.Object

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

Field Detail

START_PROGRESS_MESSAGE

public static final String START_PROGRESS_MESSAGE

Message sent to the application to notify that a task has started. This message comes with the IlvProgressMonitor associated with the task being started as the parameter.

See Also:

Constant Field Values

NEW_PROGRESS_VALUE_MESSAGE

public static final String NEW_PROGRESS_VALUE_MESSAGE

Message sent to the application to notify a new progression value of the task. This message comes with the IlvProgressMonitor associated with the task as the parameter.

See Also:

Constant Field Values

END_PROGRESS_MESSAGE

public static final String END_PROGRESS_MESSAGE

Message sent to the application to notify that a task has ended. This message comes with the IlvProgressMonitor associated with the task as the parameter.

See Also:

Constant Field Values

Constructor Detail

IlvProgressMonitor

public IlvProgressMonitor(IlvApplication application,
                          Object message,
                          String note,
                          int min,
                          int max)

Constructs a new progress monitor.

Parameters:

application - The application the task in running in.

message - A descriptive message that will be shown to the user to indicate what operation is being monitored. See the constructor of the javax.swing.ProgressMonitor class for more information. It is recommended that this message be a key to a string resource.

note - A short note describing the state of the operation. See the constructor of the javax.swing.ProgressMonitor class for more information. It is recommended that this message be a key to a string resource.

min - The lower bound of the range

max - The upper bound of the range

See Also:

getApplication(), setApplication(ilog.views.appframe.IlvApplication)

IlvProgressMonitor

public IlvProgressMonitor(Action action,
                          IlvApplication application,
                          Object message,
                          String note,
                          int min,
                          int max)

Constructs a new progress monitor associated with the processing of the specified action in a separate thread.

Parameters:

action - The action in the thread. This action must have the property ilog.views.appframe.IlvAction.ACTION_PROCESSED_IN_NEW_THREAD equal to Boolean.TRUE.

application - The application the task is running in.

message - A descriptive message that will be shown to the user to indicate what operation is being monitored. See the constructor of the javax.swing.ProgressMonitor class for more information. It is recommended that this message be a key to a string resource. If null, the Action.LONG_DESCRIPTION property of the specified action will be used.

note - A short note describing the state of the operation. See the constructor of the javax.swing.ProgressMonitor class for more information. It is recommended that this message be a key to a string resource.

min - The lower bound of the range

max - The upper bound of the range

Method Detail

getName

public String getName()

Returns the name that identifies the task that this monitor is associated with.

See Also:

setName(java.lang.String)

setName

public void setName(String name)

Sets a new name for identifying the task that this monitor is associated with.

Parameters:

name - The new identifier name of the task.

See Also:

getName()

getApplication

public IlvApplication getApplication()

Returns the application of the monitor.

See Also:

setApplication(ilog.views.appframe.IlvApplication)

setApplication

public void setApplication(IlvApplication application)

Sets the application of the monitor.

Parameters:

application - The application of the monitor.

See Also:

getApplication()

setProgress

public void setProgress(int newValue)

Sets a new progression value.

Overrides:

setProgress in class ProgressMonitor

Parameters:

newValue - The new current value, between the maximum and minimum specified for this monitor.

See Also:

incrementProgressValue(int)

incrementProgressValue

public void incrementProgressValue(int value)

Increments the progression value to the specified value.

Parameters:

value - The incremental value to add to the current progression value.

See Also:

setProgress(int)

close

public void close()

Indicates that the task monitored by this object is complete. This happens automatically when the value set by setProgress is >= max, but it may be called earlier if the operation ends early.

Overrides:

close in class ProgressMonitor

isInProgress

public boolean isInProgress()

Determines whether the task that this monitor is associated with is in progress.

Returns:

true if the task is in progress; false otherwise.

isCanceled

public boolean isCanceled()

Returns true if the user clicks the Cancel button in the progress dialog.

Overrides:

isCanceled in class ProgressMonitor

getMessage

public String getMessage()

Returns the message describing the task monitored by this object.