Child pages
  • JSField

Versions Compared

Key

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

...

HTML Table
id
classservoy sSummary
Colgroup Tag
Column
padding0px
width80px

Column

Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Constants Summary
tbody
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#CALENDARCALENDAR
Constant for specifying the display type of a JSField.
tbody
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#CHECKSCHECKS
Constant for specifying the display type of a JSField.
tbody
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#COMBOBOXCOMBOBOX
Constant for specifying the display type of a JSField.
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#HTMLHTML_AREA
Constant for specifying the display type of a JSField.
tbody
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#IMAGEIMAGE_MEDIA
Constant for specifying the display type of a JSField.
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#LISTBOXLISTBOX
Constant for specifying the display type of a JSField.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#MULTISELECTMULTISELECT_LISTBOX
Constant for specifying the display type of a JSField.
tbody
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#PASSWORDPASSWORD
Constant for specifying the display type of a JSField.
tbody
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#RADIOSRADIOS
Constant for specifying the display type of a JSField.
tbody
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#RTFRTF_AREA
Constant for specifying the display type of a JSField.
tbody
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#SPINNERSPINNER
Constant for specifying the display type of a JSField.
tbody
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#TEXTTEXT_AREA
Constant for specifying the display type of a JSField.
tbody
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#TEXTTEXT_FIELD
Constant for specifying the display type of a JSField.
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#TYPETYPE_AHEAD
Constant for specifying the display type of a JSField.

HTML Table
id
classservoy sSummary
Colgroup Tag
Column
padding0px
width80px

Column

tbody
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Property Summary
tbody
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#anchorsanchors
Enables a component to stick to a specific side of form and/or to
grow or shrink when a window is resized.
tbody
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#backgroundbackground
The background color of the component.
tbody
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#borderTypeborderType
The type, color and style of border of the component.
tbody
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#dataProviderIDdataProviderID
The dataprovider of the component.
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#displayTypedisplayType
The type of display used by the field.
tbody
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#displaysTagsdisplaysTags
Flag that enables or disables merging of data inside components using tags (placeholders).
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#editableeditable
Flag that tells if the content of the field can be edited or not.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#enabledenabled
The enable state of the component, default true.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#fontTypefontType
The font type of the component.
tbody
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#foregroundforeground
The foreground color of the component.
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#formIndexformIndex
The Z index of this component.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#formatformat
The format that should be applied when displaying the data in the component.
tbody
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#groupIDgroupID
A String representing a group ID for this component.
tbody
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#heightheight
The height in pixels of the component.
tbody
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#horizontalAlignmenthorizontalAlignment
Horizontal alignment of the text inside the component.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#marginmargin
The margins of the component.
tbody
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#namename
The name of the component.
tbody
Table Row (tr)
Table Cell (td)
JSMethod
Table Cell (td)
#onActiononAction
The method that is executed when the component is clicked.
tbody
Table Row (tr)
Table Cell (td)
JSMethod
Table Cell (td)
#onDataChangeonDataChange
Method that is executed when the data in the component is successfully changed.
tbody
Table Row (tr)
Table Cell (td)
JSMethod
Table Cell (td)
#onFocusGainedonFocusGained
The method that is executed when the component gains focus.
tbody
Table Row (tr)
Table Cell (td)
JSMethod
Table Cell (td)
#onFocusLostonFocusLost
The method that is executed when the component looses focus.
tbody
Table Row (tr)
Table Cell (td)
JSMethod
Table Cell (td)
#onRenderonRender
The method that is executed when the component is rendered.
tbody
Table Row (tr)
Table Cell (td)
JSMethod
Table Cell (td)
#onRightClickonRightClick
The method that is executed when the component is right clicked.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#placeholderTextplaceholderText
The text that is displayed in field when the field doesn't have a text value.
tbody
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#printSlidingprintSliding
Enables an element to resize based on its content and/or move when printing.
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#printableprintable
Flag that tells if the component should be printed or not when the form is printed.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#scrollbarsscrollbars
Scrollbar options for the vertical and horizontal scrollbars.
tbody
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#selectOnEnterselectOnEnter
Flag that tells if the content of the field should be automatically selected
when the field receives focus.
tbody
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#styleClassstyleClass
The name of the style class that should be applied to this component.
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#tabSeqtabSeq
An index that specifies the position of the component in the tab sequence.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#titleTexttitleText
The text that is displayed in the column header associated with the component when the form
is in table view.
tbody
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#toolTipTexttoolTipText
The text displayed when hovering over the component with a mouse cursor.
tbody
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#transparenttransparent
Flag that tells if the component is transparent or not.
tbody
Table Row (tr)
Table Cell (td)
JSValueList
Table Cell (td)
#valuelistvaluelist
The valuelist that is used by this field when displaying data.
tbody
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#visiblevisible
The visible property of the component, default true.
tbody
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#widthwidth
The width in pixels of the component.
tbody
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#xx
The x coordinate of the component on the form.
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#yy
The y coordinate of the component on the form.

