dialogs

(plugins.dialogs)

Methods Summary

Methods Details

showErrorDialog(dialogTitle, dialogMessage, buttonsText)

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.

Parameters String dialogTitle Dialog title. String dialogMessage Dialog message. Array buttonsText variable arguments of button texts.

Returns String pressed button text

Sample

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

showInfoDialog(dialogTitle, dialogMessage, buttonsText)

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.

Parameters String dialogTitle Dialog title. String dialogMessage Dialog message. Array buttonsText variable arguments of button texts.

Returns String pressed button text

Sample

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

showInputDialog()

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

Returns String input text or null

Sample

//show input dialog ,returns nothing when canceled
var typedInput = plugins.dialogs.showInputDialog('Specify','Your name');

showInputDialog(dialog_title)

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

Parameters String dialog_title ;

Returns String input text or null

Sample

//show input dialog ,returns nothing when canceled
var typedInput = plugins.dialogs.showInputDialog('Specify','Your name');

showInputDialog(dialog_title, msg)

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

Parameters String dialog_title ; String msg ;

Returns String input text or null

Sample

//show input dialog ,returns nothing when canceled
var typedInput = plugins.dialogs.showInputDialog('Specify','Your name');

showInputDialog(dialog_title, msg, initialValue)

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

Parameters String dialog_title ; String msg ; String initialValue ;

Returns String input text or null

Sample

//show input dialog ,returns nothing when canceled
var typedInput = plugins.dialogs.showInputDialog('Specify','Your name');

showQuestionDialog(dialogTitle, dialogMessage, buttonsText)

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.

Parameters String dialogTitle Dialog title. String dialogMessage Dialog message. Array buttonsText variable arguments of button texts.

Returns String pressed button text

Sample

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

showSelectDialog(dialog_title, msg, optionArray)

Shows a selection dialog, where the user can select an entry from a list of options. Returns the selected entry, or nothing when canceled.

Parameters String dialog_title ; String msg ; Array optionArray ;

Returns String selected value or null

Sample

//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'));

showSelectDialog(dialog_title, msg, options)

Shows a selection dialog, where the user can select an entry from a list of options. Returns the selected entry, or nothing when canceled.

Parameters String dialog_title ; String msg ; Array options ;

Returns String selected value or null

Sample

//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'));

showWarningDialog(dialogTitle, dialogMessage, buttonsText)

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.

Parameters String dialogTitle Dialog title. String dialogMessage Dialog message. Array buttonsText variable arguments of button texts.

Returns String pressed button text

Sample

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

Last updated