Page History

{div:style=}

Wiki Markup

Div

style	display:none

DO

NOT

EDIT

THE

CONTENT

OF

THIS

PAGE

DIRECTLY

(EXCEPT

INSIDE

THE

DIV

BELOW

WITH

ID=DESCRIPTION),

UNLESS

YOU

KNOW

WHAT

YOU'RE

DOING.

THE

STRUCTURE

OF

THE

CONTENT

IS

VITAL

IN

BEING

ABLE

TO

AUTO

UPDATE

THE

CONTENT

THROUGH

THE

DOC

GENERATOR.

\\ \\ Enter additional information related to this

Enter additional information related to this 'class'

inside

the

\

{div}

macro

with

'id=description'

{div} {div:id=description}{div}\\ {table:id=|class=servoy sReturnTypes}{tr:style=height: 30px;}{th}Extends{th}{tr}{tr}{td}{span:class=sWordList}[JSComponent]{span}{td}{tr}{table}\\ {table:id=|class=servoy sSummary}{colgroup}{column:width=80px|padding=0px}{column}{column}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=2}Property Summary{th}{tr}{tbody}{tr}{td}[String]{td}{td}[#dataProviderID] The dataprovider of the component.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#displaysTags] Flag that enables or disables merging of data inside components using tags (placeholders).{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#enabled] The enable state of the component, default true.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#format] The format that should be applied when displaying data(using dataProviderID) in the label/button.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#height] The height in pixels of the component.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#labelSize] Size property for a label, values 1 to 60 correspond to header class h1 to h6{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#name] The name of the component.{td}{tr}{tbody}{tbody}{tr}{td}[JSMethod]{td}{td}[#onAction] The method that is executed when the component is clicked.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#styleClass] The name of the style class that should be applied to this component.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#text] The text that is displayed inside the component.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#visible] The visible property of the component, default true.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#width] The width in pixels of the component.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#x] The x coordinate of the component on the form.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#y] The y coordinate of the component on the form.{td}{tr}{tbody}{table}\\ {table:id=|class=servoy sSummary}{colgroup}{column:width=80px|padding=0px}{column}{column}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=2}Method Summary{th}{tr}{tbody}{tr}{td}[JSTitle]{td}{td}[#getTitle]\() Get title label for the label.{td}{tr}{tbody}{table}\\ {table:id=property|class=servoy sDetail}{colgroup}{column:width=100%|padding=0px}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=1}Property Details{th}{tr}{tbody:id=dataProviderID}{tr:id=name}{td}h6.dataProviderID{td}{tr}{tr:id=des}{td}{div:class=sIndent}The dataprovider of the component.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

Div

id	description

HTML Table

id
class	servoy sReturnTypes

Table Row (tr)

style	height: 30px;

Table Head (th)
Extends

Table Row (tr)

Table Cell (td)

Span

class	sWordList

JSComponent

HTML Table

id
class	servoy sSummary

Colgroup Tag

Column

padding	0px
width	80px

Column

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Property Summary

Table Body (tbody)

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
#dataProviderID The dataprovider of the component.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
#displaysTags Flag that enables or disables merging of data inside components using tags (placeholders).

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
#enabled The enable state of the component, default true.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
#format The format that should be applied when displaying data(using dataProviderID) in the label/button.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Number

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

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
#labelSize Size property for a label, values 1 to 60 correspond to header class h1 to h6

Table Body (tbody)

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
#name The name of the component.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
JSMethod

Table Cell (td)
#onAction The method that is executed when the component is clicked.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
#styleClass The name of the style class that should be applied to this component.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
#text The text that is displayed inside the component.

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 Body (tbody)

Table Row (tr)

Table Cell (td)
Number

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

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Number

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

HTML Table

id
class	servoy sSummary

Colgroup Tag

Column

padding	0px
width	80px

Column

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Method Summary

Table Body (tbody)

Table Row (tr)

Table Cell (td)
JSTitle

Table Cell (td)
#getTitle() Get title label for the label.

HTML Table

id	property
class	servoy sDetail

Colgroup Tag

Column

padding	0px
width	100%

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	1

Property Details

Table Body (tbody)

id	dataProviderID

Table Row (tr)

id	name

Table Cell (td)
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

String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


// Normally the dataprovider is specified when a 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	displaysTags

Table Row (tr)

id	name

Table Cell (td)
displaysTags

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Flag that enables or disables merging of data inside components using tags (placeholders).
Tags (or placeholders) are words surrounded by %%on each side. There are data tags and
standard tags. Data tags consist in names of dataproviders surrounded by%%. Standard tags
are a set of predefined tags that are made available by the system.

See the "Merging data" section for more details about tags.

The default value of this flag is "false", that is merging of data is disabled by default.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


var label = form.newLabel('You are viewing record no. %%parent_table_id%%. You are running on server %%serverURL%%.', 
					10, 10, 600, 100);
label.displaysTags = true;

...

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	enabled

Table Row (tr)

id	name

Table Cell (td)
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

Boolean

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 data(using dataProviderID) in the label/button.
Some examples are "#%", "dd-MM-yyyy", "MM-dd-yyyy", etc.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


var label = form.newLabel('', 10, 10, 100, 100);
label.format = '$#.00';

...

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

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.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

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 width: ' + field.width);
application.output('original height: ' + field.height);
field.width = 200;
field.height = 100;
application.output('modified width: ' + field.width);
application.output('modified height: ' + field.height);

...

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	labelSize

Table Row (tr)

id	name

Table Cell (td)
labelSize

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Size property for a label, values 1 to 60 correspond to header class h1 to h6

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


var label = form.newLabel('Hello', 1);
label.labelSize = 2 // corresponds to header class

...

h2

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

String

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

JSMethod

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	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

String

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.

...

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	text

Table Row (tr)

id	name

Table Cell (td)
text

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The text that is displayed inside the component.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


// In general the text is specified when creating the component.
var label = form.newLabel('Initial text', 10, 10, 100, 20);
// But it can be changed later if needed.
label.text = 'Changed text';

...

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

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

Boolean

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	width

Table Row (tr)

id	name

Table Cell (td)
width

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The width in pixels of the component.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

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 width: ' + field.width);
application.output('original height: ' + field.height);
field.width = 200;
field.height = 100;
application.output('modified width: ' + field.width);
application.output('modified height: ' + field

...

.height);

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

Number

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

Number

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)

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	getTitle

Table Row (tr)

id	name

Table Cell (td)
getTitle

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSTitle

Span

style	font-weight: bold;

getTitle

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Get title label for the label.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSTitle

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');
var label = form.newLabel('Customers', 1);
label.getTitle().text = 'Some text'
forms['someForm'].controller.show()

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Child pages

Versions Compared

Old Version 7

New Version 8

Key

dataProviderID

displaysTags

enabled

format

height

labelSize

name

onAction

styleClass

text

visible

width

x

y

getTitle