Class Roo.bootstrap.MessageBox

Package:	Roo.bootstrap
Defined In:	Roo/bootstrap/MessageBox.js.
Class:	MessageBox

Utility class for generating different styles of message boxes. The alias Roo.Msg can also be used.
Example usage:


// Basic alert:
Roo.Msg.alert('Status', 'Changes saved successfully.');

// Prompt for user data:
Roo.Msg.prompt('Name', 'Please enter your name:', function(btn, text){
    if (btn == 'ok'){
        // process text value...
    }
});

// Show a dialog using config options:
Roo.Msg.show({
   title:'Save Changes?',
   msg: 'Your are closing a tab that has unsaved changes. Would you like to save your changes?',
   buttons: Roo.Msg.YESNOCANCEL,
   fn: processResult,
   animEl: 'elId'
});

Class Comments / Notes => [Add Your comment/notes about this class]

Public Methods
Method		Defined By
	Roo.bootstrap.MessageBox.alert (String *title, String msg, Function fn, Object scope) : Roo.MessageBox Displays a standard read-only message box with an OK button (comparable to the basic JavaScript Window.alert). Displays a standard read-only message box with an OK button (comparable to the basic JavaScript Window.alert). If a callback function is passed it will be called after the user clicks the button, and the id of the button that was clicked will be passed as the only parameter to the callback (could also be the top-right close button). Parameters: String title* The title bar text String msg The message box body text Function fn (optional) The callback function invoked after the message box is closed Object scope (optional) The scope of the callback function Returns: Roo.MessageBox This message box	Roo.bootstrap.MessageBox
	Roo.bootstrap.MessageBox.confirm (String *title, String msg, Function fn, Object scope) : Roo.MessageBox Displays a confirmation message box with Yes and No buttons (comparable to JavaScript's Window.confirm). Displays a confirmation message box with Yes and No buttons (comparable to JavaScript's Window.confirm). If a callback function is passed it will be called after the user clicks either button, and the id of the button that was clicked will be passed as the only parameter to the callback (could also be the top-right close button). Parameters: String title* The title bar text String msg The message box body text Function fn (optional) The callback function invoked after the message box is closed Object scope (optional) The scope of the callback function Returns: Roo.MessageBox This message box	Roo.bootstrap.MessageBox
	Roo.bootstrap.MessageBox.getDialog () : Roo.BasicDialog Returns a reference to the underlying {link Roo.BasicDialog} element Returns a reference to the underlying {link Roo.BasicDialog} element Returns: Roo.BasicDialog The BasicDialog element	Roo.bootstrap.MessageBox
	Roo.bootstrap.MessageBox.hide () Hides the message box if it is displayed Hides the message box if it is displayed	Roo.bootstrap.MessageBox
	Roo.bootstrap.MessageBox.isVisible () : Boolean Returns true if the message box is currently displayed Returns true if the message box is currently displayed Returns: Boolean True if the message box is visible, else false	Roo.bootstrap.MessageBox
	Roo.bootstrap.MessageBox.progress (String *title, String msg) : Roo.MessageBox Displays a message box with a progress bar. Displays a message box with a progress bar. This message box has no buttons and is not closeable by the user. You are responsible for updating the progress bar as needed via {link* Roo.MessageBoxupdateProgress} and closing the message box when the process is complete. Parameters: String title The title bar text String msg The message box body text Returns: Roo.MessageBox This message box	Roo.bootstrap.MessageBox
	Roo.bootstrap.MessageBox.prompt (String *title, String msg, Function fn, Object scope, Boolean/Number multiline) : Roo.MessageBox Displays a message box with OK and Cancel buttons prompting the user to enter some text (comparable to JavaScript's Window.prompt). Displays a message box with OK and Cancel buttons prompting the user to enter some text (comparable to JavaScript's Window.prompt). The prompt can be a single-line or multi-line textbox. If a callback function is passed it will be called after the user clicks either button, and the id of the button that was clicked (could also be the top-right close button) and the text that was entered will be passed as the two parameters to the callback. Parameters: String title* The title bar text String msg The message box body text Function fn (optional) The callback function invoked after the message box is closed Object scope (optional) The scope of the callback function Boolean/Number multiline (optional) True to create a multiline textbox using the defaultTextHeight property, or the height in pixels to create the textbox (defaults to false / single-line) Returns: Roo.MessageBox This message box	Roo.bootstrap.MessageBox
	Roo.bootstrap.MessageBox.show (Object *config) : Roo.MessageBox Displays a new message box, or reinitializes an existing message box, based on the config options passed in. Displays a new message box, or reinitializes an existing message box, based on the config options passed in. All functions (e.g. prompt, alert, etc) on MessageBox call this function internally. The following config object properties are supported: Property Type Description ---------- --------------- ------------------------------------------------------------------------------------ animEl String/Element An id or Element from which the message box should animate as it opens and closes (defaults to undefined) buttons Object/Boolean A button config object (e.g., Roo.MessageBox.OKCANCEL or {ok:'Foo', cancel:'Bar'}), or false to not show any buttons (defaults to false) closable Boolean False to hide the top-right close button (defaults to true). Note that progress and wait dialogs will ignore this property and always hide the close button as they can only be closed programmatically. cls String A custom CSS class to apply to the message box element defaultTextHeight Number The default height in pixels of the message box's multiline textarea if displayed (defaults to 75) fn Function A callback function to execute after closing the dialog. The arguments to the function will be btn (the name of the button that was clicked, if applicable, e.g. "ok"), and text (the value of the active text field, if applicable). Progress and wait dialogs will ignore this option since they do not respond to user actions and can only be closed programmatically, so any required function should be called by the same code after it closes the dialog. icon String A CSS class that provides a background image to be used as an icon for the dialog (e.g., Roo.MessageBox.WARNING or 'custom-class', defaults to '') maxWidth Number The maximum width in pixels of the message box (defaults to 600) minWidth Number The minimum width in pixels of the message box (defaults to 100) modal Boolean False to allow user interaction with the page while the message box is displayed (defaults to true) msg String A string that will replace the existing message box body text (defaults to the XHTML-compliant non-breaking space character ' ') multiline Boolean True to prompt the user to enter multi-line text (defaults to false) progress Boolean True to display a progress bar (defaults to false) progressText String The text to display inside the progress bar if progress = true (defaults to '') prompt Boolean True to prompt the user to enter single-line text (defaults to false) proxyDrag Boolean True to display a lightweight proxy while dragging (defaults to false) title String The title text value String The string value to set into the active textbox element if displayed wait Boolean True to display a progress bar (defaults to false) width Number The width of the dialog in pixels Example usage: `Roo.Msg.show({ title: 'Address', msg: 'Please enter your address:', width: 300, buttons: Roo.MessageBox.OKCANCEL, multiline: true, fn: saveAddress, animEl: 'addAddressBtn' });` Parameters: Object config* Configuration options Returns: Roo.MessageBox This message box	Roo.bootstrap.MessageBox
	Roo.bootstrap.MessageBox.updateProgress (Number *value, String text) : Roo.MessageBox Updates a progress-style message box's text and progress bar. Updates a progress-style message box's text and progress bar. Only relevant on message boxes initiated via {link* Roo.MessageBoxprogress} or by calling {link Roo.MessageBoxshow} with progress: true. Parameters: Number value Any number between 0 and 1 (e.g., .5) String text (optional) If defined, the message box's body text is replaced with the specified string (defaults to undefined) Returns: Roo.MessageBox This message box	Roo.bootstrap.MessageBox
	Roo.bootstrap.MessageBox.updateText (String *text) : Roo.MessageBox Updates the message box body text Updates the message box body text Parameters: String text* (optional) Replaces the message box element's innerHTML with the specified string (defaults to the XHTML-compliant non-breaking space character ' ') Returns: Roo.MessageBox This message box	Roo.bootstrap.MessageBox
	Roo.bootstrap.MessageBox.wait (String *msg, String title) : Roo.MessageBox Displays a message box with an infinitely auto-updating progress bar. Displays a message box with an infinitely auto-updating progress bar. This can be used to block user interaction while waiting for a long-running process to complete that does not have defined intervals. You are responsible for closing the message box when the process is complete. Parameters: String msg* The message box body text String title (optional) The title bar text Returns: Roo.MessageBox This message box	Roo.bootstrap.MessageBox

Documentation generated by Introspection Doc Generator on Fri Jul 13 2018 14:10:53 GMT+0800 (HKT) Based on JsDoc Toolkit