HTML Table
id
classservoy sSummary
Colgroup Tag
Column
padding0px
width80px

Column

tbody
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Method Summary
Table Row (tr)
Table Cell (td)
Object
Table Cell (td)
#getDesignTimePropertygetDesignTimeProperty()
Get a design-time property of an element.
Table Body (tbody)tr
Table Cell (td)
String[]
Table Cell (td)
getDesignTimePropertyNames()
Get the design-time properties of an element.
tbody
Table Row (tr)
Table Cell (td)
UUID
Table Cell (td)
#getUUIDgetUUID()
Returns the UUID of this component.
Table Row (tr)
Table Cell (td)
Object
Table Cell (td)
#putDesignTimePropertyputDesignTimeProperty()
Set a design-time property of an element.
Table Body (tbody)
tr
Table Row (tr)
Table Cell (td)
Object
Table Cell (td)
#removeDesignTimePropertyremoveDesignTimeProperty()
Clear a design-time property of an element.

HTML Table
idconstant
classservoy sDetail
Colgroup Tag
Column
padding0px
width100%

Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan1
Constants Details
Table Body (tbody)
idCALENDAR
Table Row (tr)
idname
Table Cell (td)
CALENDAR
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Constant for specifying the display type of a JSField. Sets the display type of the
field to calendar. The field will show a formatted date and will have a button which
pops up a calendar for date selection.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Number
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

var cal = form.newField('my_table_date', JSField.CALENDAR, 10, 10, 100, 20);
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idCHECKS
Table Row (tr)
idname
Table Cell (td)
CHECKS
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Constant for specifying the display type of a JSField. Sets the display type of the
field to checkbox. The field will show a checkbox, or a list of checkboxes if the valuelist
property is also set.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Number
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

var vlist = solutionModel.newValueList('options', JSValueList.CUSTOM_VALUES);
vlist.customValues = "one\ntwo\nthree\nfour";
var chk = form.newField('my_table_options', JSField.CHECKS, 10, 40, 100, 50);
chk.valuelist = vlist;
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idCOMBOBOX
Table Row (tr)
idname
Table Cell (td)
COMBOBOX
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Constant for specifying the display type of a JSField. Sets the display type of the
field to combobox.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Number
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

var vlist = solutionModel.newValueList('options', JSValueList.CUSTOM_VALUES);
vlist.customValues = "one\ntwo\nthree\nfour";
var cmb = form.newField('my_table_options', JSField.COMBOBOX, 10, 100, 100, 20);
cmb.valuelist = vlist;
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idHTML_AREA
Table Row (tr)
idname
Table Cell (td)
HTML_AREA
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Constant for specifying the display type of a JSField. Sets the display type of the
field to HTML area. The field will display formatted HTML content.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Number
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

var html = form.newField('my_table_html', JSField.HTML_AREA, 10, 130, 100, 50);
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idIMAGE_MEDIA
Table Row (tr)
idname
Table Cell (td)
IMAGE_MEDIA
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Constant for specifying the display type of a JSField. Sets the display type of the
field to image. The field will display images.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Number
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

var img = form.newField('my_table_image', JSField.IMAGE_MEDIA, 10, 190, 100, 50);
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idLISTBOX
Table Row (tr)
idname
Table Cell (td)
LISTBOX
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Constant for specifying the display type of a JSField. Sets the display type of the
field to list box. The field will show a selection list with single choice selection.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Number
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

