JSTab

Unknown macro: {div}

DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY (EXCEPT INSIDE THE DIV BELOW WITH ID=DESCRIPTION), UNLESS YOU KNOW WHAT YOU'RE DOING.
THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO AUTO UPDATE THE CONTENT THROUGH THE DOC GENERATOR.

Enter additional information related to this 'class' inside the {div} macro with 'id=description'

Unknown macro: {div}

Unknown macro: {table}

{column:width=80px|padding=0px}{column}{column}{column}

Unknown macro: {tr}

Unknown macro: {th}

Property Summary

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

JSForm

Unknown macro: {td}

containsForm
The name of the form displayed in the tab.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

String

Unknown macro: {td}

foreground
The foreground color of the tab.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

JSMedia

Unknown macro: {td}

imageMedia
The name of the image Media file used.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

String

Unknown macro: {td}

mnemonic
Mnemonic used to switch to tab.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

String

Unknown macro: {td}

name
The name of the tab.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

String

Unknown macro: {td}

relationName
The name of the relation that links the form which contains the tab
with the form displayed in the tab.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

String

Unknown macro: {td}

text
The text on the tab.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

String

Unknown macro: {td}

toolTipText
The text displayed when hovering over the component with a mouse cursor.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Number

Unknown macro: {td}

x
The X coordinate of the tab.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Number

Unknown macro: {td}

y
The Y coordinate of the tab.

Unknown macro: {table}

{column:width=80px|padding=0px}{column}{column}{column}

Unknown macro: {tr}

Unknown macro: {th}

Method Summary

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

UUID

Unknown macro: {td}

getUUID()
Returns the UUID of this component.

Unknown macro: {table}

{column:width=100%|padding=0px}{column}

Unknown macro: {tr}

Unknown macro: {th}

Property Details

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

containsForm

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

The name of the form displayed in the tab.

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

JSForm

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

var childForm = solutionModel.newForm('childForm', 'db:/example_data/child_table', null, false, 400, 300);
var anotherChildForm = solutionModel.newForm('anotherChildForm', 'db:/example_data/child_table', null, false, 400, 300);
var firstTab = tabs.newTab('firstTab', 'Child Form', childForm, relation);
firstTab.containsForm = anotherChildForm;

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

foreground

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

The foreground color of the tab.

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

String

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

var firstTab = tabs.newTab('firstTab', 'Child Form', childForm, relation);
firstTab.foreground = '#FF0000';

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

imageMedia

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

The name of the image Media file used.

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

JSMedia

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

var bytes = plugins.file.readFile('d:/ball.jpg');
var ballImage = solutionModel.newMedia('ball.jpg', bytes);
var firstTab = tabs.newTab('firstTab', 'Child Form', childForm, relation);
firstTab.imageMedia = ballImage;

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

mnemonic

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

Mnemonic used to switch to tab.

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

String

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

var childForm = solutionModel.newForm('childForm', 'db:/example_data/child_table', null, false, 400, 300);
var anotherChildForm = solutionModel.newForm('anotherChildForm', 'db:/example_data/child_table', null, false, 400, 300);
var firstTab = tabs.newTab('firstTab', 'Child Form', childForm, relation);
firstTab.mnemonic = 'a';

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

name

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

The name of the tab.

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

String

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

var firstTab = tabs.newTab('firstTab', 'Child Form', childForm, relation);
firstTab.name = 'firstTabRenamed';

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

relationName

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

The name of the relation that links the form which contains the tab
with the form displayed in the tab.

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

String

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

var firstTab = tabs.newTab('firstTab', 'Child Form', childForm);
firstTab.relationName = 'parent_table_to_child_table';

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

text

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

The text on the tab.

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

String

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

var firstTab = tabs.newTab('firstTab', 'Child Form', childForm, relation);
firstTab.text = 'Better Title';

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

toolTipText

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

The text displayed when hovering over the component with a mouse cursor.

NOTE:
HTML should be used for multi-line tooltips; you can also use any
valid HTML tags to format tooltip text. For example:
<html>This includes<b>bolded text</b> and
<font color='blue'>BLUE</font> text as well.</html>

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

String

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

var firstTab = tabs.newTab('firstTab', 'Child Form', childForm, relation);
firstTab.toolTipText = 'Tooltip';

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

x

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

The X coordinate of the tab. This influences the order in which the tabs are displayed.
The tabs are displayed in increasing order of the X coordinate. If two tabs have the
same X coordinate, then they are displayed in increasing order of the Y coordinate.

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

Number

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

// Create two tabs, then make the second one be displayed to the left of the first
// by setting their X coordinates in the needed order.
var firstTab = tabs.newTab('firstTab', 'Child Form', childForm, relation);
firstTab.x = 10;
var secondTab = tabs.newTab('secondTab', 'Another Child Form', anotherChildForm);
secondTab.x = 0;

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

y

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

The Y coordinate of the tab. Together with the X coordinate, this influences the order
in which the tabs are displayed. The tabs are displayed in increasing order of the X coordinate,
and if two tabs have the same X coordinate, then they are displayed in increasing order
of the Y coordinate.

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

Number

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

// Create two tabs, then make the second one be displayed to the left of the first
// by setting their X to the same value and Y coordinates in the needed order. 
var firstTab = tabs.newTab('firstTab', 'Child Form', childForm, relation);
firstTab.x = 0;
firstTab.y = 10;
var secondTab = tabs.newTab('secondTab', 'Another Child Form', anotherChildForm);
secondTab.x = 0;
secondTab.y = 0;

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {table}

{column:width=100%|padding=0px}{column}

Unknown macro: {tr}

Unknown macro: {th}

Method Details

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

getUUID

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

UUID

Unknown macro: {span}

getUUID

Unknown macro: {span}

()

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

Returns the UUID of this component.

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

UUID

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

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

Unknown macro: {tr}

Unknown macro: {td}

Child pages

JSTab

containsForm

foreground

imageMedia

mnemonic

name

relationName

text

toolTipText

x

y

getUUID