Child pages
  • UICONSTANTS

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
{hidden}
Wiki Markup
Hidden
DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY, UNLESS YOU KNOW WHAT YOU'RE DOING.
		THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO EXTRACT CHANGES FROM THE PAGE AND MERGE THEM BACK INTO SERVOY SOURCE{hidden}
\\ 

{table:id=|class=servoy sSummary}{colgroup}{column:padding=0px|width=80px}{column}{column}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=2}Constants Summary{th}{tr}{tbody}{tr}{td}[String]{td}{td}[


HTML Table
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)
#COMBOBOX_SHOW_POPUP_ON_FOCUS_GAIN

...


Property

...

that

...

can

...

be

...

set

...

using

...

application.

...

Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#DATE_FORMATTERS_LENIENT

...


Property

...

that

...

can

...

be

...

set

...

using

...

application.

...

Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#DATE_FORMATTERS_ROLL_INSTEAD_OF_ADD

...


Property

...

that

...

can

...

be

...

set

...

using

...

application.

...

Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#LEAVE_FIELDS_READONLY_IN_FIND_MODE

...


Property

...

than

...

can

...

be

...

set

...

using

...

application.

...

Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#TOOLTIP_DISMISS_DELAY

...


Property

...

than

...

can

...

be

...

set

...

using

...

application.

...

Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#TOOLTIP_INITIAL_DELAY

...


Property

...

than

...

can

...

be

...

set

...

using

...

application.

...

Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#TYPE_AHEAD_SHOW_POPUP_ON_FOCUS_GAIN

...


Property

...

that

...

can

...

be

...

set

...

using

...

application.

...

Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#TYPE_AHEAD_SHOW_POPUP_WHEN_EMPTY

...


Property

...

that

...

can

...

be

...

set

...

using

...

application.

...

Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#USE_SYSTEM_PRINT_DIALOG

...


Property

...

than

...

can

...

be

...

set

...

using

...

application.

HTML Table
idconstant
classservoy sDetail
Colgroup Tag
Column
padding0px
width100%

Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan1
Constants Details
Table Body (tbody)
idCOMBOBOX_SHOW_POPUP_ON_FOCUS_GAIN
|
class
=
node
}{
Table Row (tr)
:
id
=
name
}{td}h6.
Table Cell (td)
COMBOBOX_SHOW_POPUP_ON_FOCUS_GAIN
{td}{tr}{tr:id=des}{td}Property that can be set using
Table Row (tr)
iddes
Table Cell (td)

Property that can be set using application.setUIProperty()

or

element.putClientProperty().

If

set

on

application

it

will

affect

all

COMBOBOX

fields.

If

set

on

an

element

it

will

affect

only

that

COMBOBOX

element/field

(with

priority

over

the

application

property).


Value

can

be

true/false/null.

If

set

to

true,

the

affected

COMBOBOX

will

show

the

pop

\

-up

when

gaining

focus.


DEFAULT:

true.

{td}{tr}{tr:id=snc}{td}*Since*\\ Replace with version info{td}{tr}{tr:id=prs}{td}*Parameters*\\{td}{tr}{tr:id=ret}{td}*Returns*\\[String]{td}{tr}{tr:id=see}{td}*Also see*\\{div:class=sIndent}{div}{td}{tr}{tr:id=link}{td}*External links*\\{div:class=sIndent}{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

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

// make all COMBOBOX fields not show the pop-up when gaining focus
application.setUIProperty(APP_UI_PROPERTY.COMBOBOX_SHOW_POPUP_ON_FOCUS_GAIN, false);
// make 
all
one COMBOBOX 
fields
field 
not
show the pop-up when gaining focus
application.setUIProperty(APP_UI_PROPERTY.COMBOBOX_SHOW_POPUP_ON_FOCUS_GAIN, false); // make one COMBOBOX field show the pop-up when gaining focus - overrides
 - overrides the application property set
forms.someForm.elements.comboboxElement.putClientProperty(APP_UI_PROPERTY.COMBOBOX_SHOW_POPUP_ON_FOCUS_GAIN, true);
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idDATE_FORMATTERS_LENIENT
|
class
=
node
}{
Table Row (tr)
:
id
=
name
}{td}h6.
Table Cell (td)
DATE_FORMATTERS_LENIENT
{td}{tr}{tr:id=des}{td}Property that can be set using
Table Row (tr)
iddes
Table Cell (td)

Property that can be set using application.setUIProperty()

or

element.putClientProperty().

If

set

on

application

it

will

affect

all

date

formatted

fields.

CAUTION:

this

property

must

be

set

on

application

before

the

fields

are

created

(for

example

in

solution

onOpen

handler).

Changing

it

after

fields

were

created

will

not

affect

