Page History

Table Cell (td)

...

visible
The

...

visible property of the component, default true.

Table Row (tr)

Table Cell (td)

...

Table Cell (td)

...

x
The

...

x coordinate of the

...

component on the form.

...

Table Row (tr)

Table Cell (td)

...

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
#visible The visible property of the component, default true.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
#width The width in pixels of the component.

...

Table Cell (td)

...

y
The y coordinate of the component on the form.

HTML Table

id
class	servoy sSummary

Colgroup Tag

Col

width	80px

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Method Summary

Table Row (tr)

Table Cell (td)

...

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
#y The y coordinate of the component on the form.

...

padding	0px
width	80px

...

JSTitle

Table Cell (td)

...

getTitle()
Get title label for the field or label.

HTML Table

id	constant
class	servoy sDetail

Colgroup Tag

Col

colspan	2
width	100%

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

...

Constants Details

Table Body (tbody)

id	CALENDAR

Table Row (tr)

...

id

...

name

Table Cell (td)

...

id	constant
class	servoy sDetail

...

padding	0px
width	100%

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	1

Constants Details

...

id	CHECKS

Table Row (tr)

id	name

Table Cell (td)
CHECKS

...

id	des

...

class	sIndent

...

CALENDAR

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Constant for specifying the display type of a JSField. Sets the display type of the
field to

...

calendar. The field will show a

...

formatted date and will have a button which
pops up a calendar for date selection.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

...

var

...

cal = form.newField('my_table_

...

date', JSField.

...

CALENDAR, 10,

...

10, 100,

...

20);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id

...

CHECKS

Table Row (tr)

id	name

Table Cell (td)

COMBOBOX

CHECKS

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Constant for specifying the display type of a JSField. Sets the display type of the
field to

...

checkbox. The field will show a checkbox, or a list of checkboxes if the valuelist
property is also set.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

...

var vlist = solutionModel.newValueList('options', JSValueList.CUSTOM_VALUES);
vlist.customValues = "one\ntwo\nthree\nfour";
var

...

chk = form.newField('my_table_options', JSField.

...

CHECKS, 10,

...

40, 100,

...

50);

...

chk.valuelist = vlist;

...

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id

...

COMBOBOX

Table Row (tr)

id	name

Table Cell (td)

PASSWORD

COMBOBOX

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Constant for specifying the display type of a JSField. Sets the display type of the

...

field

...

to combobox.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

...

var

...

vlist =

...

solutionModel.

...

newValueList('options', JSValueList.CUSTOM_VALUES);
vlist.customValues = "one\ntwo\nthree\nfour";
var cmb = form.newField('my_table_options', JSField.

...

COMBOBOX, 10,

...

100, 100, 20);
cmb.valuelist = vlist;

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id

...

PASSWORD

Table Row (tr)

id	name

Table Cell (td)

RADIOS

PASSWORD

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Constant for specifying the display type of a JSField. Sets the display type of the

...

fiels to

...

password. The field will

...

allow the user to enter passwords, masking the typed
characters.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

...

var

...

pwd = form.newField('my_table_

...

text', JSField.

...

PASSWORD, 10,

...

250, 100,

...

20);

...

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id

...

RADIOS

Table Row (tr)

id	name

Table Cell (td)

TEXT_AREA

RADIOS

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Constant for specifying the display type of a JSField. Sets the display type of the
field to

...

radio buttons. The field will show

...

a radio button, or a list of them if
the valuelist property is also set.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

...

var

...

vlist =

...

solutionModel.

...

newValueList('

...

options',

...

JSValueList.

...

CUSTOM_VALUES);
vlist.customValues = "one\ntwo\nthree\nfour";
var radio = form.newField('my_table_options', JSField.RADIOS, 10, 280, 100, 50);
radio.valuelist = vlist;

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	TEXT_

...

AREA

Table Row (tr)

id	name

Table Cell (td)
TEXT_

...

AREA

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Constant for specifying the display type of a JSField. Sets the display type of the
field to text

...

area. The field will show

...

text on

...

multiple lines.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

...

var

...

tarea = form.newField('my_table_text', JSField.TEXT_

...

AREA, 10,

...

400, 100,

...

50);

...

Table Row (tr)

class	lastDetailRow

Table Cell (td)

...

id	property
class	servoy sDetail

...

padding	0px
width	100%

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	1

Property Details

Table Body (tbody)

id

...

TEXT_FIELD

Table Row (tr)

id	name

Table Cell (td)

dataProviderID

...

TEXT_FIELD

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

...

Constant for specifying the display type of a JSField. Sets the display type of the
field to text field. The field will show regular text on a single line.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

...

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

...

var

...

tfield = form.newField('

...

my_table_text', JSField.TEXT_FIELD, 10,

...

460, 100, 20);

...

class	lastDetailRow

...

Table Row (tr)

class	lastDetailRow

Table Cell (td)

HTML Table

id	property
class	servoy sDetail

Colgroup Tag

Col

colspan	2
width	100%

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Property Details

Table Body (tbody)

id

...

dataProviderID

Table Row (tr)

id	name

Table Cell (td)

displayType

dataProviderID

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The

...

dataprovider of

...

the

...

component.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

...

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

...

//

...

Normally

...

the

...

dataprovider is specified when

...

component is created.
var

...

field = form.newField('

...

parent_table_

...

text', JSField.

...

TEXT_FIELD, 10,

...

40, 100, 20);
// But it can be

...

modified later if needed.

...

field.dataProviderID = '

...

parent_table_

...

id';

...

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id

...

displayType

Table Row (tr)

id	name

Table Cell (td)

enabled

displayType

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The

...

type of

...

display used by the field. Can be one of CALENDAR, CHECKS,
COMBOBOX, HTML_AREA, IMAGE_MEDIA, PASSWORD, RADIOS, RTF_AREA, TEXT_AREA,
TEXT_FIELD, TYPE_AHEAD, LIST_BOX, MULTISELECT_LISTBOX or SPINNER.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

...

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// The

...

display

...

type

...

is specified when the field is created.
var cal = form.newField('

...

my_table_

...

date', JSField.

...

CALENDAR, 10, 10, 100, 20);

...

// But it can be changed if needed.
cal.dataProviderID =

...

'my_table_text';
cal.displayType = JSField.TEXT_FIELD;

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id

...

enabled

Table Row (tr)

id	name

Table Cell (td)

format

enabled

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The

...

enable state of the component, default true.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var form = solutionModel.newForm('printForm', 'db:/example_data/parent_table', null, false, 400, 300);
var field = form.newField('parent_table_text', JSField.TEXT_FIELD, 10, 10, 100, 20);
field.enabled = false;

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	format

Table Row (tr)

id	name

Table Cell (td)
format

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The format that should be applied when displaying the data in the component.
There are different options for the different dataprovider types that are assigned to this field.
For Integer fields, there is a display and an edit format, using http://docs.oracle.com/javase/7/docs/api/java/text/

...

DecimalFormat.html

...

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


var field = form.newField('my_table_number', JSField.TEXT_FIELD, 10, 10, 100, 20);
field.format = '$#.00';

...

class	lastDetailRow

...

id	height

Table Row (tr)

id	name

Table Cell (td)
height

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The height in pixels of the component.

...

and the max (string) length can be set.
For Text/String fields, there are options to force uppercase,lowercase or only numbers. Or a mask can be set that restrict the input the pattern chars can be found here: http://docs.oracle.com/javase/7/docs/api/javax/swing/text/MaskFormatter.html
A mask can have a placehoder (what is shown when there is no data) and if the data must be stored raw (without literals of the mask). A max text length can also be set to force
the max text length input, this doesn't work on mask because that max length is controlled with the mask.
For Date fields a display and edit format can be set by using a pattern from here: http://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html, you can also say this must behave like a mask (the edit format)
A mask only works with when the edit format is exactly that mask (1 char is 1 number/char), because for example MM then only 2 numbers are allowed MMM that displays the month as a string is not supported as a mask.
Some examples are "dd-MM-yyyy", "MM-dd-yyyy", etc.
The format property is also used to set the UI Converter, this means that you can convert the value object to something else before it gets set into the field, this can also result in a type change of the data.
So a string in scripting/db is converted to a integer in the ui, then you have to set an integer format.
This property is applicable only for types: TEXT_FIELD, COMBOBOX, TYPE_AHEAD, CALENDAR and SPINNER.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

...

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

...

