Child pages
  • JSLabel

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Rev: 1381949650879

...

HTML Table
id
classservoy sSummary
Colgroup Tag
Column
padding0px
width80px

Column

Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Property Summary
tbody
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#dataProviderIDdataProviderID
The dataprovider of the component.
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#displaysTagsdisplaysTags
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)
#enabledenabled
The enable state of the component, default true.
tbody
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#formatformat
The format that should be applied when displaying data(using dataProviderID) in the label/button.
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#height
The height in pixels of the component.
Table Body (tbody)
#labelSize
labelSize
Size property for a label, values 1 to 60 correspond to header class h1 to h6
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#namename
The name of the component.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
JSMethodString
Table Cell (td)
#onActionstyleClass
The method that is executed when the component is clicked.
Table Body (tbody)
#styleClass
The name of the style class that name of the style class that should be applied to this component.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#texttext
The text that is displayed inside the component.
tbody
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#visiblevisible
The visible property of the component, default true.
tbody
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#widthx
The width in pixels x coordinate of the component on the form.
tbody
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#xy
The x y coordinate of the component on the form.

tr
HTML Table
id
Table Cell (td)
Number
Table Cell (td)
#y
The y coordinate of the component on the form.
HTML Table
servoy
idclassclassservoy sSummary
Colgroup Tag
Column
padding0px
width80px

Column

tbody
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Method Summary
Table Row (tr)
Table Cell (td)
JSTitle
Table Cell (td)
#getTitlegetTitle()
Get title label for the label.

HTML Table
idproperty
classservoy sDetail
Colgroup Tag
Column
padding0px
width100%

Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan1
Property Details
Table Body (tbody)
iddataProviderID
Table Row (tr)
idname
Table Cell (td)
dataProviderID
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The dataprovider of the component.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

...

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

Table Body (tbody)
iddisplaysTags
Table Row (tr)
idname
Table Cell (td)
displaysTags
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

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)
idret
Table Cell (td)
Returns
Div
classsIndent
Boolean
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

...

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

Table Body (tbody)
idenabled
Table Row (tr)
idname
Table Cell (td)
enabled
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The enable state of the component, default true.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Boolean
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

...

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

Table Body (tbody)
idformat
Table Row (tr)
idname
Table Cell (td)
format
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
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)
idret
Table Cell (td)
Returns
Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

...

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

...

Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
id

...

labelSize
Table Row (tr)
idname
Table Cell (td)
height
labelSize
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

...

Size property for a label, values 1 to 60 correspond to header class h1 to h6
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Number
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

...

var 

...

label = form.

...

newLabel('

...

Hello', 

...

classlastDetailRow

...

idlabelSize
Table Row (tr)
idname
Table Cell (td)
labelSize
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Size property for a label, values 1 to 60 correspond to header class h1 to h6
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Number
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

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

...

classlastDetailRow

...

idname
Table Row (tr)
idname
Table Cell (td)
name
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The name of the component. Through this name it can also accessed in methods.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

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

...

classlastDetailRow

...

idonAction
Table Row (tr)
idname
Table Cell (td)
onAction
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The method that is executed when the component is clicked.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
JSMethod

...

idsam

...

classsIndent

...

languagejavascript

...

1);
label.labelSize = 2 // corresponds to header class h2
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)

...

idstyleClass

...

idname

...

...

styleClass

...

Table Row (tr)
id

...

classsIndent

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

...

name
Table Cell (td)
name
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The name of the component. Through this name it can also accessed in methods.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

...

var form = solutionModel.newForm('

...

someForm', 'db:/example_data/parent_table', null, false, 

...

620, 300);
var 

...

label = form.

...

classlastDetailRow

...

idtext
Table Row (tr)
idname
Table Cell (td)
text

...

iddes

...

classsIndent

...

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

Table Body (tbody)
idstyleClass
Table Row (tr)
idname
Table Cell (td)
styleClass
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

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)
idret
Table Cell (td)
Returns
Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
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)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
id

...

text
Table Row (tr)
idname
Table Cell (td)
visible
text
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The

...

text that is displayed inside the component

...

.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent

...

String
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
// 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)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
id

...

visible
Table Row (tr)
idname
Table Cell (td)
width
visible
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The

...

visible property of the component, default true.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent

...

Boolean
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

...

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

Table Body (tbody)
idx
Table Row (tr)
idname
Table Cell (td)
x
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The x coordinate of the component on the form.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Number
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

...

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

Table Body (tbody)
idy
Table Row (tr)
idname
Table Cell (td)
y
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The y coordinate of the component on the form.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Number
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

...

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

HTML Table
idfunction
classservoy sDetail
Colgroup Tag
Column
padding0px
width100%

Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan1
Method Details
Table Body (tbody)
idgetTitle
Table Row (tr)
idname
Table Cell (td)
getTitle
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
JSTitle
Span
stylefont-weight: bold;
getTitle
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Get title label for the label.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
JSTitle
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

...

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

...

Table Row (tr)
classlastDetailRow
Table Cell (td)