Child pages
  • dialogs

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Divcache
HTML Table
id
classservoy sSummary
Colgroup Tag
Col
width80px
Col
Table Head (thead)
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Method Summary
Table Row (tr)
Table Cell (td)
String
Table Cell (td)showErrorDialog(dialogTitle, dialogMessage, buttonsText)
indexstyletruedisplay: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.

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 .

showInfoDialog(dialogTitle, dialogMessage, buttonsText)
servoy sSummary12%30%58%height: 30px;3Methods SummaryShows a message dialog with the specified title, message and a customizable set of buttons.
refresh100d
showRefreshtrue
iddoc
titleRefresh page
showDatetrue
retryEnable
id

servoy sReturnTypes2100%height: 30px;2Supported ClientssWordListSmartClientsWordListWebClientsWordListNGClientsWordListMobileClient

Table Cell (td)
String
Table Cell (td)
Table Row (tr)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)showInputDialog()
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 Row (tr)
Table Cell (td)
String
Table Cell (td)showInputDialog(dialog_title)
Shows an input dialog where the user can enter data. Table Row (tr)
Table Cell (td)
String
Table Cell (td)showInputDialog(dialog_title, msg)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)showInputDialog(dialog_title, msg, initialValue)
Shows an input dialog where the user can enter data.Shows an input dialog where the user can enter data. Table Row (tr)
Table Cell (td)
String
Table Cell (td)showQuestionDialog(dialogTitle, dialogMessage)
Shows a message dialog with the specified title, message and a customizable set of buttons. Table Row (tr)
Table Cell (td)
String
Table Cell (td)showQuestionDialog(dialogTitle, dialogMessage, buttonsText)
Shows a message dialog with the specified title, message and a customizable set of buttons. Table Row (tr)
Table Cell (td)
String
Table Cell (td)showSelectDialog(dialog_title, msg, optionArray)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)showSelectDialog(dialog_title, msg, options)
Shows a selection dialog, where the user can select an entry from a list of options.Shows a selection dialog, where the user can select an entry from a list of options. Table Row (tr)
Table Cell (td)
String
Table Cell (td)showWarningDialog(dialogTitle, dialogMessage)
Shows a message dialog with the specified title, message and a customizable set of buttons. Table Row (tr)td

String

Table Cell (td)
showWarningDialog(dialogTitle, dialogMessage, buttonsText)
Shows a message dialog with the specified title, message and a customizable set of buttons.
HTML Table

functionclass Colgroup Tag Colcolspanservoy sDetail2width100%

Col
Table Head (thead) Table Row (tr)styleheight:30px;
Table Head (th)
colspan2
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)

tr

iddes 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
.
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 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
Span

Returns

Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
//show dialog
var thePressedButton = plugins.dialogs.showErrorDialog('Title', 'Value not allowed','OK');
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
idsIndent pressed button textclients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
showInfoDialogname

showInfoDialog(dialogTitle, dialogMessage, buttonsText)

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.
{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.
ret

Table Cell (td) Table Row (tr)

idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String
Span
stylefont-weight: bold;
showInputDialog
Span

Returns

Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
//show dialog
var thePressedButton = plugins.dialogs.showInfoDialog('Title', 'Value not allowed','OK');
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

sIndent pressed button textclients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
showInputDialogname

showInputDialog()

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

Returns

sIndent input text or null
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 input text or null
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 input text or null
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
showInputDialogname

showInputDialog(dialog_title, msg, initialValue)

Table Row (tr)idclass

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

Parameters

DivsIndent{String}
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
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.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
(dialogTitle, dialogMessage, buttonsText)
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.
{String...} buttonsText - Array of button texts.
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)
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
Spandialog_title
{String} msg
{String} initialValue ;msg ;initialValue ;ret

Returns

sIndent input text or null
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
showQuestionDialogname

showQuestionDialog(dialogTitle, dialogMessage, buttonsText)

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.buttonsTextArray of button texts.
ret

Returns

sIndent pressed button text
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
showSelectDialogname

showSelectDialog(dialog_title, msg, optionArray)

Table Row (tr)id Divclass

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

Parameters

Divclass

sIndent{String}

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 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'));
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
Spandialog_title
{String} msg
{Object[]} optionArray ;msg ;optionArray ;ret

Returns

sIndent selected value or null
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
showSelectDialogname

showSelectDialog(dialog_title, msg, options)

Table Row (tr)id Divclass

des Table Cell (td)idsIndent
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)tdprs

Parameters

Divclass

sIndent{String}

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
(dialogTitle, dialogMessage, buttonsText)
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.
{String...} buttonsText - Array of button texts.
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','OK');
Table Row (tr)
classlastDetailRow
Table Cell (td) dialog_title
{String} msg
{String...} options
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 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'));
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
;msg ;options ;ret

Returns

sIndent selected value or null
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
showWarningDialogname

showWarningDialog(dialogTitle, dialogMessage, buttonsText)

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.buttonsTextArray of button texts.
ret

Returns

sIndent pressed button text
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow