sos.wizard
Class ProgressPage

java.lang.Object
  |
  +--sos.wizard.AbstractModel
        |
        +--sos.wizard.AbstractPage
              |
              +--sos.wizard.ProgressPage

All Implemented Interfaces:

Model, Page, java.io.Serializable

public class ProgressPage

extends AbstractPage

A page that shows the progress of an underlying task.

A progress page is complete when either the task has finished or the task has been interrupted. The editor is responsible for executing the task and invoking setTaskAborted or setTaskCompleted, as appropriate.

Since:

1.0

See Also:

Task, ProgressPageEditor

Field Summary

Fields inherited from interface sos.wizard.Page

COMPLETE_PROPERTY, NAME_PROPERTY

Constructor Summary

ProgressPage(java.lang.Object name, Task task)
Creates a ProgressPage with the specified name and task.

Method Summary

Task	getTask() Returns the underlying task to be completed.
boolean	isComplete() Returns true if this page is considered complete, or finished.
boolean	isTaskAborted() Returns true if this page has been informed that the task was aborted.
void	setTaskAborted() Informs this page that the task has been aborted.
void	setTaskCompleted() Informs this page that the task has successfully completed.

Methods inherited from class sos.wizard.AbstractPage

getValue, putValue, validate

Methods inherited from class sos.wizard.AbstractModel

addPropertyChangeListener, addPropertyChangeListener, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, removePropertyChangeListener, removePropertyChangeListener

Methods inherited from class java.lang.Object

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

Methods inherited from interface sos.wizard.Model

addPropertyChangeListener, addPropertyChangeListener, removePropertyChangeListener, removePropertyChangeListener

Constructor Detail

ProgressPage

public ProgressPage(java.lang.Object name,
                    Task task)

Creates a ProgressPage with the specified name and task.

Parameters:

name - name of this page

task - task to be completed

Method Detail

getTask

public Task getTask()

Returns the underlying task to be completed.

Returns:

the task to be completed

isComplete

public boolean isComplete()

Description copied from interface: Page

Returns true if this page is considered complete, or finished.

Returns:

true if this page is complete

setTaskCompleted

public void setTaskCompleted()

Informs this page that the task has successfully completed.

See Also:

setTaskAborted()

setTaskAborted

public void setTaskAborted()

Informs this page that the task has been aborted.

See Also:

setTaskCompleted()

isTaskAborted

public boolean isTaskAborted()

Returns true if this page has been informed that the task was aborted.

Returns:

true if this page has been informed that the task was aborted.

See Also:

setTaskAborted()