TemplateWizard.Iterator (Datasystems API)

Skip navigation links

org.openide.loaders 7.63.1

All Classes

SEARCH:

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

All Superinterfaces:

org.openide.nodes.Node.Cookie, java.io.Serializable, org.openide.WizardDescriptor.Iterator<org.openide.WizardDescriptor>

Enclosing class:

TemplateWizard
```
public static interface TemplateWizard.Iterator
extends org.openide.WizardDescriptor.Iterator<org.openide.WizardDescriptor>, java.io.Serializable, org.openide.nodes.Node.Cookie
```
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 the settings object and they are encourage to store its data by the use of putProperty method and read it using getProperty.
Implements Node.Cookie since version 2.13

See Also:

TemplateRegistration

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`initialize(TemplateWizard wiz)`	Initializes the iterator after it is constructed.
`java.util.Set<DataObject>`	`instantiate(TemplateWizard wiz)`	Instantiates the template using information 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
```
java.util.Set<DataObject> instantiate(TemplateWizard wiz)
                               throws java.io.IOException
```
    Instantiates the template using information provided by the wizard. If instantiation fails then wizard remains open to enable correct values.
    
    Parameters:
    
    wiz - the wizard
    
    Returns:
    
    set of data objects that have been created (should contain at least one)
    
    Throws:
    
    java.io.IOException - if the instantiation fails
  - initialize
```
void initialize(TemplateWizard wiz)
```
    Initializes the iterator after it is constructed. The iterator can for example obtain the target chooser from the wizard if it does not wish to provide its own.
    
    Parameters:
    
    wiz - template wizard that wishes to use the iterator
  - uninitialize
```
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.
    
    Parameters:
    
    wiz - wizard which is no longer being used

Skip navigation links

org.openide.loaders 7.63.1

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Built on April 24 2018. | Portions Copyright 1997-2018 Oracle. All rights reserved.