\nProvides precise pixel measurements for blocks of text so that you can determine exactly how high and\nwide, in pixels, a given block of text will be. Note that when measuring text, it should be plain text and\nshould not contain any HTML, otherwise it may not be measured correctly.
\n\n\n\n\nThe measurement works by copying the relevant CSS styles that can affect the font related display, \nthen checking the size of an element that is auto-sized. Note that if the text is multi-lined, you must \nprovide a fixed width when doing the measurement.
\n\n\n\n\n\nIf multiple measurements are being done on the same element, you create a new instance to initialize \nto avoid the overhead of copying the styles to the element repeatedly.\n
\n\n", - "extends": null, - "mixins": [ - - ], - "alternateClassNames": [ + "allMixins": [ ], - "xtype": null, - "author": null, + "deprecated": null, "docauthor": null, - "singleton": false, - "private": false, - "cfg": [ + "members": { + "cfg": [ - ], - "method": [ - { - "tagname": "method", - "name": "TextMetrics", - "member": "Ext.util.TextMetrics", - "doc": "\n", - "params": [ - { + ], + "method": [ + { + "deprecated": null, + "alias": null, + "href": "TextMetrics.html#Ext-util-TextMetrics-method-constructor", + "tagname": "method", + "protected": false, + "shortDoc": "Creates new TextMetrics. ...", + "static": false, + "params": [ + { + "type": "Mixed", + "optional": false, + "doc": "The element to bind to.
\n", + "name": "bindTo" + }, + { + "type": "Number", + "optional": true, + "doc": "(optional) A fixed width to apply to the measuring element.
\n", + "name": "fixedWidth" + } + ], + "private": false, + "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/util/TextMetrics.js", + "doc": "Creates new TextMetrics.
\n", + "owner": "Ext.util.TextMetrics", + "name": "TextMetrics", + "html_filename": "TextMetrics.html", + "return": { + "type": "Object", + "doc": "\n" + }, + "linenr": 47 + }, + { + "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" + }, + "html_filename": "Base3.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "TextMetrics.html#Ext-util-TextMetrics-method-bind", + "shortDoc": "Binds this TextMetrics instance to a new element ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/util/TextMetrics.js", + "private": false, + "params": [ + { + "type": "Mixed", + "optional": false, + "doc": "The element
\n", + "name": "el" + } + ], + "name": "bind", + "owner": "Ext.util.TextMetrics", + "doc": "Binds this TextMetrics instance to a new element
\n", + "linenr": 82, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "TextMetrics.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Base3.html#Ext-Base-method-callOverridden", + "shortDoc": "Call the original method that was previously overridden with Ext.Base.override\n\nExt.define('My.Cat', {\n constructo...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", + "private": false, + "params": [ + { + "type": "Array/Arguments", + "optional": false, + "doc": "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\"\nThe element to bind to.
\n", - "optional": false + "doc": "Returns the result after calling the overridden method
\n" }, - { - "type": "Number", - "name": "fixedWidth", - "doc": "A fixed width to apply to the measuring element.
\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" + "html_filename": "Base3.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/TextMetrics.js", - "linenr": 50, - "html_filename": "TextMetrics.html", - "href": "TextMetrics.html#Ext-util-TextMetrics-method-constructor", - "shortDoc": "\n" - }, - { - "tagname": "method", - "name": "bind", - "member": "Ext.util.TextMetrics", - "doc": "Binds this TextMetrics instance to a new element
\n", - "params": [ - { + { + "deprecated": null, + "alias": null, + "protected": true, + "tagname": "method", + "href": "Base3.html#Ext-Base-method-callParent", + "shortDoc": "Call the parent's overridden method. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", + "private": false, + "params": [ + { + "type": "Array/Arguments", + "optional": false, + "doc": "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'\nThe element
\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" + "doc": "Returns the result from the superclass' method
\n" + }, + "html_filename": "Base3.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/TextMetrics.js", - "linenr": 86, - "html_filename": "TextMetrics.html", - "href": "TextMetrics.html#Ext-util-TextMetrics-method-bind", - "shortDoc": "Binds this TextMetrics instance to a new element
\n" - }, - { - "tagname": "method", - "name": "destroy", - "member": "Ext.util.TextMetrics", - "doc": "Destroy this instance
\n", - "params": [ + { + "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": [ - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/TextMetrics.js", - "linenr": 127, - "html_filename": "TextMetrics.html", - "href": "TextMetrics.html#Ext-util-TextMetrics-method-destroy", - "shortDoc": "Destroy this instance
\n" - }, - { - "tagname": "method", - "name": "getHeight", - "member": "Ext.util.TextMetrics", - "doc": "Returns the measured height of the specified text
\n", - "params": [ - { - "type": "String", - "name": "text", - "doc": "The text to measure
\n", - "optional": false - } - ], - "return": { - "type": "Number", - "doc": "height The height in pixels
\n" + ], + "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", + "doc": "the created instance.
\n" + }, + "html_filename": "Base3.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/TextMetrics.js", - "linenr": 118, - "html_filename": "TextMetrics.html", - "href": "TextMetrics.html#Ext-util-TextMetrics-method-getHeight", - "shortDoc": "Returns the measured height of the specified text
\n" - }, - { - "tagname": "method", - "name": "getSize", - "member": "Ext.util.TextMetrics", - "doc": "Only available on the instance returned from createInstance, not on the singleton.
\n\n\nReturns the size of the specified text based on the internal element's style and width properties
\n", - "params": [ - { - "type": "String", - "name": "text", - "doc": "The text to measure
\n", - "optional": false - } - ], - "return": { - "type": "Object", - "doc": "An object containing the text's size {width: (width), height: (height)}
\n" + { + "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()\nReturns the measured width of the specified text
\n", - "params": [ - { - "type": "String", - "name": "text", - "doc": "The text to measure
\n", - "optional": false - } - ], - "return": { - "type": "Number", - "doc": "width The width in pixels
\n" + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "TextMetrics.html#Ext-util-TextMetrics-method-destroy", + "shortDoc": "Destroy this instance ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/util/TextMetrics.js", + "private": false, + "params": [ + + ], + "name": "destroy", + "owner": "Ext.util.TextMetrics", + "doc": "Destroy this instance
\n", + "linenr": 123, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "TextMetrics.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/TextMetrics.js", - "linenr": 108, - "html_filename": "TextMetrics.html", - "href": "TextMetrics.html#Ext-util-TextMetrics-method-getWidth", - "shortDoc": "Returns the measured width of the specified text
\n" - }, - { - "tagname": "method", - "name": "measure", - "member": "Ext.util.TextMetrics", - "doc": "Measures the size of the specified text
\n", - "params": [ - { - "type": "String/HTMLElement", - "name": "el", - "doc": "The element, dom node or id from which to copy existing CSS styles\nthat can affect the size of the rendered text
\n", - "optional": false + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "TextMetrics.html#Ext-util-TextMetrics-method-getHeight", + "shortDoc": "Returns the measured height of the specified text ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/util/TextMetrics.js", + "private": false, + "params": [ + { + "type": "String", + "optional": false, + "doc": "The text to measure
\n", + "name": "text" + } + ], + "name": "getHeight", + "owner": "Ext.util.TextMetrics", + "doc": "Returns the measured height of the specified text
\n", + "linenr": 114, + "return": { + "type": "Number", + "doc": "height The height in pixels
\n" }, - { + "html_filename": "TextMetrics.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": [ + + ], + "name": "getName", + "owner": "Ext.Base", + "doc": "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'\nThe text to measure
\n", - "optional": false + "doc": "className
\n" }, - { - "type": "Number", - "name": "fixedWidth", - "doc": "(optional) If the text will be multiline, you have to set a fixed width\nin order to accurately measure the text height
\n", - "optional": true - } - ], - "return": { - "type": "Object", - "doc": "An object containing the text's size {width: (width), height: (height)}
\n" + "html_filename": "Base3.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/TextMetrics.js", - "linenr": 19, - "html_filename": "TextMetrics.html", - "href": "TextMetrics.html#Ext-util-TextMetrics-method-measure", - "shortDoc": "Measures the size of the specified text
\n" - }, - { - "tagname": "method", - "name": "setFixedWidth", - "member": "Ext.util.TextMetrics", - "doc": "Sets a fixed width on the internal measurement element. If the text will be multiline, you have\nto set a fixed width in order to accurately measure the text height.
\n", - "params": [ - { + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "TextMetrics.html#Ext-util-TextMetrics-method-getSize", + "shortDoc": "Returns the size of the specified text based on the internal element's style and width properties ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/util/TextMetrics.js", + "private": false, + "params": [ + { + "type": "String", + "optional": false, + "doc": "The text to measure
\n", + "name": "text" + } + ], + "name": "getSize", + "owner": "Ext.util.TextMetrics", + "doc": "Returns the size of the specified text based on the internal element's style and width properties
\n", + "linenr": 67, + "return": { + "type": "Object", + "doc": "An object containing the text's size {width: (width), height: (height)}
The text to measure
\n", + "name": "text" + } + ], + "name": "getWidth", + "owner": "Ext.util.TextMetrics", + "doc": "Returns the measured width of the specified text
\n", + "linenr": 104, + "return": { "type": "Number", - "name": "width", - "doc": "The width to set on the element
\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" + "doc": "width The width in pixels
\n" + }, + "html_filename": "TextMetrics.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/TextMetrics.js", - "linenr": 99, - "html_filename": "TextMetrics.html", - "href": "TextMetrics.html#Ext-util-TextMetrics-method-setFixedWidth", - "shortDoc": "Sets a fixed width on the internal measurement element. If the text will be multiline, you have\nto set a fixed width..." - } - ], - "property": [ + { + "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'\nmixins The mixin prototypes as key - value pairs
\n" + }, + "html_filename": "Base3.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "TextMetrics.html#Ext-util-TextMetrics-method-measure", + "shortDoc": "Measures the size of the specified text ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/util/TextMetrics.js", + "private": false, + "params": [ + { + "type": "String/HTMLElement", + "optional": false, + "doc": "The element, dom node or id from which to copy existing CSS styles\nthat can affect the size of the rendered text
\n", + "name": "el" + }, + { + "type": "String", + "optional": false, + "doc": "The text to measure
\n", + "name": "text" + }, + { + "type": "Number", + "optional": true, + "doc": "(optional) If the text will be multiline, you have to set a fixed width\nin order to accurately measure the text height
\n", + "name": "fixedWidth" + } + ], + "name": "measure", + "owner": "Ext.util.TextMetrics", + "doc": "Measures the size of the specified text
\n", + "linenr": 16, + "return": { + "type": "Object", + "doc": "An object containing the text's size {width: (width), height: (height)}
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": "TextMetrics.html#Ext-util-TextMetrics-method-setFixedWidth", + "shortDoc": "Sets a fixed width on the internal measurement element. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/util/TextMetrics.js", + "private": false, + "params": [ + { + "type": "Number", + "optional": false, + "doc": "The width to set on the element
\n", + "name": "width" + } + ], + "name": "setFixedWidth", + "owner": "Ext.util.TextMetrics", + "doc": "Sets a fixed width on the internal measurement element. If the text will be multiline, you have\nto set a fixed width in order to accurately measure the text height.
\n", + "linenr": 95, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "TextMetrics.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": [ - ], - "event": [ + ], + "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\nGet 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'\nProvides precise pixel measurements for blocks of text so that you can determine exactly how high and\nwide, in pixels, a given block of text will be. Note that when measuring text, it should be plain text and\nshould not contain any HTML, otherwise it may not be measured correctly.
\n\nThe measurement works by copying the relevant CSS styles that can affect the font related display,\nthen checking the size of an element that is auto-sized. Note that if the text is multi-lined, you must\nprovide a fixed width when doing the measurement.
\n\nIf multiple measurements are being done on the same element, you create a new instance to initialize\nto avoid the overhead of copying the styles to the element repeatedly.
\n", "mixedInto": [ ], - "allMixins": [ + "linenr": 1, + "xtypes": [ - ] + ], + "html_filename": "TextMetrics.html", + "extends": "Ext.Base" }); \ No newline at end of file