Page History

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.

Div

id	description

HTML Table

id
class	servoy sReturnTypes

Colgroup Tag

Col

colspan	2
width	100%

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Extends

Table Row (tr)

Table Cell (td)

Span

class	sWordList

JSComponent

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

Property Summary

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
anchors Enables a component to stick to a specific side of form and/or to grow or shrink when a window is resized.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
background The background color of the component.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
borderType The type, color and style of border of the component.

Table Row (tr)

Table Cell (td)
Boolean

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

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
fontType The font type of the component.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
foreground The foreground color of the component.

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
formIndex The Z index of this component.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
groupID A String representing a group ID for this component.

Table Row (tr)

Table Cell (td)
Number

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

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
initialSort The default sort order for the rows displayed in the portal.

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
multiLine When set, portal rows can have a custom layout of fields, buttons, etc.

Table Row (tr)

Table Cell (td)
String

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

Table Row (tr)

Table Cell (td)
JSMethod

Table Cell (td)
onDrag The method that is triggered when (non Design Mode) dragging occurs.

Table Row (tr)

Table Cell (td)
JSMethod

Table Cell (td)
onDragEnd The method that is triggered when (non Design Mode) dragging end occurs.

Table Row (tr)

Table Cell (td)
JSMethod

Table Cell (td)
onDragOver The method that is triggered when (non Design Mode) dragging over a component occurs.

Table Row (tr)

Table Cell (td)
JSMethod

Table Cell (td)
onDrop The method that is triggered when (non Design Mode) dropping occurs.

Table Row (tr)

Table Cell (td)
JSMethod

Table Cell (td)
onRender The method that is executed when the component is rendered.

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
printSliding Enables an element to resize based on its content and/or move when printing.

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
printable Flag that tells if the component should be printed or not when the form is printed.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
relationName The name of the relationship between the table related to the currently active form and the table you want to show data from in the portal.

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
reorderable When set, the portal rows can be re-ordered by dragging the column headers.

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
resizable When set the portal rows can be resized by users.

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
rowHeight The height of each row in pixels.

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
scrollbars Scrollbar options for the vertical and horizontal scrollbars.

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
showHorizontalLines When set, the portal displays horizontal lines between the rows.

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
showVerticalLines When set the portal displays vertical lines between the columns.

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
sortable When set, users can sort the contents of the portal by clicking on the column headings.

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

Table Cell (td)
Number

Table Cell (td)
tabSeq An index that specifies the position of the component in the tab sequence.

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
transparent Flag that tells if the component is transparent or not.

Table Row (tr)

Table Cell (td)
Boolean

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

Table Row (tr)

Table Cell (td)
Number

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

Table Row (tr)

Table Cell (td)
Number

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

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

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

Table Cell (td)
getButton(name) Retrieves a button from the portal based on the name of the button.

Table Row (tr)

Table Cell (td)
JSButton[]

Table Cell (td)
getButtons() Retrieves an array with all buttons in the portal.

Table Row (tr)

Table Cell (td)
Object

Table Cell (td)
getDesignTimeProperty() Get a design-time property of an element.

Table Row (tr)

Table Cell (td)
String[]

Table Cell (td)
getDesignTimePropertyNames() Get the design-time properties of an element.

Table Row (tr)

Table Cell (td)
JSField

Table Cell (td)
getField(name) Retrieves a field from this portal based on the name of the field.

Table Row (tr)

Table Cell (td)
JSField[]

Table Cell (td)
getFields() Retrieves an array with all fields in a portal.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
getIntercellSpacing() The additional spacing between cell rows.

Table Row (tr)

Table Cell (td)
JSLabel

Table Cell (td)
getLabel(name) Retrieves a label from this portal based on the name of the label.

Table Row (tr)

Table Cell (td)
JSLabel[]

Table Cell (td)
getLabels() Retrieves all labels from the portal.

Table Row (tr)

Table Cell (td)
UUID

Table Cell (td)
getUUID() Returns the UUID of this component.

Table Row (tr)

Table Cell (td)
JSButton

Table Cell (td)
newButton(text, x, width, height, action) Creates a new button on the portal with the given text, place, size and JSMethod as the onClick action.

Table Row (tr)

Table Cell (td)
JSField

Table Cell (td)
newCalendar(dataprovider, x, width, height) Creates a new calendar field in the portal.

Table Row (tr)

Table Cell (td)
JSField

Table Cell (td)
newCheck(dataprovider, x, width, height) Creates a new checkbox field in the portal.

Table Row (tr)

Table Cell (td)
JSField

Table Cell (td)
newComboBox(dataprovider, x, width, height) Creates a new combobox field in the portal.

Table Row (tr)

Table Cell (td)
JSField

Table Cell (td)
newField(dataprovider, displaytype, x, width, height) Creates a new field on this form.

Table Row (tr)

Table Cell (td)
JSField

Table Cell (td)
newHtmlArea(dataprovider, x, width, height) Creates a new HTML Area field in the portal.

Table Row (tr)

Table Cell (td)
JSField

Table Cell (td)
newImageMedia(dataprovider, x, width, height) Creates a new Image Media field in the portal.

Table Row (tr)

Table Cell (td)
JSLabel

Table Cell (td)
newLabel(txt, x, width, height) Creates a new label on the form, with the given text, place and size.

Table Row (tr)

Table Cell (td)
JSLabel

Table Cell (td)
newLabel(text, x, width, height, action) Creates a new label on the form, with the given text, place, size and an JSMethod as the onClick action.

Table Row (tr)

Table Cell (td)
JSField

Table Cell (td)
newPassword(dataprovider, x, width, height) Creates a new password field in the portal.

Table Row (tr)

Table Cell (td)
JSField

Table Cell (td)
newRadios(dataprovider, x, width, height) Creates a new radio buttons field in the portal.

Table Row (tr)

Table Cell (td)
JSField

Table Cell (td)
newRtfArea(dataprovider, x, width, height) Creates a new RTF Area field in the portal.

Table Row (tr)

Table Cell (td)
JSField

Table Cell (td)
newTextArea(dataprovider, x, width, height) Creates a new text area field in the portal.

Table Row (tr)

Table Cell (td)
JSField

Table Cell (td)
newTextField(dataprovider, x, width, height) Creates a new text field in the portal.

Table Row (tr)

Table Cell (td)
JSField

Table Cell (td)
newTypeAhead(dataprovider, x, width, height) Creates a new type ahead field in the portal.

Table Row (tr)

Table Cell (td)
Object

