Page History
...
Code Block |
---|
"functionName": { "returns": "string", "parameters":[ { "name":"start", "type":"int" } { "name":"end", "type":"int" } ] } |
Example
As an example we could have a Tab Panel that has a definition like: (note: this example does not contain the entire Tab Panel spec)
...
title | datafield.spec |
---|
...
Security
Components can be protected using two special security types: visible and protected.
For example. when a component is made readonly from the server the component will make the its UI non-editable. However, a malicious client could still send json messages to the server and update data.
Similarly, when a form or component is marked invisible, its data should not be sent to the client since it may contain sensitive data.
Protecting properties
Protected properties are used to protect an entire component or specific properties or handlers.
When the property is blocking no changes or function calls from the client are accepted.
For example, an enabled property as defined below will be true by default, when set to false not changes from the client to the component will be accepted. Also no functions cannot be called from the client.
Code Block | ||||
---|---|---|---|---|
| ||||
"model": {
"enabled" : { "type": "protected", "blockingOn": false, "default": true }
} |
Protection can be done for specific properties or functions.
In this example, when protectCustomer is set to true, customerAddress can still be changed the the client, but customerName en removecustomer are protected.
Code Block |
---|
"model:" {
"customerAddress": "string",
"customerName": "string",
"protectCustomer": { "type": "protected", "for": "removecustomer, customerName" }
},
"handlers:" {
"removecustomer": "function"
} |
Protecting properties themselves can never be modified from the client.
Visibility properties
Container security
Example
As an example we could have a Tab Panel that has a definition like: (note: this example does not contain the entire Tab Panel spec)
Code Block | ||||
---|---|---|---|---|
| ||||
{ "name": "servoydefault-tabpanel", "displayName": "Tab Panel", "version": 1, "icon": "servoydefault/tabpanel/tabs.gif", "definition": "servoydefault/tabpanel/tabpanel.js", "serverscript": "servoydefault/tabpanel/tabpanel_server.js", "libraries": [{"name":"accordionpanel", "version":"1", "url":"servoydefault/tabpanel/accordionpanel.css", "mimetype":"text/css"}], "model": { "background" : "color", "borderType" : {"type":"border","stringformat":true}, "enabled" : { "type": "protected", "blockingOn": false, "default": true }, "fontType" : {"type":"font","stringformat":true}, "foreground" : "color", "horizontalAlignment" : {"type" :"int", "scope" :"design", "values" :[{"LEFT":2}, {"CENTER":0},{"RIGHT":4}],"default" : -1}, "location" : "point", "readOnly" : "protected", "selectedTabColor" : "color", "size" : {"type" :"dimension", "default" : {"width":300, "height":300}}, "styleClass" : { "type" :"styleclass", "scope" :"design", "values" :[]}, "tabIndex" : "int", "tabOrientation" : {"type" :"int", "scope" :"design", "values" :[{"default" :0}, {"TOP":1}, {"HIDE":-1}]}, "tabSeq" : {"type" :"tabseq", "scope" :"design"}, "tabs" : {"type":"tab[]", "droppable":true}, "transparent" : "boolean", "visible" : "visible" }, "handlers": { "onChangeMethodID" : "function", "onTabChangeMethodID" : "function" }, "api": { "addTab": { "returns": "boolean", "parameters":[ { "name":"form/formname", "type":"object []" }, { "name":"name", "type":"object", "optional":true }, { "name":"tabText", "type":"object", "optional":true }, { "name":"tooltip", "type":"object", "optional":true }, { "name":"iconURL", "type":"object", "optional":true }, { "name":"fg", "type":"object", "optional":true }, { "name":"bg", "type":"object", "optional":true }, { "name":"relatedfoundset/relationname", "type":"object", "optional":true }, { "name":"index", "type":"object", "optional":true } ] }, "getMaxTabIndex": { "returns": "int" }, "getMnemonicAt": { "returns": "string", "parameters":[ { "name":"i", "type":"int" } ] }, "getSelectedTabFormName": { "returns": "string" }, "getTabBGColorAt": { "returns": "string", "parameters":[ { "name":"unnamed_0", "type":"int" } ] }, "getTabFGColorAt": { "returns": "string", "parameters":[ { "name":"i", "type":"int" } ] }, "getTabFormNameAt": { "returns": "string", "parameters":[ { "name":"i", "type":"int" } ] }, "getTabNameAt": { "returns": "string", "parameters":[ { "name":"i", "type":"int" } ] }, "getTabRelationNameAt": { "returns": "string", "parameters":[ { "name":"i", "type":"int" } ] }, "getTabTextAt": { "returns": "string", "parameters":[ { "name":"i", "type":"int" } ] }, "isTabEnabled": { "returns": "boolean", "parameters":[ { "name":"unnamed_0", "type":"int" } ] }, "isTabEnabledAt": { "returns": "boolean", "parameters":[ { "name":"i", "type":"int" } ] }, "removeAllTabs": { "returns": "boolean" }, "removeTabAt": { "returns": "boolean", "parameters":[ { "name":"index", "type":"int" } ] }, "setMnemonicAt": { "parameters":[ { "name":"index", "type":"int" }, { "name":"text", "type":"string" } ] }, "setTabBGColorAt": { "parameters":[ { "name":"unnamed_0", "type":"int" }, { "name":"unnamed_1", "type":"string" } ] }, "setTabEnabled": { "parameters":[ { "name":"unnamed_0", "type":"int" }, { "name":"unnamed_1", "type":"boolean" } ] }, "setTabEnabledAt": { "parameters":[ { "name":"i", "type":"int" }, { "name":"b", "type":"boolean" } ] }, "setTabFGColorAt": { "parameters":[ { "name":"i", "type":"int" }, { "name":"s", "type":"string" } ] }, "setTabTextAt": { "parameters":[ { "name":"index", "returnstype": "booleanint", "parameters":[ { }, "name":"form/formname", "type":"object []" { }, { "name":"nametext", "type":"object", string" "optional":"true" } } ] }, "getMaxTabIndex": { ] "returns": "int" } } }, "types": { "tab": { "model": { "name": "string", "containsFormId": "form", : "form", "text": "tagstring", "relationName": "relation", "active": "boolean", "foreground": "color", "disabled": "boolean", "imageMediaID": "stringmedia", "mnemonic": "string" } } } } |