Interface WizardDescriptor.ProgressInstantiatingIterator<Data>

Type Parameters:

Data - in practice this should be WizardDescriptor

All Superinterfaces:

WizardDescriptor.AsynchronousInstantiatingIterator<Data>, WizardDescriptor.InstantiatingIterator<Data>, WizardDescriptor.Iterator<Data>

Enclosing class:

WizardDescriptor

public static interface WizardDescriptor.ProgressInstantiatingIterator<Data>
extends WizardDescriptor.AsynchronousInstantiatingIterator<Data>

Iterator for a wizard that wants to notify users while instantiate is running by a progress bar. The method instantiate is called outside ATW queue. (This interface can replace TemplateWizard.Iterator in a template's declaration.)

Since:

org.openide.dialogs 7.1

Method Summary

Modifier and Type	Method	Description
Set	instantiate(org.netbeans.api.progress.ProgressHandle handle)	Is called in separate thread when the Finish button are clicked and allows implement asynchronous instantating of newly created objects.

Methods inherited from interface org.openide.WizardDescriptor.AsynchronousInstantiatingIterator

instantiate

Methods inherited from interface org.openide.WizardDescriptor.InstantiatingIterator

initialize, uninitialize

Methods inherited from interface org.openide.WizardDescriptor.Iterator

addChangeListener, current, hasNext, hasPrevious, name, nextPanel, previousPanel, removeChangeListener

Method Details

instantiate

Set instantiate(org.netbeans.api.progress.ProgressHandle handle)
         throws IOException

Is called in separate thread when the Finish button are clicked and allows implement asynchronous instantating of newly created objects. While instantiating users are notified by progress bar in wizard's panel. Notfication will be visualized by a progress bar. Note: The ProgressHandle is not started, need to start it and report progress by messages in the progress() method.

Parameters:

handle - progress bar handle

Returns:

a set of objects created (the exact type is at the discretion of the caller)

Throws:

IOException - when instantiate fails