Page History

Hidden

DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY, UNLESS YOU KNOW WHAT YOU'RE DOING.		THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO EXTRACT CHANGES FROM THE PAGE AND MERGE THEM BACK INTO SERVOY SOURCE

HTML Table

class	servoy sReturnTypes

Table Row (tr)

style	height: 30px;

Table Head (th)
Return Types

Table Row (tr)

Table Cell (td)

Span

class	sWordList

ALIGNMENT

Span

class	sWordList

ANCHOR

Span

class	sWordList

CURSOR

Span

class	sWordList

DEFAULTS

Span

class	sWordList

JSButton

Span

class	sWordList

JSComponent

Span

class	sWordList

JSField

Span

class	sWordList

JSForm

Span

class	sWordList

JSLabel

Span

class	sWordList

JSMedia

Span

class	sWordList

JSMethod

Span

class	sWordList

JSPart

Span

class	sWordList

JSPortal

Span

class	sWordList

JSRelation

Span

class	sWordList

JSRelationItem

Span

class	sWordList

JSStyle

Span

class	sWordList

JSTab

Span

class	sWordList

JSTabPanel

Span

class	sWordList

JSValueList

Span

class	sWordList

JSVariable

Span

class	sWordList

MEDIAOPTION

Span

class	sWordList

PRINTSLIDING

Span

class	sWordList

SCROLLBAR

HTML Table

class	servoy sSummery

Colgroup Tag

Column

padding	0px
width	80px

Column

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Method Summery

Table Body (tbody)

Table Row (tr)

Table Cell (td)
JSComponent

Table Cell (td)
#cloneComponent(newName, component)

Table Body (tbody)

Table Row (tr)

Table Cell (td)
JSComponent

Table Cell (td)
#cloneComponent(newName, component, [newParentForm]) Makes an exact copy of the given component (JSComponent/JSField/JSLabel), gives it a new name and optionally moves it to a new parent form.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
JSForm

Table Cell (td)
#cloneForm(newName, jsForm) Makes an exact copy of the given form and gives it the new name.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
JSForm

Table Cell (td)
#getForm(name) Gets the specified form object and returns information about the form (see JSForm node).

Table Body (tbody)

Table Row (tr)

Table Cell (td)
JSForm[]

Table Cell (td)
#getForms()

Table Body (tbody)

Table Row (tr)

Table Cell (td)
JSForm[]

Table Cell (td)
#getForms(datasource)

Table Body (tbody)

Table Row (tr)

Table Cell (td)
JSForm[]

Table Cell (td)
#getForms([server], [tablename]) Get an array of forms, that are all based on datasource/servername or tablename.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
JSMethod

Table Cell (td)
#getGlobalMethod(name) Gets an existing global method by the specified name.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
JSMethod[]

Table Cell (td)
#getGlobalMethods() The list of all global methods.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
JSVariable

Table Cell (td)
#getGlobalVariable(name) Gets an existing global variable by the specified name.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
JSVariable[]

Table Cell (td)
#getGlobalVariables() Gets an array of all global variables.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
JSMedia

Table Cell (td)
#getMedia(name) Gets the specified media object; can be assigned to a button/label.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
JSMedia[]

Table Cell (td)
#getMediaList() Gets the list of all media objects.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
JSRelation

Table Cell (td)
#getRelation(name) Gets an existing relation by the specified name and returns a JSRelation Object.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
JSRelation[]

Table Cell (td)
#getRelations([primary_server_name/primary_data_source], [primary_table_name]) Gets an array of all relations; or an array of all global relations if the specified table is NULL.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
JSStyle

Table Cell (td)
#getStyle(name) Gets the style specified by the given name.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
JSValueList

Table Cell (td)
#getValueList(name) Gets an existing valuelist by the specified name and returns a JSValueList Object that can be assigned to a field.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
JSValueList[]

Table Cell (td)
#getValueLists() Gets an array of all valuelists for the currently active solution.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
JSForm

Table Cell (td)
#newForm(name, server_name\|data_source, [table_name], style, show_in_menu, width, height) Creates a new JSForm Object.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
JSMethod

Table Cell (td)
#newGlobalMethod(code) Creates a new global method with the specified code.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
JSVariable

Table Cell (td)
#newGlobalVariable(name, type) Creates a new global variable with the specified name and number type.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
JSMedia

