Class Ext.MessageBox

Package:	Ext
Class:	MessageBox
Extends:	Object
Defined In:	MessageBox.js

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

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

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

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

This class is a singleton and cannot be created directly.

Properties - Methods - Events

Public Properties

Property		Defined By
	OK : Object	MessageBox
	Button config that displays a single OK button	MessageBox
	OKCANCEL : Object	MessageBox
	Button config that displays OK and Cancel buttons	MessageBox
	YESNO : Object	MessageBox
	Button config that displays Yes and No buttons	MessageBox
	YESNOCANCEL : Object	MessageBox
	Button config that displays Yes, No and Cancel buttons	MessageBox
	buttonText : Object	MessageBox
	An object containing the default button text strings that can be overriden for localized language support. Supported ...	MessageBox
	defaultTextHeight : Number	MessageBox
	The default height in pixels of the message box's multiline textarea if displayed (defaults to 75)	MessageBox
	maxWidth : Number	MessageBox
	The maximum width in pixels of the message box (defaults to 600)	MessageBox
	minProgressWidth : Number	MessageBox
	The minimum width in pixels of the message box if it is a progress-style dialog. This is useful for setting a differ...	MessageBox
	minWidth : Number	MessageBox
	The minimum width in pixels of the message box (defaults to 100)	MessageBox

Public Methods

