Page History

...

[
    {
        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, boolean value, default is false
                //… more attributes …
            }, //… more fields …
        ],
        validators : [  //optional
            //… properties custom validators …
        ],
        buttons : [  //optional
            //… custom properties page buttons …
        ]
    }, //… more properties page …
]

Field Types

Check Box

Image Modified

• type : 'checkboxCheckBox'
• Refer to Option Field Attributes for extra attributes.
• 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 : 'codeeditorCodeEditor'
• mode : Optional, used for specified highlight mode. Default to "text", available values are "text", "java", "html", "javascript", "css", "json", "sql" and "xml".
• 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

Image Modified

• type : 'GridCombine'
• Refer to Grid Related Attributes for extra attributes.
• Combine Grid is used to migrate 2 or more single value property fields (etc Text Field & Select Box) to multi values field in Grid View.
• 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

Image Added

• type : 'ElementSelect'
• url : a URL which will return Properties Option JSON object of the selected element. Built-in URL is "[CONTEXT_PATH]/web/property/json[APP_PATH]/getPropertyOptions" which will return the Properties Option JSON object of a plugin.
• Refer to Option Field Attributes for extra attributes.
• Usually used for select a plugin and configure the properties of the selected plugin.

Fixed Row Grid

Grid

Header

Hidden Field

...

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

...

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.

Grid

...

Related Attributes

Validator Types

AJAX

Page Button

...

Single Value Field

Multi Values Field

Combine Grid Field

...

Grid Field

Element Select