git.roojs.org Git - roojs1/blob - Roo/util/TextMetrics.js

   1 /*
   2  * Based on:
   3  * Ext JS Library 1.1.1
   4  * Copyright(c) 2006-2007, Ext JS, LLC.
   5  *
   6  * Originally Released Under LGPL - original licence link has changed is not relivant.
   7  *
   8  * Fork - LGPL
   9  * <script type="text/javascript">
  10  */
  11
  12
  13 /**
  14  * @class Roo.util.TextMetrics
  15  * Provides precise pixel measurements for blocks of text so that you can determine exactly how high and
  16  * wide, in pixels, a given block of text will be.
  17  * @singleton
  18  */
  19 Roo.util.TextMetrics = function(){
  20     var shared;
  21     return {
  22         /**
  23          * Measures the size of the specified text
  24          * @param {String/HTMLElement} el The element, dom node or id from which to copy existing CSS styles
  25          * that can affect the size of the rendered text
  26          * @param {String} text The text to measure
  27          * @param {Number} fixedWidth (optional) If the text will be multiline, you have to set a fixed width
  28          * in order to accurately measure the text height
  29          * @return {Object} An object containing the text's size {width: (width), height: (height)}
  30          */
  31         measure : function(el, text, fixedWidth){
  32             if(!shared){
  33                 shared = Roo.util.TextMetrics.Instance(el, fixedWidth);
  34             }
  35             shared.bind(el);
  36             shared.setFixedWidth(fixedWidth || 'auto');
  37             return shared.getSize(text);
  38         },
  39
  40         /**
  41          * Return a unique TextMetrics instance that can be bound directly to an element and reused.  This reduces
  42          * the overhead of multiple calls to initialize the style properties on each measurement.
  43          * @param {String/HTMLElement} el The element, dom node or id that the instance will be bound to
  44          * @param {Number} fixedWidth (optional) If the text will be multiline, you have to set a fixed width
  45          * in order to accurately measure the text height
  46          * @return {Roo.util.TextMetrics.Instance} instance The new instance
  47          */
  48         createInstance : function(el, fixedWidth){
  49             return Roo.util.TextMetrics.Instance(el, fixedWidth);
  50         }
  51     };
  52 }();
  53 /**
  54  * @class Roo.util.TextMetrics.Instance
  55  * Provides precise pixel measurements for blocks of text so that you can determine exactly how high and
  56  * wide, in pixels, a given block of text will be.
  57  */
  58
  59
  60 Roo.util.TextMetrics.Instance = function(bindTo, fixedWidth){
  61     var ml = new Roo.Element(document.createElement('div'));
  62     document.body.appendChild(ml.dom);
  63     ml.position('absolute');
  64     ml.setLeftTop(-1000, -1000);
  65     ml.hide();
  66
  67     if(fixedWidth){
  68         ml.setWidth(fixedWidth);
  69     }
  70
  71     var instance = {
  72         /**
  73          * Returns the size of the specified text based on the internal element's style and width properties
  74          * @param {String} text The text to measure
  75          * @return {Object} An object containing the text's size {width: (width), height: (height)}
  76          */
  77         getSize : function(text){
  78             ml.update(text);
  79             var s = ml.getSize();
  80             ml.update('');
  81             return s;
  82         },
  83
  84         /**
  85          * Binds this TextMetrics instance to an element from which to copy existing CSS styles
  86          * that can affect the size of the rendered text
  87          * @param {String/HTMLElement} el The element, dom node or id
  88          */
  89         bind : function(el){
  90             ml.setStyle(
  91                 Roo.fly(el).getStyles('font-size','font-style', 'font-weight', 'font-family','line-height')
  92             );
  93         },
  94
  95         /**
  96          * Sets a fixed width on the internal measurement element.  If the text will be multiline, you have
  97          * to set a fixed width in order to accurately measure the text height.
  98          * @param {Number} width The width to set on the element
  99          */
 100         setFixedWidth : function(width){
 101             ml.setWidth(width);
 102         },
 103
 104         /**
 105          * Returns the measured width of the specified text
 106          * @param {String} text The text to measure
 107          * @return {Number} width The width in pixels
 108          */
 109         getWidth : function(text){
 110             ml.dom.style.width = 'auto';
 111             return this.getSize(text).width;
 112         },
 113
 114         /**
 115          * Returns the measured height of the specified text.  For multiline text, be sure to call
 116          * {@link #setFixedWidth} if necessary.
 117          * @param {String} text The text to measure
 118          * @return {Number} height The height in pixels
 119          */
 120         getHeight : function(text){
 121             return this.getSize(text).height;
 122         }
 123     };
 124
 125     instance.bind(bindTo);
 126
 127     return instance;
 128 };
 129
 130 // backwards compat
 131 Roo.Element.measureText = Roo.util.TextMetrics.measure;