Element Detail

• folder

  java.lang.String folder

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

• position

  int position

  Optional position within folder().

  Default:

  2147483647

• id

  java.lang.String id

  Special file basename to use rather than inferring one from the declaring element, when content() is empty. Useful for pure templates referenced from PrivilegedTemplates.

  Default:

  ""

• content

  java.lang.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 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"}

  Default:

  {}

• displayName

  java.lang.String displayName

  Localized label for the template. Mandatory unless content() is specified, in which case it would be defaulted by the data node. May use the usual #key syntax.

  Default:

  ""

• iconBase

  java.lang.String iconBase

  Icon to use for the template. Should be an absolute resource path (no initial slash). Mandatory unless content() is specified, in which case it would be defaulted by the data node.

  Default:

  ""

• description

  java.lang.String description

  Optional but recommended relative resource path to an HTML description of the template.

  Default:

  ""

• scriptEngine

  java.lang.String scriptEngine

  Optional name of a script engine to use when processing file content, such as freemarker.

  See Also:

  ScriptEngineFactory.getNames()

  Default:

  ""

• category

  java.lang.String[] category

  Optional list of categories interpreted by the project system.

  Default:

  {}

• requireProject

  boolean requireProject

  Set to false if the template can be instantiated without a project.

  Default:

  true

• targetName

  java.lang.String targetName

  Default (pre-filled) target name for the template, without extension. May use the usual #key syntax for localization or branding.

  Default:

  ""

• page

  java.lang.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 wizards in NetBeans wiki.

  Returns:

  location to a resource with HTML page

  Since:

  1.2

  Default:

  ""

• techIds

  java.lang.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:

  list of preferred technology ids

  Since:

  1.4

  Default:

  {}