Usages
- Custom Builder Plugin is used for extends the builder feature in addition to the default form, list, userview & process builder.
- Custom Builder Plugin let app designer build extra definition which auto handles the load/store/merge/export/import by the platform.
- A useable Custom Builder Plugin must extend org.joget.apps.app.model.CustomBuilderAbstract abstract class.
Abstract Class
org.joget.apps.app.model.CustomBuilderAbstract
- 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 Custom Builder Plugin.
Method Detail
Abstract Methods
getIcon
public String getIcon();
The unique font awesome icon of the builder. Eg. "fas fa-key".
getColor
public String getColor();
The unique color code of the builder. Eg. "#85ea2d".
getObjectName
public String getObjectName();
The unique shortname of the output definition of the builder. Eg. "api", "report", etc.
getObjectLabel
public String getObjectLabel();
The unique label of the output definition of the builder. Eg. "API", "Report", etc.
getIdPrefix
public String getIdPrefix();
The prefix for created output definition ID. Eg. "API-", "rp-", etc.
getResourceBundlePath
public String getResourceBundlePath();
The resource bundle file path. The resource bundle message key can be retrieved in the builder javascript using 'get_cbuilder_msg(String key)'.
getBuilderConfig
public String getBuilderConfig();
The builder configuration in JSON format.
Plugin Properties Options
- Please refer to Plugin Properties Options for more information.
Sample Plugins
- Page Buider