Files
MessageBox.js

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

Note that the MessageBox is asynchronous. Unlike a regular JavaScript alert (which will halt\nbrowser execution), showing a MessageBox will not cause the code to stop. For this reason, if you have code\nthat should only run after some user feedback from the MessageBox, you must use a callback function\n(see the function parameter for show for more details).

Example usage:

// Basic alert:\nExt.Msg.alert('Status', 'Changes saved successfully.');\n\n// Prompt for user data and process the result using a callback:\nExt.Msg.prompt('Name', 'Please enter your name:', function(btn, text){\n    if (btn == 'ok'){\n        // process text value and close...\n    }\n});\n\n// Show a dialog using config options:\nExt.Msg.show({\n   title:'Save Changes?',\n   msg: 'You are closing a tab that has unsaved changes. Would you like to save your changes?',\n   buttons: Ext.Msg.YESNOCANCEL,\n   fn: processResult,\n   animEl: 'elId',\n   icon: Ext.MessageBox.QUESTION\n});\n

\n\n

Defined By

Properties

Ext.MessageBox
view source

CANCEL : Object

Button config that displays a single Cancel button ...

Button config that displays a single Cancel button

Defaults to: {cancel: true}

Ext.MessageBox
view source

ERROR : String

The CSS class that provides the ERROR icon image ...

The CSS class that provides the ERROR icon image

Defaults to: 'ext-mb-error'

Ext.MessageBox
view source

INFO : String

The CSS class that provides the INFO icon image ...

The CSS class that provides the INFO icon image

Defaults to: 'ext-mb-info'

Ext.MessageBox
view source

OK : Object

Button config that displays a single OK button ...

Button config that displays a single OK button

Defaults to: {ok: true}

Ext.MessageBox
view source

OKCANCEL : Object

Button config that displays OK and Cancel buttons ...

Button config that displays OK and Cancel buttons

Defaults to: {ok: true, cancel: true}

Ext.MessageBox
view source

QUESTION : String

The CSS class that provides the QUESTION icon image ...

The CSS class that provides the QUESTION icon image

Defaults to: 'ext-mb-question'

Ext.MessageBox
view source

WARNING : String

The CSS class that provides the WARNING icon image ...

The CSS class that provides the WARNING icon image

Defaults to: 'ext-mb-warning'

Ext.MessageBox
view source

YESNO : Object

Button config that displays Yes and No buttons ...

Button config that displays Yes and No buttons

Defaults to: {yes: true, no: true}

Ext.MessageBox
view source

YESNOCANCEL : Object

Button config that displays Yes, No and Cancel buttons ...

Button config that displays Yes, No and Cancel buttons

Defaults to: {yes: true, no: true, cancel: true}

Ext.MessageBox
view source

buttonText : Object

An object containing the default button text strings that can be overriden for localized language support. ...

An object containing the default button text strings that can be overriden for localized language support.\nSupported properties are: ok, cancel, yes and no. Generally you should include a locale-specific\nresource file for handling language support across the framework.\nCustomize the default text like so: Ext.MessageBox.buttonText.yes = \"oui\"; //french

Defaults to: {ok: "OK", cancel: "Cancel", yes: "Yes", no: "No"}

Ext.MessageBox
view source

defaultTextHeight : Number

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

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

Defaults to: 75

Ext.MessageBox
view source

maxWidth : Number

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

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

Defaults to: 600

Ext.MessageBox
view source

minProgressWidth : Number

The minimum width in pixels of the message box if it is a progress-style dialog. ...

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

Defaults to: 250

Ext.MessageBox
view source

minPromptWidth : Number

The minimum width in pixels of the message box if it is a prompt dialog. ...

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

Defaults to: 250

Ext.MessageBox
view source

minWidth : Number

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

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

Defaults to: 100

Defined By

Methods

Ext.MessageBox
view source

alert( title, msg, [fn], [scope] ) : Ext.MessageBoxchainable

Displays a standard read-only message box with an OK button (comparable to the basic JavaScript alert prompt). ...

