X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/3789b528d8dd8aad4558e38e22d775bcab1cbd36..HEAD:/docs/output/Ext.form.Basic.js diff --git a/docs/output/Ext.form.Basic.js b/docs/output/Ext.form.Basic.js index 7a6d05f6..aad462d5 100644 --- a/docs/output/Ext.form.Basic.js +++ b/docs/output/Ext.form.Basic.js @@ -1,1523 +1 @@ -Ext.data.JsonP.Ext_form_Basic({ - "tagname": "class", - "name": "Ext.form.Basic", - "doc": "
Provides input field management, validation, submission, and form loading services for the collection\nof Field instances within a Ext.container.Container. It is recommended\nthat you use a Ext.form.Panel as the form container, as that has logic to automatically\nhook up an instance of Ext.form.Basic (plus other conveniences related to field configuration.)
\n\nThe Basic class delegates the handling of form loads and submits to instances of Ext.form.action.Action.\nSee the various Action implementations for specific details of each one's functionality, as well as the\ndocumentation for doAction which details the configuration options that can be specified in\neach action call.
\n\nThe default submit Action is Ext.form.action.Submit, which uses an Ajax request to submit the\nform's values to a configured URL. To enable normal browser submission of an Ext form, use the\nstandardSubmit config option.
\n\nNote: File uploads are not performed using normal 'Ajax' techniques; see the description for\nhasUpload for details.
\n\nExt.create('Ext.form.Panel', {\n title: 'Basic Form',\n renderTo: Ext.getBody(),\n bodyPadding: 5,\n width: 350,\n\n // Any configuration items here will be automatically passed along to\n // the Ext.form.Basic instance when it gets created.\n\n // The form will submit an AJAX request to this URL when submitted\n url: 'save-form.php',\n\n items: [{\n fieldLabel: 'Field',\n name: 'theField'\n }],\n\n buttons: [{\n text: 'Submit',\n handler: function() {\n // The getForm() method returns the Ext.form.Basic instance:\n var form = this.up('form').getForm();\n if (form.isValid()) {\n // Submit the Ajax request and handle the response\n form.submit({\n success: function(form, action) {\n Ext.Msg.alert('Success', action.result.msg);\n },\n failure: function(form, action) {\n Ext.Msg.alert('Failed', action.result.msg);\n }\n });\n }\n }\n }]\n});\n
\n",
- "extends": "Ext.util.Observable",
- "mixins": [
-
- ],
- "alternateClassNames": [
- "Ext.form.BasicForm"
- ],
- "xtype": null,
- "author": null,
- "docauthor": null,
- "singleton": false,
- "private": false,
- "cfg": [
- {
- "tagname": "cfg",
- "name": "api",
- "member": "Ext.form.Basic",
- "type": "Object",
- "doc": "(Optional) If specified, load and submit actions will be handled\nwith Ext.form.action.DirectLoad and Ext.form.action.DirectLoad.\nMethods which have been imported by Ext.direct.Manager can be specified here to load and submit\nforms.\nSuch as the following:
\n\napi: {\n load: App.ss.MyProfile.load,\n submit: App.ss.MyProfile.submit\n}\n
\n\n\nLoad actions can use paramOrder
or paramsAsHash
\nto customize how the load method is invoked.\nSubmit actions will always use a standard form submit. The formHandler configuration must\nbe set on the associated server-side method which has been imported by Ext.direct.Manager.
Parameters to pass with all requests. e.g. baseParams: {id: '123', foo: 'bar'}.
\n\n\nParameters are encoded as standard HTTP parameters using Ext.Object.toQueryString.
\n\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Basic.js", - "linenr": 190, - "html_filename": "Basic.html", - "href": "Basic.html#Ext-form-Basic-cfg-baseParams", - "shortDoc": "Parameters to pass with all requests. e.g. baseParams: {id: '123', foo: 'bar'}.\n\n\nParameters are encoded as standard ..." - }, - { - "tagname": "cfg", - "name": "errorReader", - "member": "Ext.form.Basic", - "type": "Ext.data.reader.Reader", - "doc": "An Ext.data.DataReader (e.g. Ext.data.reader.Xml) to be used to\nread field error messages returned from 'submit' actions. This is optional\nas there is built-in support for processing JSON responses.
\n\n\nThe Records which provide messages for the invalid Fields must use the\nField name (or id) as the Record ID, and must contain a field called 'msg'\nwhich contains the error message.
\n\n\nThe errorReader does not have to be a full-blown implementation of a\nReader. It simply needs to implement a read(xhr) function\nwhich returns an Array of Records in an object with the following\nstructure:
\n\n\n{\n records: recordArray\n}\n
\n\n",
- "private": false,
- "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Basic.js",
- "linenr": 166,
- "html_filename": "Basic.html",
- "href": "Basic.html#Ext-form-Basic-cfg-errorReader",
- "shortDoc": "An Ext.data.DataReader (e.g. Ext.data.reader.Xml) to be used to\nread field error messages returned from 'submit' acti..."
- },
- {
- "tagname": "cfg",
- "name": "listeners",
- "member": "Ext.util.Observable",
- "type": "Object",
- "doc": "(optional)
A config object containing one or more event handlers to be added to this\nobject during initialization. This should be a valid listeners config object as specified in the\naddListener example for attaching multiple handlers at once.
\n\nDOM events from ExtJs Components
\n\n\nWhile some ExtJs Component classes export selected DOM events (e.g. \"click\", \"mouseover\" etc), this\n\n\n
is usually only done when extra value can be added. For example the DataView's\nclick
event passing the node clicked on. To access DOM\nevents directly from a child element of a Component, we need to specify the element
option to\nidentify the Component property to add a DOM listener to:
new Ext.panel.Panel({\n width: 400,\n height: 200,\n dockedItems: [{\n xtype: 'toolbar'\n }],\n listeners: {\n click: {\n element: 'el', //bind to the underlying el property on the panel\n fn: function(){ console.log('click el'); }\n },\n dblclick: {\n element: 'body', //bind to the underlying body property on the panel\n fn: function(){ console.log('dblclick body'); }\n }\n }\n});\n
\n\n\n\n",
- "private": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
- "linenr": 103,
- "html_filename": "Observable.html",
- "href": "Observable.html#Ext-util-Observable-cfg-listeners",
- "shortDoc": "(optional) A config object containing one or more event handlers to be added to this\nobject during initialization. T..."
- },
- {
- "tagname": "cfg",
- "name": "method",
- "member": "Ext.form.Basic",
- "type": "String",
- "doc": "The request method to use (GET or POST) for form actions if one isn't supplied in the action options.
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Basic.js", - "linenr": 156, - "html_filename": "Basic.html", - "href": "Basic.html#Ext-form-Basic-cfg-method" - }, - { - "tagname": "cfg", - "name": "paramOrder", - "member": "Ext.form.Basic", - "type": "Array/String", - "doc": "A list of params to be executed server side.\nDefaults to undefined. Only used for the api
\nload
configuration.
Specify the params in the order in which they must be executed on the\nserver-side as either (1) an Array of String values, or (2) a String of params\ndelimited by either whitespace, comma, or pipe. For example,\nany of the following would be acceptable:
\n\n\nparamOrder: ['param1','param2','param3']\nparamOrder: 'param1 param2 param3'\nparamOrder: 'param1,param2,param3'\nparamOrder: 'param1|param2|param'\n
\n\n",
- "private": false,
- "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Basic.js",
- "linenr": 218,
- "html_filename": "Basic.html",
- "href": "Basic.html#Ext-form-Basic-cfg-paramOrder",
- "shortDoc": "A list of params to be executed server side.\nDefaults to undefined. Only used for the api\nload configuration.\n\n\nSpeci..."
- },
- {
- "tagname": "cfg",
- "name": "paramsAsHash",
- "member": "Ext.form.Basic",
- "type": "Boolean",
- "doc": "Only used for the api
\nload
configuration. If true, parameters will be sent as a\nsingle hash collection of named arguments (defaults to false). Providing a\nparamOrder nullifies this configuration.
An Ext.data.DataReader (e.g. Ext.data.reader.Xml) to be used to read\ndata when executing 'load' actions. This is optional as there is built-in\nsupport for processing JSON responses.
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Basic.js", - "linenr": 160, - "html_filename": "Basic.html", - "href": "Basic.html#Ext-form-Basic-cfg-reader", - "shortDoc": "An Ext.data.DataReader (e.g. Ext.data.reader.Xml) to be used to read\ndata when executing 'load' actions. This is opti..." - }, - { - "tagname": "cfg", - "name": "standardSubmit", - "member": "Ext.form.Basic", - "type": "Boolean", - "doc": "If set to true, a standard HTML form submit is used instead\nof a XHR (Ajax) style form submission. Defaults to false. All of\nthe field values, plus any additional params configured via baseParams\nand/or the options
to submit, will be included in the\nvalues submitted in the form.
Timeout for form actions in seconds (default is 30 seconds).
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Basic.js", - "linenr": 196, - "html_filename": "Basic.html", - "href": "Basic.html#Ext-form-Basic-cfg-timeout" - }, - { - "tagname": "cfg", - "name": "trackResetOnLoad", - "member": "Ext.form.Basic", - "type": "Boolean", - "doc": "If set to true, reset() resets to the last loaded\nor setValues() data instead of when the form was first created. Defaults to false.
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Basic.js", - "linenr": 247, - "html_filename": "Basic.html", - "href": "Basic.html#Ext-form-Basic-cfg-trackResetOnLoad", - "shortDoc": "If set to true, reset() resets to the last loaded\nor setValues() data instead of when the form was first created. De..." - }, - { - "tagname": "cfg", - "name": "url", - "member": "Ext.form.Basic", - "type": "String", - "doc": "The URL to use for form actions if one isn't supplied in the\ndoAction options.
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Basic.js", - "linenr": 184, - "html_filename": "Basic.html", - "href": "Basic.html#Ext-form-Basic-cfg-url" - }, - { - "tagname": "cfg", - "name": "waitMsgTarget", - "member": "Ext.form.Basic", - "type": "Mixed", - "doc": "By default wait messages are displayed with Ext.MessageBox.wait. You can target a specific\nelement by passing it or its id or mask the form itself by passing in true. Defaults to undefined.
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Basic.js", - "linenr": 262, - "html_filename": "Basic.html", - "href": "Basic.html#Ext-form-Basic-cfg-waitMsgTarget", - "shortDoc": "By default wait messages are displayed with Ext.MessageBox.wait. You can target a specific\nelement by passing it or i..." - }, - { - "tagname": "cfg", - "name": "waitTitle", - "member": "Ext.form.Basic", - "type": "String", - "doc": "The default title to show for the waiting message box (defaults to 'Please Wait...')
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Basic.js", - "linenr": 241, - "html_filename": "Basic.html", - "href": "Basic.html#Ext-form-Basic-cfg-waitTitle" - } - ], - "method": [ - { - "tagname": "method", - "name": "Basic", - "member": "Ext.form.Basic", - "doc": "\n", - "params": [ - { - "type": "Ext.container.Container", - "name": "owner", - "doc": "The component that is the container for the form, usually a Ext.form.Panel
\n", - "optional": false - }, - { - "type": "Object", - "name": "config", - "doc": "Configuration options. These are normally specified in the config to the\nExt.form.Panel constructor, which passes them along to the BasicForm automatically.
\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Basic.js", - "linenr": 1, - "html_filename": "Basic.html", - "href": "Basic.html#Ext-form-Basic-method-constructor", - "shortDoc": "\n" - }, - { - "tagname": "method", - "name": "addEvents", - "member": "Ext.util.Observable", - "doc": "Adds the specified events to the list of events which this Observable may fire.
\n", - "params": [ - { - "type": "Object/String", - "name": "o", - "doc": "Either an object with event names as properties with a value of true
\nor the first event name string if multiple event names are being passed as separate parameters.
[additional] Optional additional event names if multiple event names are being passed as separate parameters.\nUsage:
\n\nthis.addEvents('storeloaded', 'storecleared');\n
\n\n",
- "optional": false
- }
- ],
- "return": {
- "type": "void",
- "doc": "\n"
- },
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
- "linenr": 452,
- "html_filename": "Observable.html",
- "href": "Observable.html#Ext-util-Observable-method-addEvents",
- "shortDoc": "Adds the specified events to the list of events which this Observable may fire.
\n" - }, - { - "tagname": "method", - "name": "addListener", - "member": "Ext.util.Observable", - "doc": "Appends an event handler to this object.
\n", - "params": [ - { - "type": "String", - "name": "eventName", - "doc": "The name of the event to listen for. May also be an object who's property names are event names. See
\n", - "optional": false - }, - { - "type": "Function", - "name": "handler", - "doc": "The method the event invokes.
\n", - "optional": false - }, - { - "type": "Object", - "name": "scope", - "doc": "(optional) The scope (this
reference) in which the handler function is executed.\nIf omitted, defaults to the object which fired the event.
(optional) An object containing handler configuration.\nproperties. This may contain any of the following properties:
this
reference) in which the handler function is executed.\nIf omitted, defaults to the object which fired the event.This option is useful during Component construction to add DOM event listeners to elements of Components which\nwill exist only after the Component is rendered. For example, to add a click listener to a Panel's body:\n
new Ext.panel.Panel({\n title: 'The title',\n listeners: {\n click: this.handlePanelClick,\n element: 'body'\n }\n});\n
\n\n\nWhen added in this way, the options available are the options applicable to Ext.core.Element.addListener
\n\n\n\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA delayed, one-time listener.\n
myPanel.on('hide', this.handleClick, this, {\nsingle: true,\ndelay: 100\n});
\n\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple events. For example:\n
myGridPanel.on({\n cellClick: this.onCellClick,\n mouseover: this.onMouseOver,\n mouseout: this.onMouseOut,\n scope: this // Important. Ensure \"this\" is correct during handler execution\n});\n
.\n\n\n", - "optional": true - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", - "linenr": 271, - "html_filename": "Observable.html", - "href": "Observable.html#Ext-util-Observable-method-addListener", - "shortDoc": "
Appends an event handler to this object.
\n" - }, - { - "tagname": "method", - "name": "addManagedListener", - "member": "Ext.util.Observable", - "doc": "Adds listeners to any Observable object (or Element) which are automatically removed when this Component\nis destroyed.\n\n", - "params": [ - { - "type": "Observable/Element", - "name": "item", - "doc": "
The item to which to add a listener/listeners.
\n", - "optional": false - }, - { - "type": "Object/String", - "name": "ename", - "doc": "The event name, or an object containing event name properties.
\n", - "optional": false - }, - { - "type": "Function", - "name": "fn", - "doc": "Optional. If the ename
parameter was an event name, this\nis the handler function.
Optional. If the ename
parameter was an event name, this\nis the scope (this
reference) in which the handler function is executed.
Optional. If the ename
parameter was an event name, this\nis the addListener options.
Adds listeners to any Observable object (or Element) which are automatically removed when this Component\nis destroyed.\n\n" - }, - { - "tagname": "method", - "name": "applyIfToFields", - "member": "Ext.form.Basic", - "doc": "
Calls Ext.applyIf for all field in this form with the passed object.
\n", - "params": [ - { - "type": "Object", - "name": "obj", - "doc": "The object to be applied
\n", - "optional": false - } - ], - "return": { - "type": "Ext.form.Basic", - "doc": "this
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Basic.js", - "linenr": 883, - "html_filename": "Basic.html", - "href": "Basic.html#Ext-form-Basic-method-applyIfToFields", - "shortDoc": "Calls Ext.applyIf for all field in this form with the passed object.
\n" - }, - { - "tagname": "method", - "name": "applyToFields", - "member": "Ext.form.Basic", - "doc": "Calls Ext.apply for all fields in this form with the passed object.
\n", - "params": [ - { - "type": "Object", - "name": "obj", - "doc": "The object to be applied
\n", - "optional": false - } - ], - "return": { - "type": "Ext.form.Basic", - "doc": "this
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Basic.js", - "linenr": 871, - "html_filename": "Basic.html", - "href": "Basic.html#Ext-form-Basic-method-applyToFields", - "shortDoc": "Calls Ext.apply for all fields in this form with the passed object.
\n" - }, - { - "tagname": "method", - "name": "capture", - "member": "Ext.util.Observable", - "doc": "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.
\n", - "params": [ - { - "type": "Observable", - "name": "o", - "doc": "The Observable to capture events from.
\n", - "optional": false - }, - { - "type": "Function", - "name": "fn", - "doc": "The function to call when an event is fired.
\n", - "optional": false - }, - { - "type": "Object", - "name": "scope", - "doc": "(optional) The scope (this
reference) in which the function is executed. Defaults to the Observable firing the event.
Check whether the dirty state of the entire form has changed since it was last checked, and\nif so fire the dirtychange event. This is automatically invoked\nwhen an individual field's dirty state changes.
\n", - "params": [ - - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Basic.js", - "linenr": 421, - "html_filename": "Basic.html", - "href": "Basic.html#Ext-form-Basic-method-checkDirty", - "shortDoc": "Check whether the dirty state of the entire form has changed since it was last checked, and\nif so fire the dirtychang..." - }, - { - "tagname": "method", - "name": "checkValidity", - "member": "Ext.form.Basic", - "doc": "Check whether the validity of the entire form has changed since it was last checked, and\nif so fire the validitychange event. This is automatically invoked\nwhen an individual field's validity changes.
\n", - "params": [ - - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Basic.js", - "linenr": 376, - "html_filename": "Basic.html", - "href": "Basic.html#Ext-form-Basic-method-checkValidity", - "shortDoc": "Check whether the validity of the entire form has changed since it was last checked, and\nif so fire the validitychang..." - }, - { - "tagname": "method", - "name": "clearInvalid", - "member": "Ext.form.Basic", - "doc": "Clears all invalid field messages in this form.
\n", - "params": [ - - ], - "return": { - "type": "Ext.form.Basic", - "doc": "this
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Basic.js", - "linenr": 843, - "html_filename": "Basic.html", - "href": "Basic.html#Ext-form-Basic-method-clearInvalid", - "shortDoc": "Clears all invalid field messages in this form.
\n" - }, - { - "tagname": "method", - "name": "clearListeners", - "member": "Ext.util.Observable", - "doc": "Removes all listeners for this object including the managed listeners
\n", - "params": [ - - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", - "linenr": 383, - "html_filename": "Observable.html", - "href": "Observable.html#Ext-util-Observable-method-clearListeners", - "shortDoc": "Removes all listeners for this object including the managed listeners
\n" - }, - { - "tagname": "method", - "name": "clearManagedListeners", - "member": "Ext.util.Observable", - "doc": "Removes all managed listeners for this object.
\n", - "params": [ - - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", - "linenr": 412, - "html_filename": "Observable.html", - "href": "Observable.html#Ext-util-Observable-method-clearManagedListeners", - "shortDoc": "Removes all managed listeners for this object.
\n" - }, - { - "tagname": "method", - "name": "destroy", - "member": "Ext.form.Basic", - "doc": "Destroys this object.
\n", - "params": [ - - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Basic.js", - "linenr": 273, - "html_filename": "Basic.html", - "href": "Basic.html#Ext-form-Basic-method-destroy", - "shortDoc": "Destroys this object.
\n" - }, - { - "tagname": "method", - "name": "doAction", - "member": "Ext.form.Basic", - "doc": "Performs a predefined action (an implementation of Ext.form.action.Action)\nto perform application-specific processing.
\n", - "params": [ - { - "type": "String/Ext.form.action.Action", - "name": "action", - "doc": "The name of the predefined action type,\nor instance of Ext.form.action.Action to perform.
\n", - "optional": false - }, - { - "type": "Object", - "name": "options", - "doc": "(optional) The options to pass to the Ext.form.action.Action\nthat will get created, if the action argument is a String.
\n\nAll of the config options listed below are supported by both the\nsubmit and load\nactions unless otherwise noted (custom actions could also accept\nother config options):
\n\n\nThe params to pass\n(defaults to the form's baseParams, or none if not defined)
\nParameters are encoded as standard HTTP parameters using Ext.Object.toQueryString.
this
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Basic.js", - "linenr": 462, - "html_filename": "Basic.html", - "href": "Basic.html#Ext-form-Basic-method-doAction", - "shortDoc": "Performs a predefined action (an implementation of Ext.form.action.Action)\nto perform application-specific processing.
\n" - }, - { - "tagname": "method", - "name": "enableBubble", - "member": "Ext.util.Observable", - "doc": "Enables events fired by this Observable to bubble up an owner hierarchy by calling\nthis.getBubbleTarget()
if present. There is no implementation in the Observable base class.
This is commonly used by Ext.Components to bubble events to owner Containers. See Ext.Component.getBubbleTarget. The default\nimplementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to\naccess the required target more quickly.
\n\n\nExample:
\n\n\nExt.override(Ext.form.field.Base, {\n// Add functionality to Field's initComponent to enable the change event to bubble\ninitComponent : Ext.Function.createSequence(Ext.form.field.Base.prototype.initComponent, function() {\n this.enableBubble('change');\n}),\n\n// We know that we want Field's events to bubble directly to the FormPanel.\ngetBubbleTarget : function() {\n if (!this.formPanel) {\n this.formPanel = this.findParentByType('form');\n }\n return this.formPanel;\n}\n});\n\nvar myForm = new Ext.formPanel({\ntitle: 'User Details',\nitems: [{\n ...\n}],\nlisteners: {\n change: function() {\n // Title goes red if form has been modified.\n myForm.header.setStyle('color', 'red');\n }\n}\n});\n
\n\n",
- "params": [
- {
- "type": "String/Array",
- "name": "events",
- "doc": "The event name to bubble, or an Array of event names.
\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", - "linenr": 554, - "html_filename": "Observable.html", - "href": "Observable.html#Ext-util-Observable-method-enableBubble", - "shortDoc": "Enables events fired by this Observable to bubble up an owner hierarchy by calling\nthis.getBubbleTarget() if present...." - }, - { - "tagname": "method", - "name": "findField", - "member": "Ext.form.Basic", - "doc": "Find a specific Ext.form.field.Field in this form by id or name.
\n", - "params": [ - { - "type": "String", - "name": "id", - "doc": "The value to search for (specify either a id or\nname or hiddenName).
\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "Ext.form.field.Field The first matching field, or null if none was found.
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Basic.js", - "linenr": 695, - "html_filename": "Basic.html", - "href": "Basic.html#Ext-form-Basic-method-findField", - "shortDoc": "Find a specific Ext.form.field.Field in this form by id or name.
\n" - }, - { - "tagname": "method", - "name": "fireEvent", - "member": "Ext.util.Observable", - "doc": "Fires the specified event with the passed parameters (minus the event name).
\n\n\nAn event may be set to bubble up an Observable parent hierarchy (See Ext.Component.getBubbleTarget)\nby calling enableBubble.
\n\n", - "params": [ - { - "type": "String", - "name": "eventName", - "doc": "The name of the event to fire.
\n", - "optional": false - }, - { - "type": "Object...", - "name": "args", - "doc": "Variable number of parameters are passed to handlers.
\n", - "optional": false - } - ], - "return": { - "type": "Boolean", - "doc": "returns false if any of the handlers return false otherwise it returns true.
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", - "linenr": 232, - "html_filename": "Observable.html", - "href": "Observable.html#Ext-util-Observable-method-fireEvent", - "shortDoc": "Fires the specified event with the passed parameters (minus the event name).\n\n\nAn event may be set to bubble up an Ob..." - }, - { - "tagname": "method", - "name": "getFieldValues", - "member": "Ext.form.Basic", - "doc": "Retrieves the fields in the form as a set of key/value pairs, using their\ngetModelData() method to collect the values.\nIf multiple fields return values under the same name those values will be combined into an Array.\nThis is similar to getValues except that this method collects type-specific data values\n(e.g. Date objects for date fields) while getValues returns only String values for submission.
\n", - "params": [ - { - "type": "Boolean", - "name": "dirtyOnly", - "doc": "(optional) If true, only fields that are dirty will be included in the result.\nDefaults to false.
\n", - "optional": true - } - ], - "return": { - "type": "Object", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Basic.js", - "linenr": 829, - "html_filename": "Basic.html", - "href": "Basic.html#Ext-form-Basic-method-getFieldValues", - "shortDoc": "Retrieves the fields in the form as a set of key/value pairs, using their\ngetModelData() method to collect the values..." - }, - { - "tagname": "method", - "name": "getFields", - "member": "Ext.form.Basic", - "doc": "Return all the Ext.form.field.Field components in the owner container.
\n", - "params": [ - - ], - "return": { - "type": "Ext.util.MixedCollection", - "doc": "Collection of the Field objects
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Basic.js", - "linenr": 322, - "html_filename": "Basic.html", - "href": "Basic.html#Ext-form-Basic-method-getFields", - "shortDoc": "Return all the Ext.form.field.Field components in the owner container.
\n" - }, - { - "tagname": "method", - "name": "getRecord", - "member": "Ext.form.Basic", - "doc": "Returns the last Ext.data.Model instance that was loaded via loadRecord
\n", - "params": [ - - ], - "return": { - "type": "Ext.data.Model", - "doc": "The record
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Basic.js", - "linenr": 625, - "html_filename": "Basic.html", - "href": "Basic.html#Ext-form-Basic-method-getRecord", - "shortDoc": "Returns the last Ext.data.Model instance that was loaded via loadRecord
\n" - }, - { - "tagname": "method", - "name": "getValues", - "member": "Ext.form.Basic", - "doc": "Retrieves the fields in the form as a set of key/value pairs, using their\ngetSubmitData() method to collect the values.\nIf multiple fields return values under the same name those values will be combined into an Array.\nThis is similar to getFieldValues except that this method collects only String values for\nsubmission, while getFieldValues collects type-specific data values (e.g. Date objects for date fields.)
\n", - "params": [ - { - "type": "Boolean", - "name": "asString", - "doc": "(optional) If true, will return the key/value collection as a single\nURL-encoded param string. Defaults to false.
\n", - "optional": true - }, - { - "type": "Boolean", - "name": "dirtyOnly", - "doc": "(optional) If true, only fields that are dirty will be included in the result.\nDefaults to false.
\n", - "optional": true - }, - { - "type": "Boolean", - "name": "includeEmptyText", - "doc": "(optional) If true, the configured emptyText of empty fields will be used.\nDefaults to false.
\n", - "optional": true - }, - { - "type": "Object", - "name": "useDataValues", - "doc": "\n", - "optional": false - } - ], - "return": { - "type": "String/Object", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Basic.js", - "linenr": 779, - "html_filename": "Basic.html", - "href": "Basic.html#Ext-form-Basic-method-getValues", - "shortDoc": "Retrieves the fields in the form as a set of key/value pairs, using their\ngetSubmitData() method to collect the value..." - }, - { - "tagname": "method", - "name": "hasInvalidField", - "member": "Ext.form.Basic", - "doc": "Returns true if the form contains any invalid fields. No fields will be marked as invalid\nas a result of calling this; to trigger marking of fields use isValid instead.
\n", - "params": [ - - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Basic.js", - "linenr": 344, - "html_filename": "Basic.html", - "href": "Basic.html#Ext-form-Basic-method-hasInvalidField", - "shortDoc": "Returns true if the form contains any invalid fields. No fields will be marked as invalid\nas a result of calling this..." - }, - { - "tagname": "method", - "name": "hasListener", - "member": "Ext.util.Observable", - "doc": "Checks to see if this object has any listeners for a specified event
\n", - "params": [ - { - "type": "String", - "name": "eventName", - "doc": "The name of the event to check for
\n", - "optional": false - } - ], - "return": { - "type": "Boolean", - "doc": "True if the event is being listened for, else false
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", - "linenr": 480, - "html_filename": "Observable.html", - "href": "Observable.html#Ext-util-Observable-method-hasListener", - "shortDoc": "Checks to see if this object has any listeners for a specified event
\n" - }, - { - "tagname": "method", - "name": "hasUpload", - "member": "Ext.form.Basic", - "doc": "Returns true if the form contains a file upload field. This is used to determine the\nmethod for submitting the form: File uploads are not performed using normal 'Ajax' techniques,\nthat is they are not performed using XMLHttpRequests. Instead a hidden <form>\nelement containing all the fields is created temporarily and submitted with its\ntarget set to refer\nto a dynamically generated, hidden <iframe> which is inserted into the document\nbut removed after the return data has been gathered.
\n\n\nThe server response is parsed by the browser to create the document for the IFRAME. If the\nserver is using JSON to send the return object, then the\nContent-Type header\nmust be set to \"text/html\" in order to tell the browser to insert the text unchanged into the document body.
\n\n\nCharacters which are significant to an HTML parser must be sent as HTML entities, so encode\n\"<\" as \"<\", \"&\" as \"&\" etc.
\n\n\nThe response text is retrieved from the document, and a fake XMLHttpRequest object\nis created containing a responseText property in order to conform to the\nrequirements of event handlers and callbacks.
\n\n\nBe aware that file upload packets are sent with the content type multipart/form\nand some server technologies (notably JEE) may require some custom processing in order to\nretrieve parameter names and parameter values from the packet content.
\n\n", - "params": [ - - ], - "return": { - "type": "void", - "doc": "Boolean
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Basic.js", - "linenr": 434, - "html_filename": "Basic.html", - "href": "Basic.html#Ext-form-Basic-method-hasUpload", - "shortDoc": "Returns true if the form contains a file upload field. This is used to determine the\nmethod for submitting the form: ..." - }, - { - "tagname": "method", - "name": "isDirty", - "member": "Ext.form.Basic", - "doc": "Returns true if any fields in this form have changed from their original values.
\n\n\nNote that if this BasicForm was configured with trackResetOnLoad then the\nFields' original values are updated when the values are loaded by setValues\nor loadRecord.
\n\n", - "params": [ - - ], - "return": { - "type": "void", - "doc": "Boolean
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Basic.js", - "linenr": 408, - "html_filename": "Basic.html", - "href": "Basic.html#Ext-form-Basic-method-isDirty", - "shortDoc": "Returns true if any fields in this form have changed from their original values.\n\n\nNote that if this BasicForm was co..." - }, - { - "tagname": "method", - "name": "isValid", - "member": "Ext.form.Basic", - "doc": "Returns true if client-side validation on the form is successful. Any invalid fields will be\nmarked as invalid. If you only want to determine overall form validity without marking anything,\nuse hasInvalidField instead.
\n", - "params": [ - - ], - "return": { - "type": "void", - "doc": "Boolean
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Basic.js", - "linenr": 359, - "html_filename": "Basic.html", - "href": "Basic.html#Ext-form-Basic-method-isValid", - "shortDoc": "Returns true if client-side validation on the form is successful. Any invalid fields will be\nmarked as invalid. If yo..." - }, - { - "tagname": "method", - "name": "load", - "member": "Ext.form.Basic", - "doc": "Shortcut to do a load action.
\n", - "params": [ - { - "type": "Object", - "name": "options", - "doc": "The options to pass to the action (see doAction for details)
\n", - "optional": false - } - ], - "return": { - "type": "Ext.form.Basic", - "doc": "this
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Basic.js", - "linenr": 579, - "html_filename": "Basic.html", - "href": "Basic.html#Ext-form-Basic-method-load", - "shortDoc": "Shortcut to do a load action.
\n" - }, - { - "tagname": "method", - "name": "loadRecord", - "member": "Ext.form.Basic", - "doc": "Loads an Ext.data.Model into this form by calling setValues with the\nrecord data.\nSee also trackResetOnLoad.
\n", - "params": [ - { - "type": "Ext.data.Model", - "name": "record", - "doc": "The record to load
\n", - "optional": false - } - ], - "return": { - "type": "Ext.form.Basic", - "doc": "this
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Basic.js", - "linenr": 613, - "html_filename": "Basic.html", - "href": "Basic.html#Ext-form-Basic-method-loadRecord", - "shortDoc": "Loads an Ext.data.Model into this form by calling setValues with the\nrecord data.\nSee also trackResetOnLoad.
\n" - }, - { - "tagname": "method", - "name": "markInvalid", - "member": "Ext.form.Basic", - "doc": "Mark fields in this form invalid in bulk.
\n", - "params": [ - { - "type": "Array/Object", - "name": "errors", - "doc": "Either an array in the form [{id:'fieldId', msg:'The message'}, ...]
,\nan object hash of {id: msg, id2: msg2}
, or a Ext.data.Errors object.
this
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Basic.js", - "linenr": 708, - "html_filename": "Basic.html", - "href": "Basic.html#Ext-form-Basic-method-markInvalid", - "shortDoc": "Mark fields in this form invalid in bulk.
\n" - }, - { - "tagname": "method", - "name": "observe", - "member": "Ext.util.Observable", - "doc": "Sets observability on the passed class constructor.
\n\nThis makes any event fired on any instance of the passed class also fire a single event through\nthe class allowing for central handling of events on many instances at once.
\n\nUsage:
\n\nExt.util.Observable.observe(Ext.data.Connection);\nExt.data.Connection.on('beforerequest', function(con, options) {\n console.log('Ajax request made to ' + options.url);\n});\n
\n",
- "params": [
- {
- "type": "Function",
- "name": "c",
- "doc": "The class constructor to make observable.
\n", - "optional": false - }, - { - "type": "Object", - "name": "listeners", - "doc": "An object containing a series of listeners to add. See addListener.
\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": true, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", - "linenr": 69, - "html_filename": "Observable.html", - "href": "Observable.html#Ext-util-Observable-method-observe", - "shortDoc": "Sets observability on the passed class constructor.\n\nThis makes any event fired on any instance of the passed class a..." - }, - { - "tagname": "method", - "name": "on", - "member": "Ext.util.Observable", - "doc": "Appends an event handler to this object (shorthand for addListener.)
\n", - "params": [ - { - "type": "String", - "name": "eventName", - "doc": "The type of event to listen for
\n", - "optional": false - }, - { - "type": "Function", - "name": "handler", - "doc": "The method the event invokes
\n", - "optional": false - }, - { - "type": "Object", - "name": "scope", - "doc": "(optional) The scope (this
reference) in which the handler function is executed.\nIf omitted, defaults to the object which fired the event.
(optional) An object containing handler configuration.
\n", - "optional": true - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", - "linenr": 616, - "html_filename": "Observable.html", - "href": "Observable.html#Ext-util-Observable-method-on", - "shortDoc": "Appends an event handler to this object (shorthand for addListener.)
\n" - }, - { - "tagname": "method", - "name": "relayEvents", - "member": "Ext.util.Observable", - "doc": "Relays selected events from the specified Observable as if the events were fired by this
.
The Observable whose events this object is to relay.
\n", - "optional": false - }, - { - "type": "Array", - "name": "events", - "doc": "Array of event names to relay.
\n", - "optional": false - }, - { - "type": "Object", - "name": "prefix", - "doc": "\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", - "linenr": 520, - "html_filename": "Observable.html", - "href": "Observable.html#Ext-util-Observable-method-relayEvents", - "shortDoc": "Relays selected events from the specified Observable as if the events were fired by this
.
Removes all added captures from the Observable.
\n", - "params": [ - { - "type": "Observable", - "name": "o", - "doc": "The Observable to release
\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": true, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", - "linenr": 46, - "html_filename": "Observable.html", - "href": "Observable.html#Ext-util-Observable-method-releaseCapture", - "shortDoc": "Removes all added captures from the Observable.
\n" - }, - { - "tagname": "method", - "name": "removeListener", - "member": "Ext.util.Observable", - "doc": "Removes an event handler.
\n", - "params": [ - { - "type": "String", - "name": "eventName", - "doc": "The type of event the handler was associated with.
\n", - "optional": false - }, - { - "type": "Function", - "name": "handler", - "doc": "The handler to remove. This must be a reference to the function passed into the addListener call.
\n", - "optional": false - }, - { - "type": "Object", - "name": "scope", - "doc": "(optional) The scope originally specified for the handler.
\n", - "optional": true - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", - "linenr": 352, - "html_filename": "Observable.html", - "href": "Observable.html#Ext-util-Observable-method-removeListener", - "shortDoc": "Removes an event handler.
\n" - }, - { - "tagname": "method", - "name": "removeManagedListener", - "member": "Ext.util.Observable", - "doc": "Removes listeners that were added by the mon method.
\n", - "params": [ - { - "type": "Observable|Element", - "name": "item", - "doc": "The item from which to remove a listener/listeners.
\n", - "optional": false - }, - { - "type": "Object|String", - "name": "ename", - "doc": "The event name, or an object containing event name properties.
\n", - "optional": false - }, - { - "type": "Function", - "name": "fn", - "doc": "Optional. If the ename
parameter was an event name, this\nis the handler function.
Optional. If the ename
parameter was an event name, this\nis the scope (this
reference) in which the handler function is executed.
Removes listeners that were added by the mon method.
\n" - }, - { - "tagname": "method", - "name": "reset", - "member": "Ext.form.Basic", - "doc": "Resets all fields in this form.
\n", - "params": [ - - ], - "return": { - "type": "Ext.form.Basic", - "doc": "this
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Basic.js", - "linenr": 857, - "html_filename": "Basic.html", - "href": "Basic.html#Ext-form-Basic-method-reset", - "shortDoc": "Resets all fields in this form.
\n" - }, - { - "tagname": "method", - "name": "resumeEvents", - "member": "Ext.util.Observable", - "doc": "Resume firing events. (see suspendEvents)\nIf events were suspended using the queueSuspended
parameter, then all\nevents fired during event suspension will be sent to any listeners now.
Set values for fields in this form in bulk.
\n", - "params": [ - { - "type": "Array/Object", - "name": "values", - "doc": "Either an array in the form:
\n\n[{id:'clientName', value:'Fred. Olsen Lines'},\n {id:'portOfLoading', value:'FXT'},\n {id:'portOfDischarge', value:'OSL'} ]
\n\n\nor an object hash of the form:
\n\n{\n clientName: 'Fred. Olsen Lines',\n portOfLoading: 'FXT',\n portOfDischarge: 'OSL'\n}
\n\n",
- "optional": false
- }
- ],
- "return": {
- "type": "Ext.form.Basic",
- "doc": "this
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Basic.js", - "linenr": 740, - "html_filename": "Basic.html", - "href": "Basic.html#Ext-form-Basic-method-setValues", - "shortDoc": "Set values for fields in this form in bulk.
\n" - }, - { - "tagname": "method", - "name": "submit", - "member": "Ext.form.Basic", - "doc": "Shortcut to do a submit action. This will use the\nAJAX submit action by default. If the standardsubmit config is\nenabled it will use a standard form element to submit, or if the api config is present it will\nuse the Ext.direct.Direct submit action.
\n", - "params": [ - { - "type": "Object", - "name": "options", - "doc": "The options to pass to the action (see doAction for details).
The following code:
\n\n\nmyFormPanel.getForm().submit({\n clientValidation: true,\n url: 'updateConsignment.php',\n params: {\n newStatus: 'delivered'\n },\n success: function(form, action) {\n Ext.Msg.alert('Success', action.result.msg);\n },\n failure: function(form, action) {\n switch (action.failureType) {\n case Ext.form.action.Action.CLIENT_INVALID:\n Ext.Msg.alert('Failure', 'Form fields may not be submitted with invalid values');\n break;\n case Ext.form.action.Action.CONNECT_FAILURE:\n Ext.Msg.alert('Failure', 'Ajax communication failed');\n break;\n case Ext.form.action.Action.SERVER_INVALID:\n Ext.Msg.alert('Failure', action.result.msg);\n }\n }\n});\n
\n\n\nwould process the following server response for a successful submission:
\n\n{\n \"success\":true, // note this is Boolean, not string\n \"msg\":\"Consignment updated\"\n}\n
\n\n\nand the following server response for a failed submission:
\n\n{\n \"success\":false, // note this is Boolean, not string\n \"msg\":\"You do not have permission to perform this operation\"\n}\n
\n\n",
- "optional": false
- }
- ],
- "return": {
- "type": "Ext.form.Basic",
- "doc": "this
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Basic.js", - "linenr": 531, - "html_filename": "Basic.html", - "href": "Basic.html#Ext-form-Basic-method-submit", - "shortDoc": "Shortcut to do a submit action. This will use the\nAJAX submit action by default. If the standardsubmit config is\nenab..." - }, - { - "tagname": "method", - "name": "suspendEvents", - "member": "Ext.util.Observable", - "doc": "Suspend the firing of all events. (see resumeEvents)
\n", - "params": [ - { - "type": "Boolean", - "name": "queueSuspended", - "doc": "Pass as true to queue up suspended events to be fired\nafter the resumeEvents call instead of discarding all suspended events;
\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", - "linenr": 490, - "html_filename": "Observable.html", - "href": "Observable.html#Ext-util-Observable-method-suspendEvents", - "shortDoc": "Suspend the firing of all events. (see resumeEvents)
\n" - }, - { - "tagname": "method", - "name": "un", - "member": "Ext.util.Observable", - "doc": "Removes an event handler (shorthand for removeListener.)
\n", - "params": [ - { - "type": "String", - "name": "eventName", - "doc": "The type of event the handler was associated with.
\n", - "optional": false - }, - { - "type": "Function", - "name": "handler", - "doc": "The handler to remove. This must be a reference to the function passed into the addListener call.
\n", - "optional": false - }, - { - "type": "Object", - "name": "scope", - "doc": "(optional) The scope originally specified for the handler.
\n", - "optional": true - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", - "linenr": 608, - "html_filename": "Observable.html", - "href": "Observable.html#Ext-util-Observable-method-un", - "shortDoc": "Removes an event handler (shorthand for removeListener.)
\n" - }, - { - "tagname": "method", - "name": "updateRecord", - "member": "Ext.form.Basic", - "doc": "Persists the values in this form into the passed Ext.data.Model object in a beginEdit/endEdit block.
\n", - "params": [ - { - "type": "Ext.data.Record", - "name": "record", - "doc": "The record to edit
\n", - "optional": false - } - ], - "return": { - "type": "Ext.form.Basic", - "doc": "this
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Basic.js", - "linenr": 588, - "html_filename": "Basic.html", - "href": "Basic.html#Ext-form-Basic-method-updateRecord", - "shortDoc": "Persists the values in this form into the passed Ext.data.Model object in a beginEdit/endEdit block.
\n" - } - ], - "property": [ - { - "tagname": "property", - "name": "owner", - "member": "Ext.form.Basic", - "type": "Ext.container.Container", - "doc": "The container component to which this BasicForm is attached.
\n", - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Basic.js", - "linenr": 84, - "html_filename": "Basic.html", - "href": "Basic.html#Ext-form-Basic-property-owner" - } - ], - "event": [ - { - "tagname": "event", - "name": "actioncomplete", - "member": "Ext.form.Basic", - "doc": "Fires when an action is completed.
\n", - "params": [ - { - "type": "Ext.form.Basic", - "name": "this", - "doc": "\n", - "optional": false - }, - { - "type": "Ext.form.action.Action", - "name": "action", - "doc": "The Ext.form.action.Action that completed
\n", - "optional": false - } - ], - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Basic.js", - "linenr": 122, - "html_filename": "Basic.html", - "href": "Basic.html#Ext-form-Basic-event-actioncomplete", - "shortDoc": "Fires when an action is completed.
\n" - }, - { - "tagname": "event", - "name": "actionfailed", - "member": "Ext.form.Basic", - "doc": "Fires when an action fails.
\n", - "params": [ - { - "type": "Ext.form.Basic", - "name": "this", - "doc": "\n", - "optional": false - }, - { - "type": "Ext.form.action.Action", - "name": "action", - "doc": "The Ext.form.action.Action that failed
\n", - "optional": false - } - ], - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Basic.js", - "linenr": 115, - "html_filename": "Basic.html", - "href": "Basic.html#Ext-form-Basic-event-actionfailed", - "shortDoc": "Fires when an action fails.
\n" - }, - { - "tagname": "event", - "name": "beforeaction", - "member": "Ext.form.Basic", - "doc": "Fires before any action is performed. Return false to cancel the action.
\n", - "params": [ - { - "type": "Ext.form.Basic", - "name": "this", - "doc": "\n", - "optional": false - }, - { - "type": "Ext.form.action.Action", - "name": "action", - "doc": "The Ext.form.action.Action to be performed
\n", - "optional": false - } - ], - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Basic.js", - "linenr": 108, - "html_filename": "Basic.html", - "href": "Basic.html#Ext-form-Basic-event-beforeaction", - "shortDoc": "Fires before any action is performed. Return false to cancel the action.
\n" - }, - { - "tagname": "event", - "name": "dirtychange", - "member": "Ext.form.Basic", - "doc": "Fires when the dirty state of the entire form changes.
\n", - "params": [ - { - "type": "Ext.form.Basic", - "name": "this", - "doc": "\n", - "optional": false - }, - { - "type": "Boolean", - "name": "dirty", - "doc": "true if the form is now dirty, false if it is no longer dirty.
\n", - "optional": false - } - ], - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Basic.js", - "linenr": 136, - "html_filename": "Basic.html", - "href": "Basic.html#Ext-form-Basic-event-dirtychange", - "shortDoc": "Fires when the dirty state of the entire form changes.
\n" - }, - { - "tagname": "event", - "name": "validitychange", - "member": "Ext.form.Basic", - "doc": "Fires when the validity of the entire form changes.
\n", - "params": [ - { - "type": "Ext.form.Basic", - "name": "this", - "doc": "\n", - "optional": false - }, - { - "type": "Boolean", - "name": "valid", - "doc": "true if the form is now valid, false if it is now invalid.
\n", - "optional": false - } - ], - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Basic.js", - "linenr": 129, - "html_filename": "Basic.html", - "href": "Basic.html#Ext-form-Basic-event-validitychange", - "shortDoc": "Fires when the validity of the entire form changes.
\n" - } - ], - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Basic.js", - "linenr": 1, - "html_filename": "Basic.html", - "href": "Basic.html#Ext-form-Basic", - "cssVar": [ - - ], - "cssMixin": [ - - ], - "component": false, - "superclasses": [ - "Ext.util.Observable" - ], - "subclasses": [ - - ], - "mixedInto": [ - - ], - "allMixins": [ - - ] -}); \ No newline at end of file +Ext.data.JsonP.Ext_form_Basic({"tagname":"class","html":"Alternate names
Ext.form.BasicFormHierarchy
Ext.BaseExt.util.ObservableExt.form.BasicRequires
Files
Provides input field management, validation, submission, and form loading services for the collection\nof Field instances within a Ext.container.Container. It is recommended\nthat you use a Ext.form.Panel as the form container, as that has logic to automatically\nhook up an instance of Ext.form.Basic (plus other conveniences related to field configuration.)
\n\nThe Basic class delegates the handling of form loads and submits to instances of Ext.form.action.Action.\nSee the various Action implementations for specific details of each one's functionality, as well as the\ndocumentation for doAction which details the configuration options that can be specified in\neach action call.
\n\nThe default submit Action is Ext.form.action.Submit, which uses an Ajax request to submit the\nform's values to a configured URL. To enable normal browser submission of an Ext form, use the\nstandardSubmit config option.
\n\nFile uploads are not performed using normal 'Ajax' techniques; see the description for\nhasUpload for details. If you're using file uploads you should read the method description.
\n\nExt.create('Ext.form.Panel', {\n title: 'Basic Form',\n renderTo: Ext.getBody(),\n bodyPadding: 5,\n width: 350,\n\n // Any configuration items here will be automatically passed along to\n // the Ext.form.Basic instance when it gets created.\n\n // The form will submit an AJAX request to this URL when submitted\n url: 'save-form.php',\n\n items: [{\n fieldLabel: 'Field',\n name: 'theField'\n }],\n\n buttons: [{\n text: 'Submit',\n handler: function() {\n // The getForm() method returns the Ext.form.Basic instance:\n var form = this.up('form').getForm();\n if (form.isValid()) {\n // Submit the Ajax request and handle the response\n form.submit({\n success: function(form, action) {\n Ext.Msg.alert('Success', action.result.msg);\n },\n failure: function(form, action) {\n Ext.Msg.alert('Failed', action.result.msg);\n }\n });\n }\n }\n }]\n});\n
\n(Optional) If specified, load and submit actions will be handled\nwith Ext.form.action.DirectLoad and Ext.form.action.DirectLoad.\nMethods which have been imported by Ext.direct.Manager can be specified here to load and submit\nforms.\nSuch as the following:
\n\napi: {\n load: App.ss.MyProfile.load,\n submit: App.ss.MyProfile.submit\n}\n
\n\n\nLoad actions can use paramOrder
or paramsAsHash
\nto customize how the load method is invoked.\nSubmit actions will always use a standard form submit. The formHandler configuration must\nbe set on the associated server-side method which has been imported by Ext.direct.Manager.
Parameters to pass with all requests. e.g. baseParams: {id: '123', foo: 'bar'}.
\n\n\nParameters are encoded as standard HTTP parameters using Ext.Object.toQueryString.
\n\nAn Ext.data.DataReader (e.g. Ext.data.reader.Xml) to be used to\nread field error messages returned from 'submit' actions. This is optional\nas there is built-in support for processing JSON responses.
\n\n\nThe Records which provide messages for the invalid Fields must use the\nField name (or id) as the Record ID, and must contain a field called 'msg'\nwhich contains the error message.
\n\n\nThe errorReader does not have to be a full-blown implementation of a\nReader. It simply needs to implement a read(xhr) function\nwhich returns an Array of Records in an object with the following\nstructure:
\n\n\n{\n records: recordArray\n}\n
\n\nA config object containing one or more event handlers to be added to this object during initialization. This\nshould be a valid listeners config object as specified in the addListener example for attaching multiple\nhandlers at once.
\n\nDOM events from Ext JS Components
\n\nWhile some Ext JS Component classes export selected DOM events (e.g. \"click\", \"mouseover\" etc), this is usually\nonly done when extra value can be added. For example the DataView's itemclick
event passing the node clicked on. To access DOM events directly from a\nchild element of a Component, we need to specify the element
option to identify the Component property to add a\nDOM listener to:
new Ext.panel.Panel({\n width: 400,\n height: 200,\n dockedItems: [{\n xtype: 'toolbar'\n }],\n listeners: {\n click: {\n element: 'el', //bind to the underlying el property on the panel\n fn: function(){ console.log('click el'); }\n },\n dblclick: {\n element: 'body', //bind to the underlying body property on the panel\n fn: function(){ console.log('dblclick body'); }\n }\n }\n});\n
\nThe request method to use (GET or POST) for form actions if one isn't supplied in the action options.
\nThe request method to use (GET or POST) for form actions if one isn't supplied in the action options.
\nA list of params to be executed server side.\nDefaults to undefined. Only used for the api
\nload
configuration.
Specify the params in the order in which they must be executed on the\nserver-side as either (1) an Array of String values, or (2) a String of params\ndelimited by either whitespace, comma, or pipe. For example,\nany of the following would be acceptable:
\n\n\nparamOrder: ['param1','param2','param3']\nparamOrder: 'param1 param2 param3'\nparamOrder: 'param1,param2,param3'\nparamOrder: 'param1|param2|param'\n
\n\nOnly used for the api
\nload
configuration. If true, parameters will be sent as a\nsingle hash collection of named arguments. Providing a\nparamOrder nullifies this configuration.
Defaults to: false
An Ext.data.DataReader (e.g. Ext.data.reader.Xml) to be used to read\ndata when executing 'load' actions. This is optional as there is built-in\nsupport for processing JSON responses.
\nIf set to true, a standard HTML form submit is used instead of a XHR (Ajax) style form submission.\nAll of the field values, plus any additional params configured via baseParams\nand/or the options
to submit, will be included in the values submitted in the form.
Timeout for form actions in seconds (default is 30 seconds).
\nDefaults to: 30
By default wait messages are displayed with Ext.MessageBox.wait. You can target a specific\nelement by passing it or its id or mask the form itself by passing in true.
\nThe container component to which this BasicForm is attached.
\nThe container component to which this BasicForm is attached.
\nGet the reference to the current class from which this object was instantiated. Unlike statics,\nthis.self
is scope-dependent and it's meant to be used for dynamic inheritance. See statics\nfor a detailed comparison
Ext.define('My.Cat', {\n statics: {\n speciesName: 'Cat' // My.Cat.speciesName = 'Cat'\n },\n\n constructor: function() {\n alert(this.self.speciesName); / dependent on 'this'\n\n return this;\n },\n\n clone: function() {\n return new this.self();\n }\n});\n\n\nExt.define('My.SnowLeopard', {\n extend: 'My.Cat',\n statics: {\n speciesName: 'Snow Leopard' // My.SnowLeopard.speciesName = 'Snow Leopard'\n }\n});\n\nvar cat = new My.Cat(); // alerts 'Cat'\nvar snowLeopard = new My.SnowLeopard(); // alerts 'Snow Leopard'\n\nvar clone = snowLeopard.clone();\nalert(Ext.getClassName(clone)); // alerts 'My.SnowLeopard'\n
\nCreates new form.
\nThe component that is the container for the form, usually a Ext.form.Panel
\nConfiguration options. These are normally specified in the config to the\nExt.form.Panel constructor, which passes them along to the BasicForm automatically.
\nAdds the specified events to the list of events which this Observable may fire.
\nEither an object with event names as properties with a value of true
or the first\nevent name string if multiple event names are being passed as separate parameters. Usage:
this.addEvents({\n storeloaded: true,\n storecleared: true\n});\n
\nAdditional event names if multiple event names are being passed as separate\nparameters. Usage:
\n\nthis.addEvents('storeloaded', 'storecleared');\n
\nAppends an event handler to this object.
\nThe name of the event to listen for. May also be an object who's property names are\nevent names.
\n\nThe method the event invokes. Will be called with arguments given to\nfireEvent plus the options
parameter described below.
The scope (this
reference) in which the handler function is executed. If\nomitted, defaults to the object which fired the event.
An object containing handler configuration.
\n\n\n\n\nNote: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler.
\n\n\n\n\nThis object may contain any of the following properties:
\n\n\n\n\nscope : Object
\n\nThe scope (this
reference) in which the handler function is executed. If omitted, defaults to the object\nwhich fired the event.
delay : Number
\n\nThe number of milliseconds to delay the invocation of the handler after the event fires.
single : Boolean
\n\nTrue to add a handler to handle just the next firing of the event, and then remove itself.
buffer : Number
\n\nCauses the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of\nmilliseconds. If the event fires again within that time, the original handler is not invoked, but the new\nhandler is scheduled in its place.
target : Observable
\n\nOnly call the handler if the event was fired on the target Observable, not if the event was bubbled up from a\nchild Observable.
element : String
\n\nThis option is only valid for listeners bound to Components. The name of a Component\nproperty which references an element to add a listener to.
\n\nThis option is useful during Component construction to add DOM event listeners to elements of\nComponents which will exist only after the Component is rendered.\nFor example, to add a click listener to a Panel's body:
\n\nnew Ext.panel.Panel({\n title: 'The title',\n listeners: {\n click: this.handlePanelClick,\n element: 'body'\n }\n});\n
Combining Options
\n\n\n\n\nUsing the options argument, it is possible to combine different types of listeners:
\n\n\n\n\nA delayed, one-time listener.
\n\n\n\n\nmyPanel.on('hide', this.handleClick, this, {\n single: true,\n delay: 100\n});\n
\n\n\n\n\nAttaching multiple handlers in 1 call
\n\n\n\n\nThe method also allows for a single argument to be passed which is a config object containing properties which\nspecify multiple events. For example:
\n\n\n\n\nmyGridPanel.on({\n cellClick: this.onCellClick,\n mouseover: this.onMouseOver,\n mouseout: this.onMouseOut,\n scope: this // Important. Ensure \"this\" is correct during handler execution\n});\n
\n\n\n\n\nOne can also specify options for each event handler separately:
\n\n\n\n\nmyGridPanel.on({\n cellClick: {fn: this.onCellClick, scope: this, single: true},\n mouseover: {fn: panel.onMouseOver, scope: panel}\n});\n
\n\nAdds listeners to any Observable object (or Ext.Element) which are automatically removed when this Component is\ndestroyed.
\nThe item to which to add a listener/listeners.
\n\nThe event name, or an object containing event name properties.
\n\nIf the ename
parameter was an event name, this is the handler function.
If the ename
parameter was an event name, this is the scope (this
reference)\nin which the handler function is executed.
If the ename
parameter was an event name, this is the\naddListener options.
Calls Ext.applyIf for all field in this form with the passed object.
\nThe object to be applied
\nthis
\nCalls Ext.apply for all fields in this form with the passed object.
\nThe object to be applied
\nthis
\nCall the original method that was previously overridden with override
\n\nExt.define('My.Cat', {\n constructor: function() {\n alert(\"I'm a cat!\");\n\n return this;\n }\n});\n\nMy.Cat.override({\n constructor: function() {\n alert(\"I'm going to be a cat!\");\n\n var instance = this.callOverridden();\n\n alert(\"Meeeeoooowwww\");\n\n return instance;\n }\n});\n\nvar kitty = new My.Cat(); // alerts \"I'm going to be a cat!\"\n // alerts \"I'm a cat!\"\n // alerts \"Meeeeoooowwww\"\n
\nThe arguments, either an array or the arguments
object
Returns the result after calling the overridden method
\nCall the parent's overridden method. For example:
\n\nExt.define('My.own.A', {\n constructor: function(test) {\n alert(test);\n }\n});\n\nExt.define('My.own.B', {\n extend: 'My.own.A',\n\n constructor: function(test) {\n alert(test);\n\n this.callParent([test + 1]);\n }\n});\n\nExt.define('My.own.C', {\n extend: 'My.own.B',\n\n constructor: function() {\n alert(\"Going to call parent's overriden constructor...\");\n\n this.callParent(arguments);\n }\n});\n\nvar a = new My.own.A(1); // alerts '1'\nvar b = new My.own.B(1); // alerts '1', then alerts '2'\nvar c = new My.own.C(2); // alerts \"Going to call parent's overriden constructor...\"\n // alerts '2', then alerts '3'\n
\nThe arguments, either an array or the arguments
object\nfrom the current method, for example: this.callParent(arguments)
Returns the result from the superclass' method
\nCheck whether the dirty state of the entire form has changed since it was last checked, and\nif so fire the dirtychange event. This is automatically invoked\nwhen an individual field's dirty state changes.
\nCheck whether the validity of the entire form has changed since it was last checked, and\nif so fire the validitychange event. This is automatically invoked\nwhen an individual field's validity changes.
\nRemoves all listeners for this object including the managed listeners
\nPerforms a predefined action (an implementation of Ext.form.action.Action)\nto perform application-specific processing.
\nThe name of the predefined action type,\nor instance of Ext.form.action.Action to perform.
\nThe options to pass to the Ext.form.action.Action\nthat will get created, if the action argument is a String.
\n\nAll of the config options listed below are supported by both the\nsubmit and load\nactions unless otherwise noted (custom actions could also accept\nother config options):
\n\n\nThe params to pass\n(defaults to the form's baseParams, or none if not defined)
\nParameters are encoded as standard HTTP parameters using Ext.Object.toQueryString.
this
\nEnables events fired by this Observable to bubble up an owner hierarchy by calling this.getBubbleTarget()
if\npresent. There is no implementation in the Observable base class.
This is commonly used by Ext.Components to bubble events to owner Containers.\nSee Ext.Component.getBubbleTarget. The default implementation in Ext.Component returns the\nComponent's immediate owner. But if a known target is required, this can be overridden to access the\nrequired target more quickly.
\n\nExample:
\n\nExt.override(Ext.form.field.Base, {\n // Add functionality to Field's initComponent to enable the change event to bubble\n initComponent : Ext.Function.createSequence(Ext.form.field.Base.prototype.initComponent, function() {\n this.enableBubble('change');\n }),\n\n // We know that we want Field's events to bubble directly to the FormPanel.\n getBubbleTarget : function() {\n if (!this.formPanel) {\n this.formPanel = this.findParentByType('form');\n }\n return this.formPanel;\n }\n});\n\nvar myForm = new Ext.formPanel({\n title: 'User Details',\n items: [{\n ...\n }],\n listeners: {\n change: function() {\n // Title goes red if form has been modified.\n myForm.header.setStyle('color', 'red');\n }\n }\n});\n
\nFind a specific Ext.form.field.Field in this form by id or name.
\nThe value to search for (specify either a id or\nname or hiddenName).
\nFires the specified event with the passed parameters (minus the event name, plus the options
object passed\nto addListener).
An event may be set to bubble up an Observable parent hierarchy (See Ext.Component.getBubbleTarget) by\ncalling enableBubble.
\nThe name of the event to fire.
\nVariable number of parameters are passed to handlers.
\nreturns false if any of the handlers return false otherwise it returns true.
\nRetrieves the fields in the form as a set of key/value pairs, using their\ngetModelData() method to collect the values.\nIf multiple fields return values under the same name those values will be combined into an Array.\nThis is similar to getValues except that this method collects type-specific data values\n(e.g. Date objects for date fields) while getValues returns only String values for submission.
\nIf true, only fields that are dirty will be included in the result.\nDefaults to false.
\nReturn all the Ext.form.field.Field components in the owner container.
\nCollection of the Field objects
\nReturns the last Ext.data.Model instance that was loaded via loadRecord
\nThe record
\nRetrieves the fields in the form as a set of key/value pairs, using their\ngetSubmitData() method to collect the values.\nIf multiple fields return values under the same name those values will be combined into an Array.\nThis is similar to getFieldValues except that this method collects only String values for\nsubmission, while getFieldValues collects type-specific data values (e.g. Date objects for date fields.)
\nIf true, will return the key/value collection as a single\nURL-encoded param string. Defaults to false.
\nIf true, only fields that are dirty will be included in the result.\nDefaults to false.
\nIf true, the configured emptyText of empty fields will be used.\nDefaults to false.
\nReturns true if the form contains any invalid fields. No fields will be marked as invalid\nas a result of calling this; to trigger marking of fields use isValid instead.
\nReturns true if the form contains a file upload field. This is used to determine the\nmethod for submitting the form: File uploads are not performed using normal 'Ajax' techniques,\nthat is they are not performed using XMLHttpRequests. Instead a hidden <form>\nelement containing all the fields is created temporarily and submitted with its\ntarget set to refer\nto a dynamically generated, hidden <iframe> which is inserted into the document\nbut removed after the return data has been gathered.
\n\n\nThe server response is parsed by the browser to create the document for the IFRAME. If the\nserver is using JSON to send the return object, then the\nContent-Type header\nmust be set to \"text/html\" in order to tell the browser to insert the text unchanged into the document body.
\n\n\nCharacters which are significant to an HTML parser must be sent as HTML entities, so encode\n\"<\" as \"<\", \"&\" as \"&\" etc.
\n\n\nThe response text is retrieved from the document, and a fake XMLHttpRequest object\nis created containing a responseText property in order to conform to the\nrequirements of event handlers and callbacks.
\n\n\nBe aware that file upload packets are sent with the content type multipart/form\nand some server technologies (notably JEE) may require some custom processing in order to\nretrieve parameter names and parameter values from the packet content.
\n\nInitialize configuration for this class. a typical example:
\n\nExt.define('My.awesome.Class', {\n // The default config\n config: {\n name: 'Awesome',\n isAwesome: true\n },\n\n constructor: function(config) {\n this.initConfig(config);\n\n return this;\n }\n});\n\nvar awesome = new My.awesome.Class({\n name: 'Super Awesome'\n});\n\nalert(awesome.getName()); // 'Super Awesome'\n
\nmixins The mixin prototypes as key - value pairs
\nReturns true if any fields in this form have changed from their original values.
\n\n\nNote that if this BasicForm was configured with trackResetOnLoad then the\nFields' original values are updated when the values are loaded by setValues\nor loadRecord.
\n\nReturns true if client-side validation on the form is successful. Any invalid fields will be\nmarked as invalid. If you only want to determine overall form validity without marking anything,\nuse hasInvalidField instead.
\nLoads an Ext.data.Model into this form by calling setValues with the\nrecord data.\nSee also trackResetOnLoad.
\nThe record to load
\nthis
\nMark fields in this form invalid in bulk.
\nEither an array in the form [{id:'fieldId', msg:'The message'}, ...]
,\nan object hash of {id: msg, id2: msg2}
, or a Ext.data.Errors object.
this
\nShorthand for addManagedListener.
\n\nAdds listeners to any Observable object (or Ext.Element) which are automatically removed when this Component is\ndestroyed.
\nThe item to which to add a listener/listeners.
\n\nThe event name, or an object containing event name properties.
\n\nIf the ename
parameter was an event name, this is the handler function.
If the ename
parameter was an event name, this is the scope (this
reference)\nin which the handler function is executed.
If the ename
parameter was an event name, this is the\naddListener options.
Shorthand for removeManagedListener.
\n\nRemoves listeners that were added by the mon method.
\nThe item from which to remove a listener/listeners.
\n\nThe event name, or an object containing event name properties.
\n\nIf the ename
parameter was an event name, this is the handler function.
If the ename
parameter was an event name, this is the scope (this
reference)\nin which the handler function is executed.
Shorthand for addListener.
\n\nAppends an event handler to this object.
\nThe name of the event to listen for. May also be an object who's property names are\nevent names.
\n\nThe method the event invokes. Will be called with arguments given to\nfireEvent plus the options
parameter described below.
The scope (this
reference) in which the handler function is executed. If\nomitted, defaults to the object which fired the event.
An object containing handler configuration.
\n\n\n\n\nNote: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler.
\n\n\n\n\nThis object may contain any of the following properties:
\n\n\n\n\nscope : Object
\n\nThe scope (this
reference) in which the handler function is executed. If omitted, defaults to the object\nwhich fired the event.
delay : Number
\n\nThe number of milliseconds to delay the invocation of the handler after the event fires.
single : Boolean
\n\nTrue to add a handler to handle just the next firing of the event, and then remove itself.
buffer : Number
\n\nCauses the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of\nmilliseconds. If the event fires again within that time, the original handler is not invoked, but the new\nhandler is scheduled in its place.
target : Observable
\n\nOnly call the handler if the event was fired on the target Observable, not if the event was bubbled up from a\nchild Observable.
element : String
\n\nThis option is only valid for listeners bound to Components. The name of a Component\nproperty which references an element to add a listener to.
\n\nThis option is useful during Component construction to add DOM event listeners to elements of\nComponents which will exist only after the Component is rendered.\nFor example, to add a click listener to a Panel's body:
\n\nnew Ext.panel.Panel({\n title: 'The title',\n listeners: {\n click: this.handlePanelClick,\n element: 'body'\n }\n});\n
Combining Options
\n\n\n\n\nUsing the options argument, it is possible to combine different types of listeners:
\n\n\n\n\nA delayed, one-time listener.
\n\n\n\n\nmyPanel.on('hide', this.handleClick, this, {\n single: true,\n delay: 100\n});\n
\n\n\n\n\nAttaching multiple handlers in 1 call
\n\n\n\n\nThe method also allows for a single argument to be passed which is a config object containing properties which\nspecify multiple events. For example:
\n\n\n\n\nmyGridPanel.on({\n cellClick: this.onCellClick,\n mouseover: this.onMouseOver,\n mouseout: this.onMouseOut,\n scope: this // Important. Ensure \"this\" is correct during handler execution\n});\n
\n\n\n\n\nOne can also specify options for each event handler separately:
\n\n\n\n\nmyGridPanel.on({\n cellClick: {fn: this.onCellClick, scope: this, single: true},\n mouseover: {fn: panel.onMouseOver, scope: panel}\n});\n
\n\nRemoves an event handler.
\nThe type of event the handler was associated with.
\n\nThe handler to remove. This must be a reference to the function passed into the\naddListener call.
\n\nThe scope originally specified for the handler. It must be the same as the\nscope argument specified in the original call to addListener or the listener will not be removed.
\n\nRemoves listeners that were added by the mon method.
\nThe item from which to remove a listener/listeners.
\n\nThe event name, or an object containing event name properties.
\n\nIf the ename
parameter was an event name, this is the handler function.
If the ename
parameter was an event name, this is the scope (this
reference)\nin which the handler function is executed.
Resumes firing events (see suspendEvents).
\n\nIf events were suspended using the queueSuspended
parameter, then all events fired\nduring event suspension will be sent to any listeners now.
Set values for fields in this form in bulk.
\nEither an array in the form:
\n\n[{id:'clientName', value:'Fred. Olsen Lines'},\n {id:'portOfLoading', value:'FXT'},\n {id:'portOfDischarge', value:'OSL'} ]
\n\n\nor an object hash of the form:
\n\n{\n clientName: 'Fred. Olsen Lines',\n portOfLoading: 'FXT',\n portOfDischarge: 'OSL'\n}
\n\nthis
\nGet the reference to the class from which this object was instantiated. Note that unlike self,\nthis.statics()
is scope-independent and it always returns the class from which it was called, regardless of what\nthis
points to during run-time
Ext.define('My.Cat', {\n statics: {\n totalCreated: 0,\n speciesName: 'Cat' // My.Cat.speciesName = 'Cat'\n },\n\n constructor: function() {\n var statics = this.statics();\n\n alert(statics.speciesName); // always equals to 'Cat' no matter what 'this' refers to\n // equivalent to: My.Cat.speciesName\n\n alert(this.self.speciesName); // dependent on 'this'\n\n statics.totalCreated++;\n\n return this;\n },\n\n clone: function() {\n var cloned = new this.self; // dependent on 'this'\n\n cloned.groupName = this.statics().speciesName; // equivalent to: My.Cat.speciesName\n\n return cloned;\n }\n});\n\n\nExt.define('My.SnowLeopard', {\n extend: 'My.Cat',\n\n statics: {\n speciesName: 'Snow Leopard' // My.SnowLeopard.speciesName = 'Snow Leopard'\n },\n\n constructor: function() {\n this.callParent();\n }\n});\n\nvar cat = new My.Cat(); // alerts 'Cat', then alerts 'Cat'\n\nvar snowLeopard = new My.SnowLeopard(); // alerts 'Cat', then alerts 'Snow Leopard'\n\nvar clone = snowLeopard.clone();\nalert(Ext.getClassName(clone)); // alerts 'My.SnowLeopard'\nalert(clone.groupName); // alerts 'Cat'\n\nalert(My.Cat.totalCreated); // alerts 3\n
\nShortcut to do a submit action. This will use the\nAJAX submit action by default. If the standardSubmit config is\nenabled it will use a standard form element to submit, or if the api config is present it will\nuse the Ext.direct.Direct submit action.
\nThe options to pass to the action (see doAction for details).
The following code:
\n\n\nmyFormPanel.getForm().submit({\n clientValidation: true,\n url: 'updateConsignment.php',\n params: {\n newStatus: 'delivered'\n },\n success: function(form, action) {\n Ext.Msg.alert('Success', action.result.msg);\n },\n failure: function(form, action) {\n switch (action.failureType) {\n case Ext.form.action.Action.CLIENT_INVALID:\n Ext.Msg.alert('Failure', 'Form fields may not be submitted with invalid values');\n break;\n case Ext.form.action.Action.CONNECT_FAILURE:\n Ext.Msg.alert('Failure', 'Ajax communication failed');\n break;\n case Ext.form.action.Action.SERVER_INVALID:\n Ext.Msg.alert('Failure', action.result.msg);\n }\n }\n});\n
\n\n\nwould process the following server response for a successful submission:
\n\n{\n \"success\":true, // note this is Boolean, not string\n \"msg\":\"Consignment updated\"\n}\n
\n\n\nand the following server response for a failed submission:
\n\n{\n \"success\":false, // note this is Boolean, not string\n \"msg\":\"You do not have permission to perform this operation\"\n}\n
\n\nthis
\nSuspends the firing of all events. (see resumeEvents)
\nPass as true to queue up suspended events to be fired\nafter the resumeEvents call instead of discarding all suspended events.
\nShorthand for removeListener.
\n\nRemoves an event handler.
\nThe type of event the handler was associated with.
\n\nThe handler to remove. This must be a reference to the function passed into the\naddListener call.
\n\nThe scope originally specified for the handler. It must be the same as the\nscope argument specified in the original call to addListener or the listener will not be removed.
\n\nPersists the values in this form into the passed Ext.data.Model object in a beginEdit/endEdit block.
\nThe record to edit
\nthis
\nAdd / override static properties of this class.
\n\nExt.define('My.cool.Class', {\n ...\n});\n\nMy.cool.Class.addStatics({\n someProperty: 'someValue', // My.cool.Class.someProperty = 'someValue'\n method1: function() { ... }, // My.cool.Class.method1 = function() { ... };\n method2: function() { ... } // My.cool.Class.method2 = function() { ... };\n});\n
\nthis
\nBorrow another class' members to the prototype of this class.
\n\nExt.define('Bank', {\n money: '$$$',\n printMoney: function() {\n alert('$$$$$$$');\n }\n});\n\nExt.define('Thief', {\n ...\n});\n\nThief.borrow(Bank, ['money', 'printMoney']);\n\nvar steve = new Thief();\n\nalert(steve.money); // alerts '$$$'\nsteve.printMoney(); // alerts '$$$$$$$'\n
\nThe class to borrow members from
\nThe names of the members to borrow
\nthis
\nCreate a new instance of this Class.
\n\nExt.define('My.cool.Class', {\n ...\n});\n\nMy.cool.Class.create({\n someConfig: true\n});\n
\n\nAll parameters are passed to the constructor of the class.
\nthe created instance.
\nCreate aliases for existing prototype methods. Example:
\n\nExt.define('My.cool.Class', {\n method1: function() { ... },\n method2: function() { ... }\n});\n\nvar test = new My.cool.Class();\n\nMy.cool.Class.createAlias({\n method3: 'method1',\n method4: 'method2'\n});\n\ntest.method3(); // test.method1()\n\nMy.cool.Class.createAlias('method5', 'method3');\n\ntest.method5(); // test.method3() -> test.method1()\n
\nThe new method name, or an object to set multiple aliases. See\nflexSetter
\nThe original method name
\nGet the current class' name in string format.
\n\nExt.define('My.cool.Class', {\n constructor: function() {\n alert(this.self.getName()); // alerts 'My.cool.Class'\n }\n});\n\nMy.cool.Class.getName(); // 'My.cool.Class'\n
\nclassName
\nAdd methods / properties to the prototype of this class.
\n\nExt.define('My.awesome.Cat', {\n constructor: function() {\n ...\n }\n});\n\n My.awesome.Cat.implement({\n meow: function() {\n alert('Meowww...');\n }\n });\n\n var kitty = new My.awesome.Cat;\n kitty.meow();\n
\nOverride prototype members of this class. Overridden methods can be invoked via\ncallOverridden
\n\nExt.define('My.Cat', {\n constructor: function() {\n alert(\"I'm a cat!\");\n\n return this;\n }\n});\n\nMy.Cat.override({\n constructor: function() {\n alert(\"I'm going to be a cat!\");\n\n var instance = this.callOverridden();\n\n alert(\"Meeeeoooowwww\");\n\n return instance;\n }\n});\n\nvar kitty = new My.Cat(); // alerts \"I'm going to be a cat!\"\n // alerts \"I'm a cat!\"\n // alerts \"Meeeeoooowwww\"\n
\nthis
\nFires when an action is completed.
\nThe Ext.form.action.Action that completed
\nThe options object passed to Ext.util.Observable.addListener.
\n\n\n\nFires when an action fails.
\nThe Ext.form.action.Action that failed
\nThe options object passed to Ext.util.Observable.addListener.
\n\n\n\nFires before any action is performed. Return false to cancel the action.
\nThe Ext.form.action.Action to be performed
\nThe options object passed to Ext.util.Observable.addListener.
\n\n\n\nFires when the dirty state of the entire form changes.
\ntrue if the form is now dirty, false if it is no longer dirty.
\nThe options object passed to Ext.util.Observable.addListener.
\n\n\n\nFires when the validity of the entire form changes.
\ntrue if the form is now valid, false if it is now invalid.
\nThe options object passed to Ext.util.Observable.addListener.
\n\n\n\n