Introduction

This form element plugin is a text field with added ability to AJAX load options based on matching keywords.

The plugin source codes can be found at JogetOSS Github. Feel free to clone and customize to suit your needs.

Autocomplete Text Field Properties

Edit Autocomplete Text Field

Figure 1: Edit Autocomplete Text Field


NameDescription
ID

Element ID (By declaring as "title", a corresponding database table column "c_title" will be created)

Please see Form Element for more information about defining the ID and list of reserved IDs.

LabelElement Label to be displayed to the end-user.
Field ID to Store Selection ValueKey in a field ID of an existing form element in the form to store the selected option "Value".
Options (Hardcoded)

Select Box options

Options defined here will not be put into use if Options Binder is defined below.

Or Choose Options Binder

Options to be populated dynamically using Options Binder plugin.

Upon selecting an option, the option "Label" will be used in this text field.
To also store the "Value" of your selection, select a field ID for Field ID to Store Selection Value property.

Advanced Options

Data

Figure 2: Edit Autocomplete Text Field > Advanced Options (Data part)


NameDescription
Value

Default Value when there's no existing value found.

A hash variable is accepted here. For example, you may key the following to pre-populate the field with currently logged in user's name.

#currentUser.fullName#
Validator

Attach a Validator plugin to validate the input value, more information at Form Validator.

When will validation takes place?

Validation will take place whenever a form is submitted, except when it is submitted as "Save as Draft".

UI

Figure 3: Edit Autocomplete Text Field > Advanced Options (UI part)


NameDescription
Size (Rows)
Width of the element.
Readonly

Determines if the element is editable.

Display Field as Label When Readonly?

Displays the value of the element as plain text when an element is set to "Readonly".

Workflow

Figure 4: Edit Autocomplete Text Field > Advanced Options (Workflow part)


NameDescription
Workflow Variable

If the form is part of a workflow process, upon saving of the form (by clicking on "Save as Draft" or "Complete" button). The value in this input field will be saved into the corresponding workflow variable named here.

Using a non-existent Workflow Variable name

You will get the following warning with the name printed out (e.g. status) in the server log if you attempt to map to a non-existent Workflow Variable.

context attribute status does not exist in process context - adding new attributes to the process context is not allowed

Download Plugin

https://marketplace.joget.org/jw/web/userview/mp/mpp/_/vad?id=autocomplete-text-field




  • No labels