Table Cell (td)
#newMedia(name, bytes) Creates a new media object that can be assigned to a label or a button.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
JSRelation

Table Cell (td)
#newRelation(name, primary_server_name\|primary_data_source, [primary_table_name], foreign_server_name\|foreign_data_source, [foreign_table_name], join_type) Creates a new JSRelation Object with a specified name; includes the primary datasource, optional table name, foreign datasource, optional foreign table name, and the type of join for the new relation.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
JSStyle

Table Cell (td)
#newStyle(name, content) Creates a new style with the given css content string under the given name.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
JSValueList

Table Cell (td)
#newValueList(name, type) Creates a new valuelist with the specified name and number type.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
#removeForm(name) Removes the specified form during the persistent connected client session.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
JSForm

Table Cell (td)
#revertForm(name) Reverts the specified form to the original (blueprint) version of the form; will result in an exception error if the form is not an original form.

HTML Table

id	function
class	servoy sDetail

Colgroup Tag

Column

padding	0px
width	100%

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	1

Method Details

Table Body (tbody)

id	cloneComponent
class	node

Table Row (tr)

id	name

Table Cell (td)
cloneComponent

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

JSComponent

Span

style	float: left; font-weight: bold;
id	iets

cloneComponent

Span

style	float: left;
id	iets

(newName, component, [newParentForm])

Table Row (tr)

id	des

Table Cell (td)
Makes an exact copy of the given component (JSComponent/JSField/JSLabel), gives it a new name and optionally moves it to a new parent form.

Table Row (tr)

id	prs

Table Cell (td)
Parameters {String} newName – the new name of the cloned component {JSComponent} component – the component to clone {JSForm} [newParentForm] – the new parent form

Table Row (tr)

id	ret

Table Cell (td)
Returns JSComponent – the exact copy of the given component

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// get an existing field to clone.
var field = solutionModel.getForm("formWithField").getField("fieldName");
// get the target form for the copied/cloned field
var form = solutionModel.getForm("targetForm");
// make a clone/copy of the field and re parent it to the target form.
var clone = solutionModel.cloneComponent("clonedField",field,form);
// show it
forms["targetForm"].controller.show();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	cloneForm
class	node

Table Row (tr)

id	name

Table Cell (td)
cloneForm

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

JSForm

Span

style	float: left; font-weight: bold;
id	iets

cloneForm

Span

style	float: left;
id	iets

(newName, jsForm)

Table Row (tr)

id	des

Table Cell (td)
Makes an exact copy of the given form and gives it the new name.

Table Row (tr)

id	prs

Table Cell (td)
Parameters {String} newName – the new name for the form clone {JSForm} jsForm – the form to be cloned

Table Row (tr)

id	ret

Table Cell (td)
Returns JSForm – a JSForm

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// get an existing form
var form = solutionModel.getForm("existingForm")
// make a clone/copy from it
var clone = solutionModel.cloneForm("clonedForm", form)
// add a new label to the clone
clone.newLabel("added label",50,50,80,20);
// show it
forms["clonedForm"].controller.show();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getForm
class	node

Table Row (tr)

id	name

Table Cell (td)
getForm

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

JSForm

Span

style	float: left; font-weight: bold;
id	iets

getForm

Span

style	float: left;
id	iets

(name)

Table Row (tr)

id	des

Table Cell (td)
Gets the specified form object and returns information about the form (see JSForm node).

Table Row (tr)

id	prs

Table Cell (td)
Parameters {String} name – the specified name of the form

Table Row (tr)

id	ret

Table Cell (td)
Returns JSForm – a JSForm

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var myForm = solutionModel.getForm('existingFormName');
//get the style of the form (for all other properties see JSForm node)
var styleName = myForm.styleName;

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getForms
class	node

Table Row (tr)

id	name

Table Cell (td)
getForms

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

JSForm[]

Span

style	float: left; font-weight: bold;
id	iets

getForms

Span

style	float: left;
id	iets

([server], [tablename])

Table Row (tr)

id	des

Table Cell (td)
Get an array of forms, that are all based on datasource/servername or tablename.

Table Row (tr)

id	prs

Table Cell (td)
Parameters {String} [server] – the datasource or servername {String} [tablename] – the tablename

Table Row (tr)

id	ret

