TemplateWizard (Datasystems API)

java.lang.Object
- org.openide.NotifyDescriptor
- - org.openide.DialogDescriptor
  - - org.openide.WizardDescriptor
    - - org.openide.loaders.TemplateWizard

```
public class TemplateWizard
extends org.openide.WizardDescriptor
```
Wizard for creation of new objects from a template.

See Also:

TemplateRegistration

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface TemplateWizard.Iterator
The interface for custom iterator.
- Nested classes/interfaces inherited from class org.openide.NotifyDescriptor
  org.openide.NotifyDescriptor.Confirmation, org.openide.NotifyDescriptor.Exception, org.openide.NotifyDescriptor.InputLine, org.openide.NotifyDescriptor.Message
- Nested classes/interfaces inherited from class org.openide.WizardDescriptor
  org.openide.WizardDescriptor.ArrayIterator<Data extends java.lang.Object>, org.openide.WizardDescriptor.AsynchronousInstantiatingIterator<Data extends java.lang.Object>, org.openide.WizardDescriptor.AsynchronousValidatingPanel<Data extends java.lang.Object>, org.openide.WizardDescriptor.BackgroundInstantiatingIterator<Data extends java.lang.Object>, org.openide.WizardDescriptor.ExtendedAsynchronousValidatingPanel<Data extends java.lang.Object>, org.openide.WizardDescriptor.FinishablePanel<Data extends java.lang.Object>, org.openide.WizardDescriptor.FinishPanel<Data extends java.lang.Object>, org.openide.WizardDescriptor.InstantiatingIterator<Data extends java.lang.Object>, org.openide.WizardDescriptor.Panel<Data extends java.lang.Object>, org.openide.WizardDescriptor.ProgressInstantiatingIterator<Data extends java.lang.Object>, org.openide.WizardDescriptor.ValidatingPanel<Data extends java.lang.Object>

Nested Classes
Modifier and Type	Class	Description
`static interface`	`TemplateWizard.Iterator`	The interface for custom iterator.

Field Summary
- Fields inherited from class org.openide.DialogDescriptor
  BOTTOM_ALIGN, DEFAULT_ALIGN, PROP_BUTTON_LISTENER, PROP_CLOSING_OPTIONS, PROP_HELP_CTX, PROP_LEAF, PROP_MODAL, PROP_OPTIONS_ALIGN, RIGHT_ALIGN
- Fields inherited from class org.openide.NotifyDescriptor
  CANCEL_OPTION, CLOSED_OPTION, DEFAULT_OPTION, ERROR_MESSAGE, INFORMATION_MESSAGE, NO_OPTION, OK_CANCEL_OPTION, OK_OPTION, PLAIN_MESSAGE, PROP_DETAIL, PROP_ERROR_NOTIFICATION, PROP_INFO_NOTIFICATION, PROP_MESSAGE, PROP_MESSAGE_TYPE, PROP_NO_DEFAULT_CLOSE, PROP_OPTION_TYPE, PROP_OPTIONS, PROP_TITLE, PROP_VALID, PROP_VALUE, PROP_WARNING_NOTIFICATION, QUESTION_MESSAGE, WARNING_MESSAGE, YES_NO_CANCEL_OPTION, YES_NO_OPTION, YES_OPTION
- Fields inherited from class org.openide.WizardDescriptor
  FINISH_OPTION, NEXT_OPTION, PREVIOUS_OPTION, PROP_AUTO_WIZARD_STYLE, PROP_CONTENT_BACK_COLOR, PROP_CONTENT_DATA, PROP_CONTENT_DISPLAYED, PROP_CONTENT_FOREGROUND_COLOR, PROP_CONTENT_NUMBERED, PROP_CONTENT_SELECTED_INDEX, PROP_ERROR_MESSAGE, PROP_HELP_DISPLAYED, PROP_HELP_URL, PROP_IMAGE, PROP_IMAGE_ALIGNMENT, PROP_INFO_MESSAGE, PROP_LEFT_DIMENSION, PROP_WARNING_MESSAGE

Constructor Summary

Constructors
Modifier	Constructor	Description
	`TemplateWizard()`	Creates new TemplateWizard
