Page History

Table of Contents

absoluteUrl	true

Usage

Plugin Properties Options allow a plugin to gather configuration data from a plugin user.
Plugin Properties Options should be returned in the abstract method "getPropertyOptions" of each plugin.

Structure

...

用法

插件属性选项允许插件从插件用户收集配置数据。
插件属性选项应该在每个插件的抽象方法“getPropertyOptions”中返回。

结构体

插件属性选项是JSON格式。
插件属性选项是一个属性页面对象的数组
属性页面对象具有称为“title”和“properties”的两个强制属性。它还具有称为“validators”和“buttons”的2个可选属性。

Code Block

language	js

Code Block

language	js
linenumbers	true

[
    {
        title : 'Page Title',
        properties : [
            {
                name : 'Property Name',
                label : 'Property Label',
                description : 'Property Description', //optional, default is NULL
                type : 'Property Type',
                value : 'Property Value', //optional, default is null
                required : 'Mandatory or Not', //optional, 'true' or 'false', default is 'false'
                //… more attributes …
            }, //… more fields …
        ],
        validators : [  //optional
            //… properties custom validators …
        ],
        buttons : [  //optional
            //… custom properties page buttons …
        ]
    }, //… more properties page …
]

...

样品外观和大体感官

...

字段类型

Check Box

type : 'CheckBox'

Refer to Option Field Attributes for extra attributes.
Refer to Dependency Field Attributes for extra attributes to do show/hide this field based on other field value.
- 有关额外的属性，请参阅选项字段属性。
- 请参阅依赖关系字段属性以获取额外的属性，以根据其他字段值显示/隐藏此字段。
- 请参阅检索插件中的属性值 - 多值字段关于如何在插件代码中使用此字段类型的值。
Refer to Retrieve Properties Value in Plugin - Multi Values Field on how to use the value of this field type in the plugin code.

Code Editor

type : 'CodeEditor'
mode : Optional, used for specified highlight mode. Default to 可选，用于指定高亮语言。默认为'text', available values are ，可用值为'text', ，'java', ，'html', ，'javascript', ，'css', ，'json', ，'sql' and 和'xml'.
Refer to Dependency Field Attributes for extra attributes to do show/hide this field based on other field value.
。
请参阅依赖关系字段属性以获取额外的属性，以根据其他字段值显示/隐藏此字段。
请参阅检索插件中的属性值 - 单值字段中关于如何在插件代码中使用此字段类型的值。Refer to Retrieve Properties Value in Plugin - Single Value Field on how to use the value of this field type in the plugin code.

Combine Grid

Combine Grid is used to migrate 2 or more single value property fields from old version plugin (etc Text Field & Select Box) to multi values field in Grid View.
Combine Grid does not support 'value' attribute.
type : 'GridCombine'
Grid 用于将两个或多个单值属性字段从旧版本插件（等待文本字段和选择框）迁移到GridView中的多值字段。
Combine Grid 不支持“value”属性
type : 'GridCombine'

columns : 'column' JSON数组必须有JSON 对象。 {key : 'key', label : 'Columns'} 其中 key ，lable 必填，required 和 options 选填

key :此列的标识符。该值需要与需要从单值字段迁移到多个值字段的字段“name”相同。
label : 列标题的标签
options : 可选，具有“ value”和“label”属性的JSON对象数组。具有'options'属性的列将显示输入字段作为选择框。
required : 可选，'true'或'false'。“row”和“column”的“required”属性设置为“true”值的网格单元是必填字段。

columns : A JSON array of 'column' JSON objects which has 2 mandatory 'key' & 'label' attributes and 2 optional 'required' & 'options' attribute.

key : Identifier of this column. This value need to be same with the field 'name' that need to migrate from single value field to multiple value field.
label : Label of the column header
options : Optional, an array of JSON object with 'value' and 'label' attributes. A column with 'options' attribute will display the input field as select box.
required : Optional, 'true' or 'false'. A grid cell with the 'required' attribute of 'row' and 'column' set to 'true' value is a mandatory field.

Code Block

language	js