Table Cell (td)
putDesignTimeProperty() Set a design-time property of an element.

Table Row (tr)

Table Cell (td)
Object

Table Cell (td)
removeDesignTimeProperty() Clear a design-time property of an element.

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
setIntercellSpacing(width, height) The additional spacing between cell rows.

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	anchors

Table Row (tr)

id	name

Table Cell (td)
anchors

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Enables a component to stick to a specific side of form and/or to
grow or shrink when a window is resized.

If opposite anchors are activated then the component with grow or
shrink with the window. For example if Top and Bottom are activated,
then the component will grow/shrink when the window is vertically
resized. If Left and Right are activated then the component
will grow/shrink when the window is horizontally resized.

If opposite anchors are not activated, then the component will
keep a constant distance from the sides of the window which
correspond to the activated anchors.

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 form = solutionModel.newForm('mediaForm', 'db:/example_data/parent_table', null, false, 400, 300);
var strechAllDirectionsLabel = form.newLabel('Strech all directions', 10, 10, 380, 280);
strechAllDirectionsLabel.background = 'red';
strechAllDirectionsLabel.anchors = SM_ANCHOR.ALL;
var strechVerticallyLabel = form.newLabel('Strech vertically', 10, 10, 190, 280);
strechVerticallyLabel.background = 'green';
strechVerticallyLabel.anchors = SM_ANCHOR.WEST | SM_ANCHOR.NORTH | SM_ANCHOR.SOUTH;
var strechHorizontallyLabel = form.newLabel('Strech horizontally', 10, 10, 380, 140);
strechHorizontallyLabel.background = 'blue';
strechHorizontallyLabel.anchors = SM_ANCHOR.NORTH | SM_ANCHOR.WEST | SM_ANCHOR.EAST;
var stickToTopLeftCornerLabel = form.newLabel('Stick to top-left corner', 10, 10, 200, 100);
stickToTopLeftCornerLabel.background = 'orange';
stickToTopLeftCornerLabel.anchors = SM_ANCHOR.NORTH | SM_ANCHOR.WEST; // This is equivalent to SM_ANCHOR.DEFAULT
var stickToBottomRightCornerLabel = form.newLabel('Stick to bottom-right corner', 190, 190, 200, 100);
stickToBottomRightCornerLabel.background = 'pink';
stickToBottomRightCornerLabel.anchors = SM_ANCHOR.SOUTH | SM_ANCHOR.EAST;

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	background

Table Row (tr)

id	name

Table Cell (td)
background

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The background color 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

// This property can be used on all types of components.
// Here it is illustrated only for labels and fields.
var greenLabel = form.newLabel('Green',10,10,100,50);
greenLabel.background = 'green'; // Use generic names for colors.
var redField = form.newField('parent_table_text',JSField.TEXT_FIELD,10,110,100,30);
redField.background = '#FF0000'; // Use RGB codes for colors.

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	borderType

Table Row (tr)

id	name

Table Cell (td)
borderType

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The type, color and style of border 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

//HINT: To know exactly the notation of this property set it in the designer and then read it once out through the solution model.
var field = form.newField('my_table_text', JSField.TEXT_FIELD, 10, 10, 100, 20);
field.borderType = solutionModel.createLineBorder(1,'#ff0000');

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	fontType

Table Row (tr)

id	name

Table Cell (td)
fontType

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The font type 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

var label = form.newLabel('Text here', 10, 50, 100, 20);
label.fontType = solutionModel.createFont('Times New Roman',1,14);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	foreground

Table Row (tr)

id	name

Table Cell (td)
foreground

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The foreground color 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

// This property can be used on all types of components.
// Here it is illustrated only for labels and fields.
var labelWithBlueText = form.newLabel('Blue text', 10, 10, 100, 30);
labelWithBlueText.foreground = 'blue'; // Use generic names for colors.
var fieldWithYellowText = form.newField('parent_table_text', JSField.TEXT_FIELD, 10, 50, 100, 20);
fieldWithYellowText.foreground = '#FFFF00'; // Use RGB codes for colors.

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	formIndex

Table Row (tr)

id	name

Table Cell (td)
formIndex

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The Z index of this component. If two components overlap,
then the component with higher Z index is displayed above
the component with lower Z index.

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 labelBelow = form.newLabel('Green', 10, 10, 100, 50);
labelBelow.background = 'green';
labelBelow.formIndex = 10;
var fieldAbove = form.newField('parent_table_text', JSField.TEXT_FIELD, 10, 10, 100, 30);
fieldAbove.background = '#FF0000';
fieldAbove.formIndex = 20;

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	groupID

Table Row (tr)

id	name

Table Cell (td)
groupID

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

A String representing a group ID for this component. If several
components have the same group ID then they belong to the same
group of components. Using the group itself, all components can
be disabled/enabled or made invisible/visible.
The group id should be a javascript compatible identifier to allow access of the group in scripting.

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, 400, 300);
var label = form.newLabel('Green', 10, 10, 100, 20);
var field = form.newField('parent_table_text', JSField.TEXT_FIELD, 10, 40, 100, 20);
label.groupID = 'someGroup';
field.groupID = 'someGroup';
forms['someForm'].elements.someGroup.enabled = false;

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	initialSort

Table Row (tr)

id	name

Table Cell (td)
initialSort

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The default sort order for the rows displayed in the portal.

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 childrenPortal = form.newPortal('pp',rel,10,10,620,460);
childrenPortal.newTextField('child_table_id', 0, 100, 20);
childrenPortal.newTextField('child_table_text',100,100,20);
childrenPortal.newTextField('child_table_parent_id', 200, 100, 20);
childrenPortal.initialSort = 'child_table_text desc';

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	multiLine

Table Row (tr)

id	name

Table Cell (td)
multiLine

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

When set, portal rows can have a custom layout of fields, buttons, etc. displayed for each
matching row (rather than the default "grid").

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 childrenPortal = form.newPortal('pp',rel,10,10,620,460);
// Set the fields some distance apart horizontally. By default this distance
// is ignored and the components are put in a grid.
var idField = childrenPortal.newTextField('child_table_id', 0, 100, 20);
idField.background = 'yellow';
var textField = childrenPortal.newTextField('child_table_text',150,100,20);
textField.background = 'green';
var parentIdField = childrenPortal.newTextField('child_table_parent_id', 300, 100, 20);
parentIdField.background = 'orange';
// Disable the grid placing of components, and make the distance between components
// become active.
childrenPortal.multiLine = true;

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	onDrag

Table Row (tr)