var vlist = solutionModel.newValueList('options', JSValueList.CUSTOM_VALUES);
vlist.customValues = "one\ntwo\nthree\nfour";
var list = form.newField('my_table_list', JSField.LISTBOX, 10, 280, 100, 50);
list.valuelist = vlist;
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idMULTISELECT_LISTBOX
Table Row (tr)
idname
Table Cell (td)
MULTISELECT_LISTBOX
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Constant for specifying the display type of a JSField. Sets the display type of the
field to list box. The field will show a selection list with multiple choice selection.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Number
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

var vlist = solutionModel.newValueList('options', JSValueList.CUSTOM_VALUES);
vlist.customValues = "one\ntwo\nthree\nfour";
var list = form.newField('my_table_options', JSField.MULTISELECT_LISTBOX, 10, 280, 100, 50);
list.valuelist = vlist;
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idPASSWORD
Table Row (tr)
idname
Table Cell (td)
PASSWORD
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Constant for specifying the display type of a JSField. Sets the display type of the
fiels to password. The field will allow the user to enter passwords, masking the typed
characters.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Number
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

var pwd = form.newField('my_table_text', JSField.PASSWORD, 10, 250, 100, 20);
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idRADIOS
Table Row (tr)
idname
Table Cell (td)
RADIOS
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Constant for specifying the display type of a JSField. Sets the display type of the
field to radio buttons. The field will show a radio button, or a list of them if
the valuelist property is also set.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Number
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

var vlist = solutionModel.newValueList('options', JSValueList.CUSTOM_VALUES);
vlist.customValues = "one\ntwo\nthree\nfour";
var radio = form.newField('my_table_options', JSField.RADIOS, 10, 280, 100, 50);
radio.valuelist = vlist;
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idRTF_AREA
Table Row (tr)
idname
Table Cell (td)
RTF_AREA
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Constant for specifying the display type of a JSField. Sets the display type of the
field to RTF area. The field will display formatted RTF content.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Number
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

var rtf = form.newField('my_table_rtf', JSField.RTF_AREA, 10, 340, 100, 50);
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idSPINNER
Table Row (tr)
idname
Table Cell (td)
SPINNER
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Constant for specifying the display type of a JSField. Sets the display type of the
field to spinner. The field will show a spinner.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Number
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

var vlist = solutionModel.newValueList('options', JSValueList.CUSTOM_VALUES);
vlist.customValues = "one\ntwo\nthree\nfour";
var spinner = form.newField('my_spinner', JSField.SPINNER, 10, 460, 100, 20);
spinner.valuelist = vlist;
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idTEXT_AREA
Table Row (tr)
idname
Table Cell (td)
TEXT_AREA
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Constant for specifying the display type of a JSField. Sets the display type of the
field to text area. The field will show text on multiple lines.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Number
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

var tarea = form.newField('my_table_text', JSField.TEXT_AREA, 10, 400, 100, 50);
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idTEXT_FIELD
Table Row (tr)
idname
Table Cell (td)
TEXT_FIELD
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Constant for specifying the display type of a JSField. Sets the display type of the
field to text field. The field will show regular text on a single line.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Number
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

var tfield = form.newField('my_table_text', JSField.TEXT_FIELD, 10, 460, 100, 20);
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idTYPE_AHEAD
Table Row (tr)
idname
Table Cell (td)
TYPE_AHEAD
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Constant for specifying the display type of a JSField. Sets the display type of the
field to type ahead. The field will show regular text, but will have type ahead
capabilities.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Number
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

var vlist = solutionModel.newValueList('options', JSValueList.CUSTOM_VALUES);
vlist.customValues = "one\ntwo\nthree\nfour";
var tahead = form.newField('my_table_text', JSField.TYPE_AHEAD, 10, 490, 100, 20);
tahead.valuelist = vlist;
Table Row (tr)
classlastDetailRow
Table Cell (td)


HTML Table
idproperty
classservoy sDetail
Colgroup Tag
Column
padding0px
width100%

Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan1
Property Details
Table Body (tbody)
idanchors
Table Row (tr)
idname
Table Cell (td)
anchors
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

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

...

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

Table Body (tbody)
idbackground
Table Row (tr)
idname
Table Cell (td)
background
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The background color of the component.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

...

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

Table Body (tbody)
idborderType
Table Row (tr)
idname
Table Cell (td)
borderType
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The type, color and style of border of the component.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

