Knowledge Base for DX 7 : Form Validator Plugin

• Usages
• Abstract Class
  • org.joget.apps.form.model.FormValidator
    • Method Detail
      • Abstract Methods
        • validate
      • Overridable Methods
        • getElementDecoration
        • getElementDecoration
      • Utility Methods
        • getElement
        • setElement
  • org.joget.apps.form.model.FormMultiRowValidator
    • Method Detail
      • Abstract Methods
        • validate
      • Overridable Methods
        • getElementDecoration
        • getElementDecoration
      • Utility Methods
        • getElement
        • setElement
• Plugin Properties Options
• Tutorials
• Related Community Plugins

Usages

• Used to extend ways to validate submitted data of an element.

• A useable Form Validator plugin must extends either org.joget.apps.form.model.FormValidator or org.joget.apps.form.model.FormMultiRowValidator abstract class.

Abstract Class

org.joget.apps.form.model.FormValidator

• 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.

• Base class for implementations to validate values for an element.

Method Detail

Abstract Methods

validate

public abstract boolean validate(org.joget.apps.form.model.Element element, org.joget.apps.form.model.FormData data, java.lang.String[] values)

Validate the submitted values for an element.

Overridable Methods

getElementDecoration

public java.lang.String getElementDecoration()

Return the HTML decoration for the attached element, e.g. marking a required field.

getElementDecoration

public java.lang.String getElementDecoration(org.joget.apps.form.model.Element element, org.joget.apps.form.model.FormData formData)

Return the HTML decoration for the attached element, e.g. marking a required field.

Utility Methods

getElement

public org.joget.apps.form.model.Element getElement()

Gets Element that this validator is tied to.

setElement

public void setElement(org.joget.apps.form.model.Element element)

Sets Element that this validator is tied to.

org.joget.apps.form.model.FormMultiRowValidator

• 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.

• Base class for implementations to validate multi row data for an element e.g. Grid.

Method Detail

Abstract Methods

validate

public abstract boolean validate(org.joget.apps.form.model.Element element, org.joget.apps.form.model.FormData data, org.joget.apps.form.model.FormRowSet rows)

Validate the submitted rows for an element.

Overridable Methods

getElementDecoration

public java.lang.String getElementDecoration()

Return the HTML decoration for the attached element, e.g. marking a required field.

getElementDecoration

public java.lang.String getElementDecoration(org.joget.apps.form.model.Element element, org.joget.apps.form.model.FormData formData)

Return the HTML decoration for the attached element, e.g. marking a required field.

Utility Methods

getElement

public org.joget.apps.form.model.Element getElement()

Gets Element that this validator is tied to.

setElement

public void setElement(org.joget.apps.form.model.Element element)

Sets Element that this validator is tied to.

Plugin Properties Options

• Please refer to Plugin Properties Options for more information.

Tutorials

• Guideline for developing a plugin

Related Community Plugins

• Bean Shell Validator
  org.joget.apps.form.lib.BeanShellValidator (wflow-core)
• Bean Shell Multirow Validator
  org.joget.apps.form.lib.BeanShellMultiRowValidator (wflow-core)
• Default Validator
  org.joget.apps.form.lib.DefaultValidator (wflow-core)
• Duplicate Value Validator
  org.joget.apps.form.lib.DuplicateValueValidator (wflow-core)