id	name

Table Cell (td)
onDrag

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The method that is triggered when (non Design Mode) dragging occurs.

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

form.onDrag = form.newMethod('function onDrag(event) { application.output("onDrag intercepted from " + event.getSource()); }');
form.onDragEnd = form.newMethod('function onDragEnd(event) { application.output("onDragEnd intercepted from " + event.getSource()); }');
form.onDragOver = form.newMethod('function onDragOver(event) { application.output("onDragOver intercepted from " + event.getSource()); }');
form.onDrop = form.newMethod('function onDrop(event) { application.output("onDrop intercepted from " + event.getSource()); }');

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	onDragEnd

Table Row (tr)

id	name

Table Cell (td)
onDragEnd

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The method that is triggered when (non Design Mode) dragging end occurs.

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

form.onDrag = form.newMethod('function onDrag(event) { application.output("onDrag intercepted from " + event.getSource()); }');
form.onDragEnd = form.newMethod('function onDragEnd(event) { application.output("onDragEnd intercepted from " + event.getSource()); }');
form.onDragOver = form.newMethod('function onDragOver(event) { application.output("onDragOver intercepted from " + event.getSource()); }');
form.onDrop = form.newMethod('function onDrop(event) { application.output("onDrop intercepted from " + event.getSource()); }');

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	onDragOver

Table Row (tr)

id	name

Table Cell (td)
onDragOver

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The method that is triggered when (non Design Mode) dragging over a component occurs.

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

form.onDrag = form.newMethod('function onDrag(event) { application.output("onDrag intercepted from " + event.getSource()); }');
form.onDragEnd = form.newMethod('function onDragEnd(event) { application.output("onDragEnd intercepted from " + event.getSource()); }');
form.onDragOver = form.newMethod('function onDragOver(event) { application.output("onDragOver intercepted from " + event.getSource()); }');
form.onDrop = form.newMethod('function onDrop(event) { application.output("onDrop intercepted from " + event.getSource()); }');

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	onDrop

Table Row (tr)

id	name

Table Cell (td)
onDrop

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The method that is triggered when (non Design Mode) dropping occurs.

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

form.onDrag = form.newMethod('function onDrag(event) { application.output("onDrag intercepted from " + event.getSource()); }');
form.onDragEnd = form.newMethod('function onDragEnd(event) { application.output("onDragEnd intercepted from " + event.getSource()); }');
form.onDragOver = form.newMethod('function onDragOver(event) { application.output("onDragOver intercepted from " + event.getSource()); }');
form.onDrop = form.newMethod('function onDrop(event) { application.output("onDrop intercepted from " + event.getSource()); }');

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	onRender

Table Row (tr)

id	name

Table Cell (td)
onRender

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The method that is executed when the component is rendered.

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

portal.onRender = form.newMethod('function onRender(event) { event.getElement().bgcolor = \'#00ff00\' }');

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	printSliding

Table Row (tr)

id	name

Table Cell (td)
printSliding

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Enables an element to resize based on its content and/or move when printing.
The component can move horizontally or vertically and can grow or shrink in
height and width, based on its content and the content of neighboring
components.

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 form = solutionModel.newForm('printForm', 'db:/example_data/parent_table', null, false, 400, 300);
var slidingLabel = form.newLabel('Some long text here', 10, 10, 5, 5);
slidingLabel.printSliding = SM_PRINT_SLIDING.GROW_HEIGHT | SM_PRINT_SLIDING.GROW_WIDTH;
slidingLabel.background = 'gray';
forms['printForm'].controller.showPrintPreview();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	printable

Table Row (tr)

id	name

Table Cell (td)
printable

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Flag that tells if the component should be printed or not when the form is printed.

By default components are printable.

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 printedField = form.newField('parent_table_text', JSField.TEXT_FIELD, 10, 10, 100, 20);
var notPrintedField = form.newField('parent_table_id', JSField.TEXT_FIELD, 10, 40, 100, 20);
notPrintedField.printable = false; // This field won't show up in print preview and won't be printed.
forms['printForm'].controller.showPrintPreview()

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	relationName

Table Row (tr)

id	name

Table Cell (td)
relationName

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The name of the relationship between the table related to the currently active
form and the table you want to show data from in the portal.

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

// Create the portal based on one relation.
var childrenPortal = form.newPortal('pp', 'parent_to_child', 10, 10, 620, 460);
var idField = childrenPortal.newTextField('child_table_id', 0, 100, 20);
var textField = childrenPortal.newTextField('child_table_text',150,100,20);
var parentIdField = childrenPortal.newTextField('child_table_parent_id', 300, 100, 20);
// Now make the portal be based on another relation.
childrenPortal.relationName = 'parent_to_smaller_children';

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	reorderable

Table Row (tr)

id	name

Table Cell (td)
reorderable

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

When set, the portal rows can be re-ordered by dragging the column headers.

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 childrenPortal = form.newPortal('pp', 'parent_to_child', 10, 10, 620, 460);
childrenPortal.newTextField('child_table_id', 0, 100, 20);
childrenPortal.newTextField('child_table_text',150,100,20);
childrenPortal.newTextField('child_table_parent_id', 300, 100, 20);
childrenPortal.reorderable = true;

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	resizable

Table Row (tr)

id	name

Table Cell (td)
resizable

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

When set the portal rows can be resized by users.

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 childrenPortal = form.newPortal('pp', 'parent_to_child', 10, 10, 620, 460);
childrenPortal.newTextField('child_table_id', 0, 100, 20);
childrenPortal.newTextField('child_table_text',150,100,20);
childrenPortal.newTextField('child_table_parent_id', 300, 100, 20);
// Make the columns resizable. By default they are not resizable.
childrenPortal.resizable = true;

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	rowHeight

Table Row (tr)

id	name

Table Cell (td)
rowHeight

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The height of each row in pixels. If 0 or not set, the height defaults to 10.

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 childrenPortal = form.newPortal('pp', 'parent_to_child', 10, 10, 620, 460);
childrenPortal.newTextField('child_table_id', 0, 100, 20);
childrenPortal.newTextField('child_table_text',150,100,20);
childrenPortal.newTextField('child_table_parent_id', 300, 100, 20);
childrenPortal.rowHeight = 30;

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	scrollbars

Table Row (tr)

id	name

Table Cell (td)
scrollbars

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Scrollbar options for the vertical and horizontal scrollbars. Each of the
vertical and horizontal scrollbars can be configured to display all the time,
to display only when needed or to never display.

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 noScrollbars = form.newField('my_table_text', JSField.TEXT_AREA, 10, 10, 100, 100);
noScrollbars.scrollbars = SM_SCROLLBAR.HORIZONTAL_SCROLLBAR_NEVER | SM_SCROLLBAR.VERTICAL_SCROLLBAR_NEVER;
var neededScrollbars = form.newField('my_table_text', JSField.TEXT_AREA, 120, 10, 100, 100);
neededScrollbars.scrollbars = SM_SCROLLBAR.HORIZONTAL_SCROLLBAR_AS_NEEDED | SM_SCROLLBAR.VERTICAL_SCROLLBAR_AS_NEEDED;
var alwaysScrollbars = form.newField('my_table_text', JSField.TEXT_AREA, 230, 10, 100, 100);
alwaysScrollbars.scrollbars = SM_SCROLLBAR.HORIZONTAL_SCROLLBAR_ALWAYS | SM_SCROLLBAR.VERTICAL_SCROLLBAR_ALWAYS;

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	showHorizontalLines

Table Row (tr)

id	name

Table Cell (td)
showHorizontalLines

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

When set, the portal displays horizontal lines between the rows.

NOTE:
In a multi-line portal, a horizontal line is only displayed
in the selected row; to display a horizontal line in all rows, add a
line to the portal.

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 childrenPortal = form.newPortal('pp', 'parent_to_child', 10, 10, 620, 460);
childrenPortal.newTextField('child_table_id', 0, 100, 20);
childrenPortal.newTextField('child_table_text',150,100,20);
childrenPortal.newTextField('child_table_parent_id', 300, 100, 20);
childrenPortal.showHorizontalLines = true;
childrenPortal.showVerticalLines = true;

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	showVerticalLines

Table Row (tr)

id	name

Table Cell (td)
showVerticalLines

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

When set the portal displays vertical lines between the columns.

NOTE:
In a multi-line portal, a vertical line is only displayed
in the selected row; to display a vertical line in all rows, add
a line to the portal.

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 childrenPortal = form.newPortal('pp', 'parent_to_child', 10, 10, 620, 460);
childrenPortal.newTextField('child_table_id', 0, 100, 20);
childrenPortal.newTextField('child_table_text',150,100,20);
childrenPortal.newTextField('child_table_parent_id', 300, 100, 20);
childrenPortal.showHorizontalLines = true;
childrenPortal.showVerticalLines = true;

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	sortable

Table Row (tr)

id	name

Table Cell (td)
sortable

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

When set, users can sort the contents of the portal by clicking on the column headings.

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 childrenPortal = form.newPortal('pp', 'parent_to_child', 10, 10, 620, 460);
childrenPortal.newTextField('child_table_id', 0, 100, 20);
childrenPortal.newTextField('child_table_text',150,100,20);
childrenPortal.newTextField('child_table_parent_id', 300, 100, 20);
childrenPortal.sortable = true;

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	tabSeq

Table Row (tr)

id	name

Table Cell (td)
tabSeq

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

An index that specifies the position of the component in the tab sequence. The components
are put into the tab sequence in increasing order of this property. A value of 0 means
to use the default mechanism of building the tab sequence (based on their location on the form).
A value of -2 means to remove the component from the tab sequence.

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

// Create three fields. Based on how they are placed, by default they will come one
// after another in the tab sequence.
var fieldOne = form.newField('parent_table_id', JSField.TEXT_FIELD, 10, 10, 100, 20);
var fieldTwo = form.newField('parent_table_text', JSField.TEXT_FIELD, 10, 40, 100, 20);
var fieldThree = form.newField('parent_table_id', JSField.TEXT_FIELD, 10, 70, 100, 20);
// Set the third field come before the first in the tab sequence, and remove the
// second field from the tab sequence.
fieldOne.tabSeq = 2;
fieldTwo.tabSeq = SM_DEFAULTS.IGNORE;
fieldThree.tabSeq = 1;

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	transparent

Table Row (tr)

id	name

Table Cell (td)
transparent

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Flag that tells if the component is transparent or not.

The default value is "false", that is the components
are not transparent.

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

// Load an image from disk an create a Media object based on it.
var imageBytes = plugins.file.readFile('d:/ball.jpg');
var media = solutionModel.newMedia('ball.jpg', imageBytes);
// Put on the form a label with the image.
var image = form.newLabel('', 10, 10, 100, 100);
image.imageMedia = media;
// Put two fields over the image. The second one will be transparent and the
// image will shine through.
var nonTransparentField = form.newField('parent_table_text', JSField.TEXT_FIELD, 10, 20, 100, 20);
var transparentField = form.newField('parent_table_text', JSField.TEXT_FIELD, 10, 50, 100, 20);
transparentField.transparent = true;

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

Col

colspan	2
width	100%

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Method Details

Table Body (tbody)

id	getButton-String

Table Row (tr)

id	name

Table Cell (td)
getButton

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSButton

Span

style	font-weight: bold;

getButton

Span
(name)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Retrieves a button from the portal based on the name of the button.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} name - The name of the button to retrieve.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSButton - A JSButton instance that corresponds to the button with the specified name.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var clickMethod = form.newMethod('function clickMe() { application.output("I was clicked!"); }');
var childrenPortal = form.newPortal('pp', 'parent_to_child', 10, 10, 620, 460);
var btn = childrenPortal.newButton('Click me!', 400, 100, 20, clickMethod);
btn.name = 'clickMeBtn'; // Give a name to the button, so we can retrieve it by name later.
// Retrieve the button by name and do something with it.
var btnBack = childrenPortal.getButton('clickMeBtn');
btnBack.background = 'yellow';
// Retrieve the button through the array of all buttons and do something with it.
var allButtons = childrenPortal.getButtons();
var btnBackAgain = allButtons[0];
btnBackAgain.foreground = 'red';

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getButtons

Table Row (tr)

id	name

Table Cell (td)
getButtons

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSButton[]

Span

style	font-weight: bold;

getButtons

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Retrieves an array with all buttons in the portal.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSButton[] - An array with all buttons in the portal.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var clickMethod = form.newMethod('function clickMe() { application.output("I was clicked!"); }');
var childrenPortal = form.newPortal('pp', 'parent_to_child', 10, 10, 620, 460);
var btn = childrenPortal.newButton('Click me!', 400, 100, 20, clickMethod);
btn.name = 'clickMeBtn'; // Give a name to the button, so we can retrieve it by name later.
// Retrieve the button by name and do something with it.
var btnBack = childrenPortal.getButton('clickMeBtn');
btnBack.background = 'yellow';
// Retrieve the button through the array of all buttons and do something with it.
var allButtons = childrenPortal.getButtons();
var btnBackAgain = allButtons[0];
btnBackAgain.foreground = 'red';

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getDesignTimeProperty

