sos.wizard
Class ProgressPageEditor

java.lang.Object
  |
  +--sos.wizard.AbstractPageEditor
        |
        +--sos.wizard.ProgressPageEditor

All Implemented Interfaces:

PageEditor

public class ProgressPageEditor

extends AbstractPageEditor

An editor of a ProgressPage. This editor runs the progress page's task in a background thread and displays a progress bar indicating the task's progress. If the task is interruptible, it also displays a Stop button to allow the user to cancel the task. If the user attempts to stop the task, this editor gives subclasses a chance to decline the interuption by invoking confirmStop.

Since:

1.0

Constructor Summary

ProgressPageEditor()
Creates a new instance of ProgressPageEditor

Method Summary

protected boolean	confirmStop() Returns true if the execution of the task should be interrupted.
java.awt.Component	getEditorComponent(javax.swing.JComponent c, Page page) Starts editing the specified component's page and returns the component that will do the rendering.

Methods inherited from class sos.wizard.AbstractPageEditor

cancelEditing, stopEditing, validatePage

Methods inherited from class java.lang.Object

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

Constructor Detail

ProgressPageEditor

public ProgressPageEditor()

Creates a new instance of ProgressPageEditor

Method Detail

confirmStop

protected boolean confirmStop()

Returns true if the execution of the task should be interrupted. This implementation always returns true. Subclasses may wish to override this default behavior and require, for example, the user to accept a confirmation dialog.

Returns:

true if the execution of the task should be interrupted

getEditorComponent

public java.awt.Component getEditorComponent(javax.swing.JComponent c,
                                             Page page)

Description copied from interface: PageEditor

Starts editing the specified component's page and returns the component that will do the rendering.

Parameters:

c - component containing page

page - page to be edited

Returns:

the component that will do the rendering