X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/6746dc89c47ed01b165cc1152533605f97eb8e8d..f562e4c6e5fac7bcb445985b99acbea4d706e6f0:/docs/output/Ext.form.CheckboxManager.js diff --git a/docs/output/Ext.form.CheckboxManager.js b/docs/output/Ext.form.CheckboxManager.js new file mode 100644 index 00000000..858e9992 --- /dev/null +++ b/docs/output/Ext.form.CheckboxManager.js @@ -0,0 +1 @@ +Ext.data.JsonP.Ext_form_CheckboxManager({"tagname":"class","html":"
Hierarchy
Ext.BaseExt.util.AbstractMixedCollectionExt.util.MixedCollectionExt.form.CheckboxManagerMixins
Files
NOTE This is a private utility class for internal use by the framework. Don't rely on its existence.
Private utility class for managing all Ext.form.field.Checkbox fields grouped by name.
\nSpecify true if the addAll\nfunction should add function references to the collection. Defaults to\nfalse.
\nDefaults to: false
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 Ext JS Components
\n\nWhile some Ext JS Component classes export selected DOM events (e.g. \"click\", \"mouseover\" etc), this is usually\nonly done when extra value can be added. For example the DataView's itemclick
event passing the node clicked on. To access DOM events directly from a\nchild element of a Component, we need to specify the element
option to identify the Component property to add a\nDOM listener to:
new Ext.panel.Panel({\n width: 400,\n height: 200,\n dockedItems: [{\n xtype: 'toolbar'\n }],\n listeners: {\n click: {\n element: 'el', //bind to the underlying el property on the panel\n fn: function(){ console.log('click el'); }\n },\n dblclick: {\n element: 'body', //bind to the underlying body property on the panel\n fn: function(){ console.log('dblclick body'); }\n }\n }\n});\n
\nThe default sort direction to use if one is not specified.
\nThe default sort direction to use if one is not specified.
\nFlag denoting that this object is sortable. Always true.
\nGet the reference to the current class from which this object was instantiated. Unlike statics,\nthis.self
is scope-dependent and it's meant to be used for dynamic inheritance. See statics\nfor a detailed comparison
Ext.define('My.Cat', {\n statics: {\n speciesName: 'Cat' // My.Cat.speciesName = 'Cat'\n },\n\n constructor: function() {\n alert(this.self.speciesName); / dependent on 'this'\n\n return this;\n },\n\n clone: function() {\n return new this.self();\n }\n});\n\n\nExt.define('My.SnowLeopard', {\n extend: 'My.Cat',\n statics: {\n speciesName: 'Snow Leopard' // My.SnowLeopard.speciesName = 'Snow Leopard'\n }\n});\n\nvar cat = new My.Cat(); // alerts 'Cat'\nvar snowLeopard = new My.SnowLeopard(); // alerts 'Snow Leopard'\n\nvar clone = snowLeopard.clone();\nalert(Ext.getClassName(clone)); // alerts 'My.SnowLeopard'\n
\nThe property in each item that contains the data to sort.
\nThe property in each item that contains the data to sort.
\nCreates new MixedCollection.
\nSpecify true if the addAll\nfunction should add function references to the collection. Defaults to\nfalse.
\nA function that can accept an item of the type(s) stored in this MixedCollection\nand return the key value for that item. This is used when available to look up the key on items that\nwere passed without an explicit key parameter to a MixedCollection method. Passing this parameter is\nequivalent to providing an implementation for the getKey method.
\nAdds an item to the collection. Fires the add event when complete.
\nThe key to associate with the item, or the new item.
\n\n\nIf a getKey implementation was specified for this MixedCollection,\nor if the key of the stored items is in a property called id,\nthe MixedCollection will be able to derive the key for the new item.\nIn this case just pass the new item in this parameter.
\n\nThe item to add.
\nThe item added.
\nAdds all elements of an Array or an Object to the collection.
\nAn Object containing properties which will be added\nto the collection, or an Array of values, each of which are added to the collection.\nFunctions references will be added to the collection if allowFunctions
\nhas been set to true.
Adds the specified events to the list of events which this Observable may fire.
\nEither an object with event names as properties with a value of true
or the first\nevent name string if multiple event names are being passed as separate parameters. Usage:
this.addEvents({\n storeloaded: true,\n storecleared: true\n});\n
\nAdditional event names if multiple event names are being passed as separate\nparameters. Usage:
\n\nthis.addEvents('storeloaded', 'storecleared');\n
\nAppends an event handler to this object.
\nThe name of the event to listen for. May also be an object who's property names are\nevent names.
\n\nThe method the event invokes. Will be called with arguments given to\nfireEvent plus the options
parameter described below.
The scope (this
reference) in which the handler function is executed. If\nomitted, defaults to the object which fired the event.
An object containing handler configuration.
\n\n\n\n\nNote: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler.
\n\n\n\n\nThis object may contain any of the following properties:
\n\n\n\n\nscope : Object
\n\nThe scope (this
reference) in which the handler function is executed. If omitted, defaults to the object\nwhich fired the event.
delay : Number
\n\nThe number of milliseconds to delay the invocation of the handler after the event fires.
single : Boolean
\n\nTrue to add a handler to handle just the next firing of the event, and then remove itself.
buffer : Number
\n\nCauses the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of\nmilliseconds. If the event fires again within that time, the original handler is not invoked, but the new\nhandler is scheduled in its place.
target : Observable
\n\nOnly call the handler if the event was fired on the target Observable, not if the event was bubbled up from a\nchild Observable.
element : String
\n\nThis option is only valid for listeners bound to Components. The name of a Component\nproperty which references an element to add a listener to.
\n\nThis option is useful during Component construction to add DOM event listeners to elements of\nComponents which will exist only after the Component is rendered.\nFor example, to add a click listener to a Panel's body:
\n\nnew Ext.panel.Panel({\n title: 'The title',\n listeners: {\n click: this.handlePanelClick,\n element: 'body'\n }\n});\n
Combining Options
\n\n\n\n\nUsing the options argument, it is possible to combine different types of listeners:
\n\n\n\n\nA delayed, one-time listener.
\n\n\n\n\nmyPanel.on('hide', this.handleClick, this, {\n single: true,\n delay: 100\n});\n
\n\n\n\n\nAttaching multiple handlers in 1 call
\n\n\n\n\nThe method also allows for a single argument to be passed which is a config object containing properties which\nspecify multiple events. For example:
\n\n\n\n\nmyGridPanel.on({\n cellClick: this.onCellClick,\n mouseover: this.onMouseOver,\n mouseout: this.onMouseOut,\n scope: this // Important. Ensure \"this\" is correct during handler execution\n});\n
\n\n\n\n\nOne can also specify options for each event handler separately:
\n\n\n\n\nmyGridPanel.on({\n cellClick: {fn: this.onCellClick, scope: this, single: true},\n mouseover: {fn: panel.onMouseOver, scope: panel}\n});\n
\n\nAdds listeners to any Observable object (or Ext.Element) which are automatically removed when this Component is\ndestroyed.
\nThe item to which to add a listener/listeners.
\n\nThe event name, or an object containing event name properties.
\n\nIf the ename
parameter was an event name, this is the handler function.
If the ename
parameter was an event name, this is the scope (this
reference)\nin which the handler function is executed.
If the ename
parameter was an event name, this is the\naddListener options.
Call the original method that was previously overridden with override
\n\nExt.define('My.Cat', {\n constructor: function() {\n alert(\"I'm a cat!\");\n\n return this;\n }\n});\n\nMy.Cat.override({\n constructor: function() {\n alert(\"I'm going to be a cat!\");\n\n var instance = this.callOverridden();\n\n alert(\"Meeeeoooowwww\");\n\n return instance;\n }\n});\n\nvar kitty = new My.Cat(); // alerts \"I'm going to be a cat!\"\n // alerts \"I'm a cat!\"\n // alerts \"Meeeeoooowwww\"\n
\nThe arguments, either an array or the arguments
object
Returns the result after calling the overridden method
\nCall the parent's overridden method. For example:
\n\nExt.define('My.own.A', {\n constructor: function(test) {\n alert(test);\n }\n});\n\nExt.define('My.own.B', {\n extend: 'My.own.A',\n\n constructor: function(test) {\n alert(test);\n\n this.callParent([test + 1]);\n }\n});\n\nExt.define('My.own.C', {\n extend: 'My.own.B',\n\n constructor: function() {\n alert(\"Going to call parent's overriden constructor...\");\n\n this.callParent(arguments);\n }\n});\n\nvar a = new My.own.A(1); // alerts '1'\nvar b = new My.own.B(1); // alerts '1', then alerts '2'\nvar c = new My.own.C(2); // alerts \"Going to call parent's overriden constructor...\"\n // alerts '2', then alerts '3'\n
\nThe arguments, either an array or the arguments
object\nfrom the current method, for example: this.callParent(arguments)
Returns the result from the superclass' method
\nRemoves all items from the collection. Fires the clear event when complete.
\nRemoves all listeners for this object including the managed listeners
\nCollects unique values of a particular property in this MixedCollection
\nThe property to collect on
\n'root' property to extract the first argument from. This is used mainly when\nsumming fields in records, where the fields are all stored inside the 'data' object
\nPass true to allow null, undefined or empty string values
\nThe unique values
\nExecutes the specified function once for every item in the collection, passing the following arguments:
\n\nThe collection item
The item's index
The total number of items in the collection
The function should return a boolean value. Returning false from the function will stop the iteration.
\nExecutes the specified function once for every key in the collection, passing each\nkey, and its associated item as the first two parameters.
\nEnables events fired by this Observable to bubble up an owner hierarchy by calling this.getBubbleTarget()
if\npresent. There is no implementation in the Observable base class.
This is commonly used by Ext.Components to bubble events to owner Containers.\nSee Ext.Component.getBubbleTarget. The default implementation in Ext.Component returns the\nComponent's immediate owner. But if a known target is required, this can be overridden to access the\nrequired target more quickly.
\n\nExample:
\n\nExt.override(Ext.form.field.Base, {\n // Add functionality to Field's initComponent to enable the change event to bubble\n initComponent : Ext.Function.createSequence(Ext.form.field.Base.prototype.initComponent, function() {\n this.enableBubble('change');\n }),\n\n // We know that we want Field's events to bubble directly to the FormPanel.\n getBubbleTarget : function() {\n if (!this.formPanel) {\n this.formPanel = this.findParentByType('form');\n }\n return this.formPanel;\n }\n});\n\nvar myForm = new Ext.formPanel({\n title: 'User Details',\n items: [{\n ...\n }],\n listeners: {\n change: function() {\n // Title goes red if form has been modified.\n myForm.header.setStyle('color', 'red');\n }\n }\n});\n
\nFilters the objects in this collection by a set of Filters, or by a single\nproperty/value pair with optional parameters for substring matching and case sensitivity. See\nFilter for an example of using Filter objects (preferred). Alternatively,\nMixedCollection can be easily filtered by property like this:
\n\n\n//create a simple store with a few people defined\nvar people = new Ext.util.MixedCollection();\npeople.addAll([\n {id: 1, age: 25, name: 'Ed'},\n {id: 2, age: 24, name: 'Tommy'},\n {id: 3, age: 24, name: 'Arne'},\n {id: 4, age: 26, name: 'Aaron'}\n]);\n\n//a new MixedCollection containing only the items where age == 24\nvar middleAged = people.filter('age', 24);\n
\n\nA property on your objects, or an array of Filter objects
\nEither string that the property values\nshould start with or a RegExp to test against the property
\nTrue to match any part of the string, not just the beginning
\nDefaults to: false
True for case sensitive comparison.
\nDefaults to: false
The new filtered collection
\nFilter by a function. Returns a new collection that has been filtered.\nThe passed function will be called with each object in the collection.\nIf the function returns true, the value is included otherwise it is filtered.
\nThe function to be called, it will receive the args o (the object), k (the key)
\nThe scope (this
reference) in which the function is executed. Defaults to this MixedCollection.
The new filtered collection
\nReturns the first item in the collection which elicits a true return value from the\npassed selection function.
\nThe selection function to execute for each item.
\nThe scope (this
reference) in which the function is executed. Defaults to the browser window.
The first item in the collection which returned true from the selection function, or null if none was found
\nFinds the index of the first matching object in this collection by a specific property/value.
\nThe name of a property on your objects.
\nA string that the property values\nshould start with or a RegExp to test against the property.
\nThe index to start searching at.
\nDefaults to: 0
True to match any part of the string, not just the beginning.
\nDefaults to: false
True for case sensitive comparison.
\nDefaults to: false
The matched index or -1
\nFind the index of the first matching object in this collection by a function.\nIf the function returns true it is considered a match.
\nThe function to be called, it will receive the args o (the object), k (the key).
\nThe scope (this
reference) in which the function is executed. Defaults to this MixedCollection.
The index to start searching at.
\nDefaults to: 0
The matched index or -1
\nFires the specified event with the passed parameters (minus the event name, plus the options
object passed\nto addListener).
An event may be set to bubble up an Observable parent hierarchy (See Ext.Component.getBubbleTarget) by\ncalling enableBubble.
\nThe name of the event to fire.
\nVariable number of parameters are passed to handlers.
\nreturns false if any of the handlers return false otherwise it returns true.
\nReturns the item associated with the passed key OR index.\nKey has priority over index. This is the equivalent\nof calling getByKey first, then if nothing matched calling getAt.
\nIf the item is found, returns the item. If the item was not found, returns undefined.\nIf an item was found, but is a Class, returns null.
\nReturns the number of items in the collection.
\nthe number of items in the collection.
\nMixedCollection has a generic way to fetch keys if you implement getKey. The default implementation\nsimply returns item.id
but you can provide your own implementation\nto return a different value as in the following examples:
// normal way\nvar mc = new Ext.util.MixedCollection();\nmc.add(someEl.dom.id, someEl);\nmc.add(otherEl.dom.id, otherEl);\n//and so on\n\n// using getKey\nvar mc = new Ext.util.MixedCollection();\nmc.getKey = function(el){\n return el.dom.id;\n};\nmc.add(someEl);\nmc.add(otherEl);\n\n// or via the constructor\nvar mc = new Ext.util.MixedCollection(false, function(el){\n return el.dom.id;\n});\nmc.add(someEl);\nmc.add(otherEl);\n
\n\nThe item for which to find the key.
\nThe key for the passed item.
\nInitialize configuration for this class. a typical example:
\n\nExt.define('My.awesome.Class', {\n // The default config\n config: {\n name: 'Awesome',\n isAwesome: true\n },\n\n constructor: function(config) {\n this.initConfig(config);\n\n return this;\n }\n});\n\nvar awesome = new My.awesome.Class({\n name: 'Super Awesome'\n});\n\nalert(awesome.getName()); // 'Super Awesome'\n
\nmixins The mixin prototypes as key - value pairs
\nPerforms initialization of this mixin. Component classes using this mixin should call this method during their\nown initialization.
\nInserts an item at the specified index in the collection. Fires the add event when complete.
\nThe index to insert the item at.
\nThe key to associate with the new item, or the item itself.
\nIf the second parameter was a key, the new item.
\nThe item inserted.
\nShorthand for addManagedListener.
\n\nAdds listeners to any Observable object (or Ext.Element) which are automatically removed when this Component is\ndestroyed.
\nThe item to which to add a listener/listeners.
\n\nThe event name, or an object containing event name properties.
\n\nIf the ename
parameter was an event name, this is the handler function.
If the ename
parameter was an event name, this is the scope (this
reference)\nin which the handler function is executed.
If the ename
parameter was an event name, this is the\naddListener options.
Shorthand for removeManagedListener.
\n\nRemoves listeners that were added by the mon method.
\nThe item from which to remove a listener/listeners.
\n\nThe event name, or an object containing event name properties.
\n\nIf the ename
parameter was an event name, this is the handler function.
If the ename
parameter was an event name, this is the scope (this
reference)\nin which the handler function is executed.
Shorthand for addListener.
\n\nAppends an event handler to this object.
\nThe name of the event to listen for. May also be an object who's property names are\nevent names.
\n\nThe method the event invokes. Will be called with arguments given to\nfireEvent plus the options
parameter described below.
The scope (this
reference) in which the handler function is executed. If\nomitted, defaults to the object which fired the event.
An object containing handler configuration.
\n\n\n\n\nNote: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler.
\n\n\n\n\nThis object may contain any of the following properties:
\n\n\n\n\nscope : Object
\n\nThe scope (this
reference) in which the handler function is executed. If omitted, defaults to the object\nwhich fired the event.
delay : Number
\n\nThe number of milliseconds to delay the invocation of the handler after the event fires.
single : Boolean
\n\nTrue to add a handler to handle just the next firing of the event, and then remove itself.
buffer : Number
\n\nCauses the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of\nmilliseconds. If the event fires again within that time, the original handler is not invoked, but the new\nhandler is scheduled in its place.
target : Observable
\n\nOnly call the handler if the event was fired on the target Observable, not if the event was bubbled up from a\nchild Observable.
element : String
\n\nThis option is only valid for listeners bound to Components. The name of a Component\nproperty which references an element to add a listener to.
\n\nThis option is useful during Component construction to add DOM event listeners to elements of\nComponents which will exist only after the Component is rendered.\nFor example, to add a click listener to a Panel's body:
\n\nnew Ext.panel.Panel({\n title: 'The title',\n listeners: {\n click: this.handlePanelClick,\n element: 'body'\n }\n});\n
Combining Options
\n\n\n\n\nUsing the options argument, it is possible to combine different types of listeners:
\n\n\n\n\nA delayed, one-time listener.
\n\n\n\n\nmyPanel.on('hide', this.handleClick, this, {\n single: true,\n delay: 100\n});\n
\n\n\n\n\nAttaching multiple handlers in 1 call
\n\n\n\n\nThe method also allows for a single argument to be passed which is a config object containing properties which\nspecify multiple events. For example:
\n\n\n\n\nmyGridPanel.on({\n cellClick: this.onCellClick,\n mouseover: this.onMouseOver,\n mouseout: this.onMouseOut,\n scope: this // Important. Ensure \"this\" is correct during handler execution\n});\n
\n\n\n\n\nOne can also specify options for each event handler separately:
\n\n\n\n\nmyGridPanel.on({\n cellClick: {fn: this.onCellClick, scope: this, single: true},\n mouseover: {fn: panel.onMouseOver, scope: panel}\n});\n
\n\nRemove all items in the passed array from the collection.
\nAn array of items to be removed.
\nthis object
\nRemoves an event handler.
\nThe type of event the handler was associated with.
\n\nThe handler to remove. This must be a reference to the function passed into the\naddListener call.
\n\nThe scope originally specified for the handler. It must be the same as the\nscope argument specified in the original call to addListener or the listener will not be removed.
\n\nRemoves listeners that were added by the mon method.
\nThe item from which to remove a listener/listeners.
\n\nThe event name, or an object containing event name properties.
\n\nIf the ename
parameter was an event name, this is the handler function.
If the ename
parameter was an event name, this is the scope (this
reference)\nin which the handler function is executed.
Reorders each of the items based on a mapping from old index to new index. Internally this\njust translates into a sort. The 'sort' event is fired whenever reordering has occured.
\nMapping from old item index to new item index
\nReplaces an item in the collection. Fires the replace event when complete.
\nThe key associated with the item to replace, or the replacement item.
\n\n\nIf you supplied a getKey implementation for this MixedCollection, or if the key\nof your stored items is in a property called id, then the MixedCollection\nwill be able to derive the key of the replacement item. If you want to replace an item\nwith one having the same key value, then just pass the replacement item in this parameter.
\n\n{Object} o (optional) If the first parameter passed was a key, the item to associate\nwith that key.
\nThe new item.
\nResumes 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.
Sorts the data in the Store by one or more of its properties. Example usage:
\n\n//sort by a single field\nmyStore.sort('myField', 'DESC');\n\n//sorting by multiple fields\nmyStore.sort([\n {\n property : 'age',\n direction: 'ASC'\n },\n {\n property : 'name',\n direction: 'DESC'\n }\n]);\n
\n\nInternally, Store converts the passed arguments into an array of Ext.util.Sorter instances, and delegates\nthe actual sorting to its internal Ext.util.MixedCollection.
\n\nWhen passing a single string argument to sort, Store maintains a ASC/DESC toggler per field, so this code:
\n\nstore.sort('myField');\nstore.sort('myField');\n
\n\nIs equivalent to this code, because Store handles the toggling automatically:
\n\nstore.sort('myField', 'ASC');\nstore.sort('myField', 'DESC');\n
\nEither a string name of one of the fields in this Store's configured\nModel, or an array of sorter configurations.
\nThe overall direction to sort the data by. Defaults to \"ASC\".
\nSorts the collection by a single sorter function
\nThe function to sort by
\nGet the reference to the class from which this object was instantiated. Note that unlike self,\nthis.statics()
is scope-independent and it always returns the class from which it was called, regardless of what\nthis
points to during run-time
Ext.define('My.Cat', {\n statics: {\n totalCreated: 0,\n speciesName: 'Cat' // My.Cat.speciesName = 'Cat'\n },\n\n constructor: function() {\n var statics = this.statics();\n\n alert(statics.speciesName); // always equals to 'Cat' no matter what 'this' refers to\n // equivalent to: My.Cat.speciesName\n\n alert(this.self.speciesName); // dependent on 'this'\n\n statics.totalCreated++;\n\n return this;\n },\n\n clone: function() {\n var cloned = new this.self; // dependent on 'this'\n\n cloned.groupName = this.statics().speciesName; // equivalent to: My.Cat.speciesName\n\n return cloned;\n }\n});\n\n\nExt.define('My.SnowLeopard', {\n extend: 'My.Cat',\n\n statics: {\n speciesName: 'Snow Leopard' // My.SnowLeopard.speciesName = 'Snow Leopard'\n },\n\n constructor: function() {\n this.callParent();\n }\n});\n\nvar cat = new My.Cat(); // alerts 'Cat', then alerts 'Cat'\n\nvar snowLeopard = new My.SnowLeopard(); // alerts 'Cat', then alerts 'Snow Leopard'\n\nvar clone = snowLeopard.clone();\nalert(Ext.getClassName(clone)); // alerts 'My.SnowLeopard'\nalert(clone.groupName); // alerts 'Cat'\n\nalert(My.Cat.totalCreated); // alerts 3\n
\nCollects all of the values of the given property and returns their sum
\nThe property to sum by
\n'root' property to extract the first argument from. This is used mainly when\nsumming fields in records, where the fields are all stored inside the 'data' object
\nThe record index to start at
\nDefaults to: 0
The record index to end at
\nDefaults to: -1
The total
\nSuspends the firing of all events. (see resumeEvents)
\nPass as true to queue up suspended events to be fired\nafter the resumeEvents call instead of discarding all suspended events.
\nShorthand for removeListener.
\n\nRemoves an event handler.
\nThe type of event the handler was associated with.
\n\nThe handler to remove. This must be a reference to the function passed into the\naddListener call.
\n\nThe scope originally specified for the handler. It must be the same as the\nscope argument specified in the original call to addListener or the listener will not be removed.
\n\nFires when an item is added to the collection.
\nThe index at which the item was added.
\nThe item added.
\nThe key associated with the added item.
\nThe options object passed to Ext.util.Observable.addListener.
\n\n\n\nFires when the collection is cleared.
\nThe options object passed to Ext.util.Observable.addListener.
\n\n\n\nFires when an item is removed from the collection.
\nThe item being removed.
\nThe key associated with the removed item.
\nThe options object passed to Ext.util.Observable.addListener.
\n\n\n\nFires when an item is replaced in the collection.
\nhe key associated with the new added.
\nThe item being replaced.
\nThe new item.
\nThe options object passed to Ext.util.Observable.addListener.
\n\n\n\n