Table Row (tr)

id	name

Table Cell (td)
getDesignTimeProperty

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Object

Span

style	font-weight: bold;

getDesignTimeProperty

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Get a design-time property of an element.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Object

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var frm = solutionModel.getForm('orders')
var fld = frm.getField('fld')
var prop = fld.getDesignTimeProperty('myprop')

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getDesignTimePropertyNames

Table Row (tr)

id	name

Table Cell (td)
getDesignTimePropertyNames

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String[]

Span

style	font-weight: bold;

getDesignTimePropertyNames

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Get the design-time properties of an element.

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 frm = solutionModel.getForm('orders')
var fld = frm.getField('fld')
var propNames = fld.getDesignTimePropertyNames()

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getField-String

Table Row (tr)

id	name

Table Cell (td)
getField

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSField

Span

style	font-weight: bold;

getField

Span
(name)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Retrieves a field from this portal based on the name of the field.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} name - The name of the field to retrieve.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSField - A JSField instance corresponding to the field with the specified name.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var childrenPortal = form.newPortal('pp', 'parent_to_my_table', 10, 10, 1180, 780);
var cal = childrenPortal.newField('my_table_date', JSField.CALENDAR, 0, 60, 20);
var tfield = childrenPortal.newField('my_table_text', JSField.TEXT_FIELD, 60, 60, 20);
tfield.name = 'textField'; // Give a name to the field so we can retrieve it later by name.
// Retrieve the text field by its name and do something with it.
var textFieldBack = childrenPortal.getField('textField');
textFieldBack.background = 'yellow';
// Retrieve the calendar field through the array of all fields and do something with it.
var allFields = childrenPortal.getFields();
var calFieldBack = allFields[0];
calFieldBack.foreground = 'red';

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getFields

Table Row (tr)

id	name

Table Cell (td)
getFields

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSField[]

Span

style	font-weight: bold;

getFields

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Retrieves an array with all fields in a portal.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSField[] - An array with JSField instances corresponding to all fields in the portal.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var childrenPortal = form.newPortal('pp', 'parent_to_my_table', 10, 10, 1180, 780);
var cal = childrenPortal.newField('my_table_date', JSField.CALENDAR, 0, 60, 20);
var tfield = childrenPortal.newField('my_table_text', JSField.TEXT_FIELD, 60, 60, 20);
tfield.name = 'textField'; // Give a name to the field so we can retrieve it later by name.
// Retrieve the text field by its name and do something with it.
var textFieldBack = childrenPortal.getField('textField');
textFieldBack.background = 'yellow';
// Retrieve the calendar field through the array of all fields and do something with it.
var allFields = childrenPortal.getFields();
var calFieldBack = allFields[0];
calFieldBack.foreground = 'red';

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getIntercellSpacing

Table Row (tr)

id	name

Table Cell (td)
getIntercellSpacing

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

getIntercellSpacing

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The additional spacing between cell rows. Is composed from the horizontal spacing
and the vertical spacing.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String - A java.awt.Dimension object holding the horizontal and vertical intercell spacing.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var spacing = childrenPortal.getIntercellSpacing();
application.output("horizontal spacing: " + spacing.width);
application.output("vertical spacing: " + spacing.height);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getLabel-String

Table Row (tr)

id	name

Table Cell (td)
getLabel

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSLabel

Span

style	font-weight: bold;

getLabel

Span
(name)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Retrieves a label from this portal based on the name of the label.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} name - The name of the label to retrieve.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSLabel - A JSLabel instance corresponding to the label with the specified name.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var calLabel = childrenPortal.newLabel('Date', 120, 60, 20);
var textLabel = childrenPortal.newLabel('Text', 180, 60, 20);
textLabel.name = 'textLabel'; // Give a name to this label, so we can retrieve it by name.
// Retrieve the second label by name.
var textLabelBack = childrenPortal.getLabel('textLabel');
textLabelBack.background = 'yellow';
// Retrieve the first label through the array of all labels.
var allLabels = childrenPortal.getLabels();
var calLabelBack = allLabels[0];
calLabelBack.foreground = 'red';

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getLabels

Table Row (tr)

id	name

Table Cell (td)
getLabels

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSLabel[]

Span

style	font-weight: bold;

getLabels

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Retrieves all labels from the portal.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSLabel[] - An array of JSLabel instances corresponding to all labels in the portal.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var calLabel = childrenPortal.newLabel('Date', 120, 60, 20);
var textLabel = childrenPortal.newLabel('Text', 180, 60, 20);
textLabel.name = 'textLabel'; // Give a name to this label, so we can retrieve it by name.
// Retrieve the second label by name.
var textLabelBack = childrenPortal.getLabel('textLabel');
textLabelBack.background = 'yellow';
// Retrieve the first label through the array of all labels.
var allLabels = childrenPortal.getLabels();
var calLabelBack = allLabels[0];
calLabelBack.foreground = 'red';

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getUUID

Table Row (tr)

id	name

Table Cell (td)
getUUID

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

UUID

Span

style	font-weight: bold;

getUUID

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns the UUID of this component.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

UUID

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var button_uuid = solutionModel.getForm("my_form").getButton("my_button").getUUID();
application.output(button_uuid.toString());

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	newButton-String_Number_Number_Number_Object

Table Row (tr)

id	name

Table Cell (td)
newButton

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSButton

Span

style	font-weight: bold;

newButton

Span
(text, x, width, height, action)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Creates a new button on the portal with the given text, place, size and JSMethod as the onClick action.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} text - The text to be displayed on the button.
{Number} x - The x coordinate of the button. If the portal does not have the "multiLine" property set, then the x coordinates are used only for determining the order of the columns in the grid. If the portal has the "multiLine" property set, then the components are actually displayed at the specified coordinates.
{Number} width - The width of the button.
{Number} height - The height of the button. In a portal the height of all components is set to the height of the first component, unless the "multiLine" property is set.
{Object} action - The JSMethod object that should be executed when the button is clicked.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSButton - A JSButton instance representing the newly created button.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var clickMethod = form.newMethod('function clickMe() { application.output("I was clicked!"); }');
var childrenPortal = form.newPortal('pp', 'parent_to_child', 10, 10, 620, 460);
childrenPortal.newButton('Click me!', 400, 100, 20, clickMethod);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	newCalendar-Object_Number_Number_Number

