Versions Compared

Key

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

...

Table of Contents

...

Introduction


English

The CheckBox

green
borderWidth1
titleBGColor#ddffcc
borderStylesolid
titleDefinition

Check Box is one of the generic HTML Form input elements.

In the Form Builder, one is able to define the options available to the Select Box via various means, including with the use of Options Binder.

Get Started

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

  1. Start Joget Server and open the App Center.

  2. Log in as admin and click on the pencil icon on the Expenses Claim to open the Design App. (see Figure 1)

...


  1. Image Added
    Figure 1

...



  1. Click on Expense Claim New and you will be directed to the Form Builder.

  2. Drag and drop a CheckBox element on to the canvas.

  3. Hover the mouse over the CheckBox element on the canvas and click on Edit to open up the Edit CheckBox properties.

  4. Fill up the Edit CheckBox properties as follows and click on OK (see Figure 2):
    1. ID: type
    2. Label: Type
    3. Options Hardcoded: 

      ValueLabel
      LocalLocal
      InternationalInternational

    Image Added
    Figure 2

  5. Click on Preview to see that it works.

CheckBox Properties

Edit CheckBox

Image Added

...

Image Removed

Figure 2: Check Box Properties

NameDescription
ID

Element ID (By declaring as "type", a corresponding database table column "c_type" 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 end-user.
Options (Hardcoded)

Select Box options

Info

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

Or Choose Options BinderOptions to be populated dynamically using Options Binder plugin.

Image Removed

...


Advanced Options

Data

Image Added

NameDescription
Default Value

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

A Hash

variable

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


Dependency

Image Added

NameDescription
Field ID to control available options based on Grouping

Dynamically change the available options based on the "grouping" attribute defined in the options by matching

to

the current value of the element ID defined.


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


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