...

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

Table Body (tbody)
iddataProviderID
Table Row (tr)
idname
Table Cell (td)
dataProviderID
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The dataprovider of the component.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

...

// Normally the dataprovider is specified when a component is created.
var field = form.newField('parent_table_text', JSField.TEXT_FIELD, 10, 40, 100, 20);
// But it can be modified later if needed.
field.dataProviderID = 'parent_table_id';

...

Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
iddisplayType
Table Row (tr)
idname
Table Cell (td)
displayType
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The type of display used by the field. Can be one of CALENDAR, CHECKS,
COMBOBOX, HTML_AREA, IMAGE_MEDIA, PASSWORD, RADIOS, RTF_AREA, TEXT_AREA,
TEXT_FIELD, TYPE_AHEAD, LIST_BOX, MULTISELECT_LISTBOX or SPINNER.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Number
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

...

// The display type is specified when the field is created.
var cal = form.newField('my_table_date', JSField.CALENDAR, 10, 10, 100, 20);
// But it can be changed if needed.
cal.dataProviderID = 'my_table_text';
cal.displayType = JSField.TEXT_FIELD;

...

Table Row (tr)
classlastDetailRow
Table Cell (td)

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

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

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

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

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

...

var field = form.newField('parent_table_text', JSField.TEXT_FIELD, 10, 40, 100, 20);
field.displaysTags = true;

...

Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
ideditable
Table Row (tr)
idname
Table Cell (td)
editable
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Flag that tells if the content of the field can be edited or not.
The default value of this flag is "true", that is the content can be edited.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Boolean
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

...

var field = form.newField('my_table_text', JSField.TEXT_FIELD, 10, 10, 100, 20);
field.editable = false;

...

Table Row (tr)
classlastDetailRow
Table Cell (td)

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

...

var form = solutionModel.newForm('printForm', 'db:/example_data/parent_table', null, false, 400, 300);
var field = form.newField('parent_table_text', JSField.TEXT_FIELD, 10, 10, 100, 20);
field.enabled = false;

...

Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idfontType
Table Row (tr)
idname
Table Cell (td)
fontType
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The font type of the component.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

...

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

...

Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idforeground
Table Row (tr)
idname
Table Cell (td)
foreground
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The foreground color of the component.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

...

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

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

...

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

Table Body (tbody)
idformat
Table Row (tr)
idname
Table Cell (td)
format
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The format that should be applied when displaying the data in the component.
There are different options for the different dataprovider types that are assigned to this field.
For Integer fields, there is a display and an edit format, using http://docs.oracle.com/javase/7/docs/api/java/text/DecimalFormat.html and the max (string) length can be set.
For Text/String fields, there are options to force uppercase,lowercase or only numbers. Or a mask can be set that restrict the input the pattern chars can be found here: http://docs.oracle.com/javase/7/docs/api/javax/swing/text/MaskFormatter.html
A mask can have a placehoder (what is shown when there is no data) and if the data must be stored raw (without literals of the mask). A max text length can also be set to force
the max text length input, this doesn't work on mask because that max length is controlled with the mask.
For Date fields a display and edit format can be set by using a pattern from here: http://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html, you can also say this must behave like a mask (the edit format)
A mask only works with when the edit format is exactly that mask (1 char is 1 number/char), because for example MM then only 2 numbers are allowed MMM that displays the month as a string is not supported as a mask.
Some examples are "dd-MM-yyyy", "MM-dd-yyyy", etc.
The format property is also used to set the UI Converter, this means that you can convert the value object to something else before it gets set into the field, this can also result in a type change of the data.
So a string in scripting/db is converted to a integer in the ui, then you have to set an integer format.
This property is applicable only for types: TEXT_FIELD, COMBOBOX, TYPE_AHEAD, CALENDAR and SPINNER.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

...

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

...

Table Row (tr)
classlastDetailRow
Table Cell (td)

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

...

var form = solutionModel.newForm('someForm', 'db:/example_data/parent_table', null, false, 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)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idheight
Table Row (tr)
idname
Table Cell (td)
height
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The height in pixels of the component.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Number
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

...

