Child pages
  • dialogs

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

padding0px
width80px

...

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

...

Table Cell (td)
String

...

DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY (EXCEPT INSIDE THE DIV BELOW WITH ID=DESCRIPTION), UNLESS YOU KNOW WHAT YOU'RE DOING.
THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO AUTO UPDATE THE CONTENT THROUGH THE DOC GENERATOR.
Enter additional information related to this 'class' inside the {div} macro with 'id=description'
Divcache
styleindexdisplay:none
Div
iddescription

The Dialogs plugin provides a few convenient functions to quickly show a dialog. It supports the following types of dialogs:

  • Error dialog
  • Info dialog
  • Input dialog
  • Question dialog
  • Select dialog
  • Warning dialog

Currently this plugin is only supported in the Smart Client. ServoyForge hosts a drop-in replacement for the Dialogs plugin adds support for the same type of Dialogs and this plugin, but then equally supported in both the Smart and Web Client. This Dialogs module can be found here.

...

Table Cell (td)
String

...

true
refresh100d
showRefreshtrue
iddoc
titleRefresh page
showDatetrue
retryEnable

servoy sReturnTypes2100%height: 30px;2Supported ClientssWordListSmartClientsWordListWebClientsWordListNGClientsWordListMobileClient

servoy sSummary12%30%58%height: 30px;3Methods SummaryShows a message dialog with the specified title, message and a customizable set of buttons.

...

...

Table Cell (td)
String

...

Shows a message dialog with the specified title, message and a customizable set of buttons.

...

Shows an input dialog where the user can enter data.

...

Table Cell (td)
String

...

Shows an input dialog where the user can enter data.

...

Table Cell (td)
String

...

...

Table Cell (td)
String

...

Shows an input dialog where the user can enter data.

...

Shows an input dialog where the user can enter data.

...

Table Cell (td)
String

...

Shows a message dialog with the specified title, message and a customizable set of buttons.

...

Table Cell (td)
String

...

Shows a message dialog with the specified title, message and a customizable set of buttons.

...

Table Cell (td)
String

...

Table Cell (td)
String

...

Shows a selection dialog, where the user can select an entry from a list of options.

...

...

Table Cell (td)
String

...

Shows a selection dialog, where the user can select an entry from a list of options.

...

Shows a message dialog with the specified title, message and a customizable set of buttons.

...

Table Cell (td)
String

...

table
Shows a message dialog with the specified title, message and a customizable set of buttons.

...

servoy sDetail

id

function

class
Colgroup Tag
Column
padding0px
width100%
Table Row (tr)
style2100%height:30px;
Table Head (th)
colspan1
Method Details
Table Body (tbody)
idshowErrorDialog-String_String_StringArray
Table Row (tr)
idname
Table Cell (td)
showErrorDialog
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String
Span
stylefont-weight: bold;
showErrorDialog
Span2Methods DetailsshowErrorDialogname

showErrorDialog(dialogTitle, dialogMessage, buttonsText)

Table Row (tr)id

des Table Cell (td) DivclasssIndent
Shows a message dialog with the specified title, message and a customizable set of
buttons. Table Row (tr)
idprs
Table Cell (td)Parameters
Div
classsIndent
{String} dialogTitle – Dialog title.
{String} dialogMessage – Dialog message.
{String...} buttonsText – Table Row (tr)id
 buttons.
Returns pressed button text, in case window is closed without pressing any button return value depends on client type.
prs

Parameters

sIndentdialogTitleDialog title.dialogMessageDialog message.buttonsTextArray of button texts.
tdret

Returns

divsIndentclients

classtd

Supported Clients

sIndent
String Table Row (tr)
idsam
Table Row (tr)
classlastDetailRow
Table Cell (td) Table Body (tbody)
idshowInfoDialog-String_String_StringArray
Table Row (tr)
idname
Table Cell (td)
showInfoDialog
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String
Span
stylefont-weight: bold;
showInfoDialog
SpanSmartClient,WebClient,NGClientsam

