TemplateRegistration (File Templates)

```
@Target(value={TYPE,METHOD,PACKAGE})
 @Retention(value=SOURCE)
public @interface TemplateRegistration
```
Registers a template the user can select. May be placed on a class (with a default constructor) or static method (with no arguments) to register an InstantiatingIterator for a custom template; or on a package to register a plain-file template with no custom behavior or define an HTML wizard using the page attribute.

Since:

7.29

See Also:

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

Required Element Summary

Required Elements
Modifier and Type Required Element and Description

String folder
Subfolder in which to place the template, such as Other or Project/Standard.

Required Elements
Modifier and Type	Required Element and Description
`String`	`folder` Subfolder in which to place the template, such as `Other` or `Project/Standard`.

Optional Element Summary

Optional Elements
Modifier and Type	Optional Element and Description
`String[]`	`category` Optional list of categories interpreted by the project system.
`String[]`	`content` File contents, as resources relative to the package of this declaration.
`Class<? extends CreateFromTemplateHandler>`	`createHandlerClass` Specifies the default handler to instantiate the template.
`String`	`description` Optional but recommended relative resource path to an HTML description of the template.
`String`	`displayName` Localized label for the template.
`String`	`iconBase` Icon to use for the template.
`String`	`id` Special file basename to use rather than inferring one from the declaring element, when `TemplateRegistration.content()` is empty.
`String`	`page` Location of the HTML page that should be used as a user interface for the wizard while instantiating this template.
`int`	`position` Optional position within `TemplateRegistration.folder()`.
`boolean`	`requireProject` Set to false if the template can be instantiated without a project.
`String`	`scriptEngine` Optional name of a script engine to use when processing file content, such as `freemarker`.
`String`	`targetName` Default (pre-filled) target name for the template, without extension.
`String[]`	`techIds` Selects some of provided technologies.

- Element Detail
  - folder
```
public abstract String folder
```
    Subfolder in which to place the template, such as Other or Project/Standard.
    
    Returns:
    
    subfolder in which to place the template
- - position
```
public abstract int position
```
    Optional position within TemplateRegistration.folder().
    
    Returns:
    
    integer to position the template among others
    
    Default:
    
    2147483647
- - id
```
public abstract String id
```
    Special file basename to use rather than inferring one from the declaring element, when TemplateRegistration.content() is empty. Useful for pure templates referenced from PrivilegedTemplates.
    
    Returns:
    
    filename to use
    
    Default:
    
    ""
- - content
```
public abstract String[] content
```
    File contents, as resources relative to the package of this declaration. A nonempty list is mandatory for a template registered on a package. For a template with a custom iterator, the content may be omitted, though it may still be specified.
    Normally only a single file is specified, but for a multifile data object, list the primary entry first.
    The file basenames (incl. extension) of the actual template files (as in TemplateWizard.getTemplate()) will be taken from the basename of the content resources, though a .template suffix may be appended to prevent template resources in a source project from being misinterpreted. For a "pure" custom iterator with no specified content, the template basename defaults to the FQN of the class or method defining it but with - for . characters, e.g. pkg-Class-method, but may be overridden with TemplateRegistration.id().
    Example usage for a simple, single-file template (with or without custom iterator):
```
content="resources/empty.php"
```
    For a form template:
```
content={"Login.java.template", "Login.form.template"}
```
    Returns:
    
    references to resources providing content for the template
    
    Default:
    
    {}
- - displayName
```
public abstract String displayName
```
    Localized label for the template. Mandatory unless TemplateRegistration.content() is specified, in which case it would be defaulted by the data node. May use the usual #key syntax.
    
    Returns:
    
    textual description of the template
    
    Default:
    
    ""
- - iconBase
```
public abstract String iconBase
```
    Icon to use for the template. Should be an absolute resource path (no initial slash). Mandatory unless TemplateRegistration.content() is specified, in which case it would be defaulted by the data node.
    
    Returns:
    
    absolute resource path without initial slash
    
    Default:
    
    ""
- - description
```
public abstract String description
```
    Optional but recommended relative resource path to an HTML description of the template.
    
    Returns:
    
    releative resource path to an HTML document
    
    Default:
    
    ""
- - scriptEngine
```
public abstract String scriptEngine
```
    Optional name of a script engine to use when processing file content, such as freemarker.
    
    Returns:
    
    identification of a script engine to use
    
    See Also:
    
    ScriptEngineFactory.getNames()
    
    Default:
    
    ""
- - category
```
public abstract String[] category
```
    Optional list of categories interpreted by the project system.
    
    Returns:
    
    names of categories
    
    Default:
    
    {}
- - requireProject
```
public abstract boolean requireProject
```
    Set to false if the template can be instantiated without a project.
    
    Returns:
    
    true or false
    
    Default:
    
    true
- - targetName
```
public abstract String targetName
```
    Default (pre-filled) target name for the template, without extension. May use the usual #key syntax for localization or branding.
    
    Returns:
    
    name of the object created from the template
    
    Default:
    
    ""
- - page
```
public abstract String page
```
    Location of the HTML page that should be used as a user interface for the wizard while instantiating this template. The page is going to be rendered in an embedded browser provided by other module. To guarantee it is present add following line into your manifest file:
```
 OpenIDE-Module-Needs: org.netbeans.api.templates.wizard
 
```
    There is a tutorial describing usage of HTML UI in NetBeans wizards:
    - when coding logic in JavaScript
    - when coding logic in Java
    - when providing UI for Maven Archetypes
    Creating portable UI for wizards has never been easier!
    Returns:
    
    location to a resource with HTML page
    
    Since:
    
    1.2
    
    Default:
    
    ""
- - techIds
```
public abstract String[] techIds
```
    Selects some of provided technologies. The HTML/Java API provides support for technology ids since version 1.1. With this attribute one can specify the preferred technologies to use in this wizard as well.
    
    Returns:
    
    Strings array of preferred technology ids
    
    Since:
    
    1.4
    
    Default:
    
    {}
- - createHandlerClass
```
public abstract Class<? extends CreateFromTemplateHandler> createHandlerClass
```
    Specifies the default handler to instantiate the template.
    
    Since:
    
    1.23
    
    Default:
    
    org.netbeans.api.templates.CreateFromTemplateHandler.class

Annotation Type TemplateRegistration

Required Element Summary

Optional Element Summary

Element Detail

folder

position

id

content

displayName

iconBase

description

scriptEngine

category

requireProject

targetName

page

techIds

createHandlerClass