Field Detail

• FREE_FILE_EXTENSION

  public static final java.lang.String FREE_FILE_EXTENSION

  Parameter to enable free file extension mode. By default, the extension of the newly created file will be inherited from the template. But if FileBuilder.createFromTemplate(org.openide.filesystems.FileObject, org.openide.filesystems.FileObject, java.lang.String, java.util.Map, org.netbeans.api.templates.FileBuilder.Mode) is called with this parameter set to Boolean.TRUE and the file name already seems to include an extension (*.*), the handler should not append any extension from the template.

  Since:

  org.openide.loaders 7.16

  See Also:

  Templates.SimpleTargetChooserBuilder.freeFileExtension, Constant Field Values

• PREFORMATTED_TEMPLATE

  public static final java.lang.String PREFORMATTED_TEMPLATE

  Specifies that no formatting or indentation should be performed on the template. The parameter can be specified as parameter to the template (possibly through layer registration of the template. Value is kept for backwards compatibility, but the attribute does not apply just to java templates.

  It's responsibility of CreateFromTemplateHandler to pay attention to this value.

  See Also:

  Constant Field Values

Method Detail

• getTemplate

  @NonNull
  public org.openide.filesystems.FileObject getTemplate​()

  Returns:

  the template file

• getTarget

  @NonNull
  public org.openide.filesystems.FileObject getTarget​()

  Returns:

  the target folder

• getName

  @CheckForNull
  public java.lang.String getName​()

  Provides the desired name for the created file. null can be returned to indicate the filename should be derived automatically.

  Returns:

  name for the created file

• getProposedName

  @NonNull
  public java.lang.String getProposedName​()

  Provides a name proposed for the file. If the caller specified the name, the value will be the same as getName(). A handler is encouraged to use the proposed name if it does not require a certain naming scheme.

  Returns:

  proposed name for the created file

• getLocale

  @NonNull
  public java.util.Locale getLocale​()

  Provides the desired user locale for creating the template

  Returns:

  locale

• getValue

  @CheckForNull
  public <T> T getValue​(java.lang.String n)

  Provides value for the named key. Values are originally provided by the caller, or the template itself; values can be provided also by CreateFromTemplateAttributes implementors.

  Type Parameters:

  T - value type.

  Parameters:

  n - key name

  Returns:

  named value or null if the key does not exist/has no value.

• getParameters

  @NonNull
  public java.util.Map<java.lang.String,java.lang.Object> getParameters​()

  Provides access to the complete parameter map.

  Returns:

  readonly string-value map.

• hasFreeExtension

  public boolean hasFreeExtension​()

  Specifies whether the extension should be taken from the specified name, or the extension is fixed to the template's one.

  Returns:

  true, if the name contains already the extension.

• isPreformatted

  public boolean isPreformatted​()