Page History

...

• Create objects and set their properties
• Clone objects
• Manipulate properties of existing objects
• Revert objects to its original design-time state
• Remove existing objects

Basic rules and functionality

With the Solution Model you can control different types of objects. Referring to these objects is done through so-called JS Objects and consist of constants, properties and/or functions.

The following list shows the objects which can be controlled by the Solution Model, its corresponding JS Object and from which JS Object it needs to be referenced from in order to use it:

When creating objects you need to make sure that the same object with the same name does not already exists. In this case you need to choose another name or remove the existing object.

By default, changes made by the Solution Model are not persistent and are only valid for the current session in which these changes are made. However, by a special setting (servoyDeveloper scripting access?) the changes are being stored back into the workspace.

Examples

This section shows (simple) examples of how different objects can be controlled with the Solution Model. Per object you will find how to:

• Create an object
• Retrieve an existing object
• Change a property of an object
• Remove an existing object

Calculations

To create a new calculation with name myCalculation on table customers of server example_data which returns 1:

var calculation = solutionModel.newCalculation('function myCalculation() { return 1; }', JSVariable.INTEGER, 'db:/example_data/customers');

To get the existing calculation myCalculation on table customers of server example_data:

var calculation = solutionModel.getCalculation('myCalculation', 'db:/example_data/customers');

To output whether or not this calculation is a stored one:

