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

   1 {
   2   "name" : "Roo.util.ClickRepeater",
   3   "augments" : [
   4     "Roo.util.Observable"
   5   ],
   6   "childClasses" : {  },
   7   "tree_children" : [],
   8   "tree_parent" : [],
   9   "desc" : "A wrapper class which can be applied to any element. Fires a \"click\" event while the\nmouse is pressed. The interval between firings may be specified in the config but\ndefaults to 10 milliseconds.\n\nOptionally, a CSS class may be applied to the element during the time it is pressed.",
  10   "isSingleton" : false,
  11   "isStatic" : false,
  12   "isBuiltin" : false,
  13   "isAbstract" : false,
  14   "isBuilderTop" : false,
  15   "memberOf" : "ClickRepeater",
  16   "example" : "",
  17   "deprecated" : "",
  18   "since" : "",
  19   "see" : "",
  20   "params" : [
  21     {
  22       "name" : "el",
  23       "type" : "String/HTMLElement/Element",
  24       "desc" : "The element to listen on",
  25       "isOptional" : false
  26     },
  27     {
  28       "name" : "config",
  29       "type" : "Object",
  30       "desc" : "",
  31       "isOptional" : false
  32     }
  33   ],
  34   "returns" : [],
  35   "throws" : "",
  36   "requires" : "",
  37   "config" : [
  38     {
  39       "name" : "stopDefault",
  40       "type" : "Boolean",
  41       "desc" : "True to stop the default click event",
  42       "memberOf" : "",
  43       "isOptional" : false,
  44       "optvalues" : []
  45     },
  46     {
  47       "name" : "listeners",
  48       "type" : "Object",
  49       "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>",
  50       "memberOf" : "Roo.util.Observable",
  51       "isOptional" : false,
  52       "optvalues" : []
  53     },
  54     {
  55       "name" : "delay",
  56       "type" : "Number",
  57       "desc" : "The initial delay before the repeating event begins firing.\nSimilar to an autorepeat key delay.",
  58       "memberOf" : "",
  59       "isOptional" : false,
  60       "optvalues" : []
  61     },
  62     {
  63       "name" : "accelerate",
  64       "type" : "Boolean",
  65       "desc" : "True if autorepeating should start slowly and accelerate.\n          \"interval\" and \"delay\" are ignored. \"immediate\" is honored.",
  66       "memberOf" : "",
  67       "isOptional" : false,
  68       "optvalues" : []
  69     },
  70     {
  71       "name" : "preventDefault",
  72       "type" : "Boolean",
  73       "desc" : "True to prevent the default click event",
  74       "memberOf" : "",
  75       "isOptional" : false,
  76       "optvalues" : []
  77     },
  78     {
  79       "name" : "interval",
  80       "type" : "Number",
  81       "desc" : "The interval between firings of the \"click\" event. Default 10 ms.",
  82       "memberOf" : "",
  83       "isOptional" : false,
  84       "optvalues" : []
  85     },
  86     {
  87       "name" : "el",
  88       "type" : "String/HTMLElement/Element",
  89       "desc" : "The element to act as a button.",
  90       "memberOf" : "",
  91       "isOptional" : false,
  92       "optvalues" : []
  93     },
  94     {
  95       "name" : "pressClass",
  96       "type" : "String",
  97       "desc" : "A CSS class name to be applied to the element while pressed.",
  98       "memberOf" : "",
  99       "isOptional" : false,
 100       "optvalues" : []
 101     }
 102   ],
 103   "methods" : [
 104     {
 105       "name" : "purgeListeners",
 106       "type" : "function",
 107       "desc" : "Removes all listeners for this object",
 108       "sig" : "()\n{\n\n}",
 109       "static" : false,
 110       "memberOf" : "Roo.util.Observable",
 111       "isStatic" : false,
 112       "isConstructor" : false,
 113       "isPrivate" : false,
 114       "example" : "",
 115       "deprecated" : "",
 116       "since" : "",
 117       "see" : "",
 118       "exceptions" : "",
 119       "requires" : "",
 120       "params" : [],
 121       "returns" : []
 122     },
 123     {
 124       "name" : "on",
 125       "type" : "function",
 126       "desc" : "Appends an event handler to this element (shorthand for addListener)",
 127       "sig" : "(eventName, handler, scope, options)",
 128       "static" : false,
 129       "memberOf" : "Roo.util.Observable",
 130       "isStatic" : false,
 131       "isConstructor" : false,
 132       "isPrivate" : false,
 133       "example" : "",
 134       "deprecated" : "",
 135       "since" : "",
 136       "see" : "",
 137       "exceptions" : "",
 138       "requires" : "",
 139       "params" : [
 140         {
 141           "name" : "eventName",
 142           "type" : "String",
 143           "desc" : "The type of event to listen for",
 144           "isOptional" : false
 145         },
 146         {
 147           "name" : "handler",
 148           "type" : "Function",
 149           "desc" : "The method the event invokes",
 150           "isOptional" : false
 151         },
 152         {
 153           "name" : "scope",
 154           "type" : "Object",
 155           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 156           "isOptional" : false
 157         },
 158         {
 159           "name" : "options",
 160           "type" : "Object",
 161           "desc" : "(optional)",
 162           "isOptional" : false
 163         }
 164       ],
 165       "returns" : []
 166     },
 167     {
 168       "name" : "un",
 169       "type" : "function",
 170       "desc" : "Removes a listener (shorthand for removeListener)",
 171       "sig" : "(eventName, handler, scope)",
 172       "static" : false,
 173       "memberOf" : "Roo.util.Observable",
 174       "isStatic" : false,
 175       "isConstructor" : false,
 176       "isPrivate" : false,
 177       "example" : "",
 178       "deprecated" : "",
 179       "since" : "",
 180       "see" : "",
 181       "exceptions" : "",
 182       "requires" : "",
 183       "params" : [
 184         {
 185           "name" : "eventName",
 186           "type" : "String",
 187           "desc" : "The type of event to listen for",
 188           "isOptional" : false
 189         },
 190         {
 191           "name" : "handler",
 192           "type" : "Function",
 193           "desc" : "The handler to remove",
 194           "isOptional" : false
 195         },
 196         {
 197           "name" : "scope",
 198           "type" : "Object",
 199           "desc" : "(optional) The scope (this object) for the handler",
 200           "isOptional" : false
 201         }
 202       ],
 203       "returns" : []
 204     },
 205     {
 206       "name" : "addEvents",
 207       "type" : "function",
 208       "desc" : "Used to define events on this Observable",
 209       "sig" : "(object)",
 210       "static" : false,
 211       "memberOf" : "Roo.util.Observable",
 212       "isStatic" : false,
 213       "isConstructor" : false,
 214       "isPrivate" : false,
 215       "example" : "",
 216       "deprecated" : "",
 217       "since" : "",
 218       "see" : "",
 219       "exceptions" : "",
 220       "requires" : "",
 221       "params" : [
 222         {
 223           "name" : "object",
 224           "type" : "Object",
 225           "desc" : "The object with the events defined",
 226           "isOptional" : false
 227         }
 228       ],
 229       "returns" : []
 230     },
 231     {
 232       "name" : "releaseCapture",
 233       "type" : "function",
 234       "desc" : "Removes <b>all</b> added captures from the Observable.",
 235       "sig" : "(o)",
 236       "static" : true,
 237       "memberOf" : "Roo.util.Observable",
 238       "isStatic" : true,
 239       "isConstructor" : false,
 240       "isPrivate" : false,
 241       "example" : "",
 242       "deprecated" : "",
 243       "since" : "",
 244       "see" : "",
 245       "exceptions" : "",
 246       "requires" : "",
 247       "params" : [
 248         {
 249           "name" : "o",
 250           "type" : "Observable",
 251           "desc" : "The Observable to release",
 252           "isOptional" : false
 253         }
 254       ],
 255       "returns" : []
 256     },
 257     {
 258       "name" : "removeListener",
 259       "type" : "function",
 260       "desc" : "Removes a listener",
 261       "sig" : "(eventName, handler, scope)",
 262       "static" : false,
 263       "memberOf" : "Roo.util.Observable",
 264       "isStatic" : false,
 265       "isConstructor" : false,
 266       "isPrivate" : false,
 267       "example" : "",
 268       "deprecated" : "",
 269       "since" : "",
 270       "see" : "",
 271       "exceptions" : "",
 272       "requires" : "",
 273       "params" : [
 274         {
 275           "name" : "eventName",
 276           "type" : "String",
 277           "desc" : "The type of event to listen for",
 278           "isOptional" : false
 279         },
 280         {
 281           "name" : "handler",
 282           "type" : "Function",
 283           "desc" : "The handler to remove",
 284           "isOptional" : false
 285         },
 286         {
 287           "name" : "scope",
 288           "type" : "Object",
 289           "desc" : "(optional) The scope (this object) for the handler",
 290           "isOptional" : false
 291         }
 292       ],
 293       "returns" : []
 294     },
 295     {
 296       "name" : "fireEvent",
 297       "type" : "function",
 298       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
 299       "sig" : "(eventName, args)",
 300       "static" : false,
 301       "memberOf" : "Roo.util.Observable",
 302       "isStatic" : false,
 303       "isConstructor" : false,
 304       "isPrivate" : false,
 305       "example" : "",
 306       "deprecated" : "",
 307       "since" : "",
 308       "see" : "",
 309       "exceptions" : "",
 310       "requires" : "",
 311       "params" : [
 312         {
 313           "name" : "eventName",
 314           "type" : "String",
 315           "desc" : "",
 316           "isOptional" : false
 317         },
 318         {
 319           "name" : "args",
 320           "type" : "Object...",
 321           "desc" : "Variable number of parameters are passed to handlers",
 322           "isOptional" : false
 323         }
 324       ],
 325       "returns" : [
 326         {
 327           "name" : "",
 328           "type" : "Boolean",
 329           "desc" : "returns false if any of the handlers return false otherwise it returns true"
 330         }
 331       ]
 332     },
 333     {
 334       "name" : "hasListener",
 335       "type" : "function",
 336       "desc" : "Checks to see if this object has any listeners for a specified event",
 337       "sig" : "(eventName)",
 338       "static" : false,
 339       "memberOf" : "Roo.util.Observable",
 340       "isStatic" : false,
 341       "isConstructor" : false,
 342       "isPrivate" : false,
 343       "example" : "",
 344       "deprecated" : "",
 345       "since" : "",
 346       "see" : "",
 347       "exceptions" : "",
 348       "requires" : "",
 349       "params" : [
 350         {
 351           "name" : "eventName",
 352           "type" : "String",
 353           "desc" : "The name of the event to check for",
 354           "isOptional" : false
 355         }
 356       ],
 357       "returns" : [
 358         {
 359           "name" : "",
 360           "type" : "Boolean",
 361           "desc" : "True if the event is being listened for, else false"
 362         }
 363       ]
 364     },
 365     {
 366       "name" : "capture",
 367       "type" : "function",
 368       "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.",
 369       "sig" : "(o, fn, scope)",
 370       "static" : true,
 371       "memberOf" : "Roo.util.Observable",
 372       "isStatic" : true,
 373       "isConstructor" : false,
 374       "isPrivate" : false,
 375       "example" : "",
 376       "deprecated" : "",
 377       "since" : "",
 378       "see" : "",
 379       "exceptions" : "",
 380       "requires" : "",
 381       "params" : [
 382         {
 383           "name" : "o",
 384           "type" : "Observable",
 385           "desc" : "The Observable to capture",
 386           "isOptional" : false
 387         },
 388         {
 389           "name" : "fn",
 390           "type" : "Function",
 391           "desc" : "The function to call",
 392           "isOptional" : false
 393         },
 394         {
 395           "name" : "scope",
 396           "type" : "Object",
 397           "desc" : "(optional) The scope (this object) for the fn",
 398           "isOptional" : false
 399         }
 400       ],
 401       "returns" : []
 402     },
 403     {
 404       "name" : "addListener",
 405       "type" : "function",
 406       "desc" : "Appends an event handler to this component",
 407       "sig" : "(eventName, handler, scope, options)",
 408       "static" : false,
 409       "memberOf" : "Roo.util.Observable",
 410       "isStatic" : false,
 411       "isConstructor" : false,
 412       "isPrivate" : false,
 413       "example" : "",
 414       "deprecated" : "",
 415       "since" : "",
 416       "see" : "",
 417       "exceptions" : "",
 418       "requires" : "",
 419       "params" : [
 420         {
 421           "name" : "eventName",
 422           "type" : "String",
 423           "desc" : "The type of event to listen for",
 424           "isOptional" : false
 425         },
 426         {
 427           "name" : "handler",
 428           "type" : "Function",
 429           "desc" : "The method the event invokes",
 430           "isOptional" : false
 431         },
 432         {
 433           "name" : "scope",
 434           "type" : "Object",
 435           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 436           "isOptional" : false
 437         },
 438         {
 439           "name" : "options",
 440           "type" : "Object",
 441           "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>",
 442           "isOptional" : false
 443         }
 444       ],
 445       "returns" : []
 446     }
 447   ],
 448   "events" : [
 449     {
 450       "name" : "mousedown",
 451       "type" : "function",
 452       "desc" : "Fires when the mouse button is depressed.",
 453       "sig" : "function (_self)\n{\n\n}",
 454       "memberOf" : "",
 455       "example" : "",
 456       "deprecated" : "",
 457       "since" : "",
 458       "see" : "",
 459       "params" : [
 460         {
 461           "name" : "this",
 462           "type" : "Roo.util.ClickRepeater",
 463           "desc" : "",
 464           "isOptional" : false
 465         }
 466       ],
 467       "returns" : []
 468     },
 469     {
 470       "name" : "click",
 471       "type" : "function",
 472       "desc" : "Fires on a specified interval during the time the element is pressed.",
 473       "sig" : "function (_self)\n{\n\n}",
 474       "memberOf" : "",
 475       "example" : "",
 476       "deprecated" : "",
 477       "since" : "",
 478       "see" : "",
 479       "params" : [
 480         {
 481           "name" : "this",
 482           "type" : "Roo.util.ClickRepeater",
 483           "desc" : "",
 484           "isOptional" : false
 485         }
 486       ],
 487       "returns" : []
 488     },
 489     {
 490       "name" : "mouseup",
 491       "type" : "function",
 492       "desc" : "Fires when the mouse key is released.",
 493       "sig" : "function (_self)\n{\n\n}",
 494       "memberOf" : "",
 495       "example" : "",
 496       "deprecated" : "",
 497       "since" : "",
 498       "see" : "",
 499       "params" : [
 500         {
 501           "name" : "this",
 502           "type" : "Roo.util.ClickRepeater",
 503           "desc" : "",
 504           "isOptional" : false
 505         }
 506       ],
 507       "returns" : []
 508     }
 509   ]
 510 }