X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/25ef3491bd9ae007ff1fc2b0d7943e6eaaccf775..7a654f8d43fdb43d78b63d90528bed6e86b608cc:/docs/output/Ext.MessageBox.html diff --git a/docs/output/Ext.MessageBox.html b/docs/output/Ext.MessageBox.html deleted file mode 100644 index cf127147..00000000 --- a/docs/output/Ext.MessageBox.html +++ /dev/null @@ -1,151 +0,0 @@ -
Package: | Ext |
Defined In: | MessageBox.js |
Class: | MessageBox |
Extends: | Object |
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
-browser execution), showing a MessageBox will not cause the code to stop. For this reason, if you have code
-that should only run after some user feedback from the MessageBox, you must use a callback function
-(see the function
parameter for show for more details).
Example usage:
-// Basic alert:
-Ext.Msg.alert('Status', 'Changes saved successfully.');
-
-// Prompt for user data and process the result using a callback:
-Ext.Msg.prompt('Name', 'Please enter your name:', function(btn, text){
- if (btn == 'ok'){
- // process text value and close...
- }
-});
-
-// Show a dialog using config options:
-Ext.Msg.show({
- title:'Save Changes?',
- msg: 'You are closing a tab that has unsaved changes. Would you like to save your changes?',
- buttons: Ext.Msg.YESNOCANCEL,
- fn: processResult,
- animEl: 'elId',
- icon: Ext.MessageBox.QUESTION
-});
Property | Defined By | |
---|---|---|
CANCEL : Object Button config that displays a single Cancel button | MessageBox | |
ERROR : String The CSS class that provides the ERROR icon image | MessageBox | |
INFO : String The CSS class that provides the INFO icon image | MessageBox | |
Msg : Object Shorthand for Ext.MessageBox | MessageBox | |
OK : Object Button config that displays a single OK button | MessageBox | |
OKCANCEL : Object Button config that displays OK and Cancel buttons | MessageBox | |
QUESTION : String The CSS class that provides the QUESTION icon image | MessageBox | |
WARNING : String The CSS class that provides the WARNING icon image | MessageBox | |
YESNO : Object Button config that displays Yes and No buttons | MessageBox | |
YESNOCANCEL : Object Button config that displays Yes, No and Cancel buttons | MessageBox | |
buttonText : Object An object containing the default button text strings that can be overriden for localized language support.
-Supported... An object containing the default button text strings that can be overriden for localized language support.
-Supported properties are: ok, cancel, yes and no. Generally you should include a locale-specific
-resource file for handling language support across the framework.
-Customize the default text like so: Ext.MessageBox.buttonText.yes = "oui"; //french | MessageBox | |
defaultTextHeight : Number The default height in pixels of the message box's multiline textarea if displayed (defaults to 75) | MessageBox | |
maxWidth : Number The maximum width in pixels of the message box (defaults to 600) | MessageBox | |
minProgressWidth : Number The minimum width in pixels of the message box if it is a progress-style dialog. This is useful
-for setting a diffe... 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) | MessageBox | |
minWidth : Number The minimum width in pixels of the message box (defaults to 100) | MessageBox |
Method | Defined By | |
---|---|---|
alert( String title , String msg , [Function fn ], [Object scope ] )
- :
- Ext.MessageBoxDisplays a standard read-only message box with an OK button (comparable to the basic JavaScript alert prompt).
-If a ... Displays a standard read-only message box with an OK button (comparable to the basic JavaScript alert prompt).
-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:
| MessageBox | |
confirm( String title , String msg , [Function fn ], [Object scope ] )
- :
- Ext.MessageBoxDisplays a confirmation message box with Yes and No buttons (comparable to JavaScript's confirm).
-If a callback func... Displays a confirmation message box with Yes and No buttons (comparable to JavaScript's 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:
| MessageBox | |
getDialog()
- :
- Ext.Window Returns a reference to the underlying Ext.Window element Returns a reference to the underlying Ext.Window element Parameters:
| MessageBox | |
hide()
- :
- Ext.MessageBox Hides the message box if it is displayed Hides the message box if it is displayed Parameters:
| MessageBox | |
isVisible()
- :
- Boolean Returns true if the message box is currently displayed Returns true if the message box is currently displayed Parameters:
| MessageBox | |
progress( String title , String msg , [String progressText ] )
- :
- Ext.MessageBoxDisplays a message box with a progress bar. This message box has no buttons and is not closeable by
-the user. You ... 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:
| MessageBox | |
prompt( String title , String msg , [Function fn ], [Object scope ], [Boolean/Number multiline ], [String value ] )
- :
- Ext.MessageBoxDisplays 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).
-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:
| MessageBox | |
setIcon( String icon )
- :
- Ext.MessageBoxAdds the specified icon to the dialog. By default, the class 'ext-mb-icon' is applied for default
-styling, and the ... Adds the specified icon to the dialog. By default, the class 'ext-mb-icon' is applied for default
-styling, and the class passed in is expected to supply the background image url. Pass in empty string ('')
-to clear any existing icon. This method must be called before the MessageBox is shown.
-The following built-in icon classes are supported, but you can also pass in a custom class name:
- -Ext.MessageBox.INFO -Ext.MessageBox.WARNING -Ext.MessageBox.QUESTION -Ext.MessageBox.ERROR - Parameters:
| MessageBox | |
show( Object config )
- :
- Ext.MessageBoxDisplays a new message box, or reinitializes an existing message box, based on the config options
-passed in. All dis... Displays a new message box, or reinitializes an existing message box, based on the config options
-passed in. All display functions (e.g. prompt, alert, etc.) on MessageBox call this function internally,
-although those calls are basic shortcuts and do not support all of the config options allowed here. Parameters:
| MessageBox | |
updateProgress( Number value , String progressText , String msg )
- :
- Ext.MessageBoxUpdates a progress-style message box's text and progress bar. Only relevant on message boxes
-initiated via Ext.Messa... Updates a progress-style message box's text and progress bar. Only relevant on message boxes
-initiated via Ext.MessageBox.progress or Ext.MessageBox.wait,
-or by calling Ext.MessageBox.show with progress: true. Parameters:
| MessageBox | |
updateText( [String text ] )
- :
- Ext.MessageBoxUpdates the message box body text Updates the message box body text Parameters:
| MessageBox | |
wait( String msg , [String title ], [Object config ] )
- :
- Ext.MessageBoxDisplays a message box with an infinitely auto-updating progress bar. This can be used to block user
-interaction wh... 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:
| MessageBox |