\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": [ + + ], + "xtype": null, + "author": null, + "docauthor": null, + "singleton": false, + "private": false, + "cfg": [ + + ], + "method": [ + { + "tagname": "method", + "name": "TextMetrics", + "member": "Ext.util.TextMetrics", + "doc": "\n", + "params": [ + { + "type": "Mixed", + "name": "bindTo", + "doc": "The element to bind to.
\n", + "optional": false + }, + { + "type": "Number", + "name": "fixedWidth", + "doc": "A fixed width to apply to the measuring element.
\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "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": [ + { + "type": "Mixed", + "name": "el", + "doc": "The element
\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "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": [ + + ], + "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" + }, + "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" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/TextMetrics.js", + "linenr": 70, + "html_filename": "TextMetrics.html", + "href": "TextMetrics.html#Ext-util-TextMetrics-method-getSize", + "shortDoc": "Only available on the instance returned from createInstance, not on the singleton.\n\n\nReturns the size of the specifie..." + }, + { + "tagname": "method", + "name": "getWidth", + "member": "Ext.util.TextMetrics", + "doc": "Returns 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" + }, + "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 + }, + { + "type": "String", + "name": "text", + "doc": "The text to measure
\n", + "optional": false + }, + { + "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" + }, + "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": [ + { + "type": "Number", + "name": "width", + "doc": "The width to set on the element
\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "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": [ + + ], + "event": [ + + ], + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/TextMetrics.js", + "linenr": 1, + "html_filename": "TextMetrics.html", + "href": "TextMetrics.html#Ext-util-TextMetrics", + "cssVar": [ + + ], + "cssMixin": [ + + ], + "component": false, + "superclasses": [ + + ], + "subclasses": [ + + ], + "mixedInto": [ + + ], + "allMixins": [ + + ] +}); \ No newline at end of file