Package ro.sync.exml.plugin

Class PluginDescriptor.PluginExtensionDescription

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

    • Field Summary

      Fields 
      Modifier and Type Field Description
      java.lang.String aditionaFrameworkDir
      The directory of the framework contributed by the plugin.
      java.lang.String cssFile
      The CSS file specified by an extension.
      java.util.List<java.io.File> folders
      The folder paths provided by the plugin descriptor.
      java.lang.String name
      Name of plugin action
      PluginExtension pluginExtension
      The plugin extension
      java.lang.String pluginType
      The plugin type
      java.lang.String resourcesFolderPath
      The path of the static resources folder relative to the plugin base dir.
      java.lang.String resourcesHref
      The href at which the resources from the static folder will be accessed.
      java.lang.String role
      The role of this extension.
      java.lang.String shortcut
      The plugin shortcut

    • Constructor Summary

      Constructors 
      Constructor Description
      PluginExtensionDescription​(java.lang.String pluginType, PluginExtension pluginExtension, java.lang.String actionName, java.lang.String shortcut, java.lang.String cssFile, java.util.List<java.io.File> folders, java.lang.String resourcesHref, java.lang.String resourcesFolderPath, java.lang.String role, java.lang.String additionalFrameworkDir)
      Constructor.

    • Field Detail

      • pluginExtension

        public final PluginExtension pluginExtension
        The plugin extension

      • pluginType

        public final java.lang.String pluginType
        The plugin type

      • name

        public final java.lang.String name
        Name of plugin action

      • shortcut

        public final java.lang.String shortcut
        The plugin shortcut

      • folders

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

      • cssFile

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

      • resourcesHref

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

      • resourcesFolderPath

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

      • role

        public final java.lang.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 java.lang.String aditionaFrameworkDir
        The directory of the framework contributed by the plugin.

    • Constructor Detail

      • PluginExtensionDescription

        public PluginExtensionDescription​(java.lang.String pluginType,
                                  PluginExtension pluginExtension,
                                  java.lang.String actionName,
                                  java.lang.String shortcut,
                                  java.lang.String cssFile,
                                  java.util.List<java.io.File> folders,
                                  java.lang.String resourcesHref,
                                  java.lang.String resourcesFolderPath,
                                  java.lang.String role,
                                  java.lang.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.
        role - The role of this extension
        additionalFrameworkDir - Additional framework directory referenced by the plugin.

    • Method Detail

      • getResourcesHref

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

      • getPluginExtension

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