Interface IPluginFormResourceDescriptor

All Known Implementing Classes:
DefaultPluginFormResourceDescriptor
public interface IPluginFormResourceDescriptor
Describes a resource that a form resources plugin wishes to provide for web forms. This is the value returned by form resources plugin.
Since:
8.3.0
Author:
XIMA MEDIA GmbH

  • Method Details

    • getFileName

      String getFileName()
      Gets the name of the file, including the file extension (if any), e.g. "style.css". File names are case-sensitive. The file name may also contain slashes, e.g. "images/logo.png". These indicate (virtual) sub folders. The HTTP endpoint, for example, uses these sub folders in the URL, which affects the resolution of relative paths.

      The file name must be unique among all resources provided by the plugin. Different plugins may provide resources with the same file name.

      Returns:
      The name of the file, including the file extension.

    • getMimeType

      String getMimeType()
      Gets the mime type of the resource, e.g. "text/css" for CSS files.
      Returns:
      The mime type of the resource.

    • getResource

      IResourceDescriptor getResource()
      Gets the accessor for the resources binary content.
      Returns:
      The accessor for the resources binary content.

    • isIncludeInForm

      boolean isIncludeInForm()
      Whether to include the resource automatically in all forms. If false, the resource is still available via the HTTP endpoint, but must be included manually. If true, the resource will be included in all rendered web forms.

      Note: Currently, this feature is supported only for CSS and JavaScript files, i.e. resource whose getMimeType() is "text/css" or "text/javascript".

      Returns:
      Whether to include the resource automatically in all forms.

    • isIncludeInTemplate

      default boolean isIncludeInTemplate()
      Whether to include the resource automatically in all HTML templates. If false, the resource is still available via the HTTP endpoint, but must be referenced manually. If true, the resource will be included in all rendered HTML templates.

      Note: Currently, this feature is supported only for CSS and JavaScript files, i.e. resource whose getMimeType() is "text/css" or "text/javascript".

      Returns:
      Whether to include the resource automatically in all forms.
      Since:
      8.3.7