Fix #5654 - roojspacker - get it working as a doc tool...

[roojs1] / docs / symbols / Roo.util.TextMetrics.json

diff --git a/docs/symbols/Roo.util.TextMetrics.json b/docs/symbols/Roo.util.TextMetrics.json
new file mode 100644 (file)
index 0000000..f108d73
--- /dev/null
+++ b/docs/symbols/Roo.util.TextMetrics.json
@@ -0,0 +1,96 @@
+{
+  "name" : "Roo.util.TextMetrics",
+  "augments" : [
+  ],
+  "desc" : "Provides 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.",
+  "isSingleton" : true,
+  "isStatic" : false,
+  "isBuiltin" : false,
+  "memberOf" : "TextMetrics",
+  "example" : "",
+  "deprecated" : "",
+  "since" : "",
+  "see" : "",
+  "params" : [
+  ],
+  "returns" : [
+  ],
+  "config" : [
+  ],
+  "methods" : [
+    {
+      "name" : "createInstance",
+      "desc" : "Return a unique TextMetrics instance that can be bound directly to an element and reused.  This reduces\nthe overhead of multiple calls to initialize the style properties on each measurement.",
+      "isStatic" : false,
+      "isConstructor" : false,
+      "isPrivate" : false,
+      "memberOf" : "Roo.util.TextMetrics",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "el",
+          "type" : "String/HTMLElement",
+          "desc" : "The element, dom node or id that the instance will be bound to",
+          "isOptional" : false
+        },
+        {
+          "name" : "fixedWidth",
+          "type" : "Number",
+          "desc" : "(optional) If the text will be multiline, you have to set a fixed width\nin order to accurately measure the text height",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+        {
+          "name" : "",
+          "type" : "Roo.util.TextMetrics.Instance",
+          "desc" : "instance The new instance"
+        }
+      ]
+    },
+    {
+      "name" : "measure",
+      "desc" : "Measures the size of the specified text",
+      "isStatic" : false,
+      "isConstructor" : false,
+      "isPrivate" : false,
+      "memberOf" : "Roo.util.TextMetrics",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "el",
+          "type" : "String/HTMLElement",
+          "desc" : "The element, dom node or id from which to copy existing CSS styles\nthat can affect the size of the rendered text",
+          "isOptional" : false
+        },
+        {
+          "name" : "text",
+          "type" : "String",
+          "desc" : "The text to measure",
+          "isOptional" : false
+        },
+        {
+          "name" : "fixedWidth",
+          "type" : "Number",
+          "desc" : "(optional) If the text will be multiline, you have to set a fixed width\nin order to accurately measure the text height",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+        {
+          "name" : "",
+          "type" : "Object",
+          "desc" : "An object containing the text's size {width: (width), height: (height)}"
+        }
+      ]
+    }
+  ],
+  "events" : [
+  ]
+}
\ No newline at end of file