org.netbeans.spi.project.ui.templates.support

Class Templates

java.lang.Object

org.netbeans.spi.project.ui.templates.support.Templates

public class Templates
extends Object

Default implementations of template UI.

For methods which take a WizardDescriptor parameter, use the wizard as passed to WizardDescriptor.InstantiatingIterator.initialize(org.openide.WizardDescriptor) or TemplateWizard.Iterator.initialize(org.openide.loaders.TemplateWizard).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Templates.SimpleTargetChooserBuilder A builder for simple target choosers.

Method Summary

Modifier and Type	Method and Description
static Templates.SimpleTargetChooserBuilder	buildSimpleTargetChooser(Project project, SourceGroup[] folders) Builder for simple target choosers.
static WizardDescriptor.Panel<WizardDescriptor>	createSimpleTargetChooser(Project project, SourceGroup[] folders) Deprecated. Use Templates.buildSimpleTargetChooser(org.netbeans.api.project.Project, org.netbeans.api.project.SourceGroup[]) instead.
static WizardDescriptor.Panel<WizardDescriptor>	createSimpleTargetChooser(Project project, SourceGroup[] folders, WizardDescriptor.Panel<WizardDescriptor> bottomPanel) Deprecated. Use Templates.buildSimpleTargetChooser(org.netbeans.api.project.Project, org.netbeans.api.project.SourceGroup[]) instead.
static boolean	getDefinesMainProject(WizardDescriptor wizardDescriptor) Checks whether a project wizard will set the main project.
static FileObject	getExistingSourcesFolder(WizardDescriptor wizardDescriptor) Find the existing sources folder selected for a custom template wizard iterator.
static Project	getProject(WizardDescriptor wizardDescriptor) Find the project selected for a custom template wizard iterator.
static FileObject	getTargetFolder(WizardDescriptor wizardDescriptor) Find the target folder selected for a custom template wizard iterator.
static String	getTargetName(WizardDescriptor wizardDescriptor) Method to communicate current choice of target name to a custom WizardDescriptor.InstantiatingIterator associated with particular template.
static FileObject	getTemplate(WizardDescriptor wizardDescriptor) Find the template with which a custom template wizard iterator is associated.
static void	setDefinesMainProject(WizardDescriptor wizardDescriptor, boolean definesMainProject) Deprecated. Projects should not be set as main by default.
static void	setTargetFolder(WizardDescriptor wizardDescriptor, FileObject folder) Stores a target folder so that it can be remembered later using Templates.getTargetFolder(org.openide.WizardDescriptor).
static void	setTargetName(WizardDescriptor wizardDescriptor, String targetName) Sets the target name for given WizardDescriptor to be used from custom target choosers

Methods inherited from class java.lang.Object

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

Method Detail

getProject

public static Project getProject(WizardDescriptor wizardDescriptor)

Find the project selected for a custom template wizard iterator.

If the user selects File | New File, this will be the project chosen in the first panel. If the user selects New from CommonProjectActions.newFileAction(), this will be the project on which the context menu was invoked.

Parameters:

wizardDescriptor - a file wizard, not null.

Returns:

the project into which the user has requested this iterator create a file (or null if not set)

getTemplate

public static FileObject getTemplate(WizardDescriptor wizardDescriptor)

Find the template with which a custom template wizard iterator is associated.

If the user selects File | New File, this will be the template chosen in the first panel. If the user selects New from CommonProjectActions.newFileAction(), this will be the template selected from the context submenu.

Parameters:

wizardDescriptor - a file or project wizard

Returns:

the corresponding template marker file (or null if not set)

getTargetFolder

public static FileObject getTargetFolder(WizardDescriptor wizardDescriptor)

Find the target folder selected for a custom template wizard iterator.

If the user selects File | New File this may not be set, unless you have called Templates.setTargetFolder(org.openide.WizardDescriptor, org.openide.filesystems.FileObject) in an earlier panel (such as that created by Templates.createSimpleTargetChooser(Project,SourceGroup[])). It may however have a preselected folder, e.g. if the user invoked New from the context menu of a folder.

