Child pages
  • JSButton

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin
{div:style=}
Wiki Markup
Div
styledisplay: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.

\\ \\ Enter additional information related to this



Enter additional information related to this 'class'

inside

the

\

{div}

macro

with

'id=description'

{div} {div:id=description}{div}\\ {table:id=|class=servoy sReturnTypes}{tr:style=height: 30px;}{th}Extends{th}{tr}{tr}{td}{span:class=sWordList}[JSComponent]{span}{td}{tr}{table}\\ {table:id=|class=servoy sSummary}{colgroup}{column:width=80px|padding=0px}{column}{column}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=2}Constants Summary{th}{tr}{tbody}{tr}{td}[String]{td}{td}[#ICON_ALERT] Constant for specifying a predefined icon type for a button.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#ICON_BACK] Constant for specifying a predefined icon type for a button.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#ICON_BARS] Constant for specifying a predefined icon type for a button.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#ICON_CHECK] Constant for specifying a predefined icon type for a button.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#ICON_DELETE] Constant for specifying a predefined icon type for a button.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#ICON_DOWN] Constant for specifying a predefined icon type for a button.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#ICON_EDIT] Constant for specifying a predefined icon type for a button.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#ICON_FORWARD] Constant for specifying a predefined icon type for a button.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#ICON_GEAR] Constant for specifying a predefined icon type for a button.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#ICON_GRID] Constant for specifying a predefined icon type for a button.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#ICON_HOME] Constant for specifying a predefined icon type for a button.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#ICON_INFO] Constant for specifying a predefined icon type for a button.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#ICON_LEFT] Constant for specifying a predefined icon type for a button.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#ICON_MINUS] Constant for specifying a predefined icon type for a button.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#ICON_PLUS] Constant for specifying a predefined icon type for a button.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#ICON_REFRESH] Constant for specifying a predefined icon type for a button.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#ICON_RIGHT] Constant for specifying a predefined icon type for a button.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#ICON_SEARCH] Constant for specifying a predefined icon type for a button.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#ICON_STAR] Constant for specifying a predefined icon type for a button.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#ICON_UP] Constant for specifying a predefined icon type for a button.{td}{tr}{tbody}{table}\\ {table:id=|class=servoy sSummary}{colgroup}{column:width=80px|padding=0px}{column}{column}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=2}Property Summary{th}{tr}{tbody}{tr}{td}[String]{td}{td}[#dataProviderID] The dataprovider of the component.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#displaysTags] Flag that enables or disables merging of data inside components using tags (placeholders).{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#enabled] The enable state of the component, default true.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#format] The format that should be applied when displaying data(using dataProviderID) in the label/button.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#height] The height in pixels of the component.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#iconType] Icon shown on a button.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#name] The name of the component.{td}{tr}{tbody}{tbody}{tr}{td}[JSMethod]{td}{td}[#onAction] The method that is executed when the component is clicked.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#styleClass] The name of the style class that should be applied to this component.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#text] The text that is displayed inside the component.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#visible] The visible property of the component, default true.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#width] The width in pixels of the component.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#x] The x coordinate of the component on the form.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#y] The y coordinate of the component on the form.{td}{tr}{tbody}{table}\\ {table:id=|class=servoy sSummary}{colgroup}{column:width=80px|padding=0px}{column}{column}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=2}Method Summary{th}{tr}{table}\\ {table:id=constant|class=servoy sDetail}{colgroup}{column:width=100%|padding=0px}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=1}Constants Details{th}{tr}{tbody:id=ICON_ALERT}{tr:id=name}{td}h6.ICON_ALERT{td}{tr}{tr:id=des}{td}{div:class=sIndent}Constant for specifying a predefined icon type for a button.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

Div
iddescription


HTML Table
id
classservoy sReturnTypes
Table Row (tr)
styleheight: 30px;
Table Head (th)
Extends
Table Row (tr)
Table Cell (td)
Span
classsWordList
JSComponent

HTML Table
id
classservoy sSummary
Colgroup Tag
Column
padding0px
width80px

Column

Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Constants Summary
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#ICON_ALERT
Constant for specifying a predefined icon type for a button.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#ICON_BACK
Constant for specifying a predefined icon type for a button.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#ICON_BARS
Constant for specifying a predefined icon type for a button.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#ICON_CHECK
Constant for specifying a predefined icon type for a button.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#ICON_DELETE
Constant for specifying a predefined icon type for a button.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#ICON_DOWN
Constant for specifying a predefined icon type for a button.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#ICON_EDIT
Constant for specifying a predefined icon type for a button.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#ICON_FORWARD
Constant for specifying a predefined icon type for a button.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#ICON_GEAR
Constant for specifying a predefined icon type for a button.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#ICON_GRID
Constant for specifying a predefined icon type for a button.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#ICON_HOME
Constant for specifying a predefined icon type for a button.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#ICON_INFO
Constant for specifying a predefined icon type for a button.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#ICON_LEFT
Constant for specifying a predefined icon type for a button.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#ICON_MINUS
Constant for specifying a predefined icon type for a button.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#ICON_PLUS
Constant for specifying a predefined icon type for a button.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#ICON_REFRESH
Constant for specifying a predefined icon type for a button.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#ICON_RIGHT
Constant for specifying a predefined icon type for a button.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#ICON_SEARCH
Constant for specifying a predefined icon type for a button.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#ICON_STAR
Constant for specifying a predefined icon type for a button.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#ICON_UP
Constant for specifying a predefined icon type for a button.

HTML Table
id
classservoy sSummary
Colgroup Tag
Column
padding0px
width80px

Column

Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Property Summary
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#dataProviderID
The dataprovider of the component.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#displaysTags
Flag that enables or disables merging of data inside components using tags (placeholders).
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#enabled
The enable state of the component, default true.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#format
The format that should be applied when displaying data(using dataProviderID) in the label/button.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#height
The height in pixels of the component.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#iconType
Icon shown on a button.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#name
The name of the component.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
JSMethod
Table Cell (td)
#onAction
The method that is executed when the component is clicked.
Table Body (tbody)
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 Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#text
The text that is displayed inside the component.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#visible
The visible property of the component, default true.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#width
The width in pixels of the component.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#x
The x coordinate of the component on the form.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#y
The y coordinate of the component on the form.

HTML Table
id
classservoy sSummary
Colgroup Tag
Column
padding0px
width80px

Column

Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Method Summary

HTML Table
idconstant
classservoy sDetail
Colgroup Tag
Column
padding0px
width100%

Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan1
Constants Details
Table Body (tbody)
idICON_ALERT
Table Row (tr)
idname
Table Cell (td)
ICON_ALERT
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Constant for specifying a predefined icon type for a button.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

myButton.iconType = JSButton.ICON_...;

...

Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idICON_BACK
Table Row (tr)
idname
Table Cell (td)
ICON_BACK
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Constant for specifying a predefined icon type for a button.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

myButton.iconType = JSButton.ICON_...;

...

Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idICON_BARS
Table Row (tr)
idname
Table Cell (td)
ICON_BARS
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Constant for specifying a predefined icon type for a button.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

myButton.iconType = JSButton.ICON_...;

...

Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idICON_CHECK
Table Row (tr)
idname
Table Cell (td)
ICON_CHECK
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Constant for specifying a predefined icon type for a button.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

myButton.iconType = JSButton.ICON_...;

...

Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idICON_DELETE
Table Row (tr)
idname
Table Cell (td)
ICON_DELETE
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Constant for specifying a predefined icon type for a button.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

myButton.iconType = JSButton.ICON_...;

...

Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idICON_DOWN
Table Row (tr)
idname
Table Cell (td)
ICON_DOWN
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Constant for specifying a predefined icon type for a button.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

myButton.iconType = JSButton.ICON_...;

...

Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idICON_EDIT
Table Row (tr)
idname
Table Cell (td)
ICON_EDIT
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Constant for specifying a predefined icon type for a button.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

myButton.iconType = JSButton.ICON_...;

...

Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idICON_FORWARD
Table Row (tr)
idname
Table Cell (td)
ICON_FORWARD
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Constant for specifying a predefined icon type for a button.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

myButton.iconType = JSButton.ICON_...;

...

Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idICON_GEAR
Table Row (tr)
idname
Table Cell (td)
ICON_GEAR
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Constant for specifying a predefined icon type for a button.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

myButton.iconType = JSButton.ICON_...;

...

Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idICON_GRID
Table Row (tr)
idname
Table Cell (td)
ICON_GRID
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Constant for specifying a predefined icon type for a button.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

myButton.iconType = JSButton.ICON_...;

...

Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idICON_HOME
Table Row (tr)
idname
Table Cell (td)
ICON_HOME
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Constant for specifying a predefined icon type for a button.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

myButton.iconType = JSButton.ICON_...;

...

Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idICON_INFO
Table Row (tr)
idname
Table Cell (td)
ICON_INFO
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Constant for specifying a predefined icon type for a button.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

myButton.iconType = JSButton.ICON_...;

...

Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idICON_LEFT
Table Row (tr)
idname
Table Cell (td)
ICON_LEFT
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Constant for specifying a predefined icon type for a button.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

myButton.iconType = JSButton.ICON_...;

...

Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idICON_MINUS
Table Row (tr)
idname
Table Cell (td)
ICON_MINUS
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Constant for specifying a predefined icon type for a button.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

myButton.iconType = JSButton.ICON_...;

...

Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idICON_PLUS
Table Row (tr)
idname
Table Cell (td)
ICON_PLUS
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Constant for specifying a predefined icon type for a button.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

myButton.iconType = JSButton.ICON_...;

...

Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idICON_REFRESH
Table Row (tr)
idname
Table Cell (td)
ICON_REFRESH
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Constant for specifying a predefined icon type for a button.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

myButton.iconType = JSButton.ICON_...;

...

Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idICON_RIGHT
Table Row (tr)
idname
Table Cell (td)
ICON_RIGHT
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Constant for specifying a predefined icon type for a button.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

myButton.iconType = JSButton.ICON_...;

...

Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idICON_SEARCH
Table Row (tr)
idname
Table Cell (td)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Constant for specifying a predefined icon type for a button.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

myButton.iconType = JSButton.ICON_...;

...

Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idICON_STAR
Table Row (tr)
idname
Table Cell (td)
ICON_STAR
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Constant for specifying a predefined icon type for a button.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

myButton.iconType = JSButton.ICON_...;

...

Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idICON_UP
Table Row (tr)
idname
Table Cell (td)
ICON_UP
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Constant for specifying a predefined icon type for a button.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

myButton.iconType = JSButton.ICON_...;

...

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)
iddataProviderID
Table Row (tr)
idname
Table Cell (td)
dataProviderID
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The dataprovider of the component.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

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

...

Table Row (tr)
classlastDetailRow
Table Cell (td)

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

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

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

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

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

var label = form.newLabel('You are viewing record no. %%parent_table_id%%. You are running on server %%serverURL%%.', 
					10, 10, 600, 100);
label.displaysTags = true;

...

Table Row (tr)
classlastDetailRow
Table Cell (td)

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

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

...

Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idformat
Table Row (tr)
idname
Table Cell (td)
format
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The format that should be applied when displaying data(using dataProviderID) in the label/button.
Some examples are "#%", "dd-MM-yyyy", "MM-dd-yyyy", etc.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

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

...

Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
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)
idiconType
Table Row (tr)
idname
Table Cell (td)
iconType
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Icon shown on a button.
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 btn = form.newButton('I am a button', 1, null);
btn.iconType = JSButton.ICON_STAR

...

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)
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)
idtext
Table Row (tr)
idname
Table Cell (td)
text
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The text that is displayed inside the component.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

// In general the text is specified when creating the component.
var label = form.newLabel('Initial text', 10, 10, 100, 20);
// But it can be changed later if needed.
label.text = 'Changed text';

...

Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
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