var field = form.newField('

...

my_table_

...

number', JSField.TEXT_FIELD, 10, 10, 100, 20);

...

class	lastDetailRow

...

id	name

Table Row (tr)

id	name

Table Cell (td)
name

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The name of the component. Through this name it can also accessed in methods.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


var form = solutionModel.newForm('someForm', 'db:/example_data/parent_table', null, false, 620, 300);
var label = form.newLabel('Label', 10, 10, 150, 150);
label.name = 'myLabel'; // Give a name to the component.
forms['someForm'].controller.show()
// Now use the name to access the component.
forms['someForm'].elements['myLabel'].text = 'Updated text';

...

class	lastDetailRow

...

id	onAction

Table Row (tr)

id	name

Table Cell (td)
onAction

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The method that is executed when the component is clicked.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


var doNothingMethod = form.newMethod('function doNothing() { application.output("Doing nothing."); }');
var onClickMethod = form.newMethod('function onClick(event) { application.output("I was clicked at " + event.getTimestamp()); }');
var onDoubleClickMethod = form.newMethod('function onDoubleClick(event) { application.output("I was double-clicked at " + event.getTimestamp()); }');
var onRightClickMethod = form.newMethod('function onRightClick(event) { application.output("I was right-clicked at " + event.getTimestamp()); }');
// At creation the button has the 'doNothing' method as onClick handler, but we'll change that later.
var btn = form.newButton('I am a button', 10, 40, 200, 20, doNothingMethod);
btn.onAction = onClickMethod;
btn.onDoubleClick = onDoubleClickMethod;
btn.onRightClick = onRightClickMethod;

...

class	lastDetailRow

...

id	onDataChange

Table Row (tr)

id	name

Table Cell (td)
onDataChange

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Method that is executed when the data in the component is successfully changed.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


var form = solutionModel.newForm('someForm', 'db:/example_data/parent_table', null, false, 620, 300);
var onDataChangeMethod = form.newMethod('function onDataChange(oldValue, newValue, event) { application.output("Data changed from " + oldValue + " to " + newValue + " at " + event.getTimestamp()); }');
var field = form.newField('parent_table_text', JSField.TEXT_FIELD, 10, 10, 100, 20);
field.onDataChange = onDataChangeMethod;
forms['someForm'].controller.show();

...

class	lastDetailRow

...

id	placeholderText

Table Row (tr)

id	name

Table Cell (td)
placeholderText

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The text that is displayed in field when the field doesn't have a text value.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


field.placeholderText = 'Search';

...

class	lastDetailRow

...

id	styleClass

Table Row (tr)

id	name

Table Cell (td)
styleClass

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The name of the style class that should be applied to this component.

When defining style classes for specific component types, their names
must be prefixed according to the type of the component. For example
in order to define a class names 'fancy' for fields, in the style
definition the class must be named 'field.fancy'. If it would be
intended for labels, then it would be named 'label.fancy'. When specifying
the class name for a component, the prefix is dropped however. Thus the
field or the label will have its styleClass property set to 'fancy' only.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


var form = solutionModel.newForm('printForm', 'db:/example_data/parent_table', null, false, 400, 300);
var field = form.newField('parent_table_text', JSField.TEXT_FIELD, 10, 10, 100, 20);
var style = solutionModel.newStyle('myStyle','field.fancy { background-color: yellow; }');
form.styleName = 'myStyle'; // First set the style on the form.
field.styleClass = 'fancy'; // Then set the style class on the field.

...

class	lastDetailRow

...

field.format = '$#.00';

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	name

Table Row (tr)

id	name

Table Cell (td)
name

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The name of the component. Through this name it can also accessed in methods.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var form = solutionModel.newForm('someForm', 'db:/example_data/parent_table', null, false, 620, 300);
var label = form.newLabel('Label', 10, 10, 150, 150);
label.name = 'myLabel'; // Give a name to the component.
forms['someForm'].controller.show()
// Now use the name to access the component.
forms['someForm'].elements['myLabel'].text = 'Updated text';

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	onAction

Table Row (tr)

id	name

Table Cell (td)
onAction

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The method that is executed when the component is clicked.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var doNothingMethod = form.newMethod('function doNothing() { application.output("Doing nothing."); }');
var onClickMethod = form.newMethod('function onClick(event) { application.output("I was clicked at " + event.getTimestamp()); }');
var onDoubleClickMethod = form.newMethod('function onDoubleClick(event) { application.output("I was double-clicked at " + event.getTimestamp()); }');
var onRightClickMethod = form.newMethod('function onRightClick(event) { application.output("I was right-clicked at " + event.getTimestamp()); }');
// At creation the button has the 'doNothing' method as onClick handler, but we'll change that later.
var btn = form.newButton('I am a button', 10, 40, 200, 20, doNothingMethod);
btn.onAction = onClickMethod;
btn.onDoubleClick = onDoubleClickMethod;
btn.onRightClick = onRightClickMethod;

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	onDataChange

Table Row (tr)

id	name

Table Cell (td)

valuelist

onDataChange

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

...

Method that is

...

executed when the data in the component is successfully changed.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

...

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

...

var

...

form = solutionModel.

...

newForm('

...

someForm',

...

class	lastDetailRow

...

id	visible

Table Row (tr)

id	name

Table Cell (td)
visible

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The visible property of the component, default true.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

...

id	sam

...

class	sIndent

...

language	javascript

...

'db:/example_data/parent_table', null, false, 620, 300);
var onDataChangeMethod = form.newMethod('function onDataChange(oldValue, newValue, event) { application.output("Data changed from " + oldValue + " to " + newValue + " at " + event.getTimestamp()); }');
var field = form.newField('parent_table_text', JSField.TEXT_FIELD, 10, 10, 100, 20)

...

;
field.onDataChange = onDataChangeMethod;
forms['someForm'].controller.show();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id

...

visible

Table Row (tr)

id	name

Table Cell (td)

width

visible

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The

...

visible property of the component, default true.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

...

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language

...

javascript

var form = solutionModel.newForm('printForm', 'db:/example_data/parent_table', null, false, 400, 300);
var field = form.newField('parent_table_text', JSField.TEXT_FIELD, 10, 10, 100, 20);
field.visible = false;

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	x

Table Row (tr)

id	name

Table Cell (td)
x

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The x coordinate of the component on the form.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

...

var field = form.newField('parent_table_text', JSField.TEXT_FIELD, 10, 10, 100, 20);
application.output('original location: ' + field.x + ', ' + field.y);
field.x = 90;
field.y = 90;
application.output('changed location: ' + field.x + ', ' + field.y);

...

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	y

Table Row (tr)

id	name

Table Cell (td)
y

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The y coordinate of the component on the form.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent