Form template

Modified on Mon, 16 Jan, 2023 at 10:58 PM

Interface IPluginProjectTemplate

Possible uses

Ability to provide form templates. The implementation provided by the interface IPluginProjectTemplate can be selected in FORMCYCLE under the menu item forms > create new > from template

Method signatures

String getTemplateName(Locale locale)

Method for providing a template name that can be localised.

Transfer value:

Locale
- The Locale object set for the currently logged in user (contains language and region information).

Return value:
Name of the template as it is to be displayed in the interface.

String getTemplateDescription(Locale locale)

Method for providing a template description that can be localised.

Transfer value:

Locale
- The Locale object set for the currently logged in user (contains language and region information).

Return value:
Template description

InputStream getTemplateFileStream()

method which returns an InputStream object, on the template provided by the template.

Return value:
Input-Stream object to a zip file, which must have the same internal structure as created by the Form Export.