Generator Plugin

Abstract Class

org.joget.apps.generator.model.GeneratorPlugin

• Under wflow-core module.
• Extended org.joget.plugin.base.ExtDefaultPlugin. Please refer to Plugin Base Abstract Class and Interface.
• Implemented org.joget.plugin.property.model.PropertyEditable. Please refer to Plugin Base Abstract Class and Interface.
• A base abstract class to develop a Generator plugin. 

Abstract Methods

generate

public abstract org.joget.apps.generator.model.GeneratorResult generate()
Execute the generator to generate/scaffolding work for app based on current working form. Please utilize GeneratorUtil in the generation logic.

getExplanation

public abstract java.lang.String getExplanation()
Gets the explanation and usage for this generator to display for admin user.

Overridable Methods

isDisabled

public boolean isDisabled()

Utility Methods

getFormId

public java.lang.String getFormId()
Gets the current working form id.

setFormId

public void setFormId(java.lang.String formId)
Sets the current working form id.

getAppDefinition

public org.joget.apps.app.model.AppDefinition getAppDefinition()
Gets the current working App Definition.

setAppDefinition

public void setAppDefinition(org.joget.apps.app.model.AppDefinition appDef)
Sets the current working App Definition.

getDefaultPropertyValues

public java.lang.String getDefaultPropertyValues()
Convenience method to get default properties from Plugin Properties Options.

Plugin Properties Options

• Please refer to Plugin Properties Options for more information.

Tutorials

• Guideline for Developing a Plugin
• How to develop a Form Submission Statistics Generator (MySQL)

Related Community Plugins

• Not available