git.roojs.org Git - roojs1/blob - docs/symbols/Roo.Document.json

   1 {
   2   "name" : "Roo.Document",
   3   "augments" : [
   4     "Roo.util.Observable"
   5   ],
   6   "childClasses" : {  },
   7   "tree_children" : [],
   8   "tree_parent" : [],
   9   "desc" : "This is a convience class to wrap up the main document loading code.. , rather than adding Roo.onReady(......)",
  10   "isSingleton" : false,
  11   "isStatic" : false,
  12   "isBuiltin" : false,
  13   "isAbstract" : false,
  14   "isBuilderTop" : false,
  15   "memberOf" : "Document",
  16   "example" : "",
  17   "deprecated" : "",
  18   "since" : "",
  19   "see" : "",
  20   "params" : [
  21     {
  22       "name" : "config",
  23       "type" : "Object",
  24       "desc" : "the methods and properties of the 'base' class for the application.\n\n Generic Page handler - implement this to start your app..\n\neg.\n MyProject = new Roo.Document({\n        events : {\n            'load' : true // your events..\n        },\n        listeners : {\n            'ready' : function() {\n                // fired on Roo.onReady()\n            }\n        }",
  25       "isOptional" : false
  26     }
  27   ],
  28   "returns" : [],
  29   "throws" : "",
  30   "requires" : "",
  31   "config" : [
  32     {
  33       "name" : "listeners",
  34       "type" : "Object",
  35       "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  </code></pre>",
  36       "memberOf" : "Roo.util.Observable",
  37       "isOptional" : false,
  38       "optvalues" : []
  39     }
  40   ],
  41   "methods" : [
  42     {
  43       "name" : "purgeListeners",
  44       "type" : "function",
  45       "desc" : "Removes all listeners for this object",
  46       "sig" : "()\n{\n\n}",
  47       "static" : false,
  48       "memberOf" : "Roo.util.Observable",
  49       "isStatic" : false,
  50       "isConstructor" : false,
  51       "isPrivate" : false,
  52       "example" : "",
  53       "deprecated" : "",
  54       "since" : "",
  55       "see" : "",
  56       "exceptions" : "",
  57       "requires" : "",
  58       "params" : [],
  59       "returns" : []
  60     },
  61     {
  62       "name" : "on",
  63       "type" : "function",
  64       "desc" : "Appends an event handler to this element (shorthand for addListener)",
  65       "sig" : "(eventName, handler, scope, options)",
  66       "static" : false,
  67       "memberOf" : "Roo.util.Observable",
  68       "isStatic" : false,
  69       "isConstructor" : false,
  70       "isPrivate" : false,
  71       "example" : "",
  72       "deprecated" : "",
  73       "since" : "",
  74       "see" : "",
  75       "exceptions" : "",
  76       "requires" : "",
  77       "params" : [
  78         {
  79           "name" : "eventName",
  80           "type" : "String",
  81           "desc" : "The type of event to listen for",
  82           "isOptional" : false
  83         },
  84         {
  85           "name" : "handler",
  86           "type" : "Function",
  87           "desc" : "The method the event invokes",
  88           "isOptional" : false
  89         },
  90         {
  91           "name" : "scope",
  92           "type" : "Object",
  93           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
  94           "isOptional" : false
  95         },
  96         {
  97           "name" : "options",
  98           "type" : "Object",
  99           "desc" : "(optional)",
 100           "isOptional" : false
 101         }
 102       ],
 103       "returns" : []
 104     },
 105     {
 106       "name" : "un",
 107       "type" : "function",
 108       "desc" : "Removes a listener (shorthand for removeListener)",
 109       "sig" : "(eventName, handler, scope)",
 110       "static" : false,
 111       "memberOf" : "Roo.util.Observable",
 112       "isStatic" : false,
 113       "isConstructor" : false,
 114       "isPrivate" : false,
 115       "example" : "",
 116       "deprecated" : "",
 117       "since" : "",
 118       "see" : "",
 119       "exceptions" : "",
 120       "requires" : "",
 121       "params" : [
 122         {
 123           "name" : "eventName",
 124           "type" : "String",
 125           "desc" : "The type of event to listen for",
 126           "isOptional" : false
 127         },
 128         {
 129           "name" : "handler",
 130           "type" : "Function",
 131           "desc" : "The handler to remove",
 132           "isOptional" : false
 133         },
 134         {
 135           "name" : "scope",
 136           "type" : "Object",
 137           "desc" : "(optional) The scope (this object) for the handler",
 138           "isOptional" : false
 139         }
 140       ],
 141       "returns" : []
 142     },
 143     {
 144       "name" : "addEvents",
 145       "type" : "function",
 146       "desc" : "Used to define events on this Observable",
 147       "sig" : "(object)",
 148       "static" : false,
 149       "memberOf" : "Roo.util.Observable",
 150       "isStatic" : false,
 151       "isConstructor" : false,
 152       "isPrivate" : false,
 153       "example" : "",
 154       "deprecated" : "",
 155       "since" : "",
 156       "see" : "",
 157       "exceptions" : "",
 158       "requires" : "",
 159       "params" : [
 160         {
 161           "name" : "object",
 162           "type" : "Object",
 163           "desc" : "The object with the events defined",
 164           "isOptional" : false
 165         }
 166       ],
 167       "returns" : []
 168     },
 169     {
 170       "name" : "releaseCapture",
 171       "type" : "function",
 172       "desc" : "Removes <b>all</b> added captures from the Observable.",
 173       "sig" : "(o)",
 174       "static" : true,
 175       "memberOf" : "Roo.util.Observable",
 176       "isStatic" : true,
 177       "isConstructor" : false,
 178       "isPrivate" : false,
 179       "example" : "",
 180       "deprecated" : "",
 181       "since" : "",
 182       "see" : "",
 183       "exceptions" : "",
 184       "requires" : "",
 185       "params" : [
 186         {
 187           "name" : "o",
 188           "type" : "Observable",
 189           "desc" : "The Observable to release",
 190           "isOptional" : false
 191         }
 192       ],
 193       "returns" : []
 194     },
 195     {
 196       "name" : "removeListener",
 197       "type" : "function",
 198       "desc" : "Removes a listener",
 199       "sig" : "(eventName, handler, scope)",
 200       "static" : false,
 201       "memberOf" : "Roo.util.Observable",
 202       "isStatic" : false,
 203       "isConstructor" : false,
 204       "isPrivate" : false,
 205       "example" : "",
 206       "deprecated" : "",
 207       "since" : "",
 208       "see" : "",
 209       "exceptions" : "",
 210       "requires" : "",
 211       "params" : [
 212         {
 213           "name" : "eventName",
 214           "type" : "String",
 215           "desc" : "The type of event to listen for",
 216           "isOptional" : false
 217         },
 218         {
 219           "name" : "handler",
 220           "type" : "Function",
 221           "desc" : "The handler to remove",
 222           "isOptional" : false
 223         },
 224         {
 225           "name" : "scope",
 226           "type" : "Object",
 227           "desc" : "(optional) The scope (this object) for the handler",
 228           "isOptional" : false
 229         }
 230       ],
 231       "returns" : []
 232     },
 233     {
 234       "name" : "fireEvent",
 235       "type" : "function",
 236       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
 237       "sig" : "(eventName, args)",
 238       "static" : false,
 239       "memberOf" : "Roo.util.Observable",
 240       "isStatic" : false,
 241       "isConstructor" : false,
 242       "isPrivate" : false,
 243       "example" : "",
 244       "deprecated" : "",
 245       "since" : "",
 246       "see" : "",
 247       "exceptions" : "",
 248       "requires" : "",
 249       "params" : [
 250         {
 251           "name" : "eventName",
 252           "type" : "String",
 253           "desc" : "",
 254           "isOptional" : false
 255         },
 256         {
 257           "name" : "args",
 258           "type" : "Object...",
 259           "desc" : "Variable number of parameters are passed to handlers",
 260           "isOptional" : false
 261         }
 262       ],
 263       "returns" : [
 264         {
 265           "name" : "",
 266           "type" : "Boolean",
 267           "desc" : "returns false if any of the handlers return false otherwise it returns true"
 268         }
 269       ]
 270     },
 271     {
 272       "name" : "hasListener",
 273       "type" : "function",
 274       "desc" : "Checks to see if this object has any listeners for a specified event",
 275       "sig" : "(eventName)",
 276       "static" : false,
 277       "memberOf" : "Roo.util.Observable",
 278       "isStatic" : false,
 279       "isConstructor" : false,
 280       "isPrivate" : false,
 281       "example" : "",
 282       "deprecated" : "",
 283       "since" : "",
 284       "see" : "",
 285       "exceptions" : "",
 286       "requires" : "",
 287       "params" : [
 288         {
 289           "name" : "eventName",
 290           "type" : "String",
 291           "desc" : "The name of the event to check for",
 292           "isOptional" : false
 293         }
 294       ],
 295       "returns" : [
 296         {
 297           "name" : "",
 298           "type" : "Boolean",
 299           "desc" : "True if the event is being listened for, else false"
 300         }
 301       ]
 302     },
 303     {
 304       "name" : "capture",
 305       "type" : "function",
 306       "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
 307       "sig" : "(o, fn, scope)",
 308       "static" : true,
 309       "memberOf" : "Roo.util.Observable",
 310       "isStatic" : true,
 311       "isConstructor" : false,
 312       "isPrivate" : false,
 313       "example" : "",
 314       "deprecated" : "",
 315       "since" : "",
 316       "see" : "",
 317       "exceptions" : "",
 318       "requires" : "",
 319       "params" : [
 320         {
 321           "name" : "o",
 322           "type" : "Observable",
 323           "desc" : "The Observable to capture",
 324           "isOptional" : false
 325         },
 326         {
 327           "name" : "fn",
 328           "type" : "Function",
 329           "desc" : "The function to call",
 330           "isOptional" : false
 331         },
 332         {
 333           "name" : "scope",
 334           "type" : "Object",
 335           "desc" : "(optional) The scope (this object) for the fn",
 336           "isOptional" : false
 337         }
 338       ],
 339       "returns" : []
 340     },
 341     {
 342       "name" : "addListener",
 343       "type" : "function",
 344       "desc" : "Appends an event handler to this component",
 345       "sig" : "(eventName, handler, scope, options)",
 346       "static" : false,
 347       "memberOf" : "Roo.util.Observable",
 348       "isStatic" : false,
 349       "isConstructor" : false,
 350       "isPrivate" : false,
 351       "example" : "",
 352       "deprecated" : "",
 353       "since" : "",
 354       "see" : "",
 355       "exceptions" : "",
 356       "requires" : "",
 357       "params" : [
 358         {
 359           "name" : "eventName",
 360           "type" : "String",
 361           "desc" : "The type of event to listen for",
 362           "isOptional" : false
 363         },
 364         {
 365           "name" : "handler",
 366           "type" : "Function",
 367           "desc" : "The method the event invokes",
 368           "isOptional" : false
 369         },
 370         {
 371           "name" : "scope",
 372           "type" : "Object",
 373           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 374           "isOptional" : false
 375         },
 376         {
 377           "name" : "options",
 378           "type" : "Object",
 379           "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n     \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t</code></pre>",
 380           "isOptional" : false
 381         }
 382       ],
 383       "returns" : []
 384     }
 385   ],
 386   "events" : []
 387 }