Sample

Div
classsIndent
Code Block
languagejavascript

//show dialog
var thePressedButton = plugins.dialogs.showErrorDialog('Title', 'Value not allowed','OK');
sIdentjavascriptlastDetailRowshowInfoDialogname

showInfoDialog(dialogTitle, dialogMessage, buttonsText)

tr

idclassdes Table Cell (td) DivsIndent
Shows a message dialog with the specified title, message and a customizable set of buttons
. Table Row (tr)
idprs
Table Cell (td)Parameters
Div
classsIndent
{String} dialogTitle – Dialog title.
{String} dialogMessage – Dialog message.
{String...} buttonsText – Table Row (tr)id
.
Returns pressed button text, in case window is closed without pressing any button return value depends on client type.
prs

Parameters

sIndentdialogTitleDialog title.dialogMessageDialog message.buttonsTextArray of button texts.
ret

Table Cell (td)

Returns

divsIndentclients

classtd

Supported Clients

sIndent
String Table Row (tr)
idsam
Table Row (tr)
classlastDetailRow
Table Cell (td) Table Body (tbody)
idshowInputDialog
Table Row (tr)
idname
Table Cell (td)
showInputDialog
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String
Span
stylefont-weight: bold;
showInputDialog
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Shows an input dialog where the user can enter data. Returns the entered data, or nothing when canceled.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

//show input dialog ,returns nothing when canceled 
var typedInput = plugins.dialogs.showInputDialog('Specify','Your name');
Table Row (tr)
classlastDetailRow
Table Cell (td) Table Body (tbody)
idshowInputDialog-String
Table Row (tr)
idname
Table Cell (td)
showInputDialog
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String
Span
stylefont-weight: bold;
showInputDialog
Span
(dialog_title)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Shows an input dialog where the user can enter data. Returns the entered data, or nothing when canceled.
Table Row (tr)
idprs
Table Cell (td)
Parameters
Div
classsIndent
{String} dialog_title
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

//show input dialog ,returns nothing when canceled 
var typedInput = plugins.dialogs.showInputDialog('Specify','Your name');
Table Row (tr)
classlastDetailRow
Table Cell (td) Table Body (tbody)
idshowInputDialog-String_String
Table Row (tr)
idname
Table Cell (td)
showInputDialog
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String
Span
stylefont-weight: bold;
showInputDialog
Span
(dialog_title, msg)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Shows an input dialog where the user can enter data. Returns the entered data, or nothing when canceled.
Table Row (tr)
idprs
Table Cell (td)
Parameters
Div
classsIndent
{String} dialog_title
{String} msg
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

//show input dialog ,returns nothing when canceled 
var typedInput = plugins.dialogs.showInputDialog('Specify','Your name');
Table Row (tr)
classlastDetailRow
Table Cell (td) Table Body (tbody)
idshowInputDialog-String_String_String
Table Row (tr)
idname
Table Cell (td)
showInputDialog
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String
Span
stylefont-weight: bold;
showInputDialog
SpanSmartClient,WebClient,NGClientsam

Sample

Div
classsIndent
Code Block
languagejavascript

//show dialog
var thePressedButton = plugins.dialogs.showInfoDialog('Title', 'Value not allowed','OK');
sIdentjavascriptlastDetailRowshowInputDialogname

showInputDialog()

dessIndent
Shows an input dialog where the user can enter data. Returns the entered data, or nothing when canceled.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
showInputDialogname

showInputDialog(dialog_title)

dessIndent
Shows an input dialog where the user can enter data. Returns the entered data, or nothing when canceled.
prs

Parameters

sIndentdialog_title ;
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
showInputDialogname

showInputDialog(dialog_title, msg)

dessIndent
Shows an input dialog where the user can enter data. Returns the entered data, or nothing when canceled.
prs

Parameters

sIndentdialog_title ;msg ;
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
showInputDialogname

