Versions Compared

Old Version 2

changes.mady.by.user Aadrian Zarin

Saved on

compared with

New Version Current

changes.mady.by.user PT

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

Introduction

English

The Popup Select Box is an enhancement of the ordinary SelectBox. Instead of selecting from a generic drop-down list, the Popup Select Box allows you to select from a Datalist instead.

The

...

Popup Select Box is only available

...

on Professional and

...

Enterprise  Edition.

Info
titleTips

If you have thousands of selections to choose from, Popup Select Box is an ideal form element to use as you will be choosing from listing with pagination and search filter, improving loading speed and user experience.

Get Started

The easiest way to see how the Popup Select Box works are to use the existing built-in App Expenses Claims. Here are the steps:

...

  1. Start the Joget Server and open the 

...

  1. App Center.

  2. Log in as admin and click on the pencil icon on the 

...

  1. Expenses Claim

...

  1. to

...

  1.  open the 

...

  1. Design App. (see Figure 1)

    Image Added
    Figure 1

  2. Click on the 

...

  1. Create New Form 

...

  1. button and fill up the Form Details as follows (see Figure 2):
    1. Form ID: popupSelectBox
    2. Form Name: 

...

    1. Popup Select Box
    2. Table Name: j_expense_claim

    Image Added
    Figure 2

  2. Drag and drop a 

...

  1. Popup Select

...

  1. Box element

...

  1.  on to the canvas.

  2. Hover

...

  1. the mouse over the Popup Select Box

...

  1. element on the canvas and click on Edit to open up the Edit Popup Select Box properties.

...


  2. Fill up the Edit Popup Select Box  properties as follows and click on 

...

  1. OK :
    1. ID: appeal_claim
    2. Label: Select Existing Claim
    3. Datalist:

...

    1. Expense All
    2. Display Field:

...

    1. title
  2. Click on the Save button on the Form Builder (see Figure 3). 

    Image Added
    Figure 3

  3. Now we will need some data in order to display some values within the Popup SelectBox, head back to Design App and click the Launch button next to the Expenses Claims App.

  4. Click on Create a New Expense Claim button, fill up the necessary details and click on Continue Next Screen button (See Figure 4)

    Image Added
    Figure 4

  5. Fill up the necessary details and click on the Complete button.

  6. Head back to the  Popup Select Box in the Form Builder. 

  7. Click on Preview and click on the Select button to display the popup Datalist. Select one or more records and click on Select Button. The selected record title be displayed (see Figure 5).

...


  1.  Image Added
    Figure

...

Image Removed

Figure 2

Image Removed

Figure 3

Image Removed

Figure 4

Image Removed

...

  1. 5

Popup Select Box Properties

Edit Popup Select Box

Image Added

Screen (Click to view)Image Removed
NameDescription
ID

Element ID (By declaring as "appeal_claim", a corresponding database table column "c_appeal_claim" 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.
Data ListData List to display for selection.
Display FieldField ID from the target Data List for eventually selected option label.

Advanced Options

Data

Image Added

NameDescription
Default Value

Default Value when there's no existing value found/selected.

Hash A hash variable is accepted here. For example, you may key the following

Code Block
#currentUser.firstName# #currentUser.lastName#

to pre-populate the field with current currently logged in user's name.

You may define multiple default options by separating them using semicolons.

Code Block
titleSample
option1;option2;option3
ID Field

Target Data List's column ID value to be saved as the option value.

Default: id

Multiple Selection

Toggle Multiple Selection.

URL Request Parameters for Datalist

Refine the target Data List selections by defining the filter criteria here.

NameDescription
ParameterTarget Data List filter parameter name
Field IDCurrent form element field ID
Default ValueDefault Value for the search parameter
Validator

Attach a Validator plugin to validate the input value.

Info
titleWhen will validation takes place?

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

UI

Image Added

NameDescription
Readonly

Determines if the element is editable.

Display field as Label when readonly?

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

Select Button LabelSelect Button Label
Popup Dialog Height

Height in character

Code Block
titleSample
500px
Popup Dialog Width

Width in character

Code Block
titleSample
90%

Workflow

Image Added

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.

Info
titleUsing 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.

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

UI

...

Button to clear all selected options in Popup Select Box
  1. Add a custom HTML element into the form.
  2. Paste the following code below. Remember to change field_id to the Popup Select Box Element ID.
 Code Block
languagexml
<button type="button" onclick="clearAll()">Clear All</button>

<script>
function clearAll(){
	FormUtil.getField("field_id").parents(".form-cell").find(".selector_remove").each(function(i, obj) {
		$('.selector_remove')[0].click();
	});
}
</script>