git.roojs.org Git - roojs1/blob - docs/symbols/Roo.util.TextMetrics.Instance.json

   1 {
   2   "name" : "Roo.util.TextMetrics.Instance",
   3   "augments" : [],
   4   "childClasses" : {  },
   5   "tree_children" : [],
   6   "tree_parent" : [],
   7   "desc" : "Instance of  TextMetrics Calcuation",
   8   "isSingleton" : false,
   9   "isStatic" : false,
  10   "isBuiltin" : false,
  11   "isAbstract" : false,
  12   "isBuilderTop" : false,
  13   "memberOf" : "Instance",
  14   "example" : "",
  15   "deprecated" : "",
  16   "since" : "",
  17   "see" : "",
  18   "params" : [
  19     {
  20       "name" : "bindto",
  21       "type" : "Object",
  22       "desc" : "",
  23       "isOptional" : false
  24     },
  25     {
  26       "name" : "fixedWidth",
  27       "type" : "Boolean",
  28       "desc" : "",
  29       "isOptional" : false
  30     }
  31   ],
  32   "returns" : [],
  33   "throws" : "",
  34   "requires" : "",
  35   "config" : [],
  36   "methods" : [
  37     {
  38       "name" : "getHeight",
  39       "type" : "function",
  40       "desc" : "Returns the measured height of the specified text.  For multiline text, be sure to call\n{@link #setFixedWidth} if necessary.",
  41       "sig" : "(text)",
  42       "static" : false,
  43       "memberOf" : "",
  44       "isStatic" : false,
  45       "isConstructor" : false,
  46       "isPrivate" : false,
  47       "example" : "",
  48       "deprecated" : "",
  49       "since" : "",
  50       "see" : "",
  51       "exceptions" : "",
  52       "requires" : "",
  53       "params" : [
  54         {
  55           "name" : "text",
  56           "type" : "String",
  57           "desc" : "The text to measure",
  58           "isOptional" : false
  59         }
  60       ],
  61       "returns" : [
  62         {
  63           "name" : "",
  64           "type" : "Number",
  65           "desc" : "height The height in pixels"
  66         }
  67       ]
  68     },
  69     {
  70       "name" : "bind",
  71       "type" : "function",
  72       "desc" : "Binds this TextMetrics instance to an element from which to copy existing CSS styles\nthat can affect the size of the rendered text",
  73       "sig" : "(el)",
  74       "static" : false,
  75       "memberOf" : "",
  76       "isStatic" : false,
  77       "isConstructor" : false,
  78       "isPrivate" : false,
  79       "example" : "",
  80       "deprecated" : "",
  81       "since" : "",
  82       "see" : "",
  83       "exceptions" : "",
  84       "requires" : "",
  85       "params" : [
  86         {
  87           "name" : "el",
  88           "type" : "String/HTMLElement",
  89           "desc" : "The element, dom node or id",
  90           "isOptional" : false
  91         }
  92       ],
  93       "returns" : []
  94     },
  95     {
  96       "name" : "getWidth",
  97       "type" : "function",
  98       "desc" : "Returns the measured width of the specified text",
  99       "sig" : "(text)",
 100       "static" : false,
 101       "memberOf" : "",
 102       "isStatic" : false,
 103       "isConstructor" : false,
 104       "isPrivate" : false,
 105       "example" : "",
 106       "deprecated" : "",
 107       "since" : "",
 108       "see" : "",
 109       "exceptions" : "",
 110       "requires" : "",
 111       "params" : [
 112         {
 113           "name" : "text",
 114           "type" : "String",
 115           "desc" : "The text to measure",
 116           "isOptional" : false
 117         }
 118       ],
 119       "returns" : [
 120         {
 121           "name" : "",
 122           "type" : "Number",
 123           "desc" : "width The width in pixels"
 124         }
 125       ]
 126     },
 127     {
 128       "name" : "setFixedWidth",
 129       "type" : "function",
 130       "desc" : "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.",
 131       "sig" : "(width)",
 132       "static" : false,
 133       "memberOf" : "",
 134       "isStatic" : false,
 135       "isConstructor" : false,
 136       "isPrivate" : false,
 137       "example" : "",
 138       "deprecated" : "",
 139       "since" : "",
 140       "see" : "",
 141       "exceptions" : "",
 142       "requires" : "",
 143       "params" : [
 144         {
 145           "name" : "width",
 146           "type" : "Number",
 147           "desc" : "The width to set on the element",
 148           "isOptional" : false
 149         }
 150       ],
 151       "returns" : []
 152     },
 153     {
 154       "name" : "getSize",
 155       "type" : "function",
 156       "desc" : "Returns the size of the specified text based on the internal element's style and width properties",
 157       "sig" : "(text)",
 158       "static" : false,
 159       "memberOf" : "",
 160       "isStatic" : false,
 161       "isConstructor" : false,
 162       "isPrivate" : false,
 163       "example" : "",
 164       "deprecated" : "",
 165       "since" : "",
 166       "see" : "",
 167       "exceptions" : "",
 168       "requires" : "",
 169       "params" : [
 170         {
 171           "name" : "text",
 172           "type" : "String",
 173           "desc" : "The text to measure",
 174           "isOptional" : false
 175         }
 176       ],
 177       "returns" : [
 178         {
 179           "name" : "",
 180           "type" : "Object",
 181           "desc" : "An object containing the text's size {width: (width), height: (height)}"
 182         }
 183       ]
 184     }
 185   ],
 186   "events" : []
 187 }