Package ro.sync.exml.plugin

Class PluginDescriptor.PluginExtensionDescription

java.lang.Object
ro.sync.exml.plugin.PluginDescriptor.PluginExtensionDescription
Enclosing class:
PluginDescriptor
public static class PluginDescriptor.PluginExtensionDescription extends Object
Contains a plugin description + plugin type + keyboard shortcuts

  • Field Details

    • pluginExtension

      public final PluginExtension pluginExtension
      The plugin extension

    • pluginType

      public final String pluginType
      The plugin type

    • name

      public final String name
      Name of plugin action

    • shortcut

      public final String shortcut
      The plugin shortcut

    • folders

      public final List<File> folders
      The folder paths provided by the plugin descriptor.

    • cssFile

      public final String cssFile
      The CSS file specified by an extension.

    • resourcesHref

      public final String resourcesHref
      The href at which the resources from the static folder will be accessed.

    • resourcesFolderPath

      public final String resourcesFolderPath
      The path of the static resources folder relative to the plugin base dir.

    • resourcesContentSecurityPolicy

      public final String resourcesContentSecurityPolicy
      The csp policy to use for the resources.

    • role

      public final String role
      The role of this extension. If the role is "config" this extension should have a class attribute with the class representing the class of a PluginConfigExtension which manages the configuration of a WebApp plugin.

    • aditionaFrameworkDir

      public final String aditionaFrameworkDir
      The directory of the framework contributed by the plugin.

  • Constructor Details

    • PluginExtensionDescription

      public PluginExtensionDescription(String pluginType, PluginExtension pluginExtension, String actionName, String shortcut, String cssFile, List<File> folders, String resourcesHref, String resourcesFolderPath, String resourcesContentSecurityPolicy, String role, String additionalFrameworkDir)
      Constructor.
      Parameters:
      pluginType - The plugin type
      pluginExtension - The plugin extension
      actionName - Name of plugin action if any.
      shortcut - The plugin shortcut
      cssFile - The CSS file specified by an AuthorCSS extension.
      folders - The folder paths provided by the plugin descriptor.
      resourcesHref - The Href at which to request the plugin's static resources.
      resourcesFolderPath - The path to the static resources folder relative to the plugin base directory.
      resourcesContentSecurityPolicy - The csp policy to use for the resource.
      role - The role of this extension
      additionalFrameworkDir - Additional framework directory referenced by the plugin.

  • Method Details

    • getResourcesHref

      public String getResourcesHref()
      Getter for the resource href.
      Returns:
      the resource href.

    • getPluginExtension

      public PluginExtension getPluginExtension()
      Returns:
      The plugin extension instance.