`protected`	`TemplateWizard(TemplateWizard.Iterator it)`	Constructor for wizards that require the target chooser or template chooser panel.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`protected TemplateWizard.Iterator`	`createDefaultIterator()`	Allows subclasses to provide their own default iterator the one that will be used if not special iterator is associated with selected template.
`protected org.openide.WizardDescriptor.Panel<org.openide.WizardDescriptor>`	`createTargetChooser()`	Method that allows subclasses to second (default) panel.
`protected org.openide.WizardDescriptor.Panel<org.openide.WizardDescriptor>`	`createTemplateChooser()`	Method that allows subclasses to provide their own panel for choosing the template (the first panel).
`static java.net.URL`	`getDescription(DataObject obj)`	Method to get a description for a data object.
`static java.lang.String`	`getDescriptionAsResource(DataObject obj)`	Deprecated. Use `getDescription(org.openide.loaders.DataObject)` instead.
`static TemplateWizard.Iterator`	`getIterator(DataObject obj)`	Finds a custom iterator attached to a template that should be used to instantiate the object.
`DataFolder`	`getTargetFolder()`	Getter for target folder.
`java.lang.String`	`getTargetName()`	Getter for the name of the target template.
`DataObject`	`getTemplate()`	Getter for template to create object from.
`DataFolder`	`getTemplatesFolder()`	Getter for the folder with templates.
`java.text.MessageFormat`	`getTitleFormat()`	Overridden to be able to set a default value for the title format.
`protected java.util.Set<DataObject>`	`handleInstantiate()`	Calls iterator's instantiate.
`protected void`	`initialize()`	Initializes important settings.
`java.util.Set<DataObject>`	`instantiate()`	Chooses the template and instantiates it.
`java.util.Set<DataObject>`	`instantiate(DataObject template)`	Chooses the template and instantiates it.
`java.util.Set<DataObject>`	`instantiate(DataObject template, DataFolder targetFolder)`	Chooses the template and instantiates it.
`static void`	`setDescription(DataObject obj, java.net.URL url)`	Method to attach a description to a data object.
`static void`	`setDescriptionAsResource(DataObject obj, java.lang.String rsrc)`	Deprecated. Use `setDescription(org.openide.loaders.DataObject, java.net.URL)` instead.
`static void`	`setIterator(DataObject obj, TemplateWizard.Iterator iter)`	Deprecated. since 2.13 you should provide the iterator from `getCookie` method
`void`	`setTargetFolder(DataFolder f)`	Sets the target folder.
`void`	`setTargetName(java.lang.String name)`	Setter for the name of the template.
`void`	`setTemplate(DataObject obj)`	Sets the template.
`void`	`setTemplatesFolder(DataFolder folder)`	Setter for the folder with templates.
`void`	`setTitleFormat(java.text.MessageFormat format)`	Overridden to be able to set own default value for the title format.
`org.openide.WizardDescriptor.Panel<org.openide.WizardDescriptor>`	`targetChooser()`	Returns wizard panel that that is used to choose target folder and name of the template.
`org.openide.WizardDescriptor.Panel<org.openide.WizardDescriptor>`	`templateChooser()`	Returns wizard panel that is used to choose a template.
`protected void`	`updateState()`	Overriden to add/remove listener to/from displayed component.

Methods inherited from class org.openide.DialogDescriptor
getButtonListener, getClosingOptions, getHelpCtx, getOptionsAlign, isLeaf, isModal, setButtonListener, setLeaf, setModal, setOptionsAlign

Methods inherited from class org.openide.NotifyDescriptor
addPropertyChangeListener, createNotificationLineSupport, firePropertyChange, getAdditionalOptions, getDefaultValue, getMessage, getMessageType, getNotificationLineSupport, getOptions, getOptionType, getTitle, getTitleForType, isNoDefaultClose, isValid, removePropertyChangeListener, setMessage, setMessageType, setNoDefaultClose, setOptionType, setTitle, setValid

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from class org.openide.WizardDescriptor
doCancelClick, doFinishClick, doNextClick, doPreviousClick, getInstantiatedObjects, getProperties, getProperty, getValue, putProperty, setAdditionalOptions, setClosingOptions, setHelpCtx, setOptions, setPanels, setPanelsAndSettings, setValue

- Constructor Detail
  - TemplateWizard
```
public TemplateWizard()
```
    Creates new TemplateWizard
  - TemplateWizard
```
protected TemplateWizard(TemplateWizard.Iterator it)
```
    Constructor for wizards that require the target chooser or template chooser panel.
    
    Parameters:
    
    it - panel iterator instance
- Method Detail
  - initialize
```
protected void initialize()
```
    Initializes important settings.
    
    Overrides:
    
    initialize in class org.openide.WizardDescriptor
  - getTemplate