Table Row (tr)

id	name

Table Cell (td)
newCalendar

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSField

Span

style	font-weight: bold;

newCalendar

Span
(dataprovider, x, width, height)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Creates a new calendar field in the portal. It is equivalent to calling "newField"
with the type JSField.CALENDAR.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Object} dataprovider - The data provider for this field. Can be either a column name, or an instance of JSVariable.
{Number} x - The x coordinate of the field. If the portal does not have the "multiLine" property set, then the x coordinates are used only for determining the order of the columns in the grid. If the portal has the "multiLine" property set, then the components are actually displayed at the specified coordinates.
{Number} width - The width of the field.
{Number} height - The height of the field. In a portal the height of all components is set to the height of the first component, unless the "multiLine" property is set.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSField - A JSField instance that corresponds to the newly created calendar.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var childrenPortal = form.newPortal('pp', 'parent_to_my_table', 10, 10, 1180, 780);
var cal = childrenPortal.newCalendar('my_table_date', 0, 60, 20);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	newCheck-Object_Number_Number_Number

Table Row (tr)

id	name

Table Cell (td)
newCheck

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSField

Span

style	font-weight: bold;

newCheck

Span
(dataprovider, x, width, height)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Creates a new checkbox field in the portal. It is equivalent to calling "newField"
with the type JSField.CHECKS.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Object} dataprovider - The data provider for this field. Can be either a column name, or an instance of JSVariable.
{Number} x - The x coordinate of the field. If the portal does not have the "multiLine" property set, then the x coordinates are used only for determining the order of the columns in the grid. If the portal has the "multiLine" property set, then the components are actually displayed at the specified coordinates.
{Number} width - The width of the field.
{Number} height - The height of the field. In a portal the height of all components is set to the height of the first component, unless the "multiLine" property is set.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSField - A JSField instance that corresponds to the newly created checkbox field.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var childrenPortal = form.newPortal('pp', 'parent_to_my_table', 10, 10, 1180, 780);
var vlist = solutionModel.newValueList('options', JSValueList.CUSTOM_VALUES);
vlist.customValues = "one\ntwo\nthree\nfour";
var chk = childrenPortal.newCheck('my_table_options', 60, 60, 50);
chk.valuelist = vlist;

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	newComboBox-Object_Number_Number_Number

Table Row (tr)

id	name

Table Cell (td)
newComboBox

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSField

Span

style	font-weight: bold;

newComboBox

Span
(dataprovider, x, width, height)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Creates a new combobox field in the portal. It is equivalent to calling "newField"
with the type JSField.COMBOBOX.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Object} dataprovider - The data provider for this field. Can be either a column name, or an instance of JSVariable.
{Number} x - The x coordinate of the field. If the portal does not have the "multiLine" property set, then the x coordinates are used only for determining the order of the columns in the grid. If the portal has the "multiLine" property set, then the components are actually displayed at the specified coordinates.
{Number} width - The width of the field.
{Number} height - The height of the field. In a portal the height of all components is set to the height of the first component, unless the "multiLine" property is set.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSField - A JSField instance that corresponds to the newly created combobox field.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var childrenPortal = form.newPortal('pp', 'parent_to_my_table', 10, 10, 1180, 780);
var vlist = solutionModel.newValueList('options', JSValueList.CUSTOM_VALUES);
vlist.customValues = "one\ntwo\nthree\nfour";
var cmb = childrenPortal.newComboBox('my_table_options', 120, 160, 20);
cmb.valuelist = vlist;

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	newField-Object_Number_Number_Number_Number

Table Row (tr)

id	name

Table Cell (td)
newField

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSField

Span

style	font-weight: bold;

newField

Span
(dataprovider, displaytype, x, width, height)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Creates a new field on this form. The type of the field is specified by
using one of the JSField constants like JSField.TEXT_FIELD.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Object} dataprovider - The data provider for this field. Can be either a column name, or an instance of JSVariable.
{Number} displaytype - The display type of the field. Use constants from JSField for this parameter.
{Number} x - The x coordinate of the field. If the portal does not have the "multiLine" property set, then the x coordinates are used only for determining the order of the columns in the grid. If the portal has the "multiLine" property set, then the components are actually displayed at the specified coordinates.
{Number} width - The width of the field.
{Number} height - The height of the field. In a portal the height of all components is set to the height of the first component, unless the "multiLine" property is set.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSField - A JSField instance that corresponds to the newly created field.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var childrenPortal = form.newPortal('pp', 'parent_to_my_table', 10, 10, 1180, 780);

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

var cal = childrenPortal.newField('my_table_date', JSField.CALENDAR, 0, 60, 20);
var chk = childrenPortal.newField('my_table_options', JSField.CHECKS, 60, 60, 50);
chk.valuelist = vlist;
var cmb = childrenPortal.newField('my_table_options', JSField.COMBOBOX, 120, 160, 20);
cmb.valuelist = vlist;
var html = childrenPortal.newField('my_table_html', JSField.HTML_AREA, 180, 60, 50);
var img = childrenPortal.newField('my_table_image', JSField.IMAGE_MEDIA, 240, 60, 50);
var pwd = childrenPortal.newField('my_table_text', JSField.PASSWORD, 300, 60, 20);
var radio = childrenPortal.newField('my_table_options', JSField.RADIOS, 360, 60, 50);
radio.valuelist = vlist;
var rtf = childrenPortal.newField('my_table_rtf', JSField.RTF_AREA, 420, 60, 50);
var tarea = childrenPortal.newField('my_table_text', JSField.TEXT_AREA, 480, 60, 50);
var tfield = childrenPortal.newField('my_table_text', JSField.TEXT_FIELD, 540, 60, 20);
var tahead = childrenPortal.newField('my_table_text', JSField.TYPE_AHEAD, 600, 60, 20);
tahead.valuelist = vlist;

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	newHtmlArea-Object_Number_Number_Number

Table Row (tr)

id	name

Table Cell (td)
newHtmlArea

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSField

Span

style	font-weight: bold;

newHtmlArea