showInputDialog(dialog_title, msg, initialValue)

Table Row (tr)idclass

des Table Cell (td) DividsIndent
Shows an input dialog where the user can enter data. Returns the entered data, or nothing when canceled.
Table Row (tr)tdprsclass

Parameters

DivsIndent{String} Spandialog_title
{String} msg
{String} initialValue
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

//show input dialog ,returns nothing when canceled 
var typedInput = plugins.dialogs.showInputDialog('Specify','Your name');
Table Row (tr)
classlastDetailRow
Table Cell (td) Table Body (tbody)
idshowQuestionDialog-String_String
Table Row (tr)
idname
Table Cell (td)
showQuestionDialog
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String
Span
stylefont-weight: bold;
showQuestionDialog
id ;msg ;initialValue ;ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
showQuestionDialogname

showQuestionDialog(dialogTitle, dialogMessage)

Table Row (tr)classdes Table Cell (td) DivsIndent
Shows a message dialog with the specified title, message and a customizable set of
buttons.
Table Row (tr)
idprs
Table Cell (td)
Parameters
Div
classsIndent
{String} dialogTitle – Dialog title.
{String} dialogMessage – Dialog message.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

//show dialog
var thePressedButton = plugins.dialogs.showQuestionDialog('Title', 'Value not allowed','OK');
Table Row (tr)
classlastDetailRow
Table Cell (td) Table Body (tbody)
idshowQuestionDialog-String_String_StringArray
Table Row (tr)
idname
Table Cell (td)
showQuestionDialog
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String
Span
stylefont-weight: bold;
showQuestionDialog
Span
 buttons.
Returns pressed button text, in case window is closed without pressing any button return value depends on client type.
prs

Parameters

sIndentdialogTitleDialog title.dialogMessageDialog message.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
showQuestionDialogname

showQuestionDialog(dialogTitle, dialogMessage, buttonsText)

tr

idclassdes Table Cell (td) DivsIndent
Shows a message dialog with the specified title, message and a customizable set of buttons
. Table Row (tr)
idprs
Table Cell (td)Parameters
Div
classsIndent
{String} dialogTitle – Dialog title.
{String} dialogMessage – Dialog message.
{String...} buttonsText – Table Row (tr)id
.
Returns pressed button text, in case window is closed without pressing any button return value depends on client type.
prs

Parameters

sIndentdialogTitleDialog title.dialogMessageDialog message.buttonsTextArray of button texts.
ret

Table Cell (td)

Returns

divsIndentclients

classtd

Supported Clients

sIndent
String Table Row (tr)
idsam
Table Row (tr)
classlastDetailRow
Table Cell (td) Table Body (tbody)
idshowSelectDialog-String_String_ObjectArray
Table Row (tr)
idname
Table Cell (td)
showSelectDialog
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String
Span
stylefont-weight: bold;
showSelectDialog
SpanSmartClient,WebClient,NGClientsam

Sample

Div
classsIndent
Code Block
languagejavascript

//show dialog
var thePressedButton = plugins.dialogs.showQuestionDialog('Title', 'Value not allowed','OK');
sIdentjavascriptlastDetailRowshowSelectDialogname

showSelectDialog(dialog_title, msg, optionArray)

tr

idclassdes Table Cell (td) DivsIndent
Shows a selection dialog, where the user can select an entry from a list of options. Returns the selected entry, or nothing when canceled.
Table Row (tr)id
prs

Table Cell (td)class

Parameters

DivsIndent{String} Table Row (tr)
idret
tddialog_title
{String} msg
{Object[]} optionArray ;msg ;optionArray ;ret

Returns

divsIndentclients

classtd

Supported Clients

sIndent
String Table Row (tr)
idsam
Table Row (tr)
classlastDetailRow
Table Cell (td) Table Body (tbody)
idshowSelectDialog-String_String_StringArray
Table Row (tr)
idname
Table Cell (td)
showSelectDialog
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String
Span
stylefont-weight: bold;
showSelectDialog
SpanSmartClient,WebClient,NGClientsam