Parameters:

wizardDescriptor - a file wizard

Returns:

the folder into which the user has requested this iterator create a file (or null if not set)

getExistingSourcesFolder

public static FileObject getExistingSourcesFolder(WizardDescriptor wizardDescriptor)

Find the existing sources folder selected for a custom template wizard iterator.

This may not be set, unless you have CommonProjectActions.newProjectAction() with CommonProjectActions.EXISTING_SOURCES_FOLDER value.

Parameters:

wizardDescriptor - a project wizard

Returns:

the existing sources folder from which the user has requested this iterator to create a project

Since:

1.3 (17th May 2005)

setTargetFolder

public static void setTargetFolder(WizardDescriptor wizardDescriptor,
                                   FileObject folder)

Stores a target folder so that it can be remembered later using Templates.getTargetFolder(org.openide.WizardDescriptor).

Parameters:

wizardDescriptor - a file wizard

folder - a target folder to remember

getTargetName

public static String getTargetName(WizardDescriptor wizardDescriptor)

Method to communicate current choice of target name to a custom WizardDescriptor.InstantiatingIterator associated with particular template.

Parameters:

wizardDescriptor - a file wizard

Returns:

the selected target name (could be null?)

See Also:

TemplateWizard.getTargetName(), ProjectChooserFactory.WIZARD_KEY_TARGET_NAME

setTargetName

public static void setTargetName(WizardDescriptor wizardDescriptor,
                                 String targetName)

Sets the target name for given WizardDescriptor to be used from custom target choosers

Parameters:

wizardDescriptor - a file wizard

targetName - a desired target name

See Also:

TemplateWizard.setTargetName(java.lang.String), ProjectChooserFactory.WIZARD_KEY_TARGET_NAME

getDefinesMainProject

public static boolean getDefinesMainProject(WizardDescriptor wizardDescriptor)

Checks whether a project wizard will set the main project. (The default is false.)

Parameters:

wizardDescriptor - a project wizard

Returns:

true if it will set a main project

Since:

org.netbeans.modules.projectuiapi/1 1.47

setDefinesMainProject

@Deprecated
public static void setDefinesMainProject(WizardDescriptor wizardDescriptor,
                                                     boolean definesMainProject)

Deprecated. Projects should not be set as main by default.

Specify whether a project wizard will set the main project. If so, and it returns at least one project directory to signal that a project will be created, the first such project will be set as the main project.

Parameters:

wizardDescriptor - a project wizard

definesMainProject - true if it will set a main project

Since:

org.netbeans.modules.projectuiapi/1 1.47

createSimpleTargetChooser

@Deprecated
public static WizardDescriptor.Panel<WizardDescriptor> createSimpleTargetChooser(Project project,
                                                                                             SourceGroup[] folders)

Deprecated. Use Templates.buildSimpleTargetChooser(org.netbeans.api.project.Project, org.netbeans.api.project.SourceGroup[]) instead.

createSimpleTargetChooser

@Deprecated
public static WizardDescriptor.Panel<WizardDescriptor> createSimpleTargetChooser(Project project,
                                                                                             SourceGroup[] folders,
                                                                                             WizardDescriptor.Panel<WizardDescriptor> bottomPanel)

Deprecated. Use Templates.buildSimpleTargetChooser(org.netbeans.api.project.Project, org.netbeans.api.project.SourceGroup[]) instead.

buildSimpleTargetChooser

public static Templates.SimpleTargetChooserBuilder buildSimpleTargetChooser(@NullAllowed
                                                                            Project project,
                                                                            @NonNull
                                                                            SourceGroup[] folders)

Builder for simple target choosers. The chooser is suitable for many kinds of templates. The user is prompted to choose a location for the new file and a name. Instantiation is handled by DataObject.createFromTemplate(org.openide.loaders.DataFolder).

Parameters:

project - The project to work on.

folders - a nonempty list of possible roots to create the new file in, or an empty list if project is null

Returns:

a builder which can be used to customize and then create the target chooser

Since:

org.netbeans.modules.projectuiapi/1 1.45