interface Alerts

jsx3.gui.Alerts

All Known Implementing Classes:

interface Alerts

Mixin interface allows implementors to show alerts, confirms, and prompts.

Since:

3.0

Method Summary
void	alert(strTitle : String, strMessage : String, fctOnOk : Function, strOk : String, objParams : objParams) show an alert dialog
protected void	configureAlert(objDialog : ?, objParams : Object) configure the dialog
void	confirm(strTitle : String, strMessage : String, fctOnOk : Function, fctOnCancel : Function, strOk : String, strCancel : String, intBtnDefault : int, fctOnNo : Function, strNo : String, objParams : objParams) show a confirm alert
protected abstract jsx3.app.Model	getAlertsParent() implementors of this mixin interface must implement this method
void	prompt(strTitle : String, strMessage : String, fctOnOk : Function, fctOnCancel : Function, strOk : String, strCancel : String, objParams : objParams) show a text box input prompt

Method Detail

alert

void alert(strTitle : String, strMessage : String, fctOnOk : Function, strOk : String, objParams : objParams)

show an alert dialog

Parameters:

strTitle – the title of the dialog

strMessage – the message to display

fctOnOk – callback function on pressing ok button, receives the dialog as an argument; if null the dialog will close itself; if defined must explicitly close the dialog

strOk – the text of the ok button, can be false to remove button from display

objParams – argument to configureAlert()

configureAlert

protected void configureAlert(objDialog : ?, objParams : Object)

configure the dialog

Parameters:

objDialog – the dialog

objParams – may include fields 'width', 'height', 'noTitle', and 'nonModal'.

void confirm(strTitle : String, strMessage : String, fctOnOk : Function, fctOnCancel : Function, strOk : String, strCancel : String, intBtnDefault : int, fctOnNo : Function, strNo : String, objParams : objParams)

show a confirm alert

Parameters:

strTitle – the title of the dialog

strMessage – the message to display

fctOnOk – callback function on pressing ok button, receives the dialog as an argument; if null the dialog will close itself; if defined must explicitly close the dialog

fctOnCancel – callback function on pressing cancel button, receives the dialog as an argument; if null the dialog will close itself; if defined must explicitly close the dialog

strOk – the text of the ok button

strCancel – the text of the cancel button

intBtnDefault – the bold button that receives return key, 1:ok, 2:cancel, 3:no

fctOnNo – callback function on pressing no button, receives the dialog as an argument; if null the dialog will close itself; if defined must explicitly close the dialog

strNo – the text of the no button

objParams – argument to configureAlert()

getAlertsParent

protected abstract jsx3.app.Model getAlertsParent()

implementors of this mixin interface must implement this method

Returns:

the parent of the alert dialogs

prompt

void prompt(strTitle : String, strMessage : String, fctOnOk : Function, fctOnCancel : Function, strOk : String, strCancel : String, objParams : objParams)

show a text box input prompt

Parameters:

strTitle – the title of the dialog

strMessage – the message to display

fctOnOk – callback function on pressing ok button, receives the dialog as an argument, and the value of the text input as a second argument; if null the dialog will close itself; if defined must explicitly close the dialog

fctOnCancel – callback function on pressing cancel button, receives the dialog as an argument; if null the dialog will close itself; if defined must explicitly close the dialog

strOk – the text of the ok button

strCancel – the text of the cancel button

objParams – argument to configureAlert()