columns : [
    {key : 'key', label : 'Columns'}, 
    {key : 'value', label : 'Value', required: 'true'},
    {key : 'label', label : 'Label', required: 'true'},
    {key : 'width', label : 'Width', options:[
        {value : '10%', label : '10%'},
        {value : '20%', label : '20%'},
        {value : '30%', label : '20%'},
        {value : '40%', label : '20%'}
    ]}
]

Refer to Dependency Field Attributes for extra attributes to do show/hide this field based on other field value.
参阅依赖关系字段属性以获取额外的属性，以根据其他字段值显示/隐藏此字段。
参阅检索插件中的属性值 - 组合网格字段，了解如何在插件代码中使用此字段类型的值。Refer to Retrieve Properties Value in Plugin - Combine Grid Field on how to use the value of this field type in the plugin code.

Element Select Box

type : 'ElementSelect'
url : A URL which will return Properties Options JSON object of the selected element. Built-in URL is 将返回所选元素的属性选项JSON对象的URL。内置的URL是 "[CONTEXT_PATH]/web/property/json[APP_PATH]/getPropertyOptions" which will return the Properties Options JSON object of a plugin.这将会返回插件属性中的 json 对象。
keep_value_on_change : Optional, 可选，'true' or 或'false'. Used to decide whether to keep the configuration of the properties options of previous selected element when a new element is selected.
Refer to Option Field Attributes for extra attributes.
Refer to Dependency Field Attributes for extra attributes to do show/hide this field based on other field value.
Usually used for select a plugin and configure the properties of the selected plugin.
。用于决定在选择新元素时是否保留先前选定元素的属性选项的配置。
有关额外的属性，请参阅选项字段属性。
参阅依赖关系字段属性以获取额外的属性，以根据其他字段值显示/隐藏此字段。
常用于选择插件并配置所选插件的属性。
参阅检索插件中的属性值 - ElementSelectBox 如何在插件代码中使用此字段类型的值。Refer to Retrieve Properties Value in Plugin - ElementSelectBox on how to use the value of this field type in the plugin code.

Fixed Row Grid

type : 'GridFixedRow'
columns : A JSON array of 'column' JSON objects which has 2 mandatory 'key' & 'label' attributes and 2 optional 'required' & 'options' attribute.
- key : Identifier of this column.
- label : Label of the column header
- options : Optional, an array of JSON object with 'value' and 'label' attributes. A column with 'options' attribute will display the input field as select box.
- required : Optional, 'true' or 'false'. A grid cell with the 'required' attribute of 'row' and 'column' set to 'true' value is a mandatory field.
rows : A JSON array of 'row' JSON Object with 'label' attribute and an optional 'required' attribute. A grid cell with the 'required' attribute of 'row' and 'column' set to 'true' value is a mandatory field.
- label : Label of a row. Used to populate in the first column or every row.
- required : Optional, 'true' or 'false'. A grid cell with the 'required' attribute of 'row' and 'column' set to 'true' value is a mandatory field.
value : A JSON array of grid row values in JSON Object format with all the 'key' attribute of 'column' object used as attribute.
具有2个强制“key ”和“label ”属性的“列” ,JSON对象的JSON数组和2个可选的“required ”和“options ”属性。
- key :此列的标识符。
- label : 列标题的标签
- options : 可选，具有“ value”和“label”属性的JSON对象数组。具有'options'属性的列将显示输入字段作为选择框。
- required : 可选，'true'或'false'。“row”和“column”的“required”属性设置为“true”值的网格单元是必填字段。
rows : 具有'label'属性和可选的“required”属性的“row” JSON对象的JSON数组。“row” , “column”的“required”属性设置为“true”的网格单元是必填字段。
- label : 一行的标签。用于填充第一列或每行。
- required : 可选，'true'或'false'。“row”和“column”的“required”属性设置为“true”值的网格单元是必填字段。
value : JSON对象格式的JSON列数组，其中所有用作“column”对象的“key”属性用作属性。

Code Block

language	js