these

existing

fields.


If

set

on

an

element

it

will

affect

only

that

date

formatted

element/field

(with

priority

over

the

application

property).


Value

can

be

true/false/null.

If

set

to

false,

date

formatted

fields

will

not

allow

input

of

out

\

-of

\

-bounds

values

(like

62

minutes

means

2

minutes

and

+1

hour).


DEFAULT:

true.

{td}{tr}{tr:id=snc}{td}*Since*\\ Replace with version info{td}{tr}{tr:id=prs}{td}*Parameters*\\{td}{tr}{tr:id=ret}{td}*Returns*\\[String]{td}{tr}{tr:id=see}{td}*Also see*\\{div:class=sIndent}{div}{td}{tr}{tr:id=link}{td}*External links*\\{div:class=sIndent}{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

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

// make all date formatted fields (created after this line is executed) not use lenient mode
application.setUIProperty(APP_UI_PROPERTY.DATE_FORMATTERS_LENIENT, false);
// make 
all
one date formatted 
fields (created after this line is executed) not use
field use lenient mode 
application.setUIProperty(APP_UI_PROPERTY.DATE_FORMATTERS_LENIENT, false); // make one date formatted field use lenient mode
- overrides the application property set
forms.someForm.elements.typeAheadElement.putClientProperty(APP_UI_PROPERTY.DATE_FORMATTERS_LENIENT, true);
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idDATE_FORMATTERS_ROLL_INSTEAD_OF_ADD
|
class
=
node
}{
Table Row (tr)
:
id
=
name
}{td}h6.
Table Cell (td)
DATE_FORMATTERS_ROLL_INSTEAD_OF_ADD
{td}{tr}{tr:id=des}{td}Property that can be set using
Table Row (tr)
iddes
Table Cell (td)

Property that can be set using application.setUIProperty()

or

element.putClientProperty().

It

is

used

only

in

Smart

Client.

If

set

on

application

it

will

affect

all

date

formatted

fields.

If

set

on

an

element

it

will

affect

only

that

date

formatted

element/field

(with

priority

over

the

application

property).


Value

can

be

true/false/null.

If

set

to

true,

only

selected

part

of

the

date

will

be

affected

when

using

up/down

keys

to

cycle

through

values.

(for

example,

pressing

up

when

cursor

is

on

minutes

and

minutes

shows

59

will

not

result

in

hour

change)


DEFAULT:

false.

{td}{tr}{tr:id=snc}{td}*Since*\\ Replace with version info{td}{tr}{tr:id=prs}{td}*Parameters*\\{td}{tr}{tr:id=ret}{td}*Returns*\\[String]{td}{tr}{tr:id=see}{td}*Also see*\\{div:class=sIndent}{div}{td}{tr}{tr:id=link}{td}*External links*\\{div:class=sIndent}{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

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

// make all date formatted fields use roll instead of add
application.setUIProperty(APP_UI_PROPERTY.DATE_FORMATTERS_ROLL_INSTEAD_OF_ADD, true);
// make 
all
one date formatted 
fields
field use 
roll
add instead of
add application.setUIProperty(APP_UI_PROPERTY.DATE_FORMATTERS_ROLL_INSTEAD_OF_ADD, true); // make one date formatted field use add instead of roll - overrides the application property
 roll - overrides the application property set
forms.someForm.elements.typeAheadElement.putClientProperty(APP_UI_PROPERTY.DATE_FORMATTERS_ROLL_INSTEAD_OF_ADD, false);
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idLEAVE_FIELDS_READONLY_IN_FIND_MODE
|
class
=
node
}{
Table Row (tr)
:
id
=
name
}{td}h6.
Table Cell (td)
LEAVE_FIELDS_READONLY_IN_FIND_MODE
{td}{tr}{tr:id=des}{td}Property than can be set using
Table Row (tr)
iddes
Table Cell (td)

Property than can be set using application.setUIProperty().

If

set

to

true,

fields

that

are

read

\

-only

won't

be

editable

in

find

mode


If

set

to

false,

fields

that

are

read

\

-only

will

be

editable

in

find

mode

The

value

can

be

true/false


DEFAULT:

false