Span
(dataprovider, x, width, height)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Creates a new HTML Area field in the portal. It is equivalent to calling "newField"
with the type JSField.HTML_AREA.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Object} dataprovider - The data provider for this field. Can be either a column name, or an instance of JSVariable.
{Number} x - The x coordinate of the field. If the portal does not have the "multiLine" property set, then the x coordinates are used only for determining the order of the columns in the grid. If the portal has the "multiLine" property set, then the components are actually displayed at the specified coordinates.
{Number} width - The width of the field.
{Number} height - The height of the field. In a portal the height of all components is set to the height of the first component, unless the "multiLine" property is set.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSField - A JSField instance that corresponds to the newly created HTML Area field.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var childrenPortal = form.newPortal('pp', 'parent_to_my_table', 10, 10, 1180, 780);
var html = childrenPortal.newHtmlArea('my_table_html', 180, 60, 50);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	newImageMedia-Object_Number_Number_Number

Table Row (tr)

id	name

Table Cell (td)
newImageMedia

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSField

Span

style	font-weight: bold;

newImageMedia

Span
(dataprovider, x, width, height)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Creates a new Image Media field in the portal. It is equivalent to calling "newField"
with the type JSField.IMAGE_MEDIA.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Object} dataprovider - The data provider for this field. Can be either a column name, or an instance of JSVariable.
{Number} x - The x coordinate of the field. If the portal does not have the "multiLine" property set, then the x coordinates are used only for determining the order of the columns in the grid. If the portal has the "multiLine" property set, then the components are actually displayed at the specified coordinates.
{Number} width - The width of the field.
{Number} height - The height of the field. In a portal the height of all components is set to the height of the first component, unless the "multiLine" property is set.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSField - A JSField instance that corresponds to the newly created Image Media field.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var childrenPortal = form.newPortal('pp', 'parent_to_my_table', 10, 10, 1180, 780);
var img = childrenPortal.newImageMedia('my_table_image', 240, 60, 50);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	newLabel-String_Number_Number_Number

Table Row (tr)

id	name

Table Cell (td)
newLabel

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSLabel

Span

style	font-weight: bold;

newLabel

Span
(txt, x, width, height)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Creates a new label on the form, with the given text, place and size.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} txt - The text that will be displayed in the label.
{Number} x - The x coordinate of the label. If the portal does not have the "multiLine" property set, then the x coordinates are used only for determining the order of the columns in the grid. If the portal has the "multiLine" property set, then the components are actually displayed at the specified coordinates.
{Number} width - The width of the label.
{Number} height - The height of the label. In a portal the height of all components is set to the height of the first component, unless the "multiLine" property is set.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSLabel - A JSLabel instance that represents the newly created label.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var clickMethod = form.newMethod('function clickMe() { application.output("I was clicked!"); }');
var childrenPortal = form.newPortal('pp', 'parent_to_my_table', 10, 10, 1180, 780);
var calLabel = childrenPortal.newLabel('Date', 120, 60, 20);
// This will result in a button being actually created, because we specify an action.
var textLabel = childrenPortal.newLabel('Text', 180, 60, 20, clickMethod);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	newLabel-String_Number_Number_Number_Object

Table Row (tr)

id	name

Table Cell (td)
newLabel

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSLabel

Span

style	font-weight: bold;

newLabel

Span
(text, x, width, height, action)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Creates a new label on the form, with the given text, place, size and an JSMethod as the onClick action.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} text - The text that will be displayed in the label.
{Number} x - The x coordinate of the label. If the portal does not have the "multiLine" property set, then the x coordinates are used only for determining the order of the columns in the grid. If the portal has the "multiLine" property set, then the components are actually displayed at the specified coordinates.
{Number} width - The width of the label.
{Number} height - The height of the label. In a portal the height of all components is set to the height of the first component, unless the "multiLine" property is set.
{Object} action - The JSMethod object that should be executed when the label is clicked.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSLabel - A JSLabel instance that represents the newly created label.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var clickMethod = form.newMethod('function clickMe() { application.output("I was clicked!"); }');
var childrenPortal = form.newPortal('pp', 'parent_to_my_table', 10, 10, 1180, 780);
var calLabel = childrenPortal.newLabel('Date', 120, 60, 20);
// This will result in a button being actually created, because we specify an action.
var textLabel = childrenPortal.newLabel('Text', 180, 60, 20, clickMethod);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	newPassword-Object_Number_Number_Number

Table Row (tr)

id	name

Table Cell (td)
newPassword

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSField

Span

style	font-weight: bold;

newPassword

Span
(dataprovider, x, width, height)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Creates a new password field in the portal. It is equivalent to calling "newField"
with the type JSField.PASSWORD.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Object} dataprovider - The data provider for this field. Can be either a column name, or an instance of JSVariable.
{Number} x - The x coordinate of the field. If the portal does not have the "multiLine" property set, then the x coordinates are used only for determining the order of the columns in the grid. If the portal has the "multiLine" property set, then the components are actually displayed at the specified coordinates.
{Number} width - The width of the field.
{Number} height - The height of the field. In a portal the height of all components is set to the height of the first component, unless the "multiLine" property is set.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSField - A JSField instance that corresponds to the newly created password field.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var childrenPortal = form.newPortal('pp', 'parent_to_my_table', 10, 10, 1180, 780);
var pwd = childrenPortal.newPassword('my_table_text', 300, 60, 20);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	newRadios-Object_Number_Number_Number

Table Row (tr)

id	name

Table Cell (td)
newRadios

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSField

Span

style	font-weight: bold;

newRadios

Span
(dataprovider, x, width, height)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Creates a new radio buttons field in the portal. It is equivalent to calling "newField"
with the type JSField.RADIOS.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Object} dataprovider - The data provider for this field. Can be either a column name, or an instance of JSVariable.
{Number} x - The x coordinate of the field. If the portal does not have the "multiLine" property set, then the x coordinates are used only for determining the order of the columns in the grid. If the portal has the "multiLine" property set, then the components are actually displayed at the specified coordinates.
{Number} width - The width of the field.
{Number} height - The height of the field. In a portal the height of all components is set to the height of the first component, unless the "multiLine" property is set.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSField - A JSField instance that corresponds to the newly created radio buttons.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var childrenPortal = form.newPortal('pp', 'parent_to_my_table', 10, 10, 1180, 780);
var vlist = solutionModel.newValueList('options', JSValueList.CUSTOM_VALUES);
vlist.customValues = "one\ntwo\nthree\nfour";
var radio = childrenPortal.newRadios('my_table_options', 360, 60, 50);
radio.valuelist = vlist;

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	newRtfArea-Object_Number_Number_Number

Table Row (tr)

id	name

Table Cell (td)
newRtfArea

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSField

Span

style	font-weight: bold;

newRtfArea