Table Cell (td)
Returns JSForm[] – an array of JSForm type elements

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var forms = solutionModel.getForms(datasource)
for (var i in forms)
		application.output(forms[i].name)

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getGlobalMethod
class	node

Table Row (tr)

id	name

Table Cell (td)
getGlobalMethod

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

JSMethod

Span

style	float: left; font-weight: bold;
id	iets

getGlobalMethod

Span

style	float: left;
id	iets

(name)

Table Row (tr)

id	des

Table Cell (td)
Gets an existing global method by the specified name.

Table Row (tr)

id	prs

Table Cell (td)
Parameters {String} name – the name of the specified global method

Table Row (tr)

id	ret

Table Cell (td)
Returns JSMethod – a JSMethod

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var method = solutionModel.getGlobalMethod("nameOfGlobalMethod"); 
	if (method != null) application.output(method.code);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getGlobalMethods
class	node

Table Row (tr)

id	name

Table Cell (td)
getGlobalMethods

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

JSMethod[]

Span

style	float: left; font-weight: bold;
id	iets

getGlobalMethods

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
The list of all global methods.

Table Row (tr)

id	ret

Table Cell (td)
Returns JSMethod[] – an array of JSMethod type elements

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var methods = solutionModel.getGlobalMethods(); 
	if (methods != null)
		for (var x in methods) 
			application.output(methods[x].getName());

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getGlobalVariable
class	node

Table Row (tr)

id	name

Table Cell (td)
getGlobalVariable

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

JSVariable

Span

style	float: left; font-weight: bold;
id	iets

getGlobalVariable

Span

style	float: left;
id	iets

(name)

Table Row (tr)

id	des

Table Cell (td)
Gets an existing global variable by the specified name.

Table Row (tr)

id	prs

Table Cell (td)
Parameters {String} name – the specified name of the global variable

Table Row (tr)

id	ret

Table Cell (td)
Returns JSVariable – a JSVariable

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var globalVariable = solutionModel.getGlobalVariable('globalVariableName');
	application.output(globalVariable.name + " has the default value of " + globalVariable.defaultValue);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getGlobalVariables
class	node

Table Row (tr)

id	name

Table Cell (td)
getGlobalVariables

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

JSVariable[]

Span

style	float: left; font-weight: bold;
id	iets

getGlobalVariables

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
Gets an array of all global variables.

Table Row (tr)

id	ret

Table Cell (td)
Returns JSVariable[] – an array of JSVariable type elements

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var globalVariables = solutionModel.getGlobalVariables();
	for (var i in globalVariables)
		application.output(globalVariables[i].name + " has the default value of " + globalVariables[i].defaultValue);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getMedia
class	node

Table Row (tr)

id	name

Table Cell (td)
getMedia

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

JSMedia

Span

style	float: left; font-weight: bold;
id	iets

getMedia

Span

style	float: left;
id	iets

(name)

Table Row (tr)

id	des

Table Cell (td)
Gets the specified media object; can be assigned to a button/label.

Table Row (tr)

id	prs

Table Cell (td)
Parameters {String} name – the specified name of the media object

Table Row (tr)

id	ret

Table Cell (td)
Returns JSMedia – a JSMedia element

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var myMedia = solutionModel.getMedia('button01.gif')
//now set the imageMedia property of your label or button
//myButton.imageMedia = myMedia
// OR
//myLabel.imageMedia = myMedia

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getMediaList
class	node

Table Row (tr)

id	name

Table Cell (td)
getMediaList

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

JSMedia[]

Span

style	float: left; font-weight: bold;
id	iets

getMediaList

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
Gets the list of all media objects.

Table Row (tr)

id	ret

Table Cell (td)
Returns JSMedia[] – a list with all the media objects.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var mediaList = solutionModel.getMediaList();
	if (mediaList.length != 0 && mediaList != null) {
		for (var x in mediaList) {
			application.output(mediaList[x]);
		}
	}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getRelation
class	node

Table Row (tr)

id	name

Table Cell (td)
getRelation

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

JSRelation

Span

style	float: left; font-weight: bold;
id	iets

getRelation

Span

style	float: left;
id	iets

(name)

Table Row (tr)

id	des

Table Cell (td)
Gets an existing relation by the specified name and returns a JSRelation Object.

Table Row (tr)

id	prs

Table Cell (td)
Parameters {String} name – the specified name of the relation

Table Row (tr)

id	ret

