X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/3789b528d8dd8aad4558e38e22d775bcab1cbd36..refs/heads/master:/docs/output/Ext.Template.js?ds=inline diff --git a/docs/output/Ext.Template.js b/docs/output/Ext.Template.js index 218ddfb2..d0b8c4a9 100644 --- a/docs/output/Ext.Template.js +++ b/docs/output/Ext.Template.js @@ -1,335 +1 @@ -Ext.data.JsonP.Ext_Template({ - "tagname": "class", - "name": "Ext.Template", - "doc": "
Represents an HTML fragment template. Templates may be precompiled\nfor greater performance.
\n\n\nAn instance of this class may be created by passing to the constructor either\na single argument, or multiple arguments:
\n\nvar t = new Ext.Template(\"<div>Hello {0}.</div>\");\nt.append('some-element', ['foo']);\n
\njoin('')
.\nvar t = new Ext.Template([\n '<div name=\"{id}\">',\n '<span class=\"{cls}\">{name:trim} {value:ellipsis(10)}</span>',\n '</div>',\n]);\nt.compile();\nt.append('some-element', {id: 'myid', cls: 'myclass', name: 'foo', value: 'bar'});\n
\njoin('')
.\nvar t = new Ext.Template(\n '<div name=\"{id}\">',\n '<span class=\"{cls}\">{name} {value}</span>',\n '</div>',\n // a configuration object:\n {\n compiled: true, // compile immediately\n }\n);\n
\nNotes:
\ndisableFormats
reduces apply
time\nwhen no formatting is required.true to disable format functions in the template. If the template doesn't contain format functions, setting\ndisableFormats to true will reduce apply time (defaults to false)
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/Template.js", - "linenr": 111, - "html_filename": "Template2.html", - "href": "Template2.html#Ext-Template-cfg-disableFormats", - "shortDoc": "true to disable format functions in the template. If the template doesn't contain format functions, setting\ndisableFo..." - } - ], - "method": [ - { - "tagname": "method", - "name": "append", - "member": "Ext.Template", - "doc": "Applies the supplied values
to the template and appends\nthe new node(s) to the specified el
.
For example usage see the constructor.
\n\n", - "params": [ - { - "type": "Mixed", - "name": "el", - "doc": "The context element
\n", - "optional": false - }, - { - "type": "Object/Array", - "name": "values", - "doc": "The template values. Can be an array if the params are numeric (i.e. {0}
)\nor an object (i.e. {foo: 'bar'}
).
(optional) true to return an Ext.core.Element (defaults to undefined)
\n", - "optional": true - } - ], - "return": { - "type": "HTMLElement/Ext.core.Element", - "doc": "The new node or Element
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/Template.js", - "linenr": 237, - "html_filename": "Template2.html", - "href": "Template2.html#Ext-Template-method-append", - "shortDoc": "Applies the supplied values to the template and appends\nthe new node(s) to the specified el.\n\nFor example usage see t..." - }, - { - "tagname": "method", - "name": "apply", - "member": "Ext.Template", - "doc": "Alias for applyTemplate\nReturns an HTML fragment of this template with the specified values
applied.
The template values. Can be an array if the params are numeric (i.e. {0}
)\nor an object (i.e. {foo: 'bar'}
).
The HTML fragment
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/Template.js", - "linenr": 272, - "html_filename": "Template2.html", - "href": "Template2.html#Ext-Template-method-apply", - "shortDoc": "Alias for applyTemplate\nReturns an HTML fragment of this template with the specified values
applied.
Creates a template from the passed element's value (display:none textarea, preferred) or innerHTML.
\n", - "params": [ - { - "type": "String/HTMLElement", - "name": "el", - "doc": "A DOM element or its id
\n", - "optional": false - }, - { - "type": "Object", - "name": "config", - "doc": "A configuration object
\n", - "optional": false - } - ], - "return": { - "type": "Ext.Template", - "doc": "The created template
\n" - }, - "private": false, - "static": true, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/Template.js", - "linenr": 59, - "html_filename": "Template2.html", - "href": "Template2.html#Ext-Template-method-from", - "shortDoc": "Creates a template from the passed element's value (display:none textarea, preferred) or innerHTML.
\n" - }, - { - "tagname": "method", - "name": "insertAfter", - "member": "Ext.Template", - "doc": "Applies the supplied values to the template and inserts the new node(s) after el.
\n", - "params": [ - { - "type": "Mixed", - "name": "el", - "doc": "The context element
\n", - "optional": false - }, - { - "type": "Object/Array", - "name": "values", - "doc": "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})
\n", - "optional": false - }, - { - "type": "Boolean", - "name": "returnElement", - "doc": "(optional) true to return a Ext.core.Element (defaults to undefined)
\n", - "optional": true - } - ], - "return": { - "type": "HTMLElement/Ext.core.Element", - "doc": "The new node or Element
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/Template.js", - "linenr": 226, - "html_filename": "Template2.html", - "href": "Template2.html#Ext-Template-method-insertAfter", - "shortDoc": "Applies the supplied values to the template and inserts the new node(s) after el.
\n" - }, - { - "tagname": "method", - "name": "insertBefore", - "member": "Ext.Template", - "doc": "Applies the supplied values to the template and inserts the new node(s) before el.
\n", - "params": [ - { - "type": "Mixed", - "name": "el", - "doc": "The context element
\n", - "optional": false - }, - { - "type": "Object/Array", - "name": "values", - "doc": "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})
\n", - "optional": false - }, - { - "type": "Boolean", - "name": "returnElement", - "doc": "(optional) true to return a Ext.core.Element (defaults to undefined)
\n", - "optional": true - } - ], - "return": { - "type": "HTMLElement/Ext.core.Element", - "doc": "The new node or Element
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/Template.js", - "linenr": 215, - "html_filename": "Template2.html", - "href": "Template2.html#Ext-Template-method-insertBefore", - "shortDoc": "Applies the supplied values to the template and inserts the new node(s) before el.
\n" - }, - { - "tagname": "method", - "name": "insertFirst", - "member": "Ext.Template", - "doc": "Applies the supplied values to the template and inserts the new node(s) as the first child of el.
\n", - "params": [ - { - "type": "Mixed", - "name": "el", - "doc": "The context element
\n", - "optional": false - }, - { - "type": "Object/Array", - "name": "values", - "doc": "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})
\n", - "optional": false - }, - { - "type": "Boolean", - "name": "returnElement", - "doc": "(optional) true to return a Ext.core.Element (defaults to undefined)
\n", - "optional": true - } - ], - "return": { - "type": "HTMLElement/Ext.core.Element", - "doc": "The new node or Element
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/Template.js", - "linenr": 204, - "html_filename": "Template2.html", - "href": "Template2.html#Ext-Template-method-insertFirst", - "shortDoc": "Applies the supplied values to the template and inserts the new node(s) as the first child of el.
\n" - }, - { - "tagname": "method", - "name": "overwrite", - "member": "Ext.Template", - "doc": "Applies the supplied values to the template and overwrites the content of el with the new node(s).
\n", - "params": [ - { - "type": "Mixed", - "name": "el", - "doc": "The context element
\n", - "optional": false - }, - { - "type": "Object/Array", - "name": "values", - "doc": "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})
\n", - "optional": false - }, - { - "type": "Boolean", - "name": "returnElement", - "doc": "(optional) true to return a Ext.core.Element (defaults to undefined)
\n", - "optional": true - } - ], - "return": { - "type": "HTMLElement/Ext.core.Element", - "doc": "The new node or Element
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/Template.js", - "linenr": 258, - "html_filename": "Template2.html", - "href": "Template2.html#Ext-Template-method-overwrite", - "shortDoc": "Applies the supplied values to the template and overwrites the content of el with the new node(s).
\n" - }, - { - "tagname": "method", - "name": "set", - "member": "Ext.Template", - "doc": "Sets the HTML used as the template and optionally compiles it.
\n", - "params": [ - { - "type": "String", - "name": "html", - "doc": "\n", - "optional": false - }, - { - "type": "Boolean", - "name": "compile", - "doc": "(optional) True to compile the template (defaults to undefined)
\n", - "optional": true - } - ], - "return": { - "type": "Ext.Template", - "doc": "this
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/Template.js", - "linenr": 154, - "html_filename": "Template2.html", - "href": "Template2.html#Ext-Template-method-set", - "shortDoc": "Sets the HTML used as the template and optionally compiles it.
\n" - } - ], - "property": [ - - ], - "event": [ - - ], - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/Template.js", - "linenr": 1, - "html_filename": "Template2.html", - "href": "Template2.html#Ext-Template", - "cssVar": [ - - ], - "cssMixin": [ - - ], - "component": false, - "superclasses": [ - - ], - "subclasses": [ - "Ext.XTemplate" - ], - "mixedInto": [ - - ], - "allMixins": [ - - ] -}); \ No newline at end of file +Ext.data.JsonP.Ext_Template({"tagname":"class","html":"Hierarchy
Ext.BaseExt.TemplateRequires
Files
Represents an HTML fragment template. Templates may be precompiled for greater performance.
\n\nAn instance of this class may be created by passing to the constructor either a single argument, or multiple\narguments:
\n\nThe single argument may be either a String or an Array:
\n\nString:
\n\nvar t = new Ext.Template(\"<div>Hello {0}.</div>\");\nt.append('some-element', ['foo']);\n
Array:
\n\nAn Array will be combined with join('')
.
var t = new Ext.Template([\n '<div name=\"{id}\">',\n '<span class=\"{cls}\">{name:trim} {value:ellipsis(10)}</span>',\n '</div>',\n]);\nt.compile();\nt.append('some-element', {id: 'myid', cls: 'myclass', name: 'foo', value: 'bar'});\n
Multiple arguments will be combined with join('')
.
var t = new Ext.Template(\n '<div name=\"{id}\">',\n '<span class=\"{cls}\">{name} {value}</span>',\n '</div>',\n // a configuration object:\n {\n compiled: true, // compile immediately\n }\n);\n
\n\ndisableFormats
reduces apply
time when no formatting is required.True to immediately compile the template. Defaults to false.
\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
\nApplies the supplied values
to the template and appends the new node(s) to the specified el
.
For example usage see Ext.Template class docs.
\nThe context element
\nThe template values. See applyTemplate for details.
\ntrue to return an Ext.Element.
\nThe new node or Element
\nAlias for applyTemplate.
\n\nReturns an HTML fragment of this template with the specified values applied.
\nThe template values. Can be an array if your params are numeric:
\n\n\n\n\nvar tpl = new Ext.Template('Name: {0}, Age: {1}');\ntpl.applyTemplate(['John', 25]);\n
\n\n\n\n\nor an object:
\n\n\n\n\nvar tpl = new Ext.Template('Name: {name}, Age: {age}');\ntpl.applyTemplate({name: 'John', age: 25});\n
\n\nThe HTML fragment
\n\nReturns an HTML fragment of this template with the specified values applied.
\nThe template values. Can be an array if your params are numeric:
\n\n\n\n\nvar tpl = new Ext.Template('Name: {0}, Age: {1}');\ntpl.applyTemplate(['John', 25]);\n
\n\n\n\n\nor an object:
\n\n\n\n\nvar tpl = new Ext.Template('Name: {name}, Age: {age}');\ntpl.applyTemplate({name: 'John', age: 25});\n
\n\nThe HTML fragment
\n\nCall the original method that was previously overridden with override
\n\nExt.define('My.Cat', {\n constructor: function() {\n alert(\"I'm a cat!\");\n\n return this;\n }\n});\n\nMy.Cat.override({\n constructor: function() {\n alert(\"I'm going to be a cat!\");\n\n var instance = this.callOverridden();\n\n alert(\"Meeeeoooowwww\");\n\n return instance;\n }\n});\n\nvar kitty = new My.Cat(); // alerts \"I'm going to be a cat!\"\n // alerts \"I'm a cat!\"\n // alerts \"Meeeeoooowwww\"\n
\nThe arguments, either an array or the arguments
object
Returns the result after calling the overridden method
\nCall the parent's overridden method. For example:
\n\nExt.define('My.own.A', {\n constructor: function(test) {\n alert(test);\n }\n});\n\nExt.define('My.own.B', {\n extend: 'My.own.A',\n\n constructor: function(test) {\n alert(test);\n\n this.callParent([test + 1]);\n }\n});\n\nExt.define('My.own.C', {\n extend: 'My.own.B',\n\n constructor: function() {\n alert(\"Going to call parent's overriden constructor...\");\n\n this.callParent(arguments);\n }\n});\n\nvar a = new My.own.A(1); // alerts '1'\nvar b = new My.own.B(1); // alerts '1', then alerts '2'\nvar c = new My.own.C(2); // alerts \"Going to call parent's overriden constructor...\"\n // alerts '2', then alerts '3'\n
\nThe arguments, either an array or the arguments
object\nfrom the current method, for example: this.callParent(arguments)
Returns the result from the superclass' method
\nCompiles the template into an internal function, eliminating the RegEx overhead.
\nthis
\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
\nApplies the supplied values to the template and inserts the new node(s) after el.
\nThe context element
\nThe template values. See applyTemplate for details.
\ntrue to return a Ext.Element.
\nThe new node or Element
\nApplies the supplied values to the template and inserts the new node(s) before el.
\nThe context element
\nThe template values. See applyTemplate for details.
\ntrue to return a Ext.Element.
\nThe new node or Element
\nApplies the supplied values to the template and inserts the new node(s) as the first child of el.
\nThe context element
\nThe template values. See applyTemplate for details.
\ntrue to return a Ext.Element.
\nThe new node or Element
\nApplies the supplied values to the template and overwrites the content of el with the new node(s).
\nThe context element
\nThe template values. See applyTemplate for details.
\ntrue to return a Ext.Element.
\nThe new node or Element
\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
\nAdd / override static properties of this class.
\n\nExt.define('My.cool.Class', {\n ...\n});\n\nMy.cool.Class.addStatics({\n someProperty: 'someValue', // My.cool.Class.someProperty = 'someValue'\n method1: function() { ... }, // My.cool.Class.method1 = function() { ... };\n method2: function() { ... } // My.cool.Class.method2 = function() { ... };\n});\n
\nthis
\nBorrow another class' members to the prototype of this class.
\n\nExt.define('Bank', {\n money: '$$$',\n printMoney: function() {\n alert('$$$$$$$');\n }\n});\n\nExt.define('Thief', {\n ...\n});\n\nThief.borrow(Bank, ['money', 'printMoney']);\n\nvar steve = new Thief();\n\nalert(steve.money); // alerts '$$$'\nsteve.printMoney(); // alerts '$$$$$$$'\n
\nThe class to borrow members from
\nThe names of the members to borrow
\nthis
\nCreate a new instance of this Class.
\n\nExt.define('My.cool.Class', {\n ...\n});\n\nMy.cool.Class.create({\n someConfig: true\n});\n
\n\nAll parameters are passed to the constructor of the class.
\nthe created instance.
\nCreate aliases for existing prototype methods. Example:
\n\nExt.define('My.cool.Class', {\n method1: function() { ... },\n method2: function() { ... }\n});\n\nvar test = new My.cool.Class();\n\nMy.cool.Class.createAlias({\n method3: 'method1',\n method4: 'method2'\n});\n\ntest.method3(); // test.method1()\n\nMy.cool.Class.createAlias('method5', 'method3');\n\ntest.method5(); // test.method3() -> test.method1()\n
\nThe new method name, or an object to set multiple aliases. See\nflexSetter
\nThe original method name
\nCreates a template from the passed element's value (display:none textarea, preferred) or innerHTML.
\nThe created template
\nGet the current class' name in string format.
\n\nExt.define('My.cool.Class', {\n constructor: function() {\n alert(this.self.getName()); // alerts 'My.cool.Class'\n }\n});\n\nMy.cool.Class.getName(); // 'My.cool.Class'\n
\nclassName
\nAdd methods / properties to the prototype of this class.
\n\nExt.define('My.awesome.Cat', {\n constructor: function() {\n ...\n }\n});\n\n My.awesome.Cat.implement({\n meow: function() {\n alert('Meowww...');\n }\n });\n\n var kitty = new My.awesome.Cat;\n kitty.meow();\n
\nOverride prototype members of this class. Overridden methods can be invoked via\ncallOverridden
\n\nExt.define('My.Cat', {\n constructor: function() {\n alert(\"I'm a cat!\");\n\n return this;\n }\n});\n\nMy.Cat.override({\n constructor: function() {\n alert(\"I'm going to be a cat!\");\n\n var instance = this.callOverridden();\n\n alert(\"Meeeeoooowwww\");\n\n return instance;\n }\n});\n\nvar kitty = new My.Cat(); // alerts \"I'm going to be a cat!\"\n // alerts \"I'm a cat!\"\n // alerts \"Meeeeoooowwww\"\n
\nthis
\n