columns : [
    {key : 'key', label : 'Columns'}, // first column will used to populate row label
    {key : 'value', label : 'Value', required: 'true'},
    {key : 'label', label : 'Label', required: 'true'},
    {key : 'width', label : 'Width', options:[
        {value : '10%

Code Block

language	js

columns : [
    {key : 'key', label : 'Columns10%'}, // first column will used to populate row label

        {keyvalue : 'value20%', label : 'Value20%'},
 required: 'true'},
       {keyvalue : 'label30%', label : 'Label20%'},
 required: 'true'},
       {keyvalue : 'width40%', label : 'Width20%', options:[
    }
    ]}
],
rows : [
    {valuelabel : '10%Username', label required: '10%true'},
    {label : 'Status'},
    {valuelabel : '20%Message'},
    {label : '20%Date'}
],
value : [
      {valuelabel : '30%Username'},
    {label : '20%Status'},
    {label :   {value : '40%'Message', labelwidth : '20%'}
    ]}
],
rows : [
    {label : 'UsernameDate', requiredvalue : 'truedateCreated'},
    {label : 'Status'},
    {label : 'Message'},
    {label : 'Date'}
],
value
]

参阅依赖关系字段属性以获取额外的属性，以根据其他字段值显示/隐藏此字段。
参阅检索插件中的属性值 - 网格字段中如何在插件代码中使用此字段类型的值。

Grid

Image Added

