Child pages
  • Password

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 sSummary}{colgroup}{column:width=80px|padding=0px}{column}{column}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=2}Event Summary{th}{tr}{tbody}{tr}{td}{td}{td}[#onAction] The method that is executed when the component is clicked.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#onDataChange] Method that is executed when the data in the component is successfully changed.{td}{tr}{tbody}{tbody}{tr}{td}{td}{td}[#onFocusGained] The method that is executed when the component gains focus.{td}{tr}{tbody}{tbody}{tr}{td}{td}{td}[#onFocusLost] The method that is executed when the component looses focus.{td}{tr}{tbody}{tbody}{tr}{td}{td}{td}[#onRender] The method that is executed when the component is rendered.{td}{tr}{tbody}{tbody}{tr}{td}{td}{td}[#onRightClick] The method that is executed when the component is right clicked.{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}[Number]{td}{td}[#anchors] Enables a component to stick to a specific side of form and/or to grow or shrink when a window is resized.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#background] The background color of the component.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#borderType] The type, color and style of border of the component.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#dataProvider] The dataprovider of the component.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#displayType] The type of display used by the field.{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}[#editable] Flag that tells if the content of the field can be edited or not.{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}[#fontType] The font type of the component.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#foreground] The foreground color of the component.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#format] The format that should be applied when displaying the data in the component.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#horizontalAlignment] Horizontal alignment of the text inside the component.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#location] The x and y position of the component, in pixels, separated by a comma.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#margin] The margins of the component.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#name] The name of the component.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#placeholderText] The text that is displayed in field when the field doesn't have a text value.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#printSliding] Enables an element to resize based on its content and/or move when printing.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#printable] Flag that tells if the component should be printed or not when the form is printed.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#scrollbars] Scrollbar options for the vertical and horizontal scrollbars.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#selectOnEnter] Flag that tells if the content of the field should be automatically selected when the field receives focus.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#size] The width and height (in pixels), separated by a comma.{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}[Number]{td}{td}[#tabSeq] An index that specifies the position of the component in the tab sequence.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#toolTipText] The text displayed when hovering over the component with a mouse cursor.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#transparent] Flag that tells if the component is transparent or not.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#valuelist] The valuelist that is used by this field when displaying data.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#visible] The visible property of the component, default true.{td}{tr}{tbody}{table}\\ {table:id=event|class=servoy sDetail}{colgroup}{column:width=100%|padding=0px}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=1}Event Details{th}{tr}{tbody:id=onAction}{tr:id=name}{td}h6.onAction{td}{tr}{tr:id=des}{td}{div:class=sIndent}The method that is executed when the component is clicked.{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=onDataChange-__JSEvent}{tr:id=name}{td}h6.onDataChange{td}{tr}{tr:id=des}{td}{div:class=sIndent}Method that is executed when the data in the component is successfully changed.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}oldValue -- old value newValue -- new value \{[JSEvent]} event -- the event that triggered the action {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=onFocusGained-JSEvent}{tr:id=name}{td}h6.onFocusGained{td}{tr}{tr:id=des}{td}{div:class=sIndent}The method that is executed when the component gains focus. NOTE: Do not call methods that will influence the focus itself.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[JSEvent]} event -- the event that triggered the action {div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=onFocusLost-JSEvent}{tr:id=name}{td}h6.onFocusLost{td}{tr}{tr:id=des}{td}{div:class=sIndent}The method that is executed when the component looses focus.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[JSEvent]} event -- the event that triggered the action {div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=onRender}{tr:id=name}{td}h6.onRender{td}{tr}{tr:id=des}{td}{div:class=sIndent}The method that is executed when the component is rendered.{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=onRightClick}{tr:id=name}{td}h6.onRightClick{td}{tr}{tr:id=des}{td}{div:class=sIndent}The method that is executed when the component is right clicked.{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table}\\ {table:id=property|class=servoy sDetail}{colgroup}{column:width=100%|padding=0px}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=1}Property Details{th}{tr}{tbody:id=anchors}{tr:id=name}{td}h6.anchors{td}{tr}{tr:id=des}{td}{div:class=sIndent}Enables a component to stick to a specific side of form and/or to grow or shrink when a window is resized. If opposite anchors are activated then the component with grow or shrink with the window. For example if Top and Bottom are activated, then the component will grow/shrink when the window is vertically resized. If Left and Right are activated then the component will grow/shrink when the window is horizontally resized. If opposite anchors are not activated, then the component will keep a constant distance from the sides of the window which correspond to the activated anchors.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Number]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=background}{tr:id=name}{td}h6.background{td}{tr}{tr:id=des}{td}{div:class=sIndent}The background color of the component.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=borderType}{tr:id=name}{td}h6.borderType{td}{tr}{tr:id=des}{td}{div:class=sIndent}The type, color and style of border of the component.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=dataProvider}{tr:id=name}{td}h6.dataProvider{td}{tr}{tr:id=des}{td}{div:class=sIndent}The dataprovider of the component.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=displayType}{tr:id=name}{td}h6.displayType{td}{tr}{tr:id=des}{td}{div:class=sIndent}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.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Number]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=displaysTags}{tr:id=name}{td}h6.displaysTags{td}{tr}{tr:id=des}{td}{div:class=sIndent}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.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=editable}{tr:id=name}{td}h6.editable{td}{tr}{tr:id=des}{td}{div:class=sIndent}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.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=enabled}{tr:id=name}{td}h6.enabled{td}{tr}{tr:id=des}{td}{div:class=sIndent}The enable state of the component, default true.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean] -- enabled state{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=fontType}{tr:id=name}{td}h6.fontType{td}{tr}{tr:id=des}{td}{div:class=sIndent}The font type of the component.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=foreground}{tr:id=name}{td}h6.foreground{td}{tr}{tr:id=des}{td}{div:class=sIndent}The foreground color of the component.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=format}{tr:id=name}{td}h6.format{td}{tr}{tr:id=des}{td}{div:class=sIndent}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

Div
iddescription


HTML Table
id
classservoy sSummary
Colgroup Tag
Column
padding0px
width80px

Column

Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Event Summary
Table Body (tbody)
Table Row (tr)
Table Cell (td)

Table Cell (td)
#onAction
The method that is executed when the component is clicked.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#onDataChange
Method that is executed when the data in the component is successfully changed.
Table Body (tbody)
Table Row (tr)
Table Cell (td)

Table Cell (td)
#onFocusGained
The method that is executed when the component gains focus.
Table Body (tbody)
Table Row (tr)
Table Cell (td)

Table Cell (td)
#onFocusLost
The method that is executed when the component looses focus.
Table Body (tbody)
Table Row (tr)
Table Cell (td)

Table Cell (td)
#onRender
The method that is executed when the component is rendered.
Table Body (tbody)
Table Row (tr)
Table Cell (td)

Table Cell (td)
#onRightClick
The method that is executed when the component is right clicked.

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)
Number
Table Cell (td)
#anchors
Enables a component to stick to a specific side of form and/or to
grow or shrink when a window is resized.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#background
The background color of the component.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#borderType
The type, color and style of border of the component.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#dataProvider
The dataprovider of the component.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#displayType
The type of display used by the field.
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)
#editable
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)
#enabled
The enable state of the component, default true.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#fontType
The font type of the component.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#foreground
The foreground color of the component.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#format
The format that should be applied when displaying the data in the component.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#horizontalAlignment
Horizontal alignment of the text inside the component.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#location
The x and y position of the component, in pixels, separated by a comma.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#margin
The margins of the component.
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)
String
Table Cell (td)
#placeholderText
The text that is displayed in field when the field doesn't have a text value.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#printSliding
Enables an element to resize based on its content and/or move when printing.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#printable
Flag that tells if the component should be printed or not when the form is printed.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#scrollbars
Scrollbar options for the vertical and horizontal scrollbars.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#selectOnEnter
Flag that tells if the content of the field should be automatically selected
when the field receives focus.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#size
The width and height (in pixels), separated by a comma.
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)
Number
Table Cell (td)
#tabSeq
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)
#toolTipText
The text displayed when hovering over the component with a mouse cursor.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#transparent
Flag that tells if the component is transparent or not.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#valuelist
The valuelist that is used by this field when displaying data.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#visible
The visible property of the component, default true.