{td}{tr}{tr:id=snc}{td}*Since*\\ Replace with version info{td}{tr}{tr:id=prs}{td}*Parameters*\\{td}{tr}{tr:id=ret}{td}*Returns*\\[String]{td}{tr}{tr:id=see}{td}*Also see*\\{div:class=sIndent}{div}{td}{tr}{tr:id=link}{td}*External links*\\{div:class=sIndent}{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

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

application.setUIProperty(APP_UI_PROPERTY.LEAVE_FIELDS_READONLY_IN_FIND_MODE, true)
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idTOOLTIP_DISMISS_DELAY
classnode
Table Row (tr)
idname
Table Cell (td)
TOOLTIP_DISMISS_DELAY
Table Row (tr)
iddes
Table Cell (td)
Property than can be set using application.setUIProperty() and
indicates the delay in milliseconds after the tooltip is dismissed.
Table Row (tr)
idret
Table Cell (td)
Returns
String
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

application.setUIProperty(APP_UI_PROPERTY.
LEAVE
TOOLTIP_
FIELDS_READONLY_IN_FIND_MODE, true) {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=TOOLTIP_DISMISS_DELAY|class=node}{tr:id=name}{td}h6.TOOLTIP_DISMISS_DELAY{td}{tr}{tr:id=des}{td}Property than can be set using
DISMISS_DELAY, 4000)
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idTOOLTIP_INITIAL_DELAY
classnode
Table Row (tr)
idname
Table Cell (td)
TOOLTIP_INITIAL_DELAY
Table Row (tr)
iddes
Table Cell (td)
Property than can be set using application.setUIProperty()
and

indicates
the
delay
in
milliseconds
after
before the
tooltip
is
dismissed.{td}{tr}{tr:id=snc}{td}*Since*\\ Replace with version info{td}{tr}{tr:id=prs}{td}*Parameters*\\{td}{tr}{tr:id=ret}{td}*Returns*\\[String]{td}{tr}{tr:id=see}{td}*Also see*\\{div:class=sIndent}{div}{td}{tr}{tr:id=link}{td}*External links*\\{div:class=sIndent}{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} application.setUIProperty(APP_UI_PROPERTY.TOOLTIP_DISMISS_DELAY, 4000) {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=TOOLTIP_INITIAL_DELAY|class=node}{tr:id=name}{td}h6.TOOLTIP_INITIAL_DELAY{td}{tr}{tr:id=des}{td}Property than can be set using application.setUIProperty() and indicates the delay in milliseconds before the tooltip is shown.{td}{tr}{tr:id=snc}{td}*Since*\\ Replace with version info{td}{tr}{tr:id=prs}{td}*Parameters*\\{td}{tr}{tr:id=ret}{td}*Returns*\\[String]{td}{tr}{tr:id=see}{td}*Also see*\\{div:class=sIndent}{div}{td}{tr}{tr:id=link}{td}*External links*\\{div:class=sIndent}{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}
shown.
Table Row (tr)
idret
Table Cell (td)
Returns
String
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

application.setUIProperty(APP_UI_PROPERTY.TOOLTIP_INITIAL_DELAY, 2000)
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idTYPE_AHEAD_SHOW_POPUP_ON_FOCUS_GAIN
classnode
Table Row (tr)
idname
Table Cell (td)
TYPE_AHEAD_SHOW_POPUP_ON_FOCUS_GAIN
Table Row (tr)
iddes
Table Cell (td)

Property that can be set using application.setUIProperty() or element.putClientProperty().

If set on application it will affect all TYPE-AHEAD fields. If set on an element it will affect only that TYPE-AHEAD element/field (with priority over the application property).
Value can be true/false/null.

If set to true, the affected TYPE_AHEAD(s) will not show the pop-up when gaining focus.
DEFAULT: true.

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

// make all TYPE-AHEAD fields not show the pop-up when gaining focus
application.setUIProperty(APP_UI_PROPERTY.TYPE_AHEAD_SHOW_POPUP_ON_FOCUS_GAIN, false);
// make one TYPE-AHEAD field show the pop-up when gaining focus - overrides the application property set
forms.someForm.elements.typeAheadElement.putClientProperty(APP_UI_PROPERTY.TYPE_AHEAD_SHOW_POPUP_ON_FOCUS_GAIN, true);
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idTYPE_AHEAD_SHOW_POPUP_WHEN_EMPTY
classnode
Table Row (tr)
idname
Table Cell (td)
TYPE_AHEAD_SHOW_POPUP_WHEN_EMPTY
Table Row (tr)
iddes
Table Cell (td)

Property that can be set using application.setUIProperty() or element.putClientProperty().

If set on application it will affect all TYPE-AHEAD fields. If set on an element it will affect only that TYPE-AHEAD element/field (with priority over the application property).
Value can be true/false/null.

If set to true, the affected TYPE_AHEAD(s) will not show the pop-up when the field content is empty.
DEFAULT: true.

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