```
public DataObject getTemplate()
```
    Getter for template to create object from.
    
    Returns:
    
    template
  - setTemplate
```
public void setTemplate(DataObject obj)
```
    Sets the template. If under the Templates/ directory it will be selected by the dialog.
    
    Parameters:
    
    obj - the template to start with
  - setTemplatesFolder
```
public void setTemplatesFolder(DataFolder folder)
```
    Setter for the folder with templates. If not specified the Templates/ folder is used.
    
    Parameters:
    
    folder - the root folder for all templates if null the default folder is used
  - getTemplatesFolder
```
public DataFolder getTemplatesFolder()
```
    Getter for the folder with templates.
    
    Returns:
    
    the folder with templates that should be used as root
  - getTargetFolder
```
public DataFolder getTargetFolder()
                           throws java.io.IOException
```
    Getter for target folder.
    
    Returns:
    
    the target folder
    
    Throws:
    
    java.io.IOException - if the target folder has not been set
  - setTargetFolder
```
public void setTargetFolder(DataFolder f)
```
    Sets the target folder.
    
    Parameters:
    
    f - the folder
  - getTargetName
```
public java.lang.String getTargetName()
```
    Getter for the name of the target template.
    
    Returns:
    
    the name or null if not yet set
  - setTargetName
```
public void setTargetName(java.lang.String name)
```
    Setter for the name of the template.
    
    Parameters:
    
    name - name for the new object, or null
  - templateChooser
```
public org.openide.WizardDescriptor.Panel<org.openide.WizardDescriptor> templateChooser()
```
    Returns wizard panel that is used to choose a template.
    
    Returns:
    
    wizard panel
  - targetChooser
```
public org.openide.WizardDescriptor.Panel<org.openide.WizardDescriptor> targetChooser()
```
    Returns wizard panel that that is used to choose target folder and name of the template.
    
    Returns:
    
    wizard panel
  - createTemplateChooser
```
protected org.openide.WizardDescriptor.Panel<org.openide.WizardDescriptor> createTemplateChooser()
```
    Method that allows subclasses to provide their own panel for choosing the template (the first panel).
    
    Returns:
    
    the panel
  - createTargetChooser
```
protected org.openide.WizardDescriptor.Panel<org.openide.WizardDescriptor> createTargetChooser()
```
    Method that allows subclasses to second (default) panel.
    
    Returns:
    
    the panel
  - createDefaultIterator
```
protected TemplateWizard.Iterator createDefaultIterator()
```
    Allows subclasses to provide their own default iterator the one that will be used if not special iterator is associated with selected template.
    This implementation creates iterator that just shows the targetChooser panel.
    
    Returns:
    
    the iterator to use as default one
  - instantiate
```
public java.util.Set<DataObject> instantiate()
                                      throws java.io.IOException
```
    Chooses the template and instantiates it.
    Beware that this blocks while the wizard is running; and if a WizardDescriptor.BackgroundInstantiatingIterator might be selected, should not be called from the AWT event queue.
    
    Returns:
    
    set of instantiated data objects (DataObject) or null if user canceled the dialog
    
    Throws:
    
    java.io.IOException - I/O error
  - instantiate
```
public java.util.Set<DataObject> instantiate(DataObject template)
                                      throws java.io.IOException
```
    Chooses the template and instantiates it. See instantiate() regarding threading behavior.
    
    Parameters:
    
    template - predefined template that should be instantiated
    
    Returns:
    
    set of instantiated data objects (DataObject) or null if user canceled the dialog
    
    Throws:
    
    java.io.IOException - I/O error
  - instantiate
```
public java.util.Set<DataObject> instantiate(DataObject template,
                                             DataFolder targetFolder)
                                      throws java.io.IOException
```
    Chooses the template and instantiates it. See instantiate() regarding threading behavior.
    
    Parameters:
    
    template - predefined template that should be instantiated
    
    targetFolder - the target folder
    
    Returns:
    
    set of instantiated data objects (DataObject) or null if user canceled the dialog
    
    Throws:
    
    java.io.IOException - I/O error
  - setTitleFormat
```
public void setTitleFormat(java.text.MessageFormat format)
```
    Overridden to be able to set own default value for the title format.
    
    Overrides:
    
    setTitleFormat in class org.openide.WizardDescriptor
    
    Parameters:
    
    format - message format
  - getTitleFormat
