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

   1 {
   2   "name" : "Roo.lib.UndoManager",
   3   "augments" : [],
   4   "childClasses" : {  },
   5   "tree_children" : [],
   6   "tree_parent" : [],
   7   "desc" : "An undo manager implementation in JavaScript. It follows the W3C UndoManager and DOM Transaction\nDraft and the undocumented and disabled Mozilla Firefox's UndoManager implementation.\nUsage:\n<pre><code>\n\n\neditor.undoManager = new Roo.lib.UndoManager(1000, editor);\n \n</code></pre>\nFor more information see this blog post with examples:\n <a href=\"http://www.cnitblog.com/seeyeah/archive/2011/12/30/38728.html/\">DomHelper\n     - Create Elements using DOM, HTML fragments and Templates</a>.",
   8   "isSingleton" : false,
   9   "isStatic" : false,
  10   "isBuiltin" : false,
  11   "isAbstract" : false,
  12   "isBuilderTop" : false,
  13   "memberOf" : "UndoManager",
  14   "example" : "",
  15   "deprecated" : "",
  16   "since" : "",
  17   "see" : "",
  18   "params" : [
  19     {
  20       "name" : "limit",
  21       "type" : "Number",
  22       "desc" : "how far back to go ... use 1000?",
  23       "isOptional" : false
  24     },
  25     {
  26       "name" : "scope",
  27       "type" : "Object",
  28       "desc" : "usually use document..",
  29       "isOptional" : false
  30     }
  31   ],
  32   "returns" : [],
  33   "throws" : "",
  34   "requires" : "",
  35   "config" : [],
  36   "methods" : [
  37     {
  38       "name" : "transact",
  39       "type" : "function",
  40       "desc" : "To push and execute a transaction, the method undoManager.transact\nmust be called by passing a transaction object as the first argument, and a merge\nflag as the second argument. A transaction object has the following properties:\n\nUsage:\n<pre><code>\nundoManager.transact({\n    label: 'Typing',\n    execute: function() { ... },\n    undo: function() { ... },\n    // redo same as execute\n    redo: function() { this.execute(); }\n}, false);\n\n// merge transaction\nundoManager.transact({\n    label: 'Typing',\n    execute: function() { ... },  // this will be run...\n    undo: function() { ... }, // what to do when undo is run.\n    // redo same as execute\n    redo: function() { this.execute(); }\n}, true); \n</code></pre>",
  41       "sig" : "(transaction)",
  42       "static" : false,
  43       "memberOf" : "",
  44       "isStatic" : false,
  45       "isConstructor" : false,
  46       "isPrivate" : false,
  47       "example" : "",
  48       "deprecated" : "",
  49       "since" : "",
  50       "see" : "",
  51       "exceptions" : "",
  52       "requires" : "",
  53       "params" : [
  54         {
  55           "name" : "transaction",
  56           "type" : "Object",
  57           "desc" : "The transaction to add to the stack.",
  58           "isOptional" : false
  59         }
  60       ],
  61       "returns" : [
  62         {
  63           "name" : "",
  64           "type" : "String",
  65           "desc" : "The HTML fragment"
  66         }
  67       ]
  68     },
  69     {
  70       "name" : "reset",
  71       "type" : "function",
  72       "desc" : "Reset the undo - probaly done on load to clear all history.",
  73       "sig" : "()\n{\n\n}",
  74       "static" : false,
  75       "memberOf" : "",
  76       "isStatic" : false,
  77       "isConstructor" : false,
  78       "isPrivate" : false,
  79       "example" : "",
  80       "deprecated" : "",
  81       "since" : "",
  82       "see" : "",
  83       "exceptions" : "",
  84       "requires" : "",
  85       "params" : [],
  86       "returns" : []
  87     },
  88     {
  89       "name" : "addEvent",
  90       "type" : "function",
  91       "desc" : "Manually add an event.\nNormall called without arguements - and it will just get added to the stack.",
  92       "sig" : "()\n{\n\n}",
  93       "static" : false,
  94       "memberOf" : "",
  95       "isStatic" : false,
  96       "isConstructor" : false,
  97       "isPrivate" : false,
  98       "example" : "",
  99       "deprecated" : "",
 100       "since" : "",
 101       "see" : "",
 102       "exceptions" : "",
 103       "requires" : "",
 104       "params" : [],
 105       "returns" : []
 106     }
 107   ],
 108   "events" : []
 109 }