HTML Table
idevent
classservoy sDetail
Colgroup Tag
Column
padding0px
width100%

Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan1
Event Details
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)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idonDataChange-__JSEvent
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)
idprs
Table Cell (td)
Parameters
Div
classsIndent
oldValue – old value
newValue – new value
{JSEvent} event – the event that triggered the action
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Boolean
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idonFocusGained-JSEvent
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)
idprs
Table Cell (td)
Parameters
Div
classsIndent
{JSEvent} event – the event that triggered the action
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idonFocusLost-JSEvent
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)
idprs
Table Cell (td)
Parameters
Div
classsIndent
{JSEvent} event – the event that triggered the action
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)
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)
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)
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)
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)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
iddataProvider
Table Row (tr)
idname
Table Cell (td)
dataProvider
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)
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)
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)
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)
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 – enabled state
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)
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)
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.
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=horizontalAlignment}{tr:id=name}{td}h6.horizontalAlignment{td}{tr}{tr:id=des}{td}{div:class=sIndent}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.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Number]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=location}{tr:id=name}{td}h6.location{td}{tr}{tr:id=des}{td}{div:class=sIndent}The x and y position of the component, in pixels, separated by a comma.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=margin}{tr:id=name}{td}h6.margin{td}{tr}{tr:id=des}{td}{div:class=sIndent}The margins of the component. They are specified in this order, separated by commas: top, left, bottom, right.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=name}{tr:id=name}{td}h6.name{td}{tr}{tr:id=des}{td}{div:class=sIndent}The name of the component. Through this name it can also accessed in methods.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=placeholderText}{tr:id=name}{td}h6.placeholderText{td}{tr}{tr:id=des}{td}{div:class=sIndent}The text that is displayed in field when the field doesn't have a text value.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=printSliding}{tr:id=name}{td}h6.printSliding{td}{tr}{tr:id=des}{td}{div:class=sIndent}Enables an element to resize based on its content and/or move when printing. The component can move horizontally or vertically and can grow or shrink in height and width, based on its content and the content of neighboring components.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Number]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=printable}{tr:id=name}{td}h6.printable{td}{tr}{tr:id=des}{td}{div:class=sIndent}Flag that tells if the component should be printed or not when the form is printed. By default components are printable.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=scrollbars}{tr:id=name}{td}h6.scrollbars{td}{tr}{tr:id=des}{td}{div:class=sIndent}Scrollbar options for the vertical and horizontal scrollbars. Each of the vertical and horizontal scrollbars can be configured to display all the time, to display only when needed or to never display.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Number]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=selectOnEnter}{tr:id=name}{td}h6.selectOnEnter{td}{tr}{tr:id=des}{td}{div:class=sIndent}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".{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=size}{tr:id=name}{td}h6.size{td}{tr}{tr:id=des}{td}{div:class=sIndent}The width and height (in pixels), separated by a comma.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=styleClass}{tr:id=name}{td}h6.styleClass{td}{tr}{tr:id=des}{td}{div:class=sIndent}The name of the style class that should be applied to this component. When defining style classes for specific component types, their names must be prefixed according to the type of the component. For example in order to define a class names 'fancy' for fields, in the style definition the class must be named 'field.fancy'. If it would be intended for labels, then it would be named 'label.fancy'. When specifying the class name for a component, the prefix is dropped however. Thus the field or the label will have its styleClass property set to 'fancy' only.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=tabSeq}{tr:id=name}{td}h6.tabSeq{td}{tr}{tr:id=des}{td}{div:class=sIndent}An index that specifies the position of the component in the tab sequence. The components are put into the tab sequence in increasing order of this property. A value of 0 means to use the default mechanism of building the tab sequence (based on their location on the form). A value of \-2 means to remove the component from the tab sequence.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Number]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=toolTipText}{tr:id=name}{td}h6.toolTipText{td}{tr}{tr:id=des}{td}{div:class=sIndent}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>{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=transparent}{tr:id=name}{td}h6.transparent{td}{tr}{tr:id=des}{td}{div:class=sIndent}Flag that tells if the component is transparent or not. The default value is "false", that is the components are not transparent.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=valuelist}{tr:id=name}{td}h6.valuelist{td}{tr}{tr:id=des}{td}{div:class=sIndent}The valuelist that is used by this field when displaying data. Can be used with fields of type CHECKS, COMBOBOX, RADIOS and TYPE\_AHEAD.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Number]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=visible}{tr:id=name}{td}h6.visible{td}{tr}{tr:id=des}{td}{div:class=sIndent}The visible property of the component, default true.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean] -- visible property{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table}
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String
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)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idlocation
Table Row (tr)
idname
Table Cell (td)
location
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The x and y position of the component, in pixels, separated by a comma.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String
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)
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)
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)
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)
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)
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)
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)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idsize
Table Row (tr)
idname
Table Cell (td)
size
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The width and height (in pixels), separated by a comma.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String
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)
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)
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)
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)
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
Number
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 – visible property
Table Row (tr)
classlastDetailRow
Table Cell (td)