```
public java.text.MessageFormat getTitleFormat()
```
    Overridden to be able to set a default value for the title format.
    
    Overrides:
    
    getTitleFormat in class org.openide.WizardDescriptor
    
    Returns:
    
    message format in title
  - handleInstantiate
```
protected java.util.Set<DataObject> handleInstantiate()
                                               throws java.io.IOException
```
    Calls iterator's instantiate. It is called when user selects a option which is not CANCEL_OPTION or CLOSED_OPTION.
    
    Returns:
    
    set of data objects that have been created (should contain at least one)
    
    Throws:
    
    java.io.IOException - if the instantiation fails
  - setDescription
```
public static void setDescription(DataObject obj,
                                  java.net.URL url)
                           throws java.io.IOException
```
    Method to attach a description to a data object. It is suggested that the URL use the nbresloc protocol.
    
    Parameters:
    
    obj - data object to attach description to
    
    url - the url with description or null if there should be no description
    
    Throws:
    
    java.io.IOException - if I/O fails
  - getDescription
```
public static java.net.URL getDescription(DataObject obj)
```
    Method to get a description for a data object.
    
    Parameters:
    
    obj - data object to attach description to
    
    Returns:
    
    the url with description or null
  - setDescriptionAsResource
```
@Deprecated
public static void setDescriptionAsResource(DataObject obj,
                                            java.lang.String rsrc)
                                     throws java.io.IOException
```
    Deprecated. Use setDescription(org.openide.loaders.DataObject, java.net.URL) instead.
    
    Set a description for a data object by resource path rather than raw URL.
    
    Parameters:
    
    obj - data object to set description for
    
    rsrc - a resource string, e.g. "com/foo/MyPage.html", or null to clear
    
    Throws:
    
    java.io.IOException - if the attribute cannot be set
  - getDescriptionAsResource
```
@Deprecated
public static java.lang.String getDescriptionAsResource(DataObject obj)
```
    Deprecated. Use getDescription(org.openide.loaders.DataObject) instead.
    
    Get a description as a resource.
    
    Parameters:
    
    obj - the data object
    
    Returns:
    
    the resource path, or null if unset (incl. if only set as a raw URL)
  - setIterator
```
@Deprecated
public static void setIterator(DataObject obj,
                               TemplateWizard.Iterator iter)
                        throws java.io.IOException
```
    Deprecated. since 2.13 you should provide the iterator from getCookie method
    
    Allows to attach a special Iterator to a template. This allows templates to completelly control the way they are instantiated.
    Better way for providing an Iterator is to return it from the dataobject.getCookie (TemplateWizard.Iterator.class) call.
    
    Parameters:
    
    obj - data object
    
    iter - TemplateWizard.Iterator to use for instantiation of this data object, or null to clear
    
    Throws:
    
    java.io.IOException - if I/O fails
  - getIterator
```
public static TemplateWizard.Iterator getIterator(DataObject obj)
```
    Finds a custom iterator attached to a template that should be used to instantiate the object. First of all it checks whether there is an iterator attached by setIterator method, if not it asks the data object for the Iterator as cookie.
    
    Parameters:
    
    obj - the data object
    
    Returns:
    
    custom iterator or null
  - updateState
```
protected void updateState()
```
    Overriden to add/remove listener to/from displayed component. Also make recreation of steps and content.
    
    Overrides:
    
    updateState in class org.openide.WizardDescriptor

Class TemplateWizard

Nested Class Summary

Nested classes/interfaces inherited from class org.openide.NotifyDescriptor

Nested classes/interfaces inherited from class org.openide.WizardDescriptor

Field Summary

Fields inherited from class org.openide.DialogDescriptor

Fields inherited from class org.openide.NotifyDescriptor

Fields inherited from class org.openide.WizardDescriptor

Constructor Summary

Method Summary

Methods inherited from class org.openide.DialogDescriptor

Methods inherited from class org.openide.NotifyDescriptor

Methods inherited from class java.lang.Object

Methods inherited from class org.openide.WizardDescriptor

Constructor Detail

TemplateWizard

TemplateWizard

Method Detail

initialize

getTemplate

setTemplate

setTemplatesFolder

getTemplatesFolder

getTargetFolder

setTargetFolder

getTargetName

setTargetName

templateChooser

targetChooser

createTemplateChooser

createTargetChooser

createDefaultIterator

instantiate

instantiate

instantiate

setTitleFormat

getTitleFormat

handleInstantiate

setDescription

getDescription

setDescriptionAsResource

getDescriptionAsResource

setIterator

getIterator

updateState