Page History

...

Sample Look and Feel

Field Types

Auto Complete

Image Added

• type : 'autocomplete'
• 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 Regular Express (Regex) Validation Attributes for extra attributes to do validation using regex.

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.

...

• 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

Image Removed

Color

Image Added

• type : 'color'
• Refer to Dependency Field Attributes for extra attributes to do show/hide this field based on other field value.

Combine Grid

Image Added

• Combine Grid is used to migrate 2 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'
• 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.

...

• type : 'ElementSelect'
• url : A URL which will return Properties Options JSON object of the selected element. Built-in URL is "[CONTEXT_PATH]/web/property/json[APP_PATH]/getPropertyOptions" which will return the Properties Options JSON object of a plugin.
• 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.
• Refer to Retrieve Properties Value in Plugin - ElementSelectBox on how to use the value of this field type in the plugin code.

...

File

Image RemovedImage Added

• type : 'GridFixedRowfile',
• 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.  
• appPath : '[APP_PATH]',
• allowInput : Optional, 'true' or 'false'. Set to 'true' to allow custom link.
• isPublic : Optional, 'true' or 'false'. Set to 'true' to auto set the permission to access by anonymous.
• allowType : Optional, a string of file extension seperated (;). Example: ".jpeg;.jpg;.gif;.png".
• maxSize : Optional, integer value in string format. In kB.
• 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.

Fixed Row Grid

Image Added

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

columns : [
    {key : 'key

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%', label : '10%'},
        {value : '20%', label : '20%'},
        {value : '30%', label : '20%Columns'},
     // first column will used to populate row label
    {valuekey : '40%value', label : '20%Value'}
,    ]}
]required: 'true'},
rows  : [
 {key : 'label', {label : 'UsernameLabel', required: 'true'},
    {labelkey : 'Statuswidth'},
    {label : 'MessageWidth'}, options:[
        {labelvalue : 'Date'}
],
value : [
10%', label : '10%'},
        {value : '20%', label : 'Username20%'},
        {value : '30%', label : 'Status20%'},
        {labelvalue : 'Message40%', widthlabel : '20%'}
    ]}
],
rows : [
    {label : 'DateUsername', value required: 'dateCreatedtrue'}
]

• 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

,
    {label : 'Status'},
    {label : 'Message'},
    {label : 'Date'}
],
value : [
    {label : 'Username'},
    {label : 'Status'},
    {label : '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.

Grid

Image Added

• 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

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

...

• 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

•  : '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 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.

Image

Image Added

• type : 'file',
• appPath : '[APP_PATH]',
• allowInput : Optional, 'true' or 'false'. Set to 'true' to allow custom link.
• isPublic : Optional, 'true' or 'false'. Set to 'true' to auto set the permission to access by anonymous.
• allowType : Optional, a string of file extension seperated (;). Example: ".jpeg;.jpg;.gif;.png".
• maxSize : Optional, integer value in string format. In kB.
• imageSize : Optional, can be integer value in string format or a css expression. Example: '50' or "width:100px;height:70px;".
• Refer to Regular Express (Regex) Validation Attributes for extra attributes to do validation using regex.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.

...

• The following attributes are designed for for Auto Complete, 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. 

...

• The following attributes are designed for options fields like like Auto Complete, 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.

...