Span
(dataprovider, x, width, height)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Creates a new RTF Area field in the portal. It is equivalent to calling "newField"
with the type JSField.RTF_AREA.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Object} dataprovider - The data provider for this field. Can be either a column name, or an instance of JSVariable.
{Number} x - The x coordinate of the field. If the portal does not have the "multiLine" property set, then the x coordinates are used only for determining the order of the columns in the grid. If the portal has the "multiLine" property set, then the components are actually displayed at the specified coordinates.
{Number} width - The width of the field.
{Number} height - The height of the field. In a portal the height of all components is set to the height of the first component, unless the "multiLine" property is set.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSField - A JSField instance that corresponds to the newly created RTF Area field.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var childrenPortal = form.newPortal('pp', 'parent_to_my_table', 10, 10, 1180, 780);
var rtf = childrenPortal.newRtfArea('my_table_rtf', 420, 60, 50);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	newTextArea-Object_Number_Number_Number

Table Row (tr)

id	name

Table Cell (td)
newTextArea

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSField

Span

style	font-weight: bold;

newTextArea

Span
(dataprovider, x, width, height)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Creates a new text area field in the portal. It is equivalent to calling "newField"
with the type JSField.TEXT_AREA.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Object} dataprovider - The data provider for this field. Can be either a column name, or an instance of JSVariable.
{Number} x - The x coordinate of the field. If the portal does not have the "multiLine" property set, then the x coordinates are used only for determining the order of the columns in the grid. If the portal has the "multiLine" property set, then the components are actually displayed at the specified coordinates.
{Number} width - The width of the field.
{Number} height - The height of the field. In a portal the height of all components is set to the height of the first component, unless the "multiLine" property is set.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSField - A JSField instance that corresponds to the newly created text area field.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var childrenPortal = form.newPortal('pp', 'parent_to_my_table', 10, 10, 1180, 780);
var tarea = childrenPortal.newTextArea('my_table_text', 480, 60, 50);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	newTextField-Object_Number_Number_Number

Table Row (tr)

id	name

Table Cell (td)
newTextField

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSField

Span

style	font-weight: bold;

newTextField

Span
(dataprovider, x, width, height)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Creates a new text field in the portal. It is equivalent to calling "newField"
with the type JSField.TEXT_FIELD.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Object} dataprovider - The data provider for this field. Can be either a column name, or an instance of JSVariable.
{Number} x - The x coordinate of the field. If the portal does not have the "multiLine" property set, then the x coordinates are used only for determining the order of the columns in the grid. If the portal has the "multiLine" property set, then the components are actually displayed at the specified coordinates.
{Number} width - The width of the field.
{Number} height - The height of the field. In a portal the height of all components is set to the height of the first component, unless the "multiLine" property is set.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSField - A JSField instance that corresponds to the newly created text field.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var childrenPortal = form.newPortal('pp', 'parent_to_my_table', 10, 10, 1180, 780);
var tfield = childrenPortal.newTextField('my_table_text', 540, 60, 20);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	newTypeAhead-Object_Number_Number_Number

Table Row (tr)

id	name

Table Cell (td)
newTypeAhead

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSField

Span

style	font-weight: bold;

newTypeAhead

Span
(dataprovider, x, width, height)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Creates a new type ahead field in the portal. It is equivalent to calling "newField"
with the type JSField.TYPE_AHEAD.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Object} dataprovider - The data provider for this field. Can be either a column name, or an instance of JSVariable.
{Number} x - The x coordinate of the field. If the portal does not have the "multiLine" property set, then the x coordinates are used only for determining the order of the columns in the grid. If the portal has the "multiLine" property set, then the components are actually displayed at the specified coordinates.
{Number} width - The width of the field.
{Number} height - The height of the field. In a portal the height of all components is set to the height of the first component, unless the "multiLine" property is set.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSField - A JSField instance that corresponds to the newly created type ahead field.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var childrenPortal = form.newPortal('pp', 'parent_to_my_table', 10, 10, 1180, 780);
var vlist = solutionModel.newValueList('options', JSValueList.CUSTOM_VALUES);
vlist.customValues = "one\ntwo\nthree\nfour";
var tahead = childrenPortal.newTypeAhead('my_table_text', 600, 60, 20);
tahead.valuelist = vlist;

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	putDesignTimeProperty

Table Row (tr)

id	name

Table Cell (td)
putDesignTimeProperty

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Object

Span

style	font-weight: bold;

putDesignTimeProperty

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Set a design-time property of an element.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Object

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var frm = solutionModel.getForm('orders')
var fld = frm.getField('fld')
fld.putDesignTimeProperty('myprop', 'strawberry')

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	removeDesignTimeProperty

Table Row (tr)

id	name

Table Cell (td)
removeDesignTimeProperty

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Object

Span

style	font-weight: bold;

removeDesignTimeProperty

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Clear a design-time property of an element.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Object

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var frm = solutionModel.getForm('orders')
var fld = frm.getField('fld')
fld.removeDesignTimeProperty('myprop')

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	setIntercellSpacing-Number_Number

Table Row (tr)

id	name

Table Cell (td)
setIntercellSpacing

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

setIntercellSpacing

Span
(width, height)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The additional spacing between cell rows. Is composed from the horizontal spacing
and the vertical spacing.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Number} width - The horizontal spacing between cells.
{Number} height - The vertical spacing between cells.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var childrenPortal = form.newPortal('pp',rel,10,10,620,460);
childrenPortal.newTextField('child_table_id', 0, 100, 20);
childrenPortal.newTextField('child_table_text',100,100,20);
childrenPortal.newTextField('child_table_parent_id', 200, 100, 20);
childrenPortal.setIntercellSpacing(5,10);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Child pages

Page History

Versions Compared

Old Version 25

New Version Current

Key

anchors

background

borderType

enabled

fontType

foreground

formIndex

groupID

height

initialSort

multiLine

name

onDrag

onDragEnd

onDragOver

onDrop

onRender

printSliding

printable

relationName

reorderable

resizable

rowHeight

scrollbars

showHorizontalLines

showVerticalLines

sortable

styleClass

tabSeq

transparent

visible

width

x

y

getButton

getButtons

getDesignTimeProperty

getDesignTimePropertyNames

getField

getFields

getIntercellSpacing

getLabel

getLabels

getUUID

newButton

newCalendar

newCheck

newComboBox

newField

newHtmlArea

newImageMedia

newLabel

newLabel

newPassword

newRadios

newRtfArea

newTextArea

newTextField

newTypeAhead

putDesignTimeProperty

removeDesignTimeProperty

setIntercellSpacing