public abstract class AbstractDescribableScriptPlugin extends java.lang.Object implements Describable
ScriptPluginProvider
's metadata:
title = Title of the Plugin description = Description of the plugin
config.X.PROPERTY_TYPE = Type name of the property, fromProperty.Type
config.X.name = Name of the property (key string) config.X.title = Title of the property config.X.description = description of the property config.X.required = true/false, if the property is required. config.X.default = default string of the property config.X.values = comma-separated values list for Select or FreeSelect properties config.X.scope = scope of the property, fromPropertyScope
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CONFIG_DEFAULT |
static java.lang.String |
CONFIG_DESCRIPTION |
static java.lang.String |
CONFIG_NAME |
static java.lang.String |
CONFIG_PROP_PREFIX |
static java.lang.String |
CONFIG_REQUIRED |
static java.lang.String |
CONFIG_SCOPE |
static java.lang.String |
CONFIG_TITLE |
static java.lang.String |
CONFIG_TYPE |
static java.lang.String |
CONFIG_VALUES |
static java.lang.String |
DESCRIPTION_PROP |
static java.lang.String |
TITLE_PROP |
Constructor and Description |
---|
AbstractDescribableScriptPlugin(ScriptPluginProvider provider,
Framework framework) |
Modifier and Type | Method and Description |
---|---|
protected static void |
createDescription(ScriptPluginProvider provider,
boolean allowCustomProperties,
DescriptionBuilder builder) |
java.util.Map<java.lang.String,java.lang.String> |
createPluginDataContext()
Return data with exported plugin details
|
Description |
getDescription()
Return the configuration description
|
Framework |
getFramework() |
ScriptPluginProvider |
getProvider() |
abstract boolean |
isAllowCustomProperties()
Subclasses return true if the script-plugin allows custom configuration properties defined in plugin metadata.
|
public static final java.lang.String TITLE_PROP
public static final java.lang.String DESCRIPTION_PROP
public static final java.lang.String CONFIG_PROP_PREFIX
public static final java.lang.String CONFIG_TITLE
public static final java.lang.String CONFIG_DESCRIPTION
public static final java.lang.String CONFIG_NAME
public static final java.lang.String CONFIG_TYPE
public static final java.lang.String CONFIG_REQUIRED
public static final java.lang.String CONFIG_DEFAULT
public static final java.lang.String CONFIG_VALUES
public static final java.lang.String CONFIG_SCOPE
public AbstractDescribableScriptPlugin(ScriptPluginProvider provider, Framework framework)
public java.util.Map<java.lang.String,java.lang.String> createPluginDataContext()
protected static void createDescription(ScriptPluginProvider provider, boolean allowCustomProperties, DescriptionBuilder builder) throws ConfigurationException
ConfigurationException
public Description getDescription()
Describable
getDescription
in interface Describable
public abstract boolean isAllowCustomProperties()
public ScriptPluginProvider getProvider()
public Framework getFramework()