var field = form.newField('parent_table_text', JSField.TEXT_FIELD, 10, 10, 100, 20);
application.output('original 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)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idhorizontalAlignment
Table Row (tr)
idname
Table Cell (td)
horizontalAlignment
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

Horizontal alignment of the text inside the component. Can be one of
LEFT, CENTER or RIGHT.

Note that this property does not refer to the horizontal alignment
of the component inside the form.

Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Number
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

...

var leftAlignedLabel = form.newLabel('LEFT', 10, 10, 300, 20);
leftAlignedLabel.horizontalAlignment = SM_ALIGNMENT.LEFT;
var hCenteredLabel = form.newLabel('CENTER', 10, 40, 300, 20);
hCenteredLabel.horizontalAlignment = SM_ALIGNMENT.CENTER;
var rightAlignedLabel = form.newLabel('RIGHT', 10, 70, 300, 20);
rightAlignedLabel.horizontalAlignment = SM_ALIGNMENT.RIGHT;

...

Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idmargin
Table Row (tr)
idname
Table Cell (td)
margin
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The margins of the component. They are specified in this order,
separated by commas: top, left, bottom, right.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

...

var label = form.newLabel('Label', 10, 10, 150, 150);
label.background = 'yellow';
label.margin = '10,20,30,40';

...

Table Row (tr)
classlastDetailRow
Table Cell (td)

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

...

var form = solutionModel.newForm('someForm', 'db:/example_data/parent_table', null, false, 620, 300);
var label = form.newLabel('Label', 10, 10, 150, 150);
label.name = 'myLabel'; // Give a name to the component.
forms['someForm'].controller.show()
// Now use the name to access the component.
forms['someForm'].elements['myLabel'].text = 'Updated text';

...

Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idonAction
Table Row (tr)
idname
Table Cell (td)
onAction
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The method that is executed when the component is clicked.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
JSMethod
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

...

var doNothingMethod = form.newMethod('function doNothing() { application.output("Doing nothing."); }');
var onClickMethod = form.newMethod('function onClick(event) { application.output("I was clicked at " + event.getTimestamp()); }');
var onDoubleClickMethod = form.newMethod('function onDoubleClick(event) { application.output("I was double-clicked at " + event.getTimestamp()); }');
var onRightClickMethod = form.newMethod('function onRightClick(event) { application.output("I was right-clicked at " + event.getTimestamp()); }');
// At creation the button has the 'doNothing' method as onClick handler, but we'll change that later.
var btn = form.newButton('I am a button', 10, 40, 200, 20, doNothingMethod);
btn.onAction = onClickMethod;
btn.onDoubleClick = onDoubleClickMethod;
btn.onRightClick = onRightClickMethod;

...

Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idonDataChange
Table Row (tr)
idname
Table Cell (td)
onDataChange
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Method that is executed when the data in the component is successfully changed.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
JSMethod
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

...

var form = solutionModel.newForm('someForm', 'db:/example_data/parent_table', null, false, 620, 300);
var onDataChangeMethod = form.newMethod('function onDataChange(oldValue, newValue, event) { application.output("Data changed from " + oldValue + " to " + newValue + " at " + event.getTimestamp()); }');
var field = form.newField('parent_table_text', JSField.TEXT_FIELD, 10, 10, 100, 20);
field.onDataChange = onDataChangeMethod;
forms['someForm'].controller.show();

...

Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idonFocusGained
Table Row (tr)
idname
Table Cell (td)
onFocusGained
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The method that is executed when the component gains focus.
NOTE: Do not call methods that will influence the focus itself.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
JSMethod
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

...

var form = solutionModel.newForm('someForm', 'db:/example_data/parent_table', null, false, 620, 300);
var onFocusLostMethod = form.newMethod('function onFocusLost(event) { application.output("Focus lost at " + event.getTimestamp()); }');
var onFocusGainedMethod = form.newMethod('function onFocusGained(event) { application.output("Focus gained at " + event.getTimestamp()); }');
var field = form.newField('parent_table_text', JSField.TEXT_FIELD, 10, 10, 100, 20);
field.onFocusGained = onFocusGainedMethod;
field.onFocusLost = onFocusLostMethod;
forms['someForm'].controller.show()

...

Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idonFocusLost
Table Row (tr)
idname
Table Cell (td)
onFocusLost
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The method that is executed when the component looses focus.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
JSMethod
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

...

var form = solutionModel.newForm('someForm', 'db:/example_data/parent_table', null, false, 620, 300);
var onFocusLostMethod = form.newMethod('function onFocusLost(event) { application.output("Focus lost at " + event.getTimestamp()); }');
var onFocusGainedMethod = form.newMethod('function onFocusGained(event) { application.output("Focus gained at " + event.getTimestamp()); }');
var field = form.newField('parent_table_text', JSField.TEXT_FIELD, 10, 10, 100, 20);
field.onFocusGained = onFocusGainedMethod;
field.onFocusLost = onFocusLostMethod;
forms['someForm'].controller.show()

...

Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idonRender
Table Row (tr)
idname
Table Cell (td)
onRender
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The method that is executed when the component is rendered.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
JSMethod
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

...

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

...

Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idonRightClick
Table Row (tr)
idname
Table Cell (td)
onRightClick
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The method that is executed when the component is right clicked.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
JSMethod
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

...

var doNothingMethod = form.newMethod('function doNothing() { application.output("Doing nothing."); }');
var onClickMethod = form.newMethod('function onClick(event) { application.output("I was clicked at " + event.getTimestamp()); }');
var onDoubleClickMethod = form.newMethod('function onDoubleClick(event) { application.output("I was double-clicked at " + event.getTimestamp()); }');
var onRightClickMethod = form.newMethod('function onRightClick(event) { application.output("I was right-clicked at " + event.getTimestamp()); }');
// At creation the button has the 'doNothing' method as onClick handler, but we'll change that later.
var btn = form.newButton('I am a button', 10, 40, 200, 20, doNothingMethod);
btn.onAction = onClickMethod;
btn.onDoubleClick = onDoubleClickMethod;
btn.onRightClick = onRightClickMethod;

...

Table Row (tr)
classlastDetailRow
Table Cell (td)

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

...

field.placeholderText = 'Search';

...

Table Row (tr)
classlastDetailRow
Table Cell (td)

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

...

var form = solutionModel.newForm('printForm', 'db:/example_data/parent_table', null, false, 400, 300);
var 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)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idprintable
Table Row (tr)
idname
Table Cell (td)
printable
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

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