Table Cell (td)
Returns JSRelation – a JSRelation

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var relation = solutionModel.getRelation('name');
	application.output("The primary server name is " + relation.primaryServerName);
	application.output("The primary table name is " + relation.primaryTableName); 
	application.output("The foreign table name is " + relation.foreignTableName); 
	application.output("The relation items are " + relation.getRelationItems());

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getRelations
class	node

Table Row (tr)

id	name

Table Cell (td)
getRelations

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

JSRelation[]

Span

style	float: left; font-weight: bold;
id	iets

getRelations

Span

style	float: left;
id	iets

([primary_server_name/primary_data_source], [primary_table_name])

Table Row (tr)

id	des

Table Cell (td)
Gets an array of all relations; or an array of all global relations if the specified table is NULL.

Table Row (tr)

id	prs

Table Cell (td)
Parameters [primary_server_name/primary_data_source] – the specified name of the server or datasource for the specified table [primary_table_name] – the specified name of the table

Table Row (tr)

id	ret

Table Cell (td)
Returns JSRelation[] – an array of all relations (all elements in the array are of type JSRelation)

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var relations = solutionModel.getRelations('server_name','table_name');
	if (relations.length != 0)
		for (var i in relations)
			application.output(relations[i].name);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getStyle
class	node

Table Row (tr)

id	name

Table Cell (td)
getStyle

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

JSStyle

Span

style	float: left; font-weight: bold;
id	iets

getStyle

Span

style	float: left;
id	iets

(name)

Table Row (tr)

id	des

Table Cell (td)
Gets the style specified by the given name.

Table Row (tr)

id	prs

Table Cell (td)
Parameters {String} name – the specified name of the style

Table Row (tr)

id	ret

Table Cell (td)
Returns JSStyle – a JSStyle

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var style = solutionModel.getStyle('my_existing_style')
	style.content = 'combobox { color: #0000ff;font: italic 10pt "Verdana";}'

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getValueList
class	node

Table Row (tr)

id	name

Table Cell (td)
getValueList

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

JSValueList

Span

style	float: left; font-weight: bold;
id	iets

getValueList

Span

style	float: left;
id	iets

(name)

Table Row (tr)

id	des

Table Cell (td)
Gets an existing valuelist by the specified name and returns a JSValueList Object that can be assigned to a field.

Table Row (tr)

id	prs

Table Cell (td)
Parameters {String} name – the specified name of the valuelist

Table Row (tr)

id	ret

Table Cell (td)
Returns JSValueList – a JSValueList object

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var myValueList = solutionModel.getValueList('myValueListHere')
//now set the valueList property of your field
//myField.valuelist = myValueList

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getValueLists
class	node

Table Row (tr)

id	name

Table Cell (td)
getValueLists

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

JSValueList[]

Span

style	float: left; font-weight: bold;
id	iets

getValueLists

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
Gets an array of all valuelists for the currently active solution.

Table Row (tr)

id	ret

Table Cell (td)
Returns JSValueList[] – an array of JSValueList objects

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var valueLists = solutionModel.getValueLists();
	if (valueLists != null && valueLists.length != 0)
		for (var i in valueLists)
			application.output(valueLists[i].name);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	newForm
class	node

Table Row (tr)

id	name

Table Cell (td)
newForm

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

JSForm

Span

style	float: left; font-weight: bold;
id	iets

newForm

Span

style	float: left;
id	iets

(name, server_name|data_source, [table_name], style, show_in_menu, width, height)

Table Row (tr)

id	des

Table Cell (td)

Creates a new JSForm Object.

NOTE: See the JSForm node for more information about form objects that can be added to the new form.

Table Row (tr)

id	prs

Table Cell (td)

Parameters
name – the specified name of the form
server_name|data_source – the specified name of the server or datasource for the specified table
[table_name] – the specified name of the table
style – the specified style
show_in_menu – if true show the name of the new form in the menu; or false for not showing
width – the width of the form in pixels
height – the height of the form in pixels

Table Row (tr)

id	ret

Table Cell (td)
Returns JSForm – a new JSForm object

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var myForm = solutionModel.newForm('newForm', 'myServer', 'myTable', 'myStyleName', false, 800, 600)
//now you can add stuff to the form (under JSForm node)
//add a label
myForm.newLabel('Name', 20, 20, 120, 30)
//add a "normal" text entry field
myForm.newTextField('dataProviderNameHere', 140, 20, 140,20)

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	newGlobalMethod
class	node

