org.openide.loaders
Interface TemplateWizard.Iterator

All Superinterfaces:

Serializable, WizardDescriptor.Iterator

Enclosing class:

TemplateWizard

public static interface TemplateWizard.Iterator

extends WizardDescriptor.Iterator, Serializable

The interface for custom iterator. Enhances to WizardDescriptor.Iterator by serialization and ability to instantiate the object.

All Panels provided by this iterator will receive a TemplateWizard as settings object and they are encourage to store its data by the use of putProperty method.

Method Summary

void	initialize(TemplateWizard wiz) Initializes the Iterator after it is constructed.
Set	instantiate(TemplateWizard wiz) Instantiates the template using informations provided by the wizard.
void	uninitialize(TemplateWizard wiz) Informs the Iterator that the TemplateWizard finished using the Iterator.

Methods inherited from interface org.openide.WizardDescriptor.Iterator

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

Method Detail

instantiate

public Set instantiate(TemplateWizard wiz)
                throws IOException

Instantiates the template using informations provided by the wizard.

Parameters:

wiz - the wizard

Returns:

set of data objects that has been created (should contain at least one

Throws:

IOException - if the instantiation fails

IllegalStateException - if the file name supplied by the wizard is not valid.

initialize

public void initialize(TemplateWizard wiz)

Initializes the Iterator after it is constructed.

Parameters:

wiz - instance of TemplateWizard that wishes to use the Iterator. The Iterator can for example obtain target Chooser from the Wizard if it does not provide its own.

uninitialize

public void uninitialize(TemplateWizard wiz)

Informs the Iterator that the TemplateWizard finished using the Iterator. The main purpose of this method is to perform cleanup tasks that should not be left on the garbage collector / default cleanup mechanisms.