Sample

Div
classsIndent
Code Block
languagejavascript

//show select,returns nothing when canceled 
var selectedValue = plugins.dialogs.showSelectDialog('Select','please select a name','jan','johan','sebastiaan');
//also possible to pass array with options
//var selectedValue = plugins.dialogs.showSelectDialog('Select','please select a name', new Array('jan','johan','sebastiaan'));
sIdentjavascriptlastDetailRowshowSelectDialogname

showSelectDialog(dialog_title, msg, options)

Table Row (tr)idclass

des Table Cell (td) DividsIndent
Shows a selection dialog, where the user can select an entry from a list of options. Returns the selected entry, or nothing when canceled.
Table Row (tr)prs

Table Cell (td)

Parameters


div

classsIndent{String} Table Row (tr)

idret
tddialog_title
{String} msg
{String...} options ;msg ;options ;ret

Returns

divsIndentclients

classid

Supported Clients

sIndent
String Table Row (tr)SmartClient,WebClient,NGClientsam

Table Cell (td) Table Row (tr)

classlastDetailRow
Table Cell (td) Table Body (tbody)
idshowWarningDialog-String_String
Table Row (tr)
idname
Table Cell (td)
showWarningDialog
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String
Span
stylefont-weight: bold;
showWarningDialog
Span
(dialogTitle, dialogMessage)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Shows a message dialog with the specified title, message and a customizable set of buttons.
Table Row (tr)
idprs
Table Cell (td)
Parameters
Div
classsIndent
{String} dialogTitle – Dialog title.
{String} dialogMessage – Dialog message.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

//show dialog
var thePressedButton = plugins.dialogs.showWarningDialog('Title', 'Value not allowed');
Table Row (tr)
classlastDetailRow
Table Cell (td) Table Body (tbody)
idshowWarningDialog-String_String_StringArray
Table Row (tr)
idname
Table Cell (td)
showWarningDialog
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String
Span
stylefont-weight: bold;
showWarningDialog
Span

Sample

Div
classsIndent
Code Block
languagejavascript

//show select,returns nothing when canceled 
var selectedValue = plugins.dialogs.showSelectDialog('Select','please select a name','jan','johan','sebastiaan');
//also possible to pass array with options
//var selectedValue = plugins.dialogs.showSelectDialog('Select','please select a name', new Array('jan','johan','sebastiaan'));
sIdentjavascriptlastDetailRowshowWarningDialogname

showWarningDialog(dialogTitle, dialogMessage)

dessIndent
Shows a message dialog with the specified title, message and a customizable set of buttons.
Returns pressed button text, in case window is closed without pressing any button return value depends on client type.
prs

Parameters

sIndentdialogTitleDialog title.dialogMessageDialog message.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
showWarningDialogname

showWarningDialog(dialogTitle, dialogMessage, buttonsText)

Table Row (tr)idclass

des Table Cell (td) DivsIndent
Shows a message dialog with the specified title, message and a customizable set of
buttons. Table Row (tr)
idprs
Table Cell (td)Parameters
Div
classsIndent
{String} dialogTitle – Dialog title.
{String} dialogMessage – Dialog message.
{String...} buttonsText – Table Row (tr)id
 buttons.
Returns pressed button text, in case window is closed without pressing any button return value depends on client type.
prs

Parameters

sIndentdialogTitleDialog title.dialogMessageDialog message.buttonsTextArray of button texts.
tdret

Returns

divsIndentclients

classtd

Supported Clients

sIndent
String Table Row (tr)
idsam
Table Row (tr)
classlastDetailRow
tdSmartClient,WebClient,NGClientsam

Sample

Div
classsIndent
Code Block
languagejavascript

//show dialog
var thePressedButton = plugins.dialogs.showWarningDialog('Title', 'Value not allowed','OK');
sIdentjavascriptlastDetailRow