Table Row (tr)

id	name

Table Cell (td)
newGlobalMethod

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

JSMethod

Span

style	float: left; font-weight: bold;
id	iets

newGlobalMethod

Span

style	float: left;
id	iets

(code)

Table Row (tr)

id	des

Table Cell (td)
Creates a new global method with the specified code.

Table Row (tr)

id	prs

Table Cell (td)
Parameters {String} code – the specified code for the global method

Table Row (tr)

id	ret

Table Cell (td)
Returns JSMethod – a JSMethod object

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var method = solutionModel.newGlobalMethod('function myglobalmethod(){currentcontroller.newRecord()}')

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	newGlobalVariable
class	node

Table Row (tr)

id	name

Table Cell (td)
newGlobalVariable

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

JSVariable

Span

style	float: left; font-weight: bold;
id	iets

newGlobalVariable

Span

style	float: left;
id	iets

(name, type)

Table Row (tr)

id	des

Table Cell (td)

Creates a new global variable with the specified name and number type.

NOTE: The global variable number type is based on the value assigned from the SolutionModel-JSVariable node; for example: JSVariable.INTEGER.

Table Row (tr)

id	prs

Table Cell (td)
Parameters {String} name – the specified name for the global variable {Number} type – the specified number type for the global variable

Table Row (tr)

id	ret

Table Cell (td)
Returns JSVariable – a JSVariable object

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var myGlobalVariable = solutionModel.newGlobalVariable('newGlobalVariable',JSVariable.INTEGER); 
	myGlobalVariable.defaultValue = 12;

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	newMedia
class	node

Table Row (tr)

id	name

Table Cell (td)
newMedia

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

JSMedia

Span

style	float: left; font-weight: bold;
id	iets

newMedia

Span

style	float: left;
id	iets

(name, bytes)

Table Row (tr)

id	des

Table Cell (td)
Creates a new media object that can be assigned to a label or a button.

Table Row (tr)

id	prs

Table Cell (td)
Parameters {String} name – The name of the new media {byte[]} bytes – The content

Table Row (tr)

id	ret

Table Cell (td)
Returns JSMedia – a JSMedia object

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var myMedia = solutionModel.newMedia('button01.gif',bytes)
//now set the imageMedia property of your label or button
//myButton.imageMedia = myMedia
// OR
//myLabel.imageMedia = myMedia

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	newRelation
class	node

Table Row (tr)

id	name

Table Cell (td)
newRelation

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

JSRelation

Span

style	float: left; font-weight: bold;
id	iets

newRelation

Span

style	float: left;
id	iets

(name, primary_server_name|primary_data_source, [primary_table_name], foreign_server_name|foreign_data_source, [foreign_table_name], join_type)

Table Row (tr)

id	des

Table Cell (td)
Creates a new JSRelation Object with a specified name; includes the primary datasource, optional table name, foreign datasource, optional foreign table name, and the type of join for the new relation.

Table Row (tr)

id	prs

Table Cell (td)

Parameters
name – the specified name of the new relation
primary_server_name|primary_data_source – the specified name of the primary server or datasource
[primary_table_name] – the specified name of the primary table
foreign_server_name|foreign_data_source – the specified name of the foreign server or datasource
[foreign_table_name] – the specified name of the foreign table
join_type – the type of join for the new relation; JSRelation.INNER_JOIN, JSRelation.LEFT_OUTER_JOIN

Table Row (tr)

id	ret

Table Cell (td)
Returns JSRelation – a JSRelation object

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var rel = solutionModel.newRelation('myRelation','myPrimaryServerName','myPrimaryTableName','myForeignServerName','myForeignTableName',JSRelation.INNER_JOIN);
application.output(rel.getRelationItems());

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	newStyle
class	node

Table Row (tr)

id	name

Table Cell (td)
newStyle

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

JSStyle

Span

style	float: left; font-weight: bold;
id	iets

newStyle

Span

style	float: left;
id	iets

(name, content)

Table Row (tr)

id	des

Table Cell (td)

Creates a new style with the given css content string under the given name.

NOTE: Will throw an exception if a style with that name already exists.

Table Row (tr)

id	prs

Table Cell (td)
Parameters {String} name – the name of the new style {String} content – the css content of the new style