By default components are printable.

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

...

var form = solutionModel.newForm('printForm', 'db:/example_data/parent_table', null, false, 400, 300);
var 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)
classlastDetailRow
Table Cell (td)

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

...

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

Table Body (tbody)
idselectOnEnter
Table Row (tr)
idname
Table Cell (td)
selectOnEnter
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Flag that tells if the content of the field should be automatically selected
when the field receives focus. The default value of this field is "false".
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Boolean
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

...

// Create two fields and set one of them to have "selectOnEnter" true. As you tab
// through the fields you can notice how the text inside the second field gets
// automatically selected when the field receives focus.
var fieldNoSelect = form.newField('my_table_text', JSField.TEXT_FIELD, 10, 10, 100, 20);
var fieldSelect = form.newField('my_table_text', JSField.TEXT_FIELD, 10, 40, 100, 20);
fieldSelect.selectOnEnter = true;

...

Table Row (tr)
classlastDetailRow
Table Cell (td)

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

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

When defining style classes for specific component types, their names
must be prefixed according to the type of the component. For example
in order to define a class names 'fancy' for fields, in the style
definition the class must be named 'field.fancy'. If it would be
intended for labels, then it would be named 'label.fancy'. When specifying
the class name for a component, the prefix is dropped however. Thus the
field or the label will have its styleClass property set to 'fancy' only.

Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

...

var form = solutionModel.newForm('printForm', 'db:/example_data/parent_table', null, false, 400, 300);
var field = form.newField('parent_table_text', JSField.TEXT_FIELD, 10, 10, 100, 20);
var style = solutionModel.newStyle('myStyle','field.fancy { background-color: yellow; }');
form.styleName = 'myStyle'; // First set the style on the form.
field.styleClass = 'fancy'; // Then set the style class on the field.

...

Table Row (tr)
classlastDetailRow
Table Cell (td)

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

...

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

Table Body (tbody)
idtitleText
Table Row (tr)
idname
Table Cell (td)
titleText
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The text that is displayed in the column header associated with the component when the form
is in table view.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

...

