Page History
...
| Code Block |
|---|
angular.module('servoydefaultTextfield',['servoy']).directive('servoydefaultTextfield', function() {
return {
restrict: 'E',
transclude: true,
scope: {
model: "=svyModel",
api: "=svyApi",
handlers: "=svyHandlers",
svyServoyapi: "=" // only needed if you really need access to this servoy provided API for more control
},
controller: function($scope, $element, $attrs) {
// fill in the api defined in the spec file
$scope.api.onDataChangeCallback = function(event, returnval) {
if(!returnval) {
$element[0].focus();
}
},
/**
* Set the focus on the textfield.
*/
$scope.api.requestFocus = function() {
$element[0].focus()
},
/**
* Get the selected text.
* @return {string} the text selected in the field.
*/
$scope.api.getSelectedText = function() {
var elem = $element[0];
return elem.value.substr(elem.selectionStart, elem.selectionEnd - elem.selectionStart);
}
/**
* Set the selected text.
* @param {int} start the start index in the text
* @param {int} end the end index in the text
*/
$scope.api.setSelection = function(start, end) {
var elem = $element[0];
if (elem.createTextRange) {
var selRange = elem.createTextRange();
selRange.collapse(true);
selRange.moveStart('character', start);
selRange.moveEnd('character', end);
selRange.select();
elem.focus();
} else if (elem.setSelectionRange) {
elem.focus();
elem.setSelectionRange(start, end);
} else if (typeof elem.selectionStart != 'undefined') {
elem.selectionStart = start;
elem.selectionEnd = end;
elem.focus();
}
}
$scope.onClick = function(event){
if ($scope.model.editable == false && $scope.handlers.onActionMethod) {
$scope.handlers.onActionMethod(event);
}
}
},
templateUrl: 'servoydefault/datatextfield/datatextfield.html',
replace: true
};
}) |
It is a good practice to document your components, please note the jsdoc tags in the code above. Servoy developer will use that JSDoc information from either the component client-side scripting file or from the component server-side scripting file to show tooltips in Solution Explorer, code editor and so on - for the API functions declared in it's .spec file.Anchor documentingApi documentingApi
First you can see the directive declaring that it uses a few things Servoy provides:
- svyModel: this is the object that contains all properties that the .spec file declares in it's "model" section.
- svyApi: this is the object that the web component .js file must populate with all the client-side API functions that the .spec file declares in it's "api" section. Some apis can also be implemented in serverside scripting, see "Serverside scripting" section of the Specification page.
- svyHandlers: this is the object that contains all handlers that the .spec file declares in it's "handlers" section. It is pre-populated by Servoy, so the handlers are already there, ready to be used.
- svyServoyapi: this is an API that Servoy provides to the component - if the component needs to do manual 'apply' or other operations. See the servoyApi section below.
The onDataChangeCallback function in the example above is used as a callback of the ondatachange spec configuration for a dataprovider.
...
The servoyApi is a Servoy specific api which can be used by web components to interact with the server. It must be declared in the private scope of the component.
| Code Block | ||||
|---|---|---|---|---|
| ||||
angular.module('mypackageComponent',['servoy']).directive('mypackageComponent', function() {
return {
restrict: 'E',
scope: {
model: "=svyModel",
svyServoyapi: "="
}, |
The servoyApi provides the following methods:
Method | Parameters | Description | ||||||||||||||||||||||||||
apply | propertyName –the name of the property of type dataprovider | Pushes a changed dataprovider value of the component to the server (sets it in the actual record). So this is the only way to acutally make the server's data aware of browser-side changes to 'dataprovider' typed properties. It is used internally by the svy-autoapply directive, but it can also be called directly by the web component itself. For example the radio button manually pushes the new value to the server when the radio is clicked (without using svy-autoapply):
| ||||||||||||||||||||||||||
callServerSideApi | methodName –the name of the serverside method to call args –the arguments of the serverside method | Used on the client side to call a function which is defined in the server side api of the component. Since Servoy 8.2, api must be defined in special category of the spec: internalApi
It returns a promise of angular where the then function will give you the return value of the callback.
In the controller or link function of the component, "mycallback" can be invoked via callServerSideApi:
| ||||||||||||||||||||||||||
formWillShow | formname – the name of the form which will be shown relationname – the name of the relation (optional) formIndex – the formIndex in the tabpanel (optional) | Prepare the form for showing. Example switching tabs in the tabpanel component:
It returns a $q promise. | ||||||||||||||||||||||||||
hideForm | formname – the name of the form to hide relationname –the name of the relation (optional) formIndex –the formIndex in the tabpanel (optional) formnameThatWillShow – the name of the form to hide (optional) relationnameThatWillShow –the name of the relation (optional) formIndexThatWillShow –the formIndex in the tabpanel (optional) | Hides the form. The outcome of the returned angular promise is a boolean, which is true if the form was hidden. Used by the tabpanel to hide the previously selected tab.
use the last 3 arguments to let the server directly know if the form that was give can be hidden then show immediately the other form and push that data . This way you won't notice stale data, because the new forms data is pushed sooner then when you ask in 2 points in time first to hide the current one and then to show the next one. The code would then be something like this:
| ||||||||||||||||||||||||||
getFormUrl | formName | Return the URL of a form. It can be used together with ng-include to include a form in the component template:
| ||||||||||||||||||||||||||
startEdit | propertyName –the name of the property which is edited | Signal that the editing of a property has started, usually at focus gained. It is automatically used internally by the svy-autoapply directive. In case svy-autoapply is not used, startEdit can be called manually by the component itself to notify the server that the record should go into edit mode (by giving the name of the model 'dataprovider' typed property):
| ||||||||||||||||||||||||||
| getFormComponentElements | propertyName –the name of the property form component property where the template should be get for templateUUID
| This api is used form component that use the "formcomponent" property type for 1 or more of its model properties. The model value should be given and the name of the property itself. This method returns that a compiled dom elements which can be copied/appended into the right place in the dom of the component. | ||||||||||||||||||||||||||
| isInDesigner | returns true when the component is shown in the designer at runtime this method will return false. This way a component can show something more, like some sample data (a valuelist component can show a few rows of data so it displays nicely) | |||||||||||||||||||||||||||
| isInAbsoluteLayout (since Servoy 8.2.2) | returns true when the component is in absolute layout form, false when it is in responsive form |
...
Overview
Content Tools
Activity