Method		Defined By
	alert( `String title`, `String msg`, [`Function fn`], [`Object scope`] ) : Ext.MessageBox	MessageBox
	Displays a standard read-only message box with an OK button (comparable to the basic JavaScript Window.alert). If a c...	MessageBox
	confirm( `String title`, `String msg`, [`Function fn`], [`Object scope`] ) : Ext.MessageBox	MessageBox
	Displays a confirmation message box with Yes and No buttons (comparable to JavaScript's Window.confirm). If a callbac...	MessageBox
	getDialog() : Ext.BasicDialog	MessageBox
	Returns a reference to the underlying Ext.BasicDialog element	MessageBox
	hide() : void	MessageBox
	Hides the message box if it is displayed	MessageBox
	isVisible() : Boolean	MessageBox
	Returns true if the message box is currently displayed	MessageBox
	progress( `String title`, `String msg` ) : Ext.MessageBox	MessageBox
	Displays a message box with a progress bar. This message box has no buttons and is not closeable by the user. You a...	MessageBox
	prompt( `String title`, `String msg`, [`Function fn`], [`Object scope`], [`Boolean/Number multiline`] ) : Ext.MessageBox	MessageBox
	Displays a message box with OK and Cancel buttons prompting the user to enter some text (comparable to JavaScript's W...	MessageBox
	show( `Object config` ) : Ext.MessageBox	MessageBox
	Displays a new message box, or reinitializes an existing message box, based on the config options passed in. All func...	MessageBox
	updateProgress( `Number value`, [`String text`] ) : Ext.MessageBox	MessageBox
	Updates a progress-style message box's text and progress bar. Only relevant on message boxes initiated via Ext.Messa...	MessageBox
	updateText( [`String text`] ) : Ext.MessageBox	MessageBox
	Updates the message box body text	MessageBox
	wait( `String msg`, [`String title`] ) : Ext.MessageBox	MessageBox
	Displays a message box with an infinitely auto-updating progress bar. This can be used to block user interaction whi...	MessageBox

Public Events

This class has no public events.

Property Details

OK

public Object OK

Button config that displays a single OK button

This property is defined by MessageBox.

OKCANCEL

public Object OKCANCEL

Button config that displays OK and Cancel buttons

This property is defined by MessageBox.

YESNO

public Object YESNO

Button config that displays Yes and No buttons

This property is defined by MessageBox.

YESNOCANCEL

public Object YESNOCANCEL

Button config that displays Yes, No and Cancel buttons

This property is defined by MessageBox.

buttonText

public Object buttonText

An object containing the default button text strings that can be overriden for localized language support. Supported properties are: ok, cancel, yes and no. Customize the default text like so: Ext.MessageBox.buttonText.yes = "Sí";

This property is defined by MessageBox.

defaultTextHeight

public Number defaultTextHeight

The default height in pixels of the message box's multiline textarea if displayed (defaults to 75)

This property is defined by MessageBox.

maxWidth

public Number maxWidth

The maximum width in pixels of the message box (defaults to 600)

This property is defined by MessageBox.

minProgressWidth

public Number minProgressWidth

The minimum width in pixels of the message box if it is a progress-style dialog. This is useful for setting a different minimum width than text-only dialogs may need (defaults to 250)

This property is defined by MessageBox.

minWidth

public Number minWidth

The minimum width in pixels of the message box (defaults to 100)

This property is defined by MessageBox.

Method Details

alert

public function alert( String title, String msg, [Function fn], [Object scope] )

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:

title : String
The title bar text
msg : String
The message box body text
fn : Function
(optional) The callback function invoked after the message box is closed
scope : Object
(optional) The scope of the callback function

Returns:

Ext.MessageBox
This message box

This method is defined by MessageBox.

confirm

public function confirm( String title, String msg, [Function fn], [Object scope] )

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:

title : String
The title bar text
msg : String
The message box body text
fn : Function
(optional) The callback function invoked after the message box is closed
scope : Object
(optional) The scope of the callback function

Returns:

Ext.MessageBox
This message box

This method is defined by MessageBox.

getDialog

public function getDialog()

Returns a reference to the underlying Ext.BasicDialog element

Parameters:

None.

Returns:

Ext.BasicDialog
The BasicDialog element

This method is defined by MessageBox.

hide

public function hide()

Hides the message box if it is displayed

Parameters:

None.

Returns:

void

This method is defined by MessageBox.

isVisible

public function isVisible()

Returns true if the message box is currently displayed

Parameters:

None.

Returns:

Boolean
True if the message box is visible, else false

This method is defined by MessageBox.

progress

public function progress( String title, String msg )

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 Ext.MessageBox.updateProgress and closing the message box when the process is complete.

Parameters:

title : String
The title bar text
msg : String
The message box body text

Returns:

Ext.MessageBox
This message box

This method is defined by MessageBox.

prompt

public function prompt( String title, String msg, [Function fn], [Object scope], [Boolean/Number multiline] )

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:

title : String
The title bar text
msg : String
The message box body text
fn : Function
(optional) The callback function invoked after the message box is closed
scope : Object
(optional) The scope of the callback function
multiline : Boolean/Number
(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:

Ext.MessageBox
This message box

This method is defined by MessageBox.

show

public function show( Object config )

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., Ext.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., Ext.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:

Ext.Msg.show({
   title: 'Address',
   msg: 'Please enter your address:',
   width: 300,
   buttons: Ext.MessageBox.OKCANCEL,
   multiline: true,
   fn: saveAddress,
   animEl: 'addAddressBtn'
});

Parameters:

config : Object
Configuration options

Returns:

Ext.MessageBox
This message box

This method is defined by MessageBox.

updateProgress

public function updateProgress( Number value, [String text] )

Updates a progress-style message box's text and progress bar. Only relevant on message boxes initiated via Ext.MessageBox.progress or by calling Ext.MessageBox.show with progress: true.

Parameters:

value : Number
Any number between 0 and 1 (e.g., .5)
text : String
(optional) If defined, the message box's body text is replaced with the specified string (defaults to undefined)

Returns:

Ext.MessageBox
This message box

This method is defined by MessageBox.

updateText

public function updateText( [String text] )

Updates the message box body text

Parameters:

text : String
(optional) Replaces the message box element's innerHTML with the specified string (defaults to the XHTML-compliant non-breaking space character ' ')

Returns:

Ext.MessageBox
This message box

This method is defined by MessageBox.

wait

public function wait( String msg, [String title] )

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:

msg : String
The message box body text
title : String
(optional) The title bar text

Returns:

Ext.MessageBox
This message box

This method is defined by MessageBox.