Table Row (tr)

id	ret

Table Cell (td)
Returns JSStyle – a JSStyle object

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var form = solutionModel.newForm('myForm','myServer','myTable',null,true,1000,800);
	if (form.transparent == false)
	{
		var style = solutionModel.newStyle('myStyle','form { background-color: yellow; }');
		style.text = style.text + 'field { background-color: blue; }';
		form.styleName = 'myStyle';
	}
	var field = form.newField('columnTextDataProvider',JSField.TEXT_FIELD,100,100,100,50);
	forms['myForm'].controller.show();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	newValueList
class	node

Table Row (tr)

id	name

Table Cell (td)
newValueList

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

JSValueList

Span

style	float: left; font-weight: bold;
id	iets

newValueList

Span

style	float: left;
id	iets

(name, type)

Table Row (tr)

id	des

Table Cell (td)
Creates a new valuelist with the specified name and number type.

Table Row (tr)

id	prs

Table Cell (td)
Parameters {String} name – the specified name for the valuelist {Number} type – the specified number type for the valuelist; may be JSValueList.CUSTOM_VALUES, JSValueList.DATABASE_VALUES, JSValueList.EMPTY_VALUE_ALWAYS, JSValueList.EMPTY_VALUE_NEVER

Table Row (tr)

id	ret

Table Cell (td)
Returns JSValueList – a JSValueList object

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var vl1 = solutionModel.newValueList("customText",JSValueList.CUSTOM_VALUES);
vl1.customValues = "customvalue1\ncustomvalue2";
var vl2 = solutionModel.newValueList("customid",JSValueList.CUSTOM_VALUES);
vl2.customValues = "customvalue1|1\ncustomvalue2|2";
var form = solutionModel.newForm("customValueListForm",controller.getDataSource(),null,true,300,300);
var combo1 = form.newComboBox("globals.text",10,10,120,20);
combo1.valuelist = vl1;
var combo2 = form.newComboBox("globals.id",10,60,120,20);
combo2.valuelist = vl2;

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	removeForm
class	node

Table Row (tr)

id	name

Table Cell (td)
removeForm

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Boolean

Span

style	float: left; font-weight: bold;
id	iets

removeForm

Span

style	float: left;
id	iets

(name)

Table Row (tr)

id	des

Table Cell (td)

Removes the specified form during the persistent connected client session.

NOTE: Make sure you call history.remove first in your Servoy method (script).

Table Row (tr)

id	prs

Table Cell (td)
Parameters {String} name – the specified name of the form to remove

Table Row (tr)

id	ret

Table Cell (td)
Returns Boolean – true is form has been removed, false if form could not be removed

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

//first remove it from the current history, to destroy any active form instance
var success = history.removeForm('myForm')
//removes the named form from this session, please make sure you called history.remove() first
if(success)
{
	solutionModel.removeForm('myForm')
}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	revertForm
class	node

Table Row (tr)

id	name

Table Cell (td)
revertForm

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

JSForm

Span

style	float: left; font-weight: bold;
id	iets

revertForm

Span

style	float: left;
id	iets

(name)

Table Row (tr)

id	des

Table Cell (td)

Reverts the specified form to the original (blueprint) version of the form; will result in an exception error if the form is not an original form.

NOTE: Make sure you call history.remove first in your Servoy method (script) or call form.controller.recreateUI() before the script ends.

Table Row (tr)

id	prs

Table Cell (td)
Parameters {String} name – the specified name of the form to revert

Table Row (tr)

id	ret

Table Cell (td)
Returns JSForm – a JSForm object

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// revert the form to the original solution form, removing any changes done to it through the solution model.
 var revertedForm = solutionModel.revertForm('myForm')
 // add a label on a random place.
 revertedForm.newLabel("MyLabel",Math.random()*100,Math.random()*100,80,20);
 // make sure that the ui is up to date.
 forms.myForm.controller.recreateUI();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Child pages

Versions Compared

Old Version 13

New Version 14

Key

cloneComponent

cloneForm

getForm

getForms

getGlobalMethod

getGlobalMethods

getGlobalVariable

getGlobalVariables

getMedia

getMediaList

getRelation

getRelations

getStyle

getValueList

getValueLists

newForm

newGlobalMethod

newGlobalVariable

newMedia

newRelation

newStyle

newValueList

removeForm

revertForm