application.output('Stored calculation: ' + calculation.isStored();

To remove existing calculation myCalculation:

solutionModel.removeCalculation('myCalculation', 'db:/example_data/customers');

Styles

To create a new stylesheet with name myStyle with a default style class for forms:

var style = solutionModel.newStyle('myStyle' 'form { background-color: transparent; }';

To get existing stylesheet myStyle:

var style = solutionModel.getStyle('myStyle')

To add a default style class for fields:

style.text += 'field { background-color: blue; }';

To remove existing stylesheet myStyle:

solutionModel.removeStyle('myStyle');

Global variables

To create a new global variable with name myGlobalVariable of type TEXT:

var globalVariable = solutionModel.newGlobalVariable('myGlobalVariable', JSVariable.TEXT);

To get existing global variable myGlobalVariable:

var globalVariable = solutionModel.getGlobalVariable('myGlobalVariable');

To change its default value to abc:

myGlobalVariable.defaultValue = 'abc';

To remove existing global variable myGlobalVariable:

solutionModel.removeGlobalVariable('myGlobalVariable');

Global methods

To create a new global method with name myGlobalMethod:

var globalMethod = solutionModel.newGlobalMethod('function myGlobalMethod() { currentcontroller.newRecord(); }');

To get existing global method myGlobalMethod:

var globalMethod = solutionModel.getGlobalMethod('myGlobalMethod');

To make it appear in the menu:

globalMethod.showInMenu = true;

To remove existing global method myGlobalMethod:

solutionModel.removeGlobalMethod('myGlobalMethod');

Forms

Forms are most commonly used with the Solution Model and have some additional functions. The following basic functions are available for this type of objects:

• Create new forms
• Get existing forms
• Clone an existing form
• Remove an existing form
• Revert an existing form to its original design-time state

To create a new form with name myForm:

var form = solutionModel.newForm('myForm');

To get existing form myForm:

var form = solutionModel.getForm('myForm');

To disable its navigator:

form.navigator = SM_DEFAULTS.NONE;

To clone existing form myForm to cloned form myClonedForm:

var form = solutionModel.getForm('myForm');
var clonedForm = solutionModel.cloneForm('myClonedForm', form);

To remove existing form myForm:

var success = history.removeForm('myForm');
if (success) {
	solutionModel.removeForm('myForm');
}

To revert existing form myForm to its original design-time state:

var success = history.removeForm('myForm');
if (success) {
	solutionModel.removeForm('myForm');
}

Form variables

To create a new form variable with name myFormVariable:

var formVariable = form.newFormVariable('myFormVariable', JSField.TEXT_FIELD);

To get existing form variable myFormVariable:

var formVariable = form.getFormVariable('myFormVariable');

To change its default value to abc:

formVariable.defaultValue = 'abc';

To remove existing form variable myFormVariable:

form.removeFormVariable('myFormVariable');

Form methods

To create a new form method with name myFormMethod:

var formMethod = form.newFormMethod('function myFormMethod() {controller.newRecord(); }');

To get existing form method myFormMethod:

var formMethod = form.getFormMethod('myformMethod');

To make it appear in the menu:

globalMethod.showInMenu = true;

To remove existing form method myFormMethod:

...

What it is

The Solution Model is the blueprint of your developed solution. You can modify its blueprint during runtime, but the object still needs to be actually built to become available to the user. Compare it to building a house and where certain rules apply when you want to make changes to the already built house.

For example, if you want to change the window frames of your house, you can just remove the existing frames and replace them by new ones. However, if you want to change the foundation of your house then you need to completely tear down your house, replace the foundation and then build up your house again. This same analogy also applies to the Solution Model.

In Servoy there are two separate layers; the Solution Model layer (blueprint) and the runtime layer (the built version of the blueprint). In Servoy you can change certain elements within the runtime layer without having to touch the Solution Model layer (like changing the position of a button or the font of a label). However, if these changes are not within the blueprint and the object needs to be recreated according to the blueprint, then these changes will be lost.

It's also possible to create new instances of a form within Servoy (by using the function application.createNewFormInstance()). But these are copies of the actual house, rather than copies of the blueprint? It is not possible for the Solution Model to grab the properties of these copies, but only from the original. So when you try to grab the new instance of a form by using the Solution Model, then it will retrieve the original form from which the new instance has been created and not the new instance itself.

Limitations

Even though the Solution Model allows a wide variety of objects that can be manipulated, there are some limitations. The following objects are (currently) not included:

• Aggregations
• Security
• Databases and their structure
• Solutions and modules

Functionality and basic rules

The Solution Model has certain types of functions:

With the Solution Model you can control different types of objects. Referring to these objects is done through so-called JS Objects and consist of constants, properties and/or functions.

The following list shows the objects which can be controlled by the Solution Model, its corresponding JS Object and from which JS Object it needs to be referenced from in order to use it:

Components basically work as an umbrella for all objects which are referenced from the JSForm object. By retrieving an object as a component, you can change properties which are shared by all these objects or conveniently clone the object including its referenced objects and properties.

When creating objects you need to make sure that the same object with the same name does not already exists. In this case you need to choose another name or remove the existing object.

As explained as an analogy in a previous section, some changes made with the Solution Model have such an impact that on other existing objects, that some of them need to be destroyed and recreated again.

By default, changes made by the Solution Model are not persistent and are only valid for the current session in which these changes are made.

Examples

This section shows some (simple) examples of how different objects can be controlled with the Solution Model. Per object you will find how to:

• Create an object
• Retrieve an existing object
• Change a property of an object
• Remove an existing object

Calculations

During development, calculations can be created as stored or unstored. As soon as the name of a calculation corresponds with a database column, it automatically becomes a stored calculation. The same rule applies for the Solution Model.

To create a new calculation with name myCalculation on table customers of server example_data which returns 1:

var calculation = solutionModel.newCalculation('function myCalculation() { return 1; }', JSVariable.INTEGER, 'db:/example_data/customers');

To get the existing calculation myCalculation on table customers of server example_data:

var calculation = solutionModel.getCalculation('myCalculation', 'db:/example_data/customers');

To output whether or not this calculation is a stored one:

application.output('Stored calculation: ' + calculation.isStored();

To remove existing calculation myCalculation:

solutionModel.removeCalculation('myCalculation', 'db:/example_data/customers');

Styles

To create a new stylesheet with name myStyle with a default style class for forms:

var style = solutionModel.newStyle('myStyle' 'form { background-color: transparent; }';

To get existing stylesheet myStyle:

var style = solutionModel.getStyle('myStyle')

To add a default style class for fields:

style.text += 'field { background-color: blue; }';

To remove existing stylesheet myStyle:

solutionModel.removeStyle('myStyle');

Global variables

To create a new global variable with name myGlobalVariable of type TEXT:

var globalVariable = solutionModel.newGlobalVariable('myGlobalVariable', JSVariable.TEXT);

To get existing global variable myGlobalVariable:

var globalVariable = solutionModel.getGlobalVariable('myGlobalVariable');

To change its default value to abc:

myGlobalVariable.defaultValue = 'abc';

To remove existing global variable myGlobalVariable:

solutionModel.removeGlobalVariable('myGlobalVariable');

Global methods

To create a new global method with name myGlobalMethod:

var globalMethod = solutionModel.newGlobalMethod('function myGlobalMethod() { currentcontroller.newRecord(); }');

To get existing global method myGlobalMethod:

var globalMethod = solutionModel.getGlobalMethod('myGlobalMethod');

To make it appear in the menu:

globalMethod.showInMenu = true;

To remove existing global method myGlobalMethod:

solutionModel.removeGlobalMethod('myGlobalMethod');

Forms

Forms are most commonly used with the Solution Model and have some additional functions. The following basic functions are available for this type of objects:

• Create new forms
• Get existing forms
• Clone an existing form
• Remove an existing form
• Revert an existing form to its original design-time state

To create a new form with name myForm:

var form = solutionModel.newForm('myForm');

To get existing form myForm:

var form = solutionModel.getForm('myForm');

To disable its navigator:

form.navigator = SM_DEFAULTS.NONE;

To clone existing form myForm to cloned form myClonedForm:

var form = solutionModel.getForm('myForm');
var clonedForm = solutionModel.cloneForm('myClonedForm', form);

To remove existing form myForm:

var success = history.removeForm('myForm');
if (success) {
	solutionModel.removeForm('myForm');
}

To revert existing form myForm to its original design-time state:

var success = history.removeForm('myForm');
if (success) {
	solutionModel.revertForm('myForm');
}

Form variables

To create a new form variable with name myFormVariable:

var formVariable = form.newFormVariable('myFormVariable', JSField.TEXT_FIELD);

To get existing form variable myFormVariable:

var formVariable = form.getFormVariable('myFormVariable');

To change its default value to abc:

formVariable.defaultValue = 'abc';

To remove existing form variable myFormVariable:

form.removeFormVariable('myFormVariable');

Form methods

To create a new form method with name myFormMethod:

var formMethod = form.newFormMethod('function myFormMethod() {controller.newRecord(); }');

To get existing form method myFormMethod:

var formMethod = form.getFormMethod('myformMethod');

To make it appear in the menu:

globalMethod.showInMenu = true;

To remove existing form method myFormMethod:

form.removeFormMethod('myFormMethod');

Form parts

To create a new body:

var part = form.newPart(JSPart.BODY, 20);

To retrieve the existing body part:

var part = form.getPart(JSPart.BODY);

To change its background to white:

part.background = 'white';

To remove the existing body part:

form.removePart(JSPart.BODY);

Beans

To create a tree view with name myBean:

...

form.removeButton('myButton');

Components

;

Components

Components basically work as an umbrella for all form elements. By retrieving a form element through a component, you can clone the element including its properties.

Or, If you want to change properties which are common to all elements, you can do this through components instead of having to retrieve each individual object separately.

To retrieve component with name myButton:

...

var media = solutionModel.getMedia('myMedia');

To change it its content:

media.bytes = plugins.http.getMediaData('http://servoy.com/images/headerimages/open_source.jpg');

...