major doc changes

[roojs1] / docs / symbols / Roo.EventObject.json

diff --git a/docs/symbols/Roo.EventObject.json b/docs/symbols/Roo.EventObject.json
index 9047577..ca12279 100644 (file)
--- a/docs/symbols/Roo.EventObject.json
+++ b/docs/symbols/Roo.EventObject.json
@@ -1,10 +1,15 @@
 {
   "name" : "Roo.EventObject",
   "augments" : [],
+  "childClasses" : {  },
+  "tree_children" : [],
+  "tree_parent" : [],
   "desc" : "EventObject exposes the Yahoo! UI Event functionality directly on the object\npassed to your event handler. It exists mostly for convenience. It also fixes the annoying null checks automatically to cleanup your code \nExample:\n<pre><code>\n function handleClick(e){ // e is not a standard event object, it is a Roo.EventObject\n    e.preventDefault();\n    var target = e.getTarget();\n    ...\n }\n var myDiv = Roo.get(\"myDiv\");\n myDiv.on(\"click\", handleClick);\n //or\n Roo.EventManager.on(\"myDiv\", 'click', handleClick);\n Roo.EventManager.addListener(\"myDiv\", 'click', handleClick);\n </code></pre>",
   "isSingleton" : true,
   "isStatic" : false,
   "isBuiltin" : false,
+  "isAbstract" : false,
+  "isBuilderTop" : false,
   "memberOf" : "EventObject",
   "example" : "",
   "deprecated" : "",
@@ -12,19 +17,26 @@
   "see" : "",
   "params" : [],
   "returns" : [],
+  "throws" : "",
+  "requires" : "",
   "config" : [],
   "methods" : [
     {
       "name" : "getPageX",
+      "type" : "function",
       "desc" : "Gets the x coordinate of the event.",
+      "sig" : "()\n{\n\n}",
+      "static" : false,
+      "memberOf" : "",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.EventObject",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [],
       "returns" : [
         {
@@ -36,15 +48,20 @@
     },
     {
       "name" : "getPageY",
+      "type" : "function",
       "desc" : "Gets the y coordinate of the event.",
+      "sig" : "()\n{\n\n}",
+      "static" : false,
+      "memberOf" : "",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.EventObject",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [],
       "returns" : [
         {
@@ -56,15 +73,20 @@
     },
     {
       "name" : "getTime",
+      "type" : "function",
       "desc" : "Gets the time of the event.",
+      "sig" : "()\n{\n\n}",
+      "static" : false,
+      "memberOf" : "",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.EventObject",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [],
       "returns" : [
         {
@@ -76,15 +98,20 @@
     },
     {
       "name" : "getXY",
+      "type" : "function",
       "desc" : "Gets the page coordinates of the event.",
+      "sig" : "()\n{\n\n}",
+      "static" : false,
+      "memberOf" : "",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.EventObject",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [],
       "returns" : [
         {
@@ -96,15 +123,20 @@
     },
     {
       "name" : "getRelatedTarget",
+      "type" : "function",
       "desc" : "Gets the related target.",
+      "sig" : "()\n{\n\n}",
+      "static" : false,
+      "memberOf" : "",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.EventObject",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [],
       "returns" : [
         {
@@ -116,15 +148,20 @@
     },
     {
       "name" : "getWheelDelta",
+      "type" : "function",
       "desc" : "Normalizes mouse wheel delta across browsers",
+      "sig" : "()\n{\n\n}",
+      "static" : false,
+      "memberOf" : "",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.EventObject",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [],
       "returns" : [
         {
@@ -136,43 +173,58 @@
     },
     {
       "name" : "stopPropagation",
+      "type" : "function",
       "desc" : "Cancels bubbling of the event.",
+      "sig" : "()\n{\n\n}",
+      "static" : false,
+      "memberOf" : "",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.EventObject",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [],
       "returns" : []
     },
     {
       "name" : "stopEvent",
+      "type" : "function",
       "desc" : "Stop the event (preventDefault and stopPropagation)",
+      "sig" : "()\n{\n\n}",
+      "static" : false,
+      "memberOf" : "",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.EventObject",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [],
       "returns" : []
     },
     {
       "name" : "within",
+      "type" : "function",
       "desc" : "Returns true if the target of this event equals el or is a child of el",
+      "sig" : "(el, related)",
+      "static" : false,
+      "memberOf" : "",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.EventObject",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [
         {
           "name" : "el",
@@ -197,15 +249,20 @@
     },
     {
       "name" : "hasModifier",
+      "type" : "function",
       "desc" : "Returns true if the control, meta, shift or alt key was pressed during this event.",
+      "sig" : "()\n{\n\n}",
+      "static" : false,
+      "memberOf" : "",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.EventObject",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [],
       "returns" : [
         {
@@ -217,15 +274,20 @@
     },
     {
       "name" : "getTarget",
+      "type" : "function",
       "desc" : "Gets the target for the event.",
+      "sig" : "(selector, maxDepth, returnEl)",
+      "static" : false,
+      "memberOf" : "",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.EventObject",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [
         {
           "name" : "selector",
@@ -256,29 +318,39 @@
     },
     {
       "name" : "preventDefault",
+      "type" : "function",
       "desc" : "Prevents the browsers default handling of the event.",
+      "sig" : "()\n{\n\n}",
+      "static" : false,
+      "memberOf" : "",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.EventObject",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [],
       "returns" : []
     },
     {
       "name" : "getCharCode",
+      "type" : "function",
       "desc" : "Gets the key code for the event.",
+      "sig" : "()\n{\n\n}",
+      "static" : false,
+      "memberOf" : "",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.EventObject",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [],
       "returns" : [
         {
@@ -290,15 +362,20 @@
     },
     {
       "name" : "getKey",
+      "type" : "function",
       "desc" : "Returns a normalized keyCode for the event.",
+      "sig" : "()\n{\n\n}",
+      "static" : false,
+      "memberOf" : "",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.EventObject",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [],
       "returns" : [
         {