var form = solutionModel.newForm('someForm', 'db:/example_data/my_table', null, false, 640, 480);
var field = form.newField('my_table_number', JSField.TEXT_FIELD, 10, 10, 100, 20);
field.titleText = 'Column Title';
form.view = JSForm.LOCKED_TABLE_VIEW;
forms['someForm'].controller.show()

...

Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idtoolTipText
Table Row (tr)
idname
Table Cell (td)
toolTipText
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

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>

Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

...

var label = form.newLabel('Stop the mouse over me!', 10, 10, 200, 20);
label.toolTipText = 'I\'m the tooltip. Do you see me?';

...

Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idtransparent
Table Row (tr)
idname
Table Cell (td)
transparent
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

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

...

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

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

...

var vlist = solutionModel.newValueList('options', JSValueList.CUSTOM_VALUES);
vlist.customValues = "one\ntwo\nthree\nfour";
var cmb = form.newField('my_table_options', JSField.COMBOBOX, 10, 100, 100, 20);
cmb.valuelist = vlist;

...

Table Row (tr)
classlastDetailRow
Table Cell (td)

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

...

var form = solutionModel.newForm('printForm', 'db:/example_data/parent_table', null, false, 400, 300);
var field = form.newField('parent_table_text', JSField.TEXT_FIELD, 10, 10, 100, 20);
field.visible = false;

...

Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idwidth
Table Row (tr)
idname
Table Cell (td)
width
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The width in pixels of the component.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Number
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

...

var field = form.newField('parent_table_text', JSField.TEXT_FIELD, 10, 10, 100, 20);
application.output('original 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)
classlastDetailRow
Table Cell (td)

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

...

var field = form.newField('parent_table_text', JSField.TEXT_FIELD, 10, 10, 100, 20);
application.output('original location: ' + field.x + ', ' + field.y);
field.x = 90;
field.y = 90;
application.output('changed location: ' + field.x + ', ' + field.y);

...

Table Row (tr)
classlastDetailRow
Table Cell (td)

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

...

var field = form.newField('parent_table_text', JSField.TEXT_FIELD, 10, 10, 100, 20);
application.output('original location: ' + field.x + ', ' + field.y);
field.x = 90;
field.

...

y = 90;
application.output('changed location: ' + field.x + ', ' + field.y);
Table Row (tr)
classlastDetailRow
Table Cell (td)

HTML Table
idfunction
classservoy sDetail
Colgroup Tag
Column
padding0px
width100%

Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan1
Method Details
Table Body (tbody)
idgetDesignTimeProperty
Table Row (tr)
idname
Table Cell (td)
getDesignTimeProperty
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Object
Span
stylefont-weight: bold;
getDesignTimeProperty
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Get a design-time property of an element.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Object
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var frm = solutionModel.getForm('orders')
var fld = frm.getField('fld')
var prop = fld.getDesignTimeProperty('myprop')
Table Row (tr)
classlastDetailRow
Table Cell (td)

...

idfunction
classservoy sDetail

...

padding0px
width100%

...

...

Table Head (th)
colspan1
Method Details

Table Body (tbody)
id

...

getDesignTimePropertyNames
Table Row (tr)
idname
Table Cell (td)

getDesignTimeProperty

getDesignTimePropertyNames
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;

...

String[]
Span
stylefont-weight: bold;

...

getDesignTimePropertyNames
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Get

...

the design-time

...

properties of an element.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent

...

String[]
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

...

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

...

propNames = fld.

...

getDesignTimePropertyNames(

...

)

...

Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idgetUUID
Table Row (tr)
idname
Table Cell (td)
getUUID
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
UUID
Span
stylefont-weight: bold;
getUUID
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns the UUID of this component.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
UUID
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

...

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

...

Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idputDesignTimeProperty
Table Row (tr)
idname
Table Cell (td)
putDesignTimeProperty
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Object
Span
stylefont-weight: bold;
putDesignTimeProperty
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Set a design-time property of an element.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Object
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

...

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

...

Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idremoveDesignTimeProperty
Table Row (tr)
idname
Table Cell (td)
removeDesignTimeProperty
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Object
Span
stylefont-weight: bold;
removeDesignTimeProperty
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Clear a design-time property of an element.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Object
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

...

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

...

Table Row (tr)
classlastDetailRow
Table Cell (td)