// make all TYPE-AHEAD fields not show the pop-up when there is empty content in the field
application.setUIProperty(APP_UI_PROPERTY.
TOOLTIP_INITIAL_DELAY, 2000) {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=TYPE_AHEAD_SHOW_POPUP_ON_FOCUS_GAIN|class=node}{tr:id=name}{td}h6
TYPE_AHEAD_SHOW_POPUP_WHEN_EMPTY, false);
// make one TYPE-AHEAD field show the pop-up when there is empty content in the field - overrides the application property set
forms.someForm.elements.typeAheadElement.putClientProperty(APP_UI_PROPERTY.TYPE_AHEAD_SHOW_POPUP_
ON_FOCUS_GAIN{td}{tr}{tr:id=des}{td}Property that can be set using application.setUIProperty() or element.putClientProperty(). If set on application it will affect all TYPE\-AHEAD fields. If set on an element it will affect only that TYPE\-AHEAD element/field (with priority over the application property). Value can be true/false/null. If set to true, the affected TYPE\_AHEAD(s) will not show the pop\-up when gaining focus. DEFAULT: true.{td}{tr}{tr:id=snc}{td}*Since*\\ Replace with version info{td}{tr}{tr:id=prs}{td}*Parameters*\\{td}{tr}{tr:id=ret}{td}*Returns*\\[String]{td}{tr}{tr:id=see}{td}*Also see*\\{div:class=sIndent}{div}{td}{tr}{tr:id=link}{td}*External links*\\{div:class=sIndent}{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} // make all TYPE-AHEAD fields not show the pop-up when gaining focus application.setUIProperty(APP_UI_PROPERTY.TYPE_AHEAD_SHOW_POPUP_ON_FOCUS_GAIN, false); // make one TYPE-AHEAD field show the pop-up when gaining focus - overrides the application property set forms.someForm.elements.typeAheadElement.putClientProperty(APP_UI_PROPERTY.TYPE_AHEAD_SHOW_POPUP_ON_FOCUS_GAIN, true); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=TYPE_AHEAD_SHOW_POPUP_WHEN_EMPTY|class=node}{tr:id=name}{td}h6.TYPE_AHEAD_SHOW_POPUP_WHEN_EMPTY{td}{tr}{tr:id=des}{td}Property that can be set using application.setUIProperty() or element.putClientProperty(). If set on application it will affect all TYPE\-AHEAD fields. If set on an element it will affect only that TYPE\-AHEAD element/field (with priority over the application property). Value can be true/false/null. If set to true, the affected TYPE\_AHEAD(s) will not show the pop\-up when the field content is empty. DEFAULT: true.{td}{tr}{tr:id=snc}{td}*Since*\\ Replace with version info{td}{tr}{tr:id=prs}{td}*Parameters*\\{td}{tr}{tr:id=ret}{td}*Returns*\\[String]{td}{tr}{tr:id=see}{td}*Also see*\\{div:class=sIndent}{div}{td}{tr}{tr:id=link}{td}*External links*\\{div:class=sIndent}{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} // make all TYPE-AHEAD fields not show the pop-up when there is empty content in the field application.setUIProperty(APP_UI_PROPERTY.TYPE_AHEAD_SHOW_POPUP_WHEN_EMPTY, false); // make one TYPE-AHEAD field show the pop-up when there is empty content in the field - overrides the application property set forms.someForm.elements.typeAheadElement.putClientProperty(APP_UI_PROPERTY.TYPE_AHEAD_SHOW_POPUP_WHEN_EMPTY, true); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=USE_SYSTEM_PRINT_DIALOG|class=node}{tr:id=name}{td}h6.USE_SYSTEM_PRINT_DIALOG{td}{tr}{tr:id=des}{td}Property than can be set using application.setUIProperty(). If set to true, the system standard Printing dialog will be used when printing is needed. If set to false, the Servoy Printing dialog will be used. The value can be true/false/null. DEFAULT: false{td}{tr}{tr:id=snc}{td}*Since*\\ Replace with version info{td}{tr}{tr:id=prs}{td}*Parameters*\\{td}{tr}{tr:id=ret}{td}*Returns*\\[String]{td}{tr}{tr:id=see}{td}*Also see*\\{div:class=sIndent}{div}{td}{tr}{tr:id=link}{td}*External links*\\{div:class=sIndent}{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}
WHEN_EMPTY, true);
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idUSE_SYSTEM_PRINT_DIALOG
classnode
Table Row (tr)
idname
Table Cell (td)
USE_SYSTEM_PRINT_DIALOG
Table Row (tr)
iddes
Table Cell (td)

Property than can be set using application.setUIProperty().

If set to true, the system standard Printing dialog will be used when printing is needed.
If set to false, the Servoy Printing dialog will be used.

The value can be true/false/null.
DEFAULT: false

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

application.setUIProperty(APP_UI_PROPERTY.USE_SYSTEM_PRINT_DIALOG, true)
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table}
Table Row (tr)
classlastDetailRow
Table Cell (td)