View Source

抽象类

org.joget.plugin.base.ExtDefaultPlugin

在wflow-plugin-base模块下
扩展org.joget.plugin.base.DefaultPlugin
实现了org.joget.plugin.base.Plugin和org.osgi.framework.BundleActivator
一个基本的抽象类，必须由每个插件扩展

方法详细

抽象方法

getName

public java.lang.String getName（）

为插件返回唯一的名称。您可以通过提供与系统插件相同的名称覆盖现有的系统插件。

getVersion

public java.lang.String getVersion（）

返回插件版本。

getDescription

public java.lang.String getDescription（）

返回插件说明。当getI18nDescription（）方法找不到资源包消息密钥“ plugin.className .pluginDesc” 时，将使用此值。

可覆盖的方法

getI18nLabel

public java.lang.String getI18nLabel（）

根据语言设置返回插件的插件标签。它将自动查找资源包消息密钥“ plugin.className .pluginLabel”。如果没有找到资源密钥，如果插件也实现了org.joget.plugin.property.model.PropertyEditable接口，则将使用 org.joget.plugin.property.model.PropertyEditable.getLabel（）。否则，使用getName（）方法的值。OSGI插件需要覆盖此方法才能提供国际化标签。

getI18nDescription

public java.lang.String getI18nDescription（）

根据语言设置返回插件的插件描述。它将自动查找资源包消息密钥“ plugin.className .pluginDesc”。如果找不到资源密钥，则使用org.joget.plugin.base.Plugin.getDescription（）的值。OSGI插件需要覆盖此方法才能提供国际化描述。

实用方法

getProperties

public java.util.Map <java.lang.String，java.lang.Object> getProperties（）

获取插件属性。

setProperties方法

public void setProperties（java.util.Map <java.lang.String，java.lang.Object> properties）

设置插件属性。

getProperty

public java.lang.Object getProperty（java.lang.String property）

通过属性键获取插件属性值。

setProperty

public void setProperty（java.lang.String property，java.lang.Object value）

设置一个插件属性。

getPropertyString

public java.lang.String getPropertyString（java.lang.String property）

通过属性键获取插件属性值，并返回java.lang.String。不存在的键将返回一个空字符串而不是NULL值。

start

public void start（org.osgi.framework.BundleContext context）

Felix OSGI框架使用的方法来注册插件。

stop

public void stop（org.osgi.framework.BundleContext context）

Felix OSGI框架用于注销插件的方法。

已弃用的方法

getPluginProperties

public org.joget.plugin.base.PluginProperty [] getPluginProperties（）

返回一组由admin用户配置的插件属性。

已弃用自版本3以来，Joget Workflow为插件配置引入了更好的UI。一个插件应该实现 org.joget.plugin.property.model.PropertyEditable 接口来提供插件配置选项。

execute

public java.lang.Object execute（java.util.Map properties）

执行插件

已弃用 此方法仅由Process Tool插件使用，因此已将其移至 org.joget.plugin.base.DefaultApplicationPlugin

接口

org.joget.plugin.property.model.PropertyEditable

在wflow-plugin-base模块下
一个插件必须实现的接口，以提供管理界面来配置插件

方法详细

界面方法

getLabel

public java.lang.String getLabel（）

返回插件标签。当资源束消息密钥“该值将被用于plugin.className .pluginlabel”,没有被使用 getI18nLabel（） 方法。

getClassName

public java.lang.String getClassName（）

返回插件类的名称。

getPropertyOptions

public java.lang.String getPropertyOptions（）

以JSON格式返回插件属性选项。请参阅插件属性选项。