Displays a standard read-only message box with an OK button (comparable to the basic JavaScript alert prompt).\nIf a callback function is passed it will be called after the user clicks the button, and the\nid of the button that was clicked will be passed as the only parameter to the callback\n(could also be the top-right close button).

Parameters

title : String
The title bar text
\n
msg : String
The message box body text
\n
fn : Function (optional)
The callback function invoked after the message box is closed
\n
scope : Object (optional)
The scope (this reference) in which the callback is executed. Defaults to the browser wnidow.
\n

Returns

Ext.MessageBox
this
\n

Ext.MessageBox
view source

confirm( title, msg, [fn], [scope] ) : Ext.MessageBoxchainable

Displays a confirmation message box with Yes and No buttons (comparable to JavaScript's confirm). ...

Displays a confirmation message box with Yes and No buttons (comparable to JavaScript's confirm).\nIf a callback function is passed it will be called after the user clicks either button,\nand the id of the button that was clicked will be passed as the only parameter to the callback\n(could also be the top-right close button).

Parameters

title : String
The title bar text
\n
msg : String
The message box body text
\n
fn : Function (optional)
The callback function invoked after the message box is closed
\n
scope : Object (optional)
The scope (this reference) in which the callback is executed. Defaults to the browser wnidow.
\n

Returns

Ext.MessageBox
this
\n

Ext.MessageBox
view source

getDialog( titleText ) : Ext.Window

Returns a reference to the underlying Ext.Window element ...

Returns a reference to the underlying Ext.Window element

Parameters

titleText : Object
\n

Returns

Ext.Window
The window
\n

Ext.MessageBox
view source

hide( ) : Ext.MessageBoxchainable

Hides the message box if it is displayed ...

Hides the message box if it is displayed

Returns

Ext.MessageBox
this
\n

Ext.MessageBox
view source

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
\n

Ext.MessageBox
view source

progress( title, msg, [progressText] ) : Ext.MessageBoxchainable

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\nthe user. You are responsible for updating the progress bar as needed via updateProgress\nand closing the message box when the process is complete.

Parameters

title : String
The title bar text
\n
msg : String
The message box body text
\n
progressText : String (optional)
The text to display inside the progress bar (defaults to '')
\n

Returns

Ext.MessageBox
this
\n

Ext.MessageBox
view source

prompt( title, msg, [fn], [scope], [multiline], [value] ) : Ext.MessageBoxchainable

Displays a message box with OK and Cancel buttons prompting the user to enter some text (comparable to JavaScript's p...

Displays a message box with OK and Cancel buttons prompting the user to enter some text (comparable to JavaScript's prompt).\nThe prompt can be a single-line or multi-line textbox. If a callback function is passed it will be called after the user\nclicks either button, and the id of the button that was clicked (could also be the top-right\nclose button) and the text that was entered will be passed as the two parameters to the callback.

Parameters

title : String
The title bar text
\n
msg : String
The message box body text
\n
fn : Function (optional)
The callback function invoked after the message box is closed
\n
scope : Object (optional)
The scope (this reference) in which the callback is executed. Defaults to the browser wnidow.
\n
multiline : Boolean/Number (optional)
True to create a multiline textbox using the defaultTextHeight\nproperty, or the height in pixels to create the textbox (defaults to false / single-line)
\n
value : String (optional)
Default value of the text input element (defaults to '')
\n

Returns

Ext.MessageBox
this
\n

Ext.MessageBox
view source

setIcon( icon ) : Ext.MessageBoxchainable

Adds the specified icon to the dialog. ...

Adds the specified icon to the dialog. By default, the class 'ext-mb-icon' is applied for default\nstyling, and the class passed in is expected to supply the background image url. Pass in empty string ('')\nto clear any existing icon. This method must be called before the MessageBox is shown.\nThe following built-in icon classes are supported, but you can also pass in a custom class name:

\n\n

Ext.MessageBox.INFO\nExt.MessageBox.WARNING\nExt.MessageBox.QUESTION\nExt.MessageBox.ERROR\n

\n\n

Parameters

icon : String
A CSS classname specifying the icon's background image url, or empty string to clear the icon
\n

Returns

Ext.MessageBox
this
\n

Ext.MessageBox
view source

show( config ) : Ext.MessageBoxchainable

Displays a new message box, or reinitializes an existing message box, based on the config options\npassed in. ...

Displays a new message box, or reinitializes an existing message box, based on the config options\npassed in. All display functions (e.g. prompt, alert, etc.) on MessageBox call this function internally,\nalthough those calls are basic shortcuts and do not support all of the config options allowed here.

Parameters

config : Object
The following config options are supported:
- animEl : String/Element
  An id or Element from which the message box should animate as it\nopens and closes (defaults to undefined)
- buttons : Object/Boolean
  A button config object (e.g., Ext.MessageBox.OKCANCEL or {ok:'Foo',\ncancel:'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\nprogress and wait dialogs will ignore this property and always hide the close button as they can only\nbe closed programmatically.
- cls : String
  A custom CSS class to apply to the message box's container element
- defaultTextHeight : Number
  The default height in pixels of the message box's multiline textarea\nif displayed (defaults to 75)
- fn : Function
  A callback function which is called when the dialog is dismissed either\nby clicking on the configured buttons, or on the dialog close button, or by pressing\nthe return button to enter input.
  \n\n
  Progress and wait dialogs will ignore this option since they do not respond to user\nactions and can only be closed programmatically, so any required function should be called\nby the same code after it closes the dialog. Parameters passed:
  - buttonId : String
    The ID of the button pressed, one of:
    \n
    ok
    \n
    yes
    \n
    no
    \n
    cancel
    \n
  - text : String
    Value of the input field if either prompt\nor multiline is true
  - opt : Object
    The config object passed to show.
  \n\n\n
- scope : Object
  The scope of the callback function
- icon : String
  A CSS class that provides a background image to be used as the body icon for the\ndialog (e.g. Ext.MessageBox.WARNING or 'custom-class') (defaults to '')
- iconCls : String
  The standard Ext.Window.iconCls to\nadd an optional header icon (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\ndisplayed (defaults to true)
- msg : String
  A string that will replace the existing message box body text (defaults to the\nXHTML-compliant non-breaking space character ' ')
- multiline : Boolean
  \nTrue 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)
- waitConfig : Object
  A Ext.ProgressBar.waitConfig object (applies only if wait = true)
- width : Number
  The width of the dialog in pixels
\nExample usage:
\n\n
```
Ext.Msg.show({\n   title: 'Address',\n   msg: 'Please enter your address:',\n   width: 300,\n   buttons: Ext.MessageBox.OKCANCEL,\n   multiline: true,\n   fn: saveAddress,\n   animEl: 'addAddressBtn',\n   icon: Ext.MessageBox.INFO\n});\n
```
\n\n

Returns

Ext.MessageBox
this
\n

Ext.MessageBox
view source

updateProgress( value, progressText, msg ) : Ext.MessageBoxchainable

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\ninitiated via progress or wait,\nor by calling show with progress: true.

Parameters

value : Number
Any number between 0 and 1 (e.g., .5, defaults to 0)
\n
progressText : String
The progress text to display inside the progress bar (defaults to '')
\n
msg : String
The message box's body text is replaced with the specified string (defaults to undefined\nso that any existing body text will not get overwritten by default unless a new value is passed in)
\n

Returns

Ext.MessageBox
this
\n

Ext.MessageBox
view source

updateText( [text] ) : Ext.MessageBoxchainable

Updates the message box body text ...

Updates the message box body text

Parameters

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

Returns

Ext.MessageBox
this
\n

Ext.MessageBox
view source

wait( msg, [title], [config] ) : Ext.MessageBoxchainable

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\ninteraction while waiting for a long-running process to complete that does not have defined intervals.\nYou are responsible for closing the message box when the process is complete.

Parameters

msg : String
The message box body text
\n
title : String (optional)
The title bar text
\n
config : Object (optional)
A Ext.ProgressBar.waitConfig object
\n

Returns

Ext.MessageBox
this
\n