A specific Ext.data.Model type that represents a name/value pair and is made to work with the\nExt.grid.property.Grid. Typically, Properties do not need to be created directly as they can be\ncreated implicitly by simply using the appropriate data configs either via the Ext.grid.property.Grid.source\nconfig property or by calling Ext.grid.property.Grid.setSource. However, if the need arises, these records\ncan also be created explicitly as shown below. Example usage:
\n\nvar rec = new Ext.grid.property.Property({\n name: 'birthday',\n value: Ext.Date.parse('17/06/1962', 'd/m/Y')\n});\n// Add record to an already populated grid\ngrid.store.addSorted(rec);\nThe name of the field treated as this Model's unique id (defaults to 'id').
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Model.js", - "linenr": 521, - "html_filename": "Model.html", - "href": "Model.html#Ext-data-Model-cfg-idProperty" - }, - { - "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});\nThe property on this Persistable object that its data is saved to.\nDefaults to 'data' (e.g. all persistable data resides in this.data.)
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Model.js", - "linenr": 503, - "html_filename": "Model.html", - "href": "Model.html#Ext-data-Model-cfg-persistanceProperty", - "shortDoc": "The property on this Persistable object that its data is saved to.\nDefaults to 'data' (e.g. all persistable data resi..." - } - ], - "method": [ - { - "tagname": "method", - "name": "Property", - "member": "Ext.grid.property.Property", - "doc": "\n", - "params": [ - { + "members": { + "cfg": [ + { + "type": "String", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "Model.html#Ext-data-Model-cfg-idProperty", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Model.js", + "private": false, + "name": "idProperty", + "owner": "Ext.data.Model", + "doc": "The name of the field treated as this Model's unique id (defaults to 'id').
\n", + "linenr": 521, + "html_filename": "Model.html" + }, + { + "type": "Object", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "Observable.html#Ext-util-Observable-cfg-listeners", + "shortDoc": "A config object containing one or more event handlers to be added to this object during initialization. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "name": "listeners", + "owner": "Ext.util.Observable", + "doc": "A 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 ExtJS Components
\n\nWhile some ExtJs 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});\nThe property on this Persistable object that its data is saved to.\nDefaults to 'data' (e.g. all persistable data resides in this.data.)
\n", + "linenr": 503, + "html_filename": "Model.html" + } + ], + "method": [ + { + "deprecated": null, + "alias": null, + "href": "Property.html#Ext-grid-property-Property-method-constructor", + "tagname": "method", + "protected": false, + "shortDoc": " ...", + "static": false, + "params": [ + { + "type": "Object", + "optional": false, + "doc": "A data object in the format:
\n\n{\n name: [name],\n value: [value]\n}The specified value's type\nwill be read automatically by the grid to determine the type of editor to use when displaying it.
\n", + "name": "config" + } + ], + "private": false, + "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/grid/property/Property.js", + "doc": "\n", + "owner": "Ext.grid.property.Property", + "name": "Property", + "html_filename": "Property.html", + "return": { "type": "Object", - "name": "config", - "doc": "A data object in the format:
\n\n{\n name: [name],\n value: [value]\n}The specified value's type\nwill be read automatically by the grid to determine the type of editor to use when displaying it.
\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/grid/property/Property.js", - "linenr": 1, - "html_filename": "Property.html", - "href": "Property.html#Ext-grid-property-Property-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');\nAdds 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 + "linenr": 1 + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-addEvents", + "shortDoc": "Adds the specified events to the list of events which this Observable may fire. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "params": [ + { + "type": "Object/String", + "optional": false, + "doc": "Either 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});\nOptional additional event names if multiple event names are being passed as separate\nparameters. Usage:
\n\nthis.addEvents('storeloaded', 'storecleared');\nAdds the specified events to the list of events which this Observable may fire.
\n", + "linenr": 494, + "return": { + "type": "void", + "doc": "\n" }, - { - "type": "Function", - "name": "handler", - "doc": "The method the event invokes.
\n", - "optional": false + "html_filename": "Observable.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-addListener", + "shortDoc": "Appends an event handler to this object. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "params": [ + { + "type": "String", + "optional": false, + "doc": "The name of the event to listen for. May also be an object who's property names are\nevent names.
\n", + "name": "eventName" + }, + { + "type": "Function", + "optional": false, + "doc": "The method the event invokes. Will be called with arguments given to\nfireEvent plus the options parameter described below.
(optional) The scope (this reference) in which the handler function is executed. If\nomitted, defaults to the object which fired the event.
(optional) An object containing handler configuration.
\n\nNote: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler.
\n\nThis object may contain any of the following properties:
\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});\nCombining Options
\n\nUsing the options argument, it is possible to combine different types of listeners:
\n\nA delayed, one-time listener.
\n\nmyPanel.on('hide', this.handleClick, this, {\n single: true,\n delay: 100\n});\nAttaching multiple handlers in 1 call
\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\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});\nOne can also specify options for each event handler separately:
\n\nmyGridPanel.on({\n cellClick: {fn: this.onCellClick, scope: this, single: true},\n mouseover: {fn: panel.onMouseOver, scope: panel}\n});\nAppends an event handler to this object.
\n", + "linenr": 278, + "return": { + "type": "void", + "doc": "\n" }, - { - "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.
The item to which to add a listener/listeners.
\n", + "name": "item" + }, + { + "type": "Object/String", + "optional": false, + "doc": "The event name, or an object containing event name properties.
\n", + "name": "ename" + }, + { + "type": "Function", + "optional": true, + "doc": "(optional) If the ename parameter was an event name, this is the handler function.
(optional) If the ename parameter was an event name, this is the scope (this reference)\nin which the handler function is executed.
(optional) If the ename parameter was an event name, this is the\naddListener options.
Adds listeners to any Observable object (or Element) which are automatically removed when this Component is\ndestroyed.
\n", + "linenr": 156, + "return": { + "type": "void", + "doc": "\n" }, - { - "type": "Object", - "name": "options", - "doc": "(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});\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});\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", - "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 + "html_filename": "Observable.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Base3.html#Ext-Base-method-addStatics", + "shortDoc": "Add / override static properties of this class. ...", + "static": true, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", + "private": false, + "params": [ + { + "type": "Object", + "optional": false, + "doc": "\n", + "name": "members" + } + ], + "name": "addStatics", + "owner": "Ext.Base", + "doc": "Add / 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});\nthis
\n" }, - { - "type": "Object/String", - "name": "ename", - "doc": "The event name, or an object containing event name properties.
\n", - "optional": false + "html_filename": "Base3.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Model.html#Ext-data-Model-method-beginEdit", + "shortDoc": "Begin an edit. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Model.js", + "private": false, + "params": [ + + ], + "name": "beginEdit", + "owner": "Ext.data.Model", + "doc": "Begin an edit. While in edit mode, no events (e.g.. the update event)\nare relayed to the containing store. When an edit has begun, it must be followed\nby either endEdit or cancelEdit.
Optional. If the ename parameter was an event name, this\nis the handler function.
The arguments, either an array or the arguments object
Call the original method that was previously overridden with Ext.Base.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\"\nReturns the result after calling the overridden method
\n" }, - { - "type": "Object", - "name": "scope", - "doc": "Optional. If the ename parameter was an event name, this\nis the scope (this reference) in which the handler function is executed.
The arguments, either an array or the arguments object\nfrom the current method, for example: this.callParent(arguments)
Call 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'\nReturns the result from the superclass' method
\n" }, - { - "type": "Object", - "name": "opt", - "doc": "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": "beginEdit", - "member": "Ext.data.Model", - "doc": "
Begin an edit. While in edit mode, no events (e.g.. the update event)\nare relayed to the containing store. When an edit has begun, it must be followed\nby either endEdit or cancelEdit.
Cancels all changes made in the current edit operation.
\n", - "params": [ + "html_filename": "Base3.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Model.html#Ext-data-Model-method-cancelEdit", + "shortDoc": "Cancels all changes made in the current edit operation. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Model.js", + "private": false, + "params": [ - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Model.js", - "linenr": 716, - "html_filename": "Model.html", - "href": "Model.html#Ext-data-Model-method-cancelEdit", - "shortDoc": "Cancels all changes made in the current edit operation.
\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 + ], + "name": "cancelEdit", + "owner": "Ext.data.Model", + "doc": "Cancels all changes made in the current edit operation.
\n", + "linenr": 740, + "return": { + "type": "void", + "doc": "\n" }, - { - "type": "Function", - "name": "fn", - "doc": "The function to call when an event is fired.
\n", - "optional": false + "html_filename": "Model.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-capture", + "shortDoc": "Starts capture on the specified Observable. ...", + "static": true, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "params": [ + { + "type": "Observable", + "optional": false, + "doc": "The Observable to capture events from.
\n", + "name": "o" + }, + { + "type": "Function", + "optional": false, + "doc": "The function to call when an event is fired.
\n", + "name": "fn" + }, + { + "type": "Object", + "optional": true, + "doc": "(optional) The scope (this reference) in which the function is executed. Defaults to\nthe Observable firing the event.
Starts capture on the specified Observable. All events will be passed to the supplied function with the event\nname + standard signature of the event before the event is fired. If the supplied function returns false,\nthe event will not fire.
\n", + "linenr": 54, + "return": { + "type": "void", + "doc": "\n" }, - { - "type": "Object", - "name": "scope", - "doc": "(optional) The scope (this reference) in which the function is executed. Defaults to the Observable firing the event.
Removes all listeners for this object including the managed listeners
\n", - "params": [ + "html_filename": "Observable.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-clearListeners", + "shortDoc": "Removes all listeners for this object including the managed listeners ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "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": [ + ], + "name": "clearListeners", + "owner": "Ext.util.Observable", + "doc": "Removes all listeners for this object including the managed listeners
\n", + "linenr": 425, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "Observable.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-clearManagedListeners", + "shortDoc": "Removes all managed listeners for this object. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "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": "commit", - "member": "Ext.data.Model", - "doc": "Usually called by the Ext.data.Store which owns the model instance.\nCommits all changes made to the instance since either creation or the last commit operation.
\n\nDevelopers should subscribe to the Ext.data.Store.update event\nto have their code notified of commit operations.
\n\n", - "params": [ - { - "type": "Boolean", - "name": "silent", - "doc": "(optional) True to skip notification of the owning\nstore of the change (defaults to false)
\n", - "optional": true - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Model.js", - "linenr": 842, - "html_filename": "Model.html", - "href": "Model.html#Ext-data-Model-method-commit", - "shortDoc": "Usually called by the Ext.data.Store which owns the model instance.\nCommits all changes made to the instance since ei..." - }, - { - "tagname": "method", - "name": "copy", - "member": "Ext.data.Model", - "doc": "Creates a copy (clone) of this Model instance.
\n", - "params": [ - { - "type": "String", - "name": "id", - "doc": "(optional) A new id, defaults to the id\nof the instance being copied. See id.\nTo generate a phantom instance with a new id use:
var rec = record.copy(); // clone the record\nExt.data.Model.id(rec); // automatically generate a unique sequential id\nCreates a copy (clone) of this Model instance.
\n" - }, - { - "tagname": "method", - "name": "destroy", - "member": "Ext.data.Model", - "doc": "Destroys the model using the configured proxy
\n", - "params": [ - { + ], + "name": "clearManagedListeners", + "owner": "Ext.util.Observable", + "doc": "Removes all managed listeners for this object.
\n", + "linenr": 454, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "Observable.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Model.html#Ext-data-Model-method-commit", + "shortDoc": "Usually called by the Ext.data.Store which owns the model instance. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Model.js", + "private": false, + "params": [ + { + "type": "Boolean", + "optional": true, + "doc": "(optional) True to skip notification of the owning\nstore of the change (defaults to false)
\n", + "name": "silent" + } + ], + "name": "commit", + "owner": "Ext.data.Model", + "doc": "Usually called by the Ext.data.Store which owns the model instance.\nCommits all changes made to the instance since either creation or the last commit operation.
\n\nDevelopers should subscribe to the Ext.data.Store.update event\nto have their code notified of commit operations.
\n\n", + "linenr": 866, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "Model.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Model.html#Ext-data-Model-method-copy", + "shortDoc": "Creates a copy (clone) of this Model instance. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Model.js", + "private": false, + "params": [ + { + "type": "String", + "optional": true, + "doc": "(optional) A new id, defaults to the id\nof the instance being copied. See id.\nTo generate a phantom instance with a new id use:
var rec = record.copy(); // clone the record\nExt.data.Model.id(rec); // automatically generate a unique sequential id\nCreates a copy (clone) of this Model instance.
\n", + "linenr": 887, + "return": { + "type": "Record", + "doc": "\n" + }, + "html_filename": "Model.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Base3.html#Ext-Base-method-create", + "shortDoc": "Create a new instance of this Class. ...", + "static": true, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", + "private": false, + "params": [ + + ], + "name": "create", + "owner": "Ext.Base", + "doc": "Create a new instance of this Class.
\n\nExt.define('My.cool.Class', {\n ...\n});\n\nMy.cool.Class.create({\n someConfig: true\n});\nAll parameters are passed to the constructor of the class.
\n", + "linenr": 329, + "return": { "type": "Object", - "name": "options", - "doc": "Options to pass to the proxy
\n", - "optional": false - } - ], - "return": { - "type": "Ext.data.Model", - "doc": "The Model instance
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Model.js", - "linenr": 991, - "html_filename": "Model.html", - "href": "Model.html#Ext-data-Model-method-destroy", - "shortDoc": "Destroys the model using the configured proxy
\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});\nThe 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": "endEdit", - "member": "Ext.data.Model", - "doc": "End an edit. If any data was modified, the containing store is notified\n(ie, the store's update event will fire).
the created instance.
\n" + }, + "html_filename": "Base3.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Base3.html#Ext-Base-method-createAlias", + "shortDoc": "Create aliases for existing prototype methods. ...", + "static": true, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", + "private": false, + "params": [ + { + "type": "String/Object", + "optional": false, + "doc": "The new method name, or an object to set multiple aliases. See\nflexSetter
\n", + "name": "alias" + }, + { + "type": "String/Object", + "optional": false, + "doc": "The original method name
\n", + "name": "origin" + } + ], + "name": "createAlias", + "owner": "Ext.Base", + "doc": "Create 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()\nOptions to pass to the proxy
\n", + "name": "options" + } + ], + "name": "destroy", + "owner": "Ext.data.Model", + "doc": "Destroys the model using the configured proxy
\n", + "linenr": 1015, + "return": { + "type": "Ext.data.Model", + "doc": "The Model instance
\n" + }, + "html_filename": "Model.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-enableBubble", + "shortDoc": "Enables events fired by this Observable to bubble up an owner hierarchy by calling this.getBubbleTarget() if\npresent. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "params": [ + { + "type": "String/[String]", + "optional": false, + "doc": "The event name to bubble, or an Array of event names.
\n", + "name": "events" + } + ], + "name": "enableBubble", + "owner": "Ext.util.Observable", + "doc": "Enables 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});\nTrue to not notify the store of the change
\n", + "name": "silent" + } + ], + "name": "endEdit", + "owner": "Ext.data.Model", + "doc": "End an edit. If any data was modified, the containing store is notified\n(ie, the store's update event will fire).
The name of the event to fire.
\n", + "name": "eventName" + }, + { + "type": "Object...", + "optional": false, + "doc": "Variable number of parameters are passed to handlers.
\n", + "name": "args" + } + ], + "name": "fireEvent", + "owner": "Ext.util.Observable", + "doc": "Fires 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.
\n", + "linenr": 233, + "return": { "type": "Boolean", - "name": "silent", - "doc": "True to not notify the store of the change
\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Model.js", - "linenr": 733, - "html_filename": "Model.html", - "href": "Model.html#Ext-data-Model-method-endEdit", - "shortDoc": "End an edit. If any data was modified, the containing store is notified\n(ie, the store's update event will fire).
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 + "doc": "returns false if any of the handlers return false otherwise it returns true.
\n" }, - { - "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": "get", - "member": "Ext.data.Model", - "doc": "Returns the value of the given field
\n", - "params": [ - { - "type": "String", - "name": "fieldName", - "doc": "The field to fetch the value for
\n", - "optional": false - } - ], - "return": { - "type": "Mixed", - "doc": "The value
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Model.js", - "linenr": 618, - "html_filename": "Model.html", - "href": "Model.html#Ext-data-Model-method-get", - "shortDoc": "Returns the value of the given field
\n" - }, - { - "tagname": "method", - "name": "getAssociatedData", - "member": "Ext.data.Model", - "doc": "Gets all of the data from this Models loaded associations.\nIt does this recursively - for example if we have a User which\nhasMany Orders, and each Order hasMany OrderItems, it will return an object like this:\n{
\n\norders: [\n {\n id: 123,\n status: 'shipped',\n orderItems: [\n ...\n ]\n }\n]\n}
\n", - "params": [ + "html_filename": "Observable.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Model.html#Ext-data-Model-method-get", + "shortDoc": "Returns the value of the given field ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Model.js", + "private": false, + "params": [ + { + "type": "String", + "optional": false, + "doc": "The field to fetch the value for
\n", + "name": "fieldName" + } + ], + "name": "get", + "owner": "Ext.data.Model", + "doc": "Returns the value of the given field
\n", + "linenr": 625, + "return": { + "type": "Mixed", + "doc": "The value
\n" + }, + "html_filename": "Model.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Model.html#Ext-data-Model-method-getAssociatedData", + "shortDoc": "Gets all of the data from this Models loaded associations. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Model.js", + "private": false, + "params": [ - ], - "return": { - "type": "Object", - "doc": "The nested data set for the Model's loaded associations
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Model.js", - "linenr": 1102, - "html_filename": "Model.html", - "href": "Model.html#Ext-data-Model-method-getAssociatedData", - "shortDoc": "Gets all of the data from this Models loaded associations.\nIt does this recursively - for example if we have a User w..." - }, - { - "tagname": "method", - "name": "getChanges", - "member": "Ext.data.Model", - "doc": "Gets a hash of only the fields that have been modified since this Model was created or commited.
\n", - "params": [ + ], + "name": "getAssociatedData", + "owner": "Ext.data.Model", + "doc": "Gets all of the data from this Models loaded associations.\nIt does this recursively - for example if we have a User which\nhasMany Orders, and each Order hasMany OrderItems, it will return an object like this:\n{
\n\norders: [\n {\n id: 123,\n status: 'shipped',\n orderItems: [\n ...\n ]\n }\n]\n}
\n", + "linenr": 1126, + "return": { + "type": "Object", + "doc": "The nested data set for the Model's loaded associations
\n" + }, + "html_filename": "Model.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Model.html#Ext-data-Model-method-getChanges", + "shortDoc": "Gets a hash of only the fields that have been modified since this Model was created or commited. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Model.js", + "private": false, + "params": [ - ], - "return": { - "type": "void", - "doc": "Object
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Model.js", - "linenr": 751, - "html_filename": "Model.html", - "href": "Model.html#Ext-data-Model-method-getChanges", - "shortDoc": "Gets a hash of only the fields that have been modified since this Model was created or commited.
\n" - }, - { - "tagname": "method", - "name": "getId", - "member": "Ext.data.Model", - "doc": "Returns the unique ID allocated to this model instance as defined by idProperty
\n", - "params": [ + ], + "name": "getChanges", + "owner": "Ext.data.Model", + "doc": "Gets a hash of only the fields that have been modified since this Model was created or commited.
\n", + "linenr": 775, + "return": { + "type": "void", + "doc": "Object
\n" + }, + "html_filename": "Model.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Model.html#Ext-data-Model-method-getId", + "shortDoc": "Returns the unique ID allocated to this model instance as defined by idProperty ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Model.js", + "private": false, + "params": [ - ], - "return": { - "type": "Number", - "doc": "The id
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Model.js", - "linenr": 1024, - "html_filename": "Model.html", - "href": "Model.html#Ext-data-Model-method-getId", - "shortDoc": "Returns the unique ID allocated to this model instance as defined by idProperty
\n" - }, - { - "tagname": "method", - "name": "getProxy", - "member": "Ext.data.Model", - "doc": "Returns the configured Proxy for this Model
\n", - "params": [ + ], + "name": "getId", + "owner": "Ext.data.Model", + "doc": "Returns the unique ID allocated to this model instance as defined by idProperty
\n", + "linenr": 1048, + "return": { + "type": "Number", + "doc": "The id
\n" + }, + "html_filename": "Model.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Base3.html#Ext-Base-method-getName", + "shortDoc": "Get the current class' name in string format. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", + "private": false, + "params": [ - ], - "return": { - "type": "Ext.data.proxy.Proxy", - "doc": "The proxy
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Model.js", - "linenr": 900, - "html_filename": "Model.html", - "href": "Model.html#Ext-data-Model-method-getProxy", - "shortDoc": "Returns the configured Proxy for this Model
\n" - }, - { - "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": "id", - "member": "Ext.data.Model", - "doc": "Generates a sequential id. This method is typically called when a record is created\nand no id has been specified. The id will automatically be assigned\nto the record. The returned id takes the form:\n{PREFIX}-{AUTO_ID}.
Ext.data.Model.PREFIX\n(defaults to 'ext-record')
Ext.data.Model.AUTO_ID\n(defaults to 1 initially)
The record being created. The record does not exist, it's a phantom.
\n", - "optional": false - } - ], - "return": { - "type": "String", - "doc": "auto-generated string id, \"ext-record-i++';
\n" - }, - "private": false, - "static": true, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Model.js", - "linenr": 468, - "html_filename": "Model.html", - "href": "Model.html#Ext-data-Model-method-id", - "shortDoc": "Generates a sequential id. This method is typically called when a record is created\nand no id has been specified. The..." - }, - { - "tagname": "method", - "name": "isModified", - "member": "Ext.data.Model", - "doc": "Returns true if the passed field name has been modified\nsince the load or last commit.
Get 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'\nReturns true if the passed field name has been modified\nsince the load or last commit.
Checks if the model is valid. See validate.
\n", - "params": [ + "doc": "className
\n" + }, + "html_filename": "Base3.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Model.html#Ext-data-Model-method-getProxy", + "shortDoc": "Returns the configured Proxy for this Model ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Model.js", + "private": false, + "params": [ - ], - "return": { - "type": "Boolean", - "doc": "True if the model is valid.
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Model.js", - "linenr": 940, - "html_filename": "Model.html", - "href": "Model.html#Ext-data-Model-method-isValid", - "shortDoc": "Checks if the model is valid. See validate.
\n" - }, - { - "tagname": "method", - "name": "join", - "member": "Ext.data.Model", - "doc": "Tells this model instance that it has been added to a store
\n", - "params": [ - { - "type": "Ext.data.Store", - "name": "store", - "doc": "The store that the model has been added to
\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Model.js", - "linenr": 1040, - "html_filename": "Model.html", - "href": "Model.html#Ext-data-Model-method-join", - "shortDoc": "Tells this model instance that it has been added to a store
\n" - }, - { - "tagname": "method", - "name": "load", - "member": "Ext.data.Model", - "doc": "Static. Asynchronously loads a model instance by id. Sample usage:
\n\n MyApp.User = Ext.define('User', {\n extend: 'Ext.data.Model',\n fields: [\n {name: 'id', type: 'int'},\n {name: 'name', type: 'string'}\n ]\n });\n\n MyApp.User.load(10, {\n scope: this,\n failure: function(record, operation) {\n //do something if the load failed\n },\n success: function(record, operation) {\n //do something if the load succeeded\n },\n callback: function(record, operation) {\n //do something whether the load succeeded or failed\n }\n });\n The id of the model to load
\n", - "optional": false + ], + "name": "getProxy", + "owner": "Ext.data.Model", + "doc": "Returns the configured Proxy for this Model
\n", + "linenr": 924, + "return": { + "type": "Ext.data.proxy.Proxy", + "doc": "The proxy
\n" }, - { - "type": "Object", - "name": "config", - "doc": "Optional config object containing success, failure and callback functions, plus optional scope
\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": true, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Model.js", - "linenr": 405, - "html_filename": "Model.html", - "href": "Model.html#Ext-data-Model-method-load", - "shortDoc": "Static. Asynchronously loads a model instance by id. Sample usage:\n\n MyApp.User = Ext.define('User', {\n ext..." - }, - { - "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});\nThe class constructor to make observable.
\n", - "optional": false + "html_filename": "Model.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-hasListener", + "shortDoc": "Checks to see if this object has any listeners for a specified event ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "params": [ + { + "type": "String", + "optional": false, + "doc": "The name of the event to check for
\n", + "name": "eventName" + } + ], + "name": "hasListener", + "owner": "Ext.util.Observable", + "doc": "Checks to see if this object has any listeners for a specified event
\n", + "linenr": 530, + "return": { + "type": "Boolean", + "doc": "True if the event is being listened for, else false
\n" }, - { - "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": [ - { + "html_filename": "Observable.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Model.html#Ext-data-Model-method-id", + "shortDoc": "Generates a sequential id. ...", + "static": true, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Model.js", + "private": false, + "params": [ + { + "type": "Ext.data.Model", + "optional": false, + "doc": "The record being created. The record does not exist, it's a phantom.
\n", + "name": "rec" + } + ], + "name": "id", + "owner": "Ext.data.Model", + "doc": "Generates a sequential id. This method is typically called when a record is created\nand no id has been specified. The id will automatically be assigned\nto the record. The returned id takes the form:\n{PREFIX}-{AUTO_ID}.
Ext.data.Model.PREFIX\n(defaults to 'ext-record')
Ext.data.Model.AUTO_ID\n(defaults to 1 initially)
The type of event to listen for
\n", - "optional": false + "doc": "auto-generated string id, \"ext-record-i++';
\n" }, - { - "type": "Function", - "name": "handler", - "doc": "The method the event invokes
\n", - "optional": false + "html_filename": "Model.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Base3.html#Ext-Base-method-implement", + "shortDoc": "Add methods / properties to the prototype of this class. ...", + "static": true, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", + "private": false, + "params": [ + { + "type": "Object", + "optional": false, + "doc": "\n", + "name": "members" + } + ], + "name": "implement", + "owner": "Ext.Base", + "doc": "Add 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();\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(optional) The scope (this reference) in which the handler function is executed.\nIf omitted, defaults to the object which fired the event.
mixins The mixin prototypes as key - value pairs
\n" }, - { - "type": "Object", - "name": "options", - "doc": "(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": "reject", - "member": "Ext.data.Model", - "doc": "Usually called by the Ext.data.Store to which this model instance has been joined.\nRejects all changes made to the model instance since either creation, or the last commit operation.\nModified fields are reverted to their original values.
\n\nDevelopers should subscribe to the Ext.data.Store.update event\nto have their code notified of reject operations.
\n\n", - "params": [ - { + "html_filename": "Base3.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Model.html#Ext-data-Model-method-isModified", + "shortDoc": "Returns true if the passed field name has been modified\nsince the load or last commit. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Model.js", + "private": false, + "params": [ + { + "type": "String", + "optional": false, + "doc": "\n", + "name": "fieldName" + } + ], + "name": "isModified", + "owner": "Ext.data.Model", + "doc": "Returns true if the passed field name has been modified\nsince the load or last commit.
(optional) True to skip notification of the owning\nstore of the change (defaults to false)
\n", - "optional": true - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Model.js", - "linenr": 811, - "html_filename": "Model.html", - "href": "Model.html#Ext-data-Model-method-reject", - "shortDoc": "Usually called by the Ext.data.Store to which this model instance has been joined.\nRejects all changes made to the mo..." - }, - { - "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 + "doc": "\n" }, - { - "type": "Array", - "name": "events", - "doc": "Array of event names to relay.
\n", - "optional": false + "html_filename": "Model.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Model.html#Ext-data-Model-method-isValid", + "shortDoc": "Checks if the model is valid. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Model.js", + "private": false, + "params": [ + + ], + "name": "isValid", + "owner": "Ext.data.Model", + "doc": "Checks if the model is valid. See validate.
\n", + "linenr": 964, + "return": { + "type": "Boolean", + "doc": "True if the model is valid.
\n" }, - { - "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 + "html_filename": "Model.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Model.html#Ext-data-Model-method-join", + "shortDoc": "Tells this model instance that it has been added to a store ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Model.js", + "private": false, + "params": [ + { + "type": "Ext.data.Store", + "optional": false, + "doc": "The store that the model has been added to
\n", + "name": "store" + } + ], + "name": "join", + "owner": "Ext.data.Model", + "doc": "Tells this model instance that it has been added to a store
\n", + "linenr": 1064, + "return": { + "type": "void", + "doc": "\n" }, - { - "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 + "html_filename": "Model.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Model.html#Ext-data-Model-method-load", + "shortDoc": "Static. ...", + "static": true, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Model.js", + "private": false, + "params": [ + { + "type": "Number", + "optional": false, + "doc": "The id of the model to load
\n", + "name": "id" + }, + { + "type": "Object", + "optional": false, + "doc": "Optional config object containing success, failure and callback functions, plus optional scope
\n", + "name": "config" + } + ], + "name": "load", + "owner": "Ext.data.Model", + "doc": "Static. Asynchronously loads a model instance by id. Sample usage:
\n\n MyApp.User = Ext.define('User', {\n extend: 'Ext.data.Model',\n fields: [\n {name: 'id', type: 'int'},\n {name: 'name', type: 'string'}\n ]\n });\n\n MyApp.User.load(10, {\n scope: this,\n failure: function(record, operation) {\n //do something if the load failed\n },\n success: function(record, operation) {\n //do something if the load succeeded\n },\n callback: function(record, operation) {\n //do something whether the load succeeded or failed\n }\n });\n (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 + "html_filename": "Model.html" + }, + { + "deprecated": null, + "alias": { + "tagname": "alias", + "cls": "Ext.util.Observable", + "doc": null, + "owner": "addManagedListener" }, - { - "type": "Object|String", - "name": "ename", - "doc": "The event name, or an object containing event name properties.
\n", - "optional": false + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-mon", + "shortDoc": "Shorthand for addManagedListener. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "params": [ + { + "type": "Observable/Element", + "optional": false, + "doc": "The item to which to add a listener/listeners.
\n", + "name": "item" + }, + { + "type": "Object/String", + "optional": false, + "doc": "The event name, or an object containing event name properties.
\n", + "name": "ename" + }, + { + "type": "Function", + "optional": true, + "doc": "(optional) If the ename parameter was an event name, this is the handler function.
(optional) If the ename parameter was an event name, this is the scope (this reference)\nin which the handler function is executed.
(optional) If the ename parameter was an event name, this is the\naddListener options.
Shorthand for addManagedListener.
\n\nAdds listeners to any Observable object (or Element) which are automatically removed when this Component is\ndestroyed.
\n", + "linenr": 681, + "return": { + "type": "void", + "doc": "\n" }, - { - "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": "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.
The item from which to remove a listener/listeners.
\n", + "name": "item" + }, + { + "type": "Object|String", + "optional": false, + "doc": "The event name, or an object containing event name properties.
\n", + "name": "ename" + }, + { + "type": "Function", + "optional": false, + "doc": "Optional. If the ename parameter was an event name, this is the handler function.
Optional. If the ename parameter was an event name, this is the scope (this reference)\nin which the handler function is executed.
Shorthand for removeManagedListener.
\n\nRemoves listeners that were added by the mon method.
\n", + "linenr": 687, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "Observable.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-observe", + "shortDoc": "Sets observability on the passed class constructor. ...", + "static": true, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "params": [ + { + "type": "Function", + "optional": false, + "doc": "The class constructor to make observable.
\n", + "name": "c" + }, + { + "type": "Object", + "optional": false, + "doc": "An object containing a series of listeners to add. See addListener.
\n", + "name": "listeners" + } + ], + "name": "observe", + "owner": "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});\nThe name of the event to listen for. May also be an object who's property names are\nevent names.
\n", + "name": "eventName" + }, + { + "type": "Function", + "optional": false, + "doc": "The method the event invokes. Will be called with arguments given to\nfireEvent plus the options parameter described below.
(optional) The scope (this reference) in which the handler function is executed. If\nomitted, defaults to the object which fired the event.
(optional) An object containing handler configuration.
\n\nNote: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler.
\n\nThis object may contain any of the following properties:
\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});\nCombining Options
\n\nUsing the options argument, it is possible to combine different types of listeners:
\n\nA delayed, one-time listener.
\n\nmyPanel.on('hide', this.handleClick, this, {\n single: true,\n delay: 100\n});\nAttaching multiple handlers in 1 call
\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\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});\nOne can also specify options for each event handler separately:
\n\nmyGridPanel.on({\n cellClick: {fn: this.onCellClick, scope: this, single: true},\n mouseover: {fn: panel.onMouseOver, scope: panel}\n});\nShorthand for addListener.
\n\nAppends an event handler to this object.
\n", + "linenr": 669, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "Observable.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Base3.html#Ext-Base-method-override", + "shortDoc": "Override prototype members of this class. ...", + "static": true, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", + "private": false, + "params": [ + { + "type": "Object", + "optional": false, + "doc": "\n", + "name": "members" + } + ], + "name": "override", + "owner": "Ext.Base", + "doc": "Override prototype members of this class. Overridden methods can be invoked via\nExt.Base.callOverridden
\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\"\nthis
\n" + }, + "html_filename": "Base3.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Model.html#Ext-data-Model-method-reject", + "shortDoc": "Usually called by the Ext.data.Store to which this model instance has been joined. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Model.js", + "private": false, + "params": [ + { + "type": "Boolean", + "optional": true, + "doc": "(optional) True to skip notification of the owning\nstore of the change (defaults to false)
\n", + "name": "silent" + } + ], + "name": "reject", + "owner": "Ext.data.Model", + "doc": "Usually called by the Ext.data.Store to which this model instance has been joined.\nRejects all changes made to the model instance since either creation, or the last commit operation.\nModified fields are reverted to their original values.
\n\nDevelopers should subscribe to the Ext.data.Store.update event\nto have their code notified of reject operations.
\n\n", + "linenr": 835, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "Model.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-relayEvents", + "shortDoc": "Relays selected events from the specified Observable as if the events were fired by this. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "params": [ + { + "type": "Object", + "optional": false, + "doc": "The Observable whose events this object is to relay.
\n", + "name": "origin" + }, + { + "type": "[String]", + "optional": false, + "doc": "Array of event names to relay.
\n", + "name": "events" + }, + { + "type": "Object", + "optional": false, + "doc": "\n", + "name": "prefix" + } + ], + "name": "relayEvents", + "owner": "Ext.util.Observable", + "doc": "Relays selected events from the specified Observable as if the events were fired by this.
The Observable to release
\n", + "name": "o" + } + ], + "name": "releaseCapture", + "owner": "Ext.util.Observable", + "doc": "Removes all added captures from the Observable.
\n", + "linenr": 44, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "Observable.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-removeListener", + "shortDoc": "Removes an event handler. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "params": [ + { + "type": "String", + "optional": false, + "doc": "The type of event the handler was associated with.
\n", + "name": "eventName" + }, + { + "type": "Function", + "optional": false, + "doc": "The handler to remove. This must be a reference to the function passed into the\naddListener call.
\n", + "name": "handler" + }, + { + "type": "Object", + "optional": true, + "doc": "(optional) The scope originally specified for the handler.
\n", + "name": "scope" + } + ], + "name": "removeListener", + "owner": "Ext.util.Observable", + "doc": "Removes an event handler.
\n", + "linenr": 392, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "Observable.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-removeManagedListener", + "shortDoc": "Removes listeners that were added by the mon method. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "params": [ + { + "type": "Observable|Element", + "optional": false, + "doc": "The item from which to remove a listener/listeners.
\n", + "name": "item" + }, + { + "type": "Object|String", + "optional": false, + "doc": "The event name, or an object containing event name properties.
\n", + "name": "ename" + }, + { + "type": "Function", + "optional": false, + "doc": "Optional. If the ename parameter was an event name, this is the handler function.
Optional. If the ename parameter was an event name, this is the scope (this reference)\nin which the handler function is executed.
Removes listeners that were added by the mon method.
\n", + "linenr": 197, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "Observable.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-resumeEvents", + "shortDoc": "Resumes firing events (see suspendEvents). ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "params": [ - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", - "linenr": 502, - "html_filename": "Observable.html", - "href": "Observable.html#Ext-util-Observable-method-resumeEvents", - "shortDoc": "Resume firing events. (see suspendEvents)\nIf events were suspended using the queueSuspended parameter, then all\nevent..." - }, - { - "tagname": "method", - "name": "save", - "member": "Ext.data.Model", - "doc": "Saves the model instance using the configured proxy
\n", - "params": [ - { - "type": "Object", - "name": "options", - "doc": "Options to pass to the proxy
\n", - "optional": false - } - ], - "return": { - "type": "Ext.data.Model", - "doc": "The Model instance
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Model.js", - "linenr": 948, - "html_filename": "Model.html", - "href": "Model.html#Ext-data-Model-method-save", - "shortDoc": "Saves the model instance using the configured proxy
\n" - }, - { - "tagname": "method", - "name": "set", - "member": "Ext.data.Model", - "doc": "Sets the given field to the given value, marks the instance as dirty
\n", - "params": [ - { - "type": "String|Object", - "name": "fieldName", - "doc": "The field to set, or an object containing key/value pairs
\n", - "optional": false + ], + "name": "resumeEvents", + "owner": "Ext.util.Observable", + "doc": "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.
The value to set
\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Model.js", - "linenr": 627, - "html_filename": "Model.html", - "href": "Model.html#Ext-data-Model-method-set", - "shortDoc": "Sets the given field to the given value, marks the instance as dirty
\n" - }, - { - "tagname": "method", - "name": "setDirty", - "member": "Ext.data.Model", - "doc": "Marks this Record as dirty. This method\nis used interally when adding phantom records to a\nwriter enabled store.
Marking a record dirty causes the phantom to\n\n\n
be returned by Ext.data.Store.getModifiedRecords where it will\nhave a create action composed for it during store save\noperations.
\n", - "params": [ + "html_filename": "Observable.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Model.html#Ext-data-Model-method-save", + "shortDoc": "Saves the model instance using the configured proxy ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Model.js", + "private": false, + "params": [ + { + "type": "Object", + "optional": false, + "doc": "Options to pass to the proxy
\n", + "name": "options" + } + ], + "name": "save", + "owner": "Ext.data.Model", + "doc": "Saves the model instance using the configured proxy
\n", + "linenr": 972, + "return": { + "type": "Ext.data.Model", + "doc": "The Model instance
\n" + }, + "html_filename": "Model.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Model.html#Ext-data-Model-method-set", + "shortDoc": "Sets the given field to the given value, marks the instance as dirty ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Model.js", + "private": false, + "params": [ + { + "type": "String|Object", + "optional": false, + "doc": "The field to set, or an object containing key/value pairs
\n", + "name": "fieldName" + }, + { + "type": "Mixed", + "optional": false, + "doc": "The value to set
\n", + "name": "value" + } + ], + "name": "set", + "owner": "Ext.data.Model", + "doc": "Sets the given field to the given value, marks the instance as dirty
\n", + "linenr": 634, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "Model.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Model.html#Ext-data-Model-method-setDirty", + "shortDoc": "Marks this Record as dirty. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Model.js", + "private": false, + "params": [ - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Model.js", - "linenr": 779, - "html_filename": "Model.html", - "href": "Model.html#Ext-data-Model-method-setDirty", - "shortDoc": "Marks this Record as dirty. This method\nis used interally when adding phantom records to a\nwriter enabled store.\n\n\nM..." - }, - { - "tagname": "method", - "name": "setId", - "member": "Ext.data.Model", - "doc": "Sets the model instance's id field to the given id
\n", - "params": [ - { - "type": "Number", - "name": "id", - "doc": "The new id
\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Model.js", - "linenr": 1032, - "html_filename": "Model.html", - "href": "Model.html#Ext-data-Model-method-setId", - "shortDoc": "Sets the model instance's id field to the given id
\n" - }, - { - "tagname": "method", - "name": "setProxy", - "member": "Ext.data.Model", - "doc": "Sets the Proxy to use for this model. Accepts any options that can be accepted by Ext.createByAlias
\n", - "params": [ - { - "type": "String/Object/Ext.data.proxy.Proxy", - "name": "proxy", - "doc": "The proxy
\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": true, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Model.js", - "linenr": 879, - "html_filename": "Model.html", - "href": "Model.html#Ext-data-Model-method-setProxy", - "shortDoc": "Sets the Proxy to use for this model. Accepts any options that can be accepted by Ext.createByAlias
\n" - }, - { - "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 + ], + "name": "setDirty", + "owner": "Ext.data.Model", + "doc": "Marks this Record as dirty. This method\nis used interally when adding phantom records to a\nwriter enabled store.
Marking a record dirty causes the phantom to\n\n\n
be returned by Ext.data.Store.getModifiedRecords where it will\nhave a create action composed for it during store save\noperations.
\n", + "linenr": 803, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "Model.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Model.html#Ext-data-Model-method-setId", + "shortDoc": "Sets the model instance's id field to the given id ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Model.js", + "private": false, + "params": [ + { + "type": "Number", + "optional": false, + "doc": "The new id
\n", + "name": "id" + } + ], + "name": "setId", + "owner": "Ext.data.Model", + "doc": "Sets the model instance's id field to the given id
\n", + "linenr": 1056, + "return": { + "type": "void", + "doc": "\n" }, - { - "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 + "html_filename": "Model.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Model.html#Ext-data-Model-method-setProxy", + "shortDoc": "Sets the Proxy to use for this model. ...", + "static": true, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Model.js", + "private": false, + "params": [ + { + "type": "String/Object/Ext.data.proxy.Proxy", + "optional": false, + "doc": "The proxy
\n", + "name": "proxy" + } + ], + "name": "setProxy", + "owner": "Ext.data.Model", + "doc": "Sets the Proxy to use for this model. Accepts any options that can be accepted by Ext.createByAlias
\n", + "linenr": 903, + "return": { + "type": "void", + "doc": "\n" }, - { - "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": "unjoin", - "member": "Ext.data.Model", - "doc": "Tells this model instance that it has been removed from the store
\n", - "params": [ + "html_filename": "Model.html" + }, + { + "deprecated": null, + "alias": null, + "protected": true, + "tagname": "method", + "href": "Base3.html#Ext-Base-method-statics", + "shortDoc": "Get the reference to the class from which this object was instantiated. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", + "private": false, + "params": [ + + ], + "name": "statics", + "owner": "Ext.Base", + "doc": "Get the reference to the class from which this object was instantiated. Note that unlike Ext.Base.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\nPass as true to queue up suspended events to be fired\nafter the resumeEvents call instead of discarding all suspended events.
\n", + "name": "queueSuspended" + } + ], + "name": "suspendEvents", + "owner": "Ext.util.Observable", + "doc": "Suspends the firing of all events. (see resumeEvents)
\n", + "linenr": 541, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "Observable.html" + }, + { + "deprecated": null, + "alias": { + "tagname": "alias", + "cls": "Ext.util.Observable", + "doc": null, + "owner": "removeListener" + }, + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-un", + "shortDoc": "Shorthand for removeListener. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "params": [ + { + "type": "String", + "optional": false, + "doc": "The type of event the handler was associated with.
\n", + "name": "eventName" + }, + { + "type": "Function", + "optional": false, + "doc": "The handler to remove. This must be a reference to the function passed into the\naddListener call.
\n", + "name": "handler" + }, + { + "type": "Object", + "optional": true, + "doc": "(optional) The scope originally specified for the handler.
\n", + "name": "scope" + } + ], + "name": "un", + "owner": "Ext.util.Observable", + "doc": "Shorthand for removeListener.
\n\nRemoves an event handler.
\n", + "linenr": 675, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "Observable.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Model.html#Ext-data-Model-method-unjoin", + "shortDoc": "Tells this model instance that it has been removed from the store ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Model.js", + "private": false, + "params": [ - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Model.js", - "linenr": 1053, - "html_filename": "Model.html", - "href": "Model.html#Ext-data-Model-method-unjoin", - "shortDoc": "Tells this model instance that it has been removed from the store
\n" - }, - { - "tagname": "method", - "name": "validate", - "member": "Ext.data.Model", - "doc": "Validates the current data against all of its configured validations and returns an\nErrors object
\n", - "params": [ + ], + "name": "unjoin", + "owner": "Ext.data.Model", + "doc": "Tells this model instance that it has been removed from the store
\n", + "linenr": 1077, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "Model.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Model.html#Ext-data-Model-method-validate", + "shortDoc": "Validates the current data against all of its configured validations and returns an\nErrors object ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Model.js", + "private": false, + "params": [ - ], - "return": { - "type": "Ext.data.Errors", - "doc": "The errors object
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Model.js", - "linenr": 908, - "html_filename": "Model.html", - "href": "Model.html#Ext-data-Model-method-validate", - "shortDoc": "Validates the current data against all of its configured validations and returns an\nErrors object
\n" - } - ], - "property": [ - { - "tagname": "property", - "name": "defaultProxyType", - "member": "Ext.data.Model", - "type": "String", - "doc": "The string type of the default Model Proxy. Defaults to 'ajax'
\n", - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Model.js", - "linenr": 526, - "html_filename": "Model.html", - "href": "Model.html#Ext-data-Model-property-defaultProxyType" - }, - { - "tagname": "property", - "name": "dirty", - "member": "Ext.data.Model", - "type": "Boolean", - "doc": "Readonly flag - true if this Record has been modified.
\n", - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Model.js", - "linenr": 497, - "html_filename": "Model.html", - "href": "Model.html#Ext-data-Model-property-dirty" - }, - { - "tagname": "property", - "name": "editing", - "member": "Ext.data.Model", - "type": "Boolean", - "doc": "Internal flag used to track whether or not the model instance is currently being edited. Read-only
\n", - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Model.js", - "linenr": 490, - "html_filename": "Model.html", - "href": "Model.html#Ext-data-Model-property-editing" - }, - { - "tagname": "property", - "name": "fields", - "member": "Ext.data.Model", - "type": "Array", - "doc": "An array of the fields defined on this model
\n", - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Model.js", - "linenr": 533, - "html_filename": "Model.html", - "href": "Model.html#Ext-data-Model-property-fields" - }, - { - "tagname": "property", - "name": "modified", - "member": "Ext.data.Model", - "type": "Object", - "doc": "Key: value pairs of all fields whose values have changed
\n", - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Model.js", - "linenr": 571, - "html_filename": "Model.html", - "href": "Model.html#Ext-data-Model-property-modified" - }, - { - "tagname": "property", - "name": "phantom", - "member": "Ext.data.Model", - "type": "Boolean", - "doc": "true when the record does not yet exist in a server-side database (see\nsetDirty). Any record which has a real database pk set as its id property\nis NOT a phantom -- it's real.
\n", - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Model.js", - "linenr": 512, - "html_filename": "Model.html", - "href": "Model.html#Ext-data-Model-property-phantom", - "shortDoc": "true when the record does not yet exist in a server-side database (see\nsetDirty). Any record which has a real databa..." - }, - { - "tagname": "property", - "name": "raw", - "member": "Ext.data.Model", - "type": "Object", - "doc": "The raw data used to create this model if created via a reader.
\n", - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Model.js", - "linenr": 560, - "html_filename": "Model.html", - "href": "Model.html#Ext-data-Model-property-raw" - }, - { - "tagname": "property", - "name": "store", - "member": "Ext.data.Model", - "type": "Ext.data.Store", - "doc": "The Ext.data.Store to which this Record belongs.
\n", - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Model.js", - "linenr": 1045, - "html_filename": "Model.html", - "href": "Model.html#Ext-data-Model-property-store" - } - ], - "event": [ + ], + "name": "validate", + "owner": "Ext.data.Model", + "doc": "Validates the current data against all of its configured validations and returns an\nErrors object
\n", + "linenr": 932, + "return": { + "type": "Ext.data.Errors", + "doc": "The errors object
\n" + }, + "html_filename": "Model.html" + } + ], + "property": [ + { + "type": "String", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "property", + "href": "Model.html#Ext-data-Model-property-defaultProxyType", + "shortDoc": "The string type of the default Model Proxy. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Model.js", + "private": false, + "name": "defaultProxyType", + "owner": "Ext.data.Model", + "doc": "The string type of the default Model Proxy. Defaults to 'ajax'
\n", + "linenr": 526, + "html_filename": "Model.html" + }, + { + "type": "Boolean", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "property", + "href": "Model.html#Ext-data-Model-property-dirty", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Model.js", + "private": false, + "name": "dirty", + "owner": "Ext.data.Model", + "doc": "Readonly flag - true if this Record has been modified.
\n", + "linenr": 497, + "html_filename": "Model.html" + }, + { + "type": "Boolean", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "property", + "href": "Model.html#Ext-data-Model-property-editing", + "shortDoc": "Internal flag used to track whether or not the model instance is currently being edited. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Model.js", + "private": false, + "name": "editing", + "owner": "Ext.data.Model", + "doc": "Internal flag used to track whether or not the model instance is currently being edited. Read-only
\n", + "linenr": 490, + "html_filename": "Model.html" + }, + { + "type": "Array", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "property", + "href": "Model.html#Ext-data-Model-property-fields", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Model.js", + "private": false, + "name": "fields", + "owner": "Ext.data.Model", + "doc": "An array of the fields defined on this model
\n", + "linenr": 533, + "html_filename": "Model.html" + }, + { + "type": "Object", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "property", + "href": "Model.html#Ext-data-Model-property-modified", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Model.js", + "private": false, + "name": "modified", + "owner": "Ext.data.Model", + "doc": "Key: value pairs of all fields whose values have changed
\n", + "linenr": 571, + "html_filename": "Model.html" + }, + { + "type": "Boolean", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "property", + "href": "Model.html#Ext-data-Model-property-phantom", + "shortDoc": "true when the record does not yet exist in a server-side database (see\nsetDirty). ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Model.js", + "private": false, + "name": "phantom", + "owner": "Ext.data.Model", + "doc": "true when the record does not yet exist in a server-side database (see\nsetDirty). Any record which has a real database pk set as its id property\nis NOT a phantom -- it's real.
\n", + "linenr": 512, + "html_filename": "Model.html" + }, + { + "type": "Object", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "property", + "href": "Model.html#Ext-data-Model-property-raw", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Model.js", + "private": false, + "name": "raw", + "owner": "Ext.data.Model", + "doc": "The raw data used to create this model if created via a reader.
\n", + "linenr": 560, + "html_filename": "Model.html" + }, + { + "type": "Class", + "deprecated": null, + "alias": null, + "protected": true, + "tagname": "property", + "href": "Base3.html#Ext-Base-property-self", + "shortDoc": "Get the reference to the current class from which this object was instantiated. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", + "private": false, + "name": "self", + "owner": "Ext.Base", + "doc": "Get the reference to the current class from which this object was instantiated. Unlike Ext.Base.statics,\nthis.self is scope-dependent and it's meant to be used for dynamic inheritance. See Ext.Base.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'\nThe Ext.data.Store to which this Record belongs.
\n", + "linenr": 1069, + "html_filename": "Model.html" + } + ], + "cssVar": [ - ], - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/grid/property/Property.js", - "linenr": 1, - "html_filename": "Property.html", - "href": "Property.html#Ext-grid-property-Property", - "cssVar": [ + ], + "cssMixin": [ - ], - "cssMixin": [ + ], + "event": [ - ], - "component": false, + ] + }, + "singleton": false, + "alias": null, "superclasses": [ + "Ext.Base", "Ext.data.Model" ], + "protected": false, + "tagname": "class", + "mixins": [ + + ], + "href": "Property.html#Ext-grid-property-Property", "subclasses": [ ], + "static": false, + "author": null, + "component": false, + "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/grid/property/Property.js", + "private": false, + "alternateClassNames": [ + "Ext.PropGridProperty" + ], + "name": "Ext.grid.property.Property", + "doc": "A specific Ext.data.Model type that represents a name/value pair and is made to work with the\nExt.grid.property.Grid. Typically, Properties do not need to be created directly as they can be\ncreated implicitly by simply using the appropriate data configs either via the Ext.grid.property.Grid.source\nconfig property or by calling Ext.grid.property.Grid.setSource. However, if the need arises, these records\ncan also be created explicitly as shown below. Example usage:
\n\nvar rec = new Ext.grid.property.Property({\n name: 'birthday',\n value: Ext.Date.parse('17/06/1962', 'd/m/Y')\n});\n// Add record to an already populated grid\ngrid.store.addSorted(rec);\n