Child pages
  • JSTextArea

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.
tbody
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#displayTypedisplayType
The type of display used by the field.
tbody
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#enabledenabled
The enable state of the component, default true.
tbody
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#formatformat
The format that should be applied when displaying the data in the component.
Table Body (tbody)
#height
The height in pixels of the component.
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
tbody
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#namename
The name of the component.
tbody
Table Row (tr)
Table Cell (td)
JSMethod
Table Cell (td)
#onActiononAction
The method that is executed when the component is clicked.
tbody
Table Row (tr)
Table Cell (td)
JSMethod
Table Cell (td)
#onDataChangeonDataChange
Method that is executed when the data in the component is successfully changed.
tbody
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#placeholderTextplaceholderText
The text that is displayed in field when the field doesn't have a text value.
tbody
Table Row (tr)
Table Cell (td)
StringBoolean
Table Cell (td)
#styleClassvisible
The name of the style class that should be applied to this component.
visible property of the component, default true.
tbody
Table Row (tr)
Table Cell (td)
JSValueListNumber
Table Cell (td)
#valuelist
The valuelist that is used by this field when displaying data.
x
The x coordinate of the component on the form.
tbody
Table Row (tr)
Table Cell (td)
BooleanNumber
Table Cell (td)
#visibley
The visible property y coordinate of the component , default trueon the form.

trtdNumber
HTML Table
id
class
servoy sSummary
tdtbody
Colgroup Tag
#width
The width in pixels of the component.
Column
padding0px
width80px

Column

tbody
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#x
The x coordinate of the component on the form.
styleheight: 30px;
Table Head (th)
colspan2
Method Summary
Table Row (tr)
Table Cell (td)
NumberJSTitle
Table Cell (td)
#y
The y coordinate of the component on the formgetTitle()
Get title label for the field or label.

HTML Table
idproperty
classservoy

...

sDetail
Colgroup Tag
Column
padding0px
width

...

100%

Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan

...

1

...

Property Details
Table Body (tbody)
iddataProviderID
Table Row (tr)

...

id

...

name
Table Cell (td)
dataProviderID

...

Table Row (tr)
iddes
Table Cell (td)
Div
class

...

padding0px
width100%
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan1
Property Details

...

iddataProviderID
Table Row (tr)
idname
Table Cell (td)
dataProviderID

...

iddes

...

classsIndent

...

sIndent
The dataprovider of the component.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String
Table Row (tr)
id

...

sam
Table Cell (td)

...

Sample
Div
classsIndent

...

Code Block

...

language

...

idsam

...

classsIndent

...

languagejavascript

...

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

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

...

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

...

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

...

Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
id

...

name
Table Row (tr)
idname
Table Cell (td)
height
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';
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
id

...

onAction
Table Row (tr)
idname
Table Cell (td)
name
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
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

...

var 

...

doNothingMethod = 

...

form.

...

newMethod('

...

function doNothing() { application.output("Doing nothing."); }');
var 

...

onClickMethod = form.

...

newMethod('

...

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

...

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

...

classlastDetailRow

...

idonDataChange
Table Row (tr)
idname
Table Cell (td)
onDataChange
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Method that is executed when the data in the component is successfully changed.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
JSMethod
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 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();

...

classlastDetailRow

...

idplaceholderText
Table Row (tr)
idname
Table Cell (td)
placeholderText
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The text that is displayed in field when the field doesn't have a text value.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

field.placeholderText = 'Search';

...

classlastDetailRow

...

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.

...

classlastDetailRow

...

idvaluelist
Table Row (tr)
idname
Table Cell (td)
valuelist
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The valuelist that is used by this field when displaying data. Can be used
with fields of type CHECKS, COMBOBOX, RADIOS and TYPE_AHEAD.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
JSValueList

...

idsam

...

classsIndent

...

languagejavascript

...

I am a button', 10, 40, 200, 20, doNothingMethod);
btn.onAction = onClickMethod;
btn.onDoubleClick = onDoubleClickMethod;
btn.onRightClick = onRightClickMethod;
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idonDataChange
Table Row (tr)
idname
Table Cell (td)
onDataChange
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Method that is executed when the data in the component is successfully changed.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
JSMethod
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 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)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
id

...

placeholderText
Table Row (tr)
idname
Table Cell (td)
visible
placeholderText
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 Cell (td)

...

Div
classsIndent

...

languagejavascript

...

The text that is displayed in field when the field doesn't have a text value.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
field.placeholderText = 'Search';
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 field or 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 field = form.newField('parent_table_text', JSField.TEXT_FIELD, 1);
field.getTitle().text = 'Parent table'
forms['someForm'].controller.show()

...

Table Row (tr)
classlastDetailRow
Table Cell (td)