oracle.javatools.dialogs.progress
Class ProgressChecklist

java.lang.Object
  oracle.javatools.dialogs.progress.ProgressChecklist

public class ProgressChecklist

extends java.lang.Object

The progress check list component provides a check list suitable for use within a progress monitor dialog. It contains a message area and a table of step descriptions with corresponding icons to represent the state of each task in progress.

Constructor Summary

ProgressChecklist(java.lang.Object message, java.lang.String[] stepNames)
Constructor.

Method Summary

void	abortSteps() Aborts all remaining steps for the progress check list.
java.awt.Component	getComponent() Gets the progress check list component.
void	nextStep(boolean stepSuccessful) Shows the current step as having succeeded or failed (updating icons) and increments the step position.
void	reset() Resets the state of the check list in order that it may be re-used.
void	setStatusColumnVisible(boolean visible) Sets the visibility of the column containing status text describing task progress.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProgressChecklist

public ProgressChecklist(java.lang.Object message,
                         java.lang.String[] stepNames)

Constructor.

Parameters:

message - a descriptive message that will be shown to the user (may be null).

stepNames - the displayed step names for the check list.

Method Detail

getComponent

public java.awt.Component getComponent()

Gets the progress check list component.

Returns:

the check list component.

reset

public void reset()

Resets the state of the check list in order that it may be re-used.

nextStep

public void nextStep(boolean stepSuccessful)

Shows the current step as having succeeded or failed (updating icons) and increments the step position.

Parameters:

stepSuccessful - a value indicating whether the step succeeeded.

abortSteps

public void abortSteps()

Aborts all remaining steps for the progress check list.

setStatusColumnVisible

public void setStatusColumnVisible(boolean visible)

Sets the visibility of the column containing status text describing task progress.

Parameters:

visible - the visibility value to set.