...
- Plugin Properties Options allow a plugin to gather configuration data from the a plugin user.
- Plugin Properties Options should be returned in the abstract method "getPropertyOptions" of each plugin.
- Plugin Properties Options are in JSON format.
...
Properties Option Types
- Hidden field - hidden
- Read only field – readonly
- Text field – textfield
- Password field – password
- Text area Area field – textarea
- HTML editor Editor field – htmleditor
- Checkbox field – checkbox
- Radio button Button field – radio
- Select box Box field – selectbox
- Multi select box Select Box field – multiselect
- Element (Plugin) select Select field – elementselect
- Grid field - grid
Properties Validator Types
- AJAX - ajax
...
Detail Attributes of Option Types
Common Attributes for All Properties Options Types Except Hidden Field and Grid
{
name : 'Property Name',
label : 'Property Label',
description : 'Property Description', //optional, default is NULL
type : 'readonly',
value : 'Property Value', //optional , default is empty string
required : 'true', //optional, boolean value, default is false
}
Extra Attributes for Text Field, Password Field, Text Area and HTML Editor
{
size : '50', //optional , integer value, default is NULL, only for text field and password field
maxlength : '50', //optional, integer value, default is NULL, only for text field and password field
rows : '50', //optional, integer value, default is NULL, only for text area and html editor
cols : '50', //optional, integer value, default is NULL , only for text area and html editor
regex_validation : '^\[a-zA-Z0-9_\|KB:a-zA-Z0-9_\]+$', //optional, default is NULL Wiki Markup
validation_message : 'Error!!' //optional, default is NULL
}
Extra Attributes for Checkbox, Radio Button, Select Box and Multi Select Box, Element Select Field
...
{ *size* : '<span style="color: #0000ff">10</span>', <span style="color: #99cc00">{ Wiki Markup
size : '10', //optional, integer value, default is 4,</span> <span style="color: #008000">only for multi select box</span> *options* : \[<span style="color: #99cc00">//is optional to use this attribute or options_ajax</span> {value: '<span style="color: #0000ff">value1</span>', label : '<span style="color: #0000ff">Value 1</span>'}, {value: '<span style="color: #0000ff">value2</span>', label : '<span style="color: #0000ff">Value 2</span>'}, {value: '<span style="color: #0000ff">value3</span>', label : '<span style="color: #0000ff">Value 3</span>'} \], * only for multi select box
options : [//is optional to use this attribute or options_ajax
{value: 'value1', label : 'Value 1'},
{value: 'value2', label : 'Value 2'},
{value: 'value3', label : 'Value 3'}
],
options_ajax_on_change* : '<span style="color: #0000ff">property1</span>', <span style="color: #99cc00">'property1', //optional, value of this property name and value will passed over to load options from ajax</span> *options_ajax* : '<span style="color: #0000ff">URL to load options JSON</span>' <span style="color: #99cc00">//optional, URL return JSON Array of a set of Objects that have value & label attribute</span> passed as HTTP request parameter to the URL defined in the options_ajax property
options_ajax : 'URL to load options JSON' //optional, URL which returns the JSON Array of a set of Objects that have value & label attribute
}
Attributes for Hidden Field
{
name : 'Property Name',
type : 'hidden',
value : 'Property Value'
}
Attributes for Grid
{ *name* : '{color:#0000ff}Property Name{color}', *label* : '{color:#0000ff}Property Label{color}', *description* : '{color:#0000ff}Property Description{color}', {color:#99cc00}//optional, default is NULL{color} *type* : '{color:#ff6600}grid{color}', *columns* : \[{color:#99cc00}// 2 type of column, with and without options attribute{color} {*key* : '{color:#0000ff}col1{color}', *label* : '{color:#0000ff}Col 1{color}'}, {*key* : '{color:#0000ff}col2{color}', *label* : '{color:#0000ff}Col 2{color}', *options* :\[ {*value* :'{color:#0000ff}option1{color}', *label* : '{color:#0000ff}Option 1{color}'}, {*value* :'{color:#0000ff}option2{color}', *label* : '{color:#0000ff}Option 2{color}'} \] }, \] *value* : \[{color:#99cc00}//optional, default is NULL{color} {col1 : 'abc', col2 : 'option1'}, {col1 : 'def', col2 : 'option2'} \], & Wiki Markup {
name : 'Property Name',
label : 'Property Label',
description : 'Property Description', //optional, default is NULL
type : 'grid',
columns : [// 2 types of column, with and without options attribute
{key : 'col1', label : 'Col 1'},
{key : 'col2', label : 'Col 2',
options :[
{value :'option1', label : 'Option 1'},
{value :'option2', label : 'Option 2'}
]
},
],value:[ //Optional. Default is null. The name of each sub-object must match a key from the columns object above. (e.g. col1 below matches col1 in one of the columns:key names above)
{ col1 : 'abc', col2 : 'option1' },{col1 : 'def', col2 : 'option2'}
],
nbsp; *required* : '{color:#0000ff}true{color}', {color:#99cc00}//optional, boolean value, default is false{color} }
required : 'true', //optional, boolean value, default is false
}
Extra Attributes for Element Select Field
{
options_ajax_on_change : 'property1', //optional, value of this property name will passover to load options from ajax this property name and value will passed as HTTP request parameter to the URL defined in the options_ajax property
options_ajax : '\[[KB:CONTEXT_PATH\]/web/property/json/getElements?classname= org.joget.apps.form.model.FormLoadElementBinder', //Load plugin list based on class name given Wiki Markup
url : '\[[KB:CONTEXT_PATH\]/web/property/json Wiki Markup \[[KB:APP_PATH\]/getPropertyOptions', //Load plugin properties Wiki Markup
keep_value_on_change : 'true' //optional, boolean value, default is false. To keep current configuration for the next selected element
}
Detail Attributes of Validator Type
Attributes for AJAX
{
type : 'ajax',
url : 'URL to validate properties page value' , // All properties in the same page will send to this url to validate, URL return a JSON Object with status (success or fail) & message (JSONArray of String) attribute
default_error_message : 'Error in this page!!' //optional, default is null
}