type : 'Grid'
columns : 具有2个强制“键”和“标签”属性的“列”JSON对象的JSON数组和2个可选的“必需”和“选项”属性。
- key : 此列的标识符。
- label :列标题的标签
- options : 可选，具有“ value”和“label”属性的JSON对象数组。具有'options'属性的列将显示输入字段作为选择框。
- required : 可选，'true'或'false'。“row”和“column”的“required”属性设置为“true”值的网格单元是必填字段。
value : JSON对象格式的JSON列数组，其中所有用作“column”对象的“key”属性用作属性。
Code Block
language js
columns : [ {

...

key : '

...

value', label : 'Value', required: 'true'},
    {key : 'label', label :

...

'Label', required: 'true'}, {

...

key : '

...

width',

...

label : '

...

Width'

...

, options:[ {

...

value : '

...

10%',

...

label : '

...

10%'}

...

,
        {value : '20%', label : '20%'},
        {value : '30%', label : '20%'},
        {value : '40%', label : '20%'}
    ]}
],
value : [
    {label : 'Username', value : 'username'},
    {label : 'Status', value : 'status'},
    {label : 'Message', value : 'message', width : '20%'},
    {label : 'Date', value : 'dateCreated'}
]

参阅依赖关系字段属性以获取额外的属性，以根据其他字段值显示/隐藏此字段。
参阅检索插件中的属性值 - 网格字段中如何在插件代码中使用此字段类型的值。

Header

Image Added

type : 'Header'
不支持“值”和“必需”属性。
参阅依赖关系字段属性以获取额外的属性，以根据其他字段值显示/隐藏此字段。
字段类型用于将字段分成不同的组。它不适用于捕获数据。

Hidden Field

type : 'Hidden'
参阅依赖关系字段属性以获取额外的属性，以根据其他字段值显示/隐藏此字段。
参阅检索插件中的属性值 - 单值字段中关于如何在插件代码中使用此字段类型的值。

HTML Editor

Image Added

type : 'HtmlEditor'
Refer to Dependency Field Attributes for extra attributes to do show/hide this field based on other field value.
Refer to Retrieve Properties Value in Plugin - Single Value Field on how to use the value of this field type in the plugin code.

Label

Image Added

type : 'Label'
参阅依赖关系字段属性以获取额外的属性，以根据其他字段值显示/隐藏此字段。
参阅检索插件中的属性值 - 单值字段中关于如何在插件代码中使用此字段类型的值。

Multi Select Box

Image Added

type ：'MultiSelect'
有关额外的属性，请参阅选项字段属性。
请参阅依赖关系字段属性以获取额外的属性，以根据其他字段值显示/隐藏此字段。
请参阅检索插件中的属性值 - 多值字段关于如何在插件代码中使用此字段类型的值。

Password Field

Image Added

type：'密码'
size ：可选，字符串格式的整数值。默认为'50'。用于控制输入字段的长度。
maxlength ：可选，字符串格式的整数值。用于限制字符数可以在输入字段中输入。
参考正则表达式（Regex）验证属性，使用正则表达式进行验证。
请参阅依赖关系字段属性以获取额外的属性，以根据其他字段值显示/隐藏此字段。
请参阅检索插件中的属性值 - 单值字段中关于如何在插件代码中使用此字段类型的值。

Radio Button

Image Added

type ：'Radio'
有关额外的属性，请参阅选项字段属性。
请参阅依赖关系字段属性以获取额外的属性，以根据其他字段值显示/隐藏此字段。
请参阅检索插件中的属性值 - 单值字段中关于如何在插件代码中使用此字段类型的值。

Readonly Text Field

Image Added

type : 'Readonly'
请参阅依赖关系字段属性以获取额外的属性，以根据其他字段值显示/隐藏此字段。
请参阅检索插件中的属性值 - 单值字段中关于如何在插件代码中使用此字段类型的值。

Select Box

Image Added

type : 'SelectBox'
有关额外的属性，请参阅选项字段属性。
请参阅依赖关系字段属性以获取额外的属性，以根据其他字段值显示/隐藏此字段。
请参阅检索插件中的属性值 - 单值字段中关于如何在插件代码中使用此字段类型的值。

Text Area

Image Added

type : 'TextArea'
rows：可选，字符串格式的整数值。默认为'5'。用于控制输入字段的高度。
cols：可选，字符串格式的整数值。默认为'50'。用于控制输入字段的长度。
参考正则表达式（Regex）验证属性，使用正则表达式进行验证。
请参阅依赖关系字段属性以获取额外的属性，以根据其他字段值显示/隐藏此字段。
请参阅检索插件中的属性值 - 单值字段中关于如何在插件代码中使用此字段类型的值。

Text Field

Image Added

type : 'TextField'
size：可选，字符串格式的整数值。默认为'50'。用于控制输入字段的长度。
maxlength：可选，字符串格式的整数值。用于限制字符数可以在输入字段中输入。
参考正则表达式（Regex）验证属性，使用正则表达式进行验证。
请参阅依赖关系字段属性以获取额外的属性，以根据其他字段值显示/隐藏此字段。
请参阅检索插件中的属性值 - 单值字段中关于如何在插件代码中使用此字段类型的值。

正则表达式（Regex）验证属性

以下属性是为密码字段，文本区域和文本字段设计的。
regex_validation：可选，以字符串格式正则表达。
validation_message：可选，验证失败时显示的错误消息。

Code Block

language	js

{
    regex_validation : '^[a-zA-Z0-9_]+$',
    validation_message : 'Invalid ID!!'
}

依赖字段属性

以下属性可用于所有字段类型。
这些属性用于根据另一个字段的值显示/隐藏一个字段。
这些属性隐藏的字段的值在保存期间将被忽略。
control_field：可选，用于控制当前字段的显示/隐藏的另一个字段的'name'。
control_value：字符串格式的可选，值或正则表达式（正则表达式）。该值需要匹配控制字段的值才能使该字段可见。
control_use_regex：可选，'true'或'false'。默认为“false”。设置为“true”以使用正则表达式（正则表达式）来匹配该值。

Code Block

language	js

{
    control_field: 'chartType',
    control_value: 'bar|xy|area|bubble|line|candlestick|ohlc',
    control_use_regex: 'true',
}

选项字段属性

以下属性设计用于选项框，如复选框，元素选择框，多选框，单选按钮和选择框。
您可以选择使用以下属性之一“选项”，“options_ajax”，“options_callback”或“options_script”来填充该字段的选项。
options：可选，具有“ value”和“label”属性的JSON对象数组。

Code Block

language	js

options : [
    {value: 'value1', label : 'Value 1'},
    {value: 'value2', label : 'Value 2'},
    {value: 'value3', label : 'Value 3'}
]

options_ajax : 可选，一个返回带有'value'和'label'属性的JSON对象数组的URL。

Code Block

language	js

options_ajax : '[CONTEXT_PATH]/web/json/console/app[APP_PATH]/datalist/options'

options_ajax_on_change : 可选，属性字段的名称。与'options_ajax'属性一起使用。字段名称及其值将作为HTTP请求参数传递到URL。

Code Block

language	js

options_ajax_on_change : 'type'
options_ajax : '[CONTEXT_PATH]/web/json/app[APP_PATH]/plugin/org.joget.plugin.enterprise.SamplePlugin/service?action=getJson'

options_callback : 可选，一个javascript函数。该字段中的所有属性将作为单个JSON对象参数传递给此函数。该函数应该返回一个带有'value'和'label'属性的JSON对象数组。

Code Block

language	js

options_callback: 'DatalistBuilder.getColumnOptions'

options_script : 可选，一个javascript字符串，它将返回带有'value'和'label'属性的JSON对象数组。

Code Block

language	js

options_script: 'var tempArray = [{\'label\':\'\',\'value\':\'\'}]; 
for(ee in DatalistBuilder.availableColumns){ var temp = {
\'label\' : UI.escapeHTML(DatalistBuilder.availableColumns[ee].label),
\'value\' : DatalistBuilder.availableColumns[ee].id}; 
tempArray.push(temp);}tempArray;'

内置JSON API for 'options_ajax'

[CONTEXT_PATH]/web/json/console/app/[APP_PATH]/forms/options
返回当前应用的所有可用forms。
[CONTEXT_PATH]/web/json/console/app/[APP_PATH]/datalist/options
返回当前应用的所有可用datalist。
[CONTEXT_PATH]/web/json/console/app/[APP_PATH]/userview/options
返回当前应用的所有可用userviews。
[CONTEXT_PATH]/web/property/json/getElements?classname={plugin interface/abstract class name, optional}
返回基于类名过滤器的所有可用插件。

内置Javascript 函数： 'options_callback'

DatalistBuilder.getColumnOptions(properties)
可以使用与Datalist Builder相关的插件。它将根据绑定器配置返回所有可用的列。

验证器类型

页面验证器在更改页面中执行。
同一页面中的所有字段数据将传递给验证器进行验证。

AJAX

调用URL进行验证。
type : 'AJAX'
url : 一个URL返回具有状态（成功或失败）和消息（StringArray of String）属性的JSON对象
default_error_message : 可选。一串错误消息。

页面按钮

Image Added

页面按钮可以添加到每个页面的底部，以提供额外的功能。例如发送测试电子邮件来测试电子邮件配置或与数据库建立测试连接。
页面按钮将从页面和弹出对话框中收集必需的字段数据，并调用AJAX URL。
name：此按钮的标识符。
label ：按钮的标签。
ajax_url：执行按钮操作的URL。URL应返回带有消息（String）属性的JSON对象。
fields ：该按钮将使用的同一页面中的字段数组名称。
addition_fields：属性字段JSON对象的数组，将在弹出对话框中显示以收集额外的数据。
例：

Refer to Dependency Field Attributes for extra attributes to do show/hide this field based on other field value.
Refer to Retrieve Properties Value in Plugin - Grid Field on how to use the value of this field type in the plugin code.

Grid

Image Removed

type : 'Grid'
columns : A JSON array of 'column' JSON objects which has 2 mandatory 'key' & 'label' attributes and 2 optional 'required' & 'options' attribute.
- key : Identifier of this column.
- label : Label of the column header
- options : Optional, an array of JSON object with 'value' and 'label' attributes. A column with 'options' attribute will display the input field as select box.
- required : Optional, 'true' or 'false'. A grid cell with the 'required' attribute of 'row' and 'column' set to 'true' value is a mandatory field.

value : A JSON array of grid row values in JSON Object format with all the 'key' attribute of 'column' object used as attribute.

Code Block

language	js

columns : [
    {key : 'value', label : 'Value', required: 'true'},
    {key : 'label', label : 'Label', required: 'true'},
    {key : 'width', label : 'Width', options:[
        {value : '10%', label : '10%'},
        {value : '20%', label : '20%'},
        {value : '30%', label : '20%'},
        {value : '40%', label : '20%'}
    ]}
],
value : [
    {label : 'Username', value : 'username'},
    {label : 'Status', value : 'status'},
    {label : 'Message', value : 'message', width : '20%'},
    {label : 'Date', value : 'dateCreated'}
]

Refer to Dependency Field Attributes for extra attributes to do show/hide this field based on other field value.
Refer to Retrieve Properties Value in Plugin - Grid Field on how to use the value of this field type in the plugin code.

Header

Image Removed

type : 'Header'
Header does not support 'value' and 'required' attributes.
Refer to Dependency Field Attributes for extra attributes to do show/hide this field based on other field value.
This field type is used for separate the fields into different groups. It is not use for capture data.

Hidden Field

type : 'Hidden'
Refer to Dependency Field Attributes for extra attributes to do show/hide this field based on other field value.
Refer to Retrieve Properties Value in Plugin - Single Value Field on how to use the value of this field type in the plugin code.

HTML Editor

Image Removed

type : 'HtmlEditor'
Refer to Dependency Field Attributes for extra attributes to do show/hide this field based on other field value.
Refer to Retrieve Properties Value in Plugin - Single Value Field on how to use the value of this field type in the plugin code.

Label

Image Removed

type : 'Label'
Refer to Dependency Field Attributes for extra attributes to do show/hide this field based on other field value.
Refer to Retrieve Properties Value in Plugin - Single Value Field on how to use the value of this field type in the plugin code.

Multi Select Box

Image Removed

type : 'MultiSelect'
Refer to Option Field Attributes for extra attributes.
Refer to Dependency Field Attributes for extra attributes to do show/hide this field based on other field value.
Refer to Retrieve Properties Value in Plugin - Multi Values Field on how to use the value of this field type in the plugin code.

Password Field

Image Removed

type : 'Password'
size : Optional, integer value in string format. Default to '50'. Used to control the length of the input field.
maxlength : Optional, integer value in string format. Used to limit the number of characters can be enter in the input field.
Refer to Regular Express (Regex) Validation Attributes for extra attributes to do validation using regex.
Refer to Dependency Field Attributes for extra attributes to do show/hide this field based on other field value.
Refer to Retrieve Properties Value in Plugin - Single Value Field on how to use the value of this field type in the plugin code.

Radio Button

Image Removed

type : 'Radio'
Refer to Option Field Attributes for extra attributes.
Refer to Dependency Field Attributes for extra attributes to do show/hide this field based on other field value.
Refer to Retrieve Properties Value in Plugin - Single Value Field on how to use the value of this field type in the plugin code.

Readonly Text Field

Image Removed

type : 'Readonly'
Refer to Dependency Field Attributes for extra attributes to do show/hide this field based on other field value.
Refer to Retrieve Properties Value in Plugin - Single Value Field on how to use the value of this field type in the plugin code.

Select Box

Image Removed

type : 'SelectBox'
Refer to Option Field Attributes for extra attributes.
Refer to Dependency Field Attributes for extra attributes to do show/hide this field based on other field value.
Refer to Retrieve Properties Value in Plugin - Single Value Field on how to use the value of this field type in the plugin code.

Text Area

Image Removed

type : 'TextArea'
rows : Optional, integer value in string format. Default to '5'. Used to control the height of the input field.
cols : Optional, integer value in string format. Default to '50'. Used to control the length of the input field.
Refer to Regular Express (Regex) Validation Attributes for extra attributes to do validation using regex.
Refer to Dependency Field Attributes for extra attributes to do show/hide this field based on other field value.
Refer to Retrieve Properties Value in Plugin - Single Value Field on how to use the value of this field type in the plugin code.

Text Field

Image Removed

type : 'TextField'
size : Optional, integer value in string format. Default to '50'. Used to control the length of the input field.
maxlength : Optional, integer value in string format. Used to limit the number of characters can be enter in the input field.
Refer to Regular Express (Regex) Validation Attributes for extra attributes to do validation using regex.
Refer to Dependency Field Attributes for extra attributes to do show/hide this field based on other field value.
Refer to Retrieve Properties Value in Plugin - Single Value Field on how to use the value of this field type in the plugin code.

Regular Express (Regex) Validation Attributes

The following attributes are designed for Password Field, Text Area and Text Field.
regex_validation : Optional, regular express in string format.
validation_message : Optional, error message to display when validation failure.

Code Block

language	js

{
    regex_validation : '^[a-zA-Z0-9_]+$',
    validation_message : 'Invalid ID!!'
}

Dependency Field Attributes

The following attributes are available for all field types.
These attributes are used to show/hide a field based on the value of another field.
The value of a field hidden by these attributes will be ignore during save.
control_field : Optional, 'name' of another field used to control the show/hide of current field.
control_value : Optional, value or regular expression (regex) in string format. This value need to match the value of the controlling field in order to make the field visible.
control_use_regex : Optional, 'true' or 'false'. Default to 'false'. Set to 'true' to use regular expression (regex) in matching the value.

Code Block

language	js

{
    control_field: 'chartType',
    control_value: 'bar|xy|area|bubble|line|candlestick|ohlc',
    control_use_regex: 'true',
}

Options Field Attributes

The following attributes are designed for options fields like Check Box, Element Select Box, Multi Select Box, Radio Button and Select Box.
You can choose to use one of the following attributes "options", "options_ajax", "options_callback" or "options_script" to populate the options for the field.
options : Optional, an array of JSON object with 'value' and 'label' attributes.

Code Block

language	js

options : [
    {value: 'value1', label : 'Value 1'},
    {value: 'value2', label : 'Value 2'},
    {value: 'value3', label : 'Value 3'}
]

options_ajax : Optional, a URL which will return an array of JSON object with 'value' and 'label' attributes.

Code Block

language	js

options_ajax : '[CONTEXT_PATH]/web/json/console/app[APP_PATH]/datalist/options'

options_ajax_on_change : Optional, name of a property field. Used together with 'options_ajax' attribute. The field name and its value will passed as HTTP request parameter to the URL.

Code Block

language	js

options_ajax_on_change : 'type'
options_ajax : '[CONTEXT_PATH]/web/json/app[APP_PATH]/plugin/org.joget.plugin.enterprise.SamplePlugin/service?action=getJson'

options_callback : Optional, a javascript function name. All attributes in the field will passed as a single JSON object parameter to this function. The function should return an array of JSON object with 'value' and 'label' attributes.

Code Block

language	js

options_callback: 'DatalistBuilder.getColumnOptions'

options_script : Optional, a string of javascript which will return an array of JSON object with 'value' and 'label' attributes.

Code Block

language	js

options_script: 'var tempArray = [{\'label\':\'\',\'value\':\'\'}]; 
for(ee in DatalistBuilder.availableColumns){ var temp = {
\'label\' : UI.escapeHTML(DatalistBuilder.availableColumns[ee].label),
\'value\' : DatalistBuilder.availableColumns[ee].id}; 
tempArray.push(temp);}tempArray;'

Built-in JSON API for 'options_ajax'

[CONTEXT_PATH]/web/json/console/app/[APP_PATH]/forms/options
Return all available forms of current app.
[CONTEXT_PATH]/web/json/console/app/[APP_PATH]/datalist/options
Return all available datalists of current app.
[CONTEXT_PATH]/web/json/console/app/[APP_PATH]/userview/options
Return all available userviews of current app.
[CONTEXT_PATH]/web/property/json/getElements?classname={plugin interface/abstract class name, optional}
Return all available plugins based on the classname filter.

Built-in Javascript Function for 'options_callback'

DatalistBuilder.getColumnOptions(properties)
Can be used by plugins related to Datalist Builder. It return all available columns based on binder configuration.

Validator Types

Page validator is execute during change page.
All fields data in the same page will pass to the validator for validation.

AJAX

Call to a URL for validation.
type : 'AJAX'
url : An URL return a JSON Object with status (success or fail) & message (JSONArray of String) attribute
default_error_message : Optional. A string of error message.

Page Button

Image Removed

Page button can be added on the bottom of each page to provide extra feature. Such as send an test email to test the email configuration or make a test connection to database.
Page button will collect the required fields data from the page and popup dialog and call an AJAX URL.
name : Identifier of this button.
label : Label of the button.
ajax_url : A URL to execute the button action. The URL should return a JSON Object with message (String) attribute.
fields : An array of fields name in the same page that will be used by this button.
addition_fields : An array of Property Field JSON object that will be shown in a popup dialog to collect extra data.

Example:

Code Block

language	js

buttons : [{
    name : 'testmail',    
    label : 'Send Test Email',
    ajax_url : '[CONTEXT_PATH]/web/json/app[APP_PATH]/plugin/org.joget.apps.app.lib.EmailTool/service?action=testmail',
    fields : ['host', 'port', 'security', 'username', 'password'],
    addition_fields : [
        {
            name : 'from',
            label : 'From',
            type : 'textfield',
            required : 'True'
        },
        {
            name : 'toSpecific',
            label : 'To',
            type : 'textfield',
            required : 'True'
        }
    ]
}]

...

变量

[CONTEXT_PATH]

该变量将被当前URL的上下文路径替换。
通常用于属性属性值，即URL
示例：
This variable will be replaced by Context Path of current URL.
Usually used in property attribute value which is URL
Example : '[CONTEXT_PATH] /web/property/json/getElements?classname=org.joget.apps.form.model.FormValidator'
Resulted URL : 结果网址：'/jw/web/property/json/getElements?classname=org.joget.apps.form.model.FormValidator'

[APP_

...

PATH]

此变量将被当前URL的当前应用程序Id和应用程序版本所替代。
通常用于属性属性值，即URL
示例
This variable will be replaced by Current App Id and App Version of current URL.
Usually used in property attribute value which is URL
Example : '[CONTEXT_PATH]/web/json/console/app[APP_PATH]/datalist/options'
Resulted URL 结果URL : '/jw/web/json/console/app/crm/3/datalist/options'

Retrieve Properties Value in Plugin

检索插件中的属性值

所有插件必须扩展“orgAll the plugin must extends the "org.joget.plugin.base.ExtDefaultPlugin" abstract class. We can use the ExtDefaultPlugin”抽象类。我们可以使用 "Object getProperty(String)" and 和 "String getPropertyString(String)" method to retrieve the configured properties.

...

方法来检索配置的属性

单值字段

Code Block

language	java

String value = getPropertyString("property_name");

...

多值字段

Code Block

language	java

String[] values = getPropertyString("property_name").split(";");

Combine Grid Field

Code Block

language	java

String[] col1_values = getPropertyString("col1_name").split(";");
String[] col2_values = getPropertyString("col2_name").split(";");

Grid Field

Code Block

language	java

Object columns = getProperty("property_name");
if (columns != null) {
    for (Object colObj : (Object[]) columns) {
        Map col = (Map) colObj;
        String col1_value = (String) opt.get("col1_key");
        String col2_value = (String) opt.get("col2_key");
    }
}

...

元素选择框（Element Select

...

Box）

Code Block

language	java

import org.joget.plugin.base.PluginManager;
import org.joget.apps.app.service.AppUtil;
import org.joget.plugin.base.ExtDefaultPlugin;
 
Object element = getProperty("property_name");
if (element != null && element instanceof Map) {
    Map elementMap = (Map) element;
    String className = (String) elementMap.get("className");
    Map<String, Object> properties = (Map<String, Object>) elementMap.get("properties");
 
    //convert it to plugin
    PluginManager pm = (PluginManager) AppUtil.getApplicationContext().getBean("pluginManager");
    ExtDefaultPlugin plugin = (ExtDefaultPlugin) pm.getPlugin(className);
    if (plugin != null) {
        plugin.setProperties(properties);
    }
}

Page tree

Page History

Versions Compared

Old Version 1

New Version Current

Key

Usage

Structure

用法

结构体

样品外观和大体感官

字段类型

Check Box

Code Editor

Combine Grid

Element Select Box

Fixed Row Grid

Grid

Header

Hidden Field

HTML Editor

Label

Multi Select Box

Password Field

Radio Button

Readonly Text Field

Select Box

Text Area

Text Field

正则表达式（Regex）验证属性

依赖字段属性

选项字段 属性

内置JSON API for 'options_ajax'

内置Javascript 函数 ： 'options_callback'

验证器类型

AJAX

页面按钮

Grid

Header

Hidden Field

HTML Editor

Label

Multi Select Box

Password Field

Radio Button

Readonly Text Field

Select Box

Text Area

Text Field

Regular Express (Regex) Validation Attributes

Dependency Field Attributes

Options Field Attributes

Built-in JSON API for 'options_ajax'

Built-in Javascript Function for 'options_callback'

Validator Types

AJAX

Page Button

变量

[CONTEXT_PATH]

[APP_

PATH]

Retrieve Properties Value in Plugin

检索插件中的属性值

单值字段

多值字段

Combine Grid Field

Grid Field

元素选择框（Element Select

Box）

选项字段属性

内置Javascript 函数： 'options_callback'