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

   1 {
   2   "name" : "Roo.util.DelayedTask",
   3   "augments" : [],
   4   "childClasses" : {  },
   5   "tree_children" : [],
   6   "tree_parent" : [],
   7   "desc" : "Provides a convenient method of performing setTimeout where a new\ntimeout cancels the old timeout. An example would be performing validation on a keypress.\nYou can use this class to buffer\nthe keypress events for a certain number of milliseconds, and perform only if they stop\nfor that amount of time.",
   8   "isSingleton" : false,
   9   "isStatic" : false,
  10   "isBuiltin" : false,
  11   "isAbstract" : false,
  12   "isBuilderTop" : false,
  13   "memberOf" : "DelayedTask",
  14   "example" : "",
  15   "deprecated" : "",
  16   "since" : "",
  17   "see" : "",
  18   "params" : [
  19     {
  20       "name" : "fn",
  21       "type" : "Function",
  22       "desc" : "(optional) The default function to timeout",
  23       "isOptional" : false
  24     },
  25     {
  26       "name" : "scope",
  27       "type" : "Object",
  28       "desc" : "(optional) The default scope of that timeout",
  29       "isOptional" : false
  30     },
  31     {
  32       "name" : "args",
  33       "type" : "Array",
  34       "desc" : "(optional) The default Array of arguments",
  35       "isOptional" : false
  36     }
  37   ],
  38   "returns" : [],
  39   "throws" : "",
  40   "requires" : "",
  41   "config" : [],
  42   "methods" : [
  43     {
  44       "name" : "delay",
  45       "type" : "function",
  46       "desc" : "Cancels any pending timeout and queues a new one",
  47       "sig" : "(delay, newFn, newScope, newArgs)",
  48       "static" : false,
  49       "memberOf" : "",
  50       "isStatic" : false,
  51       "isConstructor" : false,
  52       "isPrivate" : false,
  53       "example" : "",
  54       "deprecated" : "",
  55       "since" : "",
  56       "see" : "",
  57       "exceptions" : "",
  58       "requires" : "",
  59       "params" : [
  60         {
  61           "name" : "delay",
  62           "type" : "Number",
  63           "desc" : "The milliseconds to delay",
  64           "isOptional" : false
  65         },
  66         {
  67           "name" : "newFn",
  68           "type" : "Function",
  69           "desc" : "(optional) Overrides function passed to constructor",
  70           "isOptional" : false
  71         },
  72         {
  73           "name" : "newScope",
  74           "type" : "Object",
  75           "desc" : "(optional) Overrides scope passed to constructor",
  76           "isOptional" : false
  77         },
  78         {
  79           "name" : "newArgs",
  80           "type" : "Array",
  81           "desc" : "(optional) Overrides args passed to constructor",
  82           "isOptional" : false
  83         }
  84       ],
  85       "returns" : []
  86     },
  87     {
  88       "name" : "cancel",
  89       "type" : "function",
  90       "desc" : "Cancel the last queued timeout",
  91       "sig" : "()\n{\n\n}",
  92       "static" : false,
  93       "memberOf" : "",
  94       "isStatic" : false,
  95       "isConstructor" : false,
  96       "isPrivate" : false,
  97       "example" : "",
  98       "deprecated" : "",
  99       "since" : "",
 100       "see" : "",
 101       "exceptions" : "",
 102       "requires" : "",
 103       "params" : [],
 104       "returns" : []
 105     }
 106   ],
 107   "events" : []
 108 }