undomanager.html 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271
  1. <div id="documentation" class="span9">
  2. <div class="classContent">
  3. <div class="membersBackground"></div>
  4. <div class=" members pos0">
  5. <div class=" membersContent pos0">
  6. <h1 class="memberHeader"><span class="name">UndoManager</span>
  7. </h1>
  8. <ul data-tabs="tabs" class="nav tabs pos0">
  9. <li data-dropdown="dropdown" class="dropdown">
  10. <ul class="dropdown-menu">
  11. </ul>
  12. </li>
  13. <li data-dropdown="dropdown" class="dropdown"><a href="#" data-toggle="dropdown" class="dropdown-toggle"><span>Constructors (1)</span><b class="caret"></b></a>
  14. <ul class="dropdown-menu">
  15. <li id="dropdown_UndoManager.new" data-id="UndoManager.new" class="memberLink"><a href="#UndoManager.new" class="" title="UndoManager.new (constructor)" data-id="UndoManager.new">new</a>
  16. </li>
  17. </ul>
  18. </li>
  19. <li data-dropdown="dropdown" class="dropdown"><a href="#" data-toggle="dropdown" class="dropdown-toggle"><span>Functions (6)</span><b class="caret"></b></a>
  20. <ul class="dropdown-menu">
  21. <li id="dropdown_UndoManager.execute" data-id="UndoManager.execute" class="memberLink"><a href="#UndoManager.execute" class="" title="UndoManager.execute (class method)" data-id="UndoManager.execute">execute</a>
  22. </li>
  23. <li id="dropdown_UndoManager.hasRedo" data-id="UndoManager.hasRedo" class="memberLink"><a href="#UndoManager.hasRedo" class="" title="UndoManager.hasRedo (class method)" data-id="UndoManager.hasRedo">hasRedo</a>
  24. </li>
  25. <li id="dropdown_UndoManager.hasUndo" data-id="UndoManager.hasUndo" class="memberLink"><a href="#UndoManager.hasUndo" class="" title="UndoManager.hasUndo (class method)" data-id="UndoManager.hasUndo">hasUndo</a>
  26. </li>
  27. <li id="dropdown_UndoManager.redo" data-id="UndoManager.redo" class="memberLink"><a href="#UndoManager.redo" class="" title="UndoManager.redo (class method)" data-id="UndoManager.redo">redo</a>
  28. </li>
  29. <li id="dropdown_UndoManager.reset" data-id="UndoManager.reset" class="memberLink"><a href="#UndoManager.reset" class="" title="UndoManager.reset (class method)" data-id="UndoManager.reset">reset</a>
  30. </li>
  31. <li id="dropdown_UndoManager.undo" data-id="UndoManager.undo" class="memberLink"><a href="#UndoManager.undo" class="" title="UndoManager.undo (class method)" data-id="UndoManager.undo">undo</a>
  32. </li>
  33. </ul>
  34. </li>
  35. <li data-dropdown="dropdown" class="dropdown">
  36. <ul class="dropdown-menu">
  37. </ul>
  38. </li>
  39. <li data-dropdown="dropdown" class="dropdown">
  40. <ul class="dropdown-menu">
  41. </ul>
  42. </li>
  43. <li data-dropdown="dropdown" class="dropdown">
  44. <ul class="dropdown-menu">
  45. </ul>
  46. </li>
  47. <li data-dropdown="dropdown" class="dropdown">
  48. <ul class="dropdown-menu">
  49. </ul>
  50. </li>
  51. </ul>
  52. </div>
  53. </div>
  54. <article id="UndoManager" data-title="UndoManager (class)" class="article">
  55. <div class="section description">
  56. <div class="memberContent"><p>This object maintains the undo stack for an <a href="edit_session.html" class="link-short" title="EditSession (class)" data-id="EditSession"><code>EditSession</code></a>.</p>
  57. </div>
  58. </div>
  59. </article>
  60. <h3 class="sectionHeader">Constructors</h3>
  61. <article id="UndoManager.new" data-title="UndoManager.new (constructor)" class="article">
  62. <div class="section method">
  63. <div class="memberContent">
  64. <div class="title"><i id="UndoManager.new" class="methodToggle methodClicker inactive icon-caret-right"></i>
  65. <ul class="signatures">
  66. <li class="signature">
  67. <ul>
  68. <li class="signature-call"><span class="constructorIdentifier">new </span><span id="UndoManager.new" class="member-name methodClicker">UndoManager</span><span class="emptyArgumentList">()</span></li>
  69. </ul>
  70. <ul class="metaInfo">
  71. </ul>
  72. </li>
  73. </ul>
  74. </div>
  75. <div class="sideToggler">
  76. <div id="ellipsis_UndoManager.new" class="ellipsis_description"><p>Resets the current undo state and creates a new <code>UndoManager</code>.</p>
  77. </div>
  78. <div class="description"><p>Resets the current undo state and creates a new <code>UndoManager</code>.</p>
  79. </div>
  80. </div>
  81. </div>
  82. </div>
  83. </article>
  84. <h3 class="sectionHeader">Methods</h3>
  85. <article id="UndoManager.execute" data-title="UndoManager.execute (class method)" class="article">
  86. <div class="section method">
  87. <div class="memberContent">
  88. <div class="title"><i id="UndoManager.execute" class="methodToggle methodClicker inactive icon-caret-right"></i>
  89. <ul class="signatures">
  90. <li class="signature">
  91. <ul>
  92. <li class="signature-call"><span id="UndoManager.execute" class="member-name methodClicker"><span class="sigClassName">UndoManager.</span><span class="sigMemberName">execute</span></span>(<span class="sigArgList"><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Object" class="argument methodClicker" title="Object" data-id="Object">Object</a> options</span>)</li>
  93. </ul>
  94. <ul class="metaInfo">
  95. </ul>
  96. </li>
  97. </ul>
  98. </div>
  99. <div class="sideToggler">
  100. <div id="ellipsis_UndoManager.execute" class="ellipsis_description"><p>Provides a means for implementing your own undo manager. <code>options</code> has one property, <code>args</code>, an <a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Array" class="link-short" title="<code>Array</code>" data-id="<code>Array</code>"><code>Array</code></a>, with two elements:</p>
  101. </div>
  102. <div class="description"><p>Provides a means for implementing your own undo manager. <code>options</code> has one property, <code>args</code>, an <a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Array" class="link-short" title="<code>Array</code>" data-id="<code>Array</code>"><code>Array</code></a>, with two elements:</p>
  103. <ul>
  104. <li><code>args[0]</code> is an array of deltas</li>
  105. <li><code>args[1]</code> is the document to associate with</li>
  106. </ul>
  107. <h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"><tr class="argumentRow "><td class="argName ">options</td><td class="argType" "><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Object" class="" title="Object" data-id="Object">Object</a></td><td class="argDescription "><p>Required. Contains additional properties</p>
  108. </td></tr></table>
  109. </div>
  110. </div>
  111. </div>
  112. </div>
  113. </article>
  114. <article id="UndoManager.hasRedo" data-title="UndoManager.hasRedo (class method)" class="article">
  115. <div class="section method">
  116. <div class="memberContent">
  117. <div class="title"><i id="UndoManager.hasRedo" class="methodToggle methodClicker inactive icon-caret-right"></i>
  118. <ul class="signatures">
  119. <li class="signature">
  120. <ul>
  121. <li class="signature-call"><span id="UndoManager.hasRedo" class="member-name methodClicker"><span class="sigClassName">UndoManager.</span><span class="sigMemberName">hasRedo</span></span><span class="emptyArgumentList">()</span>
  122. <li class="signature-returns">
  123. <ul class="argument-types">
  124. <li class="argument-type"><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Boolean" class="returnType " title="Boolean" data-id="Boolean">Boolean</a></li>
  125. </ul>
  126. </li></li>
  127. </ul>
  128. <ul class="metaInfo">
  129. </ul>
  130. </li>
  131. </ul>
  132. </div>
  133. <div class="sideToggler">
  134. <div id="ellipsis_UndoManager.hasRedo" class="ellipsis_description"><p>Returns <code>true</code> if there are redo operations left to perform.</p>
  135. </div>
  136. <div class="description"><p>Returns <code>true</code> if there are redo operations left to perform.</p>
  137. </div>
  138. </div>
  139. </div>
  140. </div>
  141. </article>
  142. <article id="UndoManager.hasUndo" data-title="UndoManager.hasUndo (class method)" class="article">
  143. <div class="section method">
  144. <div class="memberContent">
  145. <div class="title"><i id="UndoManager.hasUndo" class="methodToggle methodClicker inactive icon-caret-right"></i>
  146. <ul class="signatures">
  147. <li class="signature">
  148. <ul>
  149. <li class="signature-call"><span id="UndoManager.hasUndo" class="member-name methodClicker"><span class="sigClassName">UndoManager.</span><span class="sigMemberName">hasUndo</span></span><span class="emptyArgumentList">()</span>
  150. <li class="signature-returns">
  151. <ul class="argument-types">
  152. <li class="argument-type"><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Boolean" class="returnType " title="Boolean" data-id="Boolean">Boolean</a></li>
  153. </ul>
  154. </li></li>
  155. </ul>
  156. <ul class="metaInfo">
  157. </ul>
  158. </li>
  159. </ul>
  160. </div>
  161. <div class="sideToggler">
  162. <div id="ellipsis_UndoManager.hasUndo" class="ellipsis_description"><p>Returns <code>true</code> if there are undo operations left to perform.</p>
  163. </div>
  164. <div class="description"><p>Returns <code>true</code> if there are undo operations left to perform.</p>
  165. </div>
  166. </div>
  167. </div>
  168. </div>
  169. </article>
  170. <article id="UndoManager.redo" data-title="UndoManager.redo (class method)" class="article">
  171. <div class="section method">
  172. <div class="memberContent">
  173. <div class="title"><i id="UndoManager.redo" class="methodToggle methodClicker inactive icon-caret-right"></i>
  174. <ul class="signatures">
  175. <li class="signature">
  176. <ul>
  177. <li class="signature-call"><span id="UndoManager.redo" class="member-name methodClicker"><span class="sigClassName">UndoManager.</span><span class="sigMemberName">redo</span></span>(<span class="sigArgList"><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Boolean" class="argument methodClicker" title="Boolean" data-id="Boolean">Boolean</a> dontSelect</span>)</li>
  178. </ul>
  179. <ul class="metaInfo">
  180. </ul>
  181. </li>
  182. </ul>
  183. </div>
  184. <div class="sideToggler">
  185. <div id="ellipsis_UndoManager.redo" class="ellipsis_description"><p>Perform a redo operation on the document, reimplementing the last change.</p>
  186. </div>
  187. <div class="description"><p>Perform a redo operation on the document, reimplementing the last change.</p>
  188. <h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"><tr class="argumentRow "><td class="argName ">dontSelect</td><td class="argType" "><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Boolean" class="" title="Boolean" data-id="Boolean">Boolean</a></td><td class="argDescription "><p>Required. If <code>true</code>, doesn&#39;t select the range of where the change occured</p>
  189. </td></tr></table>
  190. </div>
  191. </div>
  192. </div>
  193. </div>
  194. </article>
  195. <article id="UndoManager.reset" data-title="UndoManager.reset (class method)" class="article">
  196. <div class="section method">
  197. <div class="memberContent">
  198. <div class="title"><i id="UndoManager.reset" class="methodToggle methodClicker inactive icon-caret-right"></i>
  199. <ul class="signatures">
  200. <li class="signature">
  201. <ul>
  202. <li class="signature-call"><span id="UndoManager.reset" class="member-name methodClicker"><span class="sigClassName">UndoManager.</span><span class="sigMemberName">reset</span></span><span class="emptyArgumentList">()</span></li>
  203. </ul>
  204. <ul class="metaInfo">
  205. </ul>
  206. </li>
  207. </ul>
  208. </div>
  209. <div class="sideToggler">
  210. <div id="ellipsis_UndoManager.reset" class="ellipsis_description"><p>Destroys the stack of undo and redo redo operations.</p>
  211. </div>
  212. <div class="description"><p>Destroys the stack of undo and redo redo operations.</p>
  213. </div>
  214. </div>
  215. </div>
  216. </div>
  217. </article>
  218. <article id="UndoManager.undo" data-title="UndoManager.undo (class method)" class="article">
  219. <div class="section method">
  220. <div class="memberContent">
  221. <div class="title"><i id="UndoManager.undo" class="methodToggle methodClicker inactive icon-caret-right"></i>
  222. <ul class="signatures">
  223. <li class="signature">
  224. <ul>
  225. <li class="signature-call"><span id="UndoManager.undo" class="member-name methodClicker"><span class="sigClassName">UndoManager.</span><span class="sigMemberName">undo</span></span>(<span class="sigArgList"><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Boolean" class="argument methodClicker" title="Boolean" data-id="Boolean">Boolean</a> dontSelect</span>)
  226. <li class="signature-returns">
  227. <ul class="argument-types">
  228. <li class="argument-type"><a href="range.html" class="returnType " title="Range (class)" data-id="Range">Range</a></li>
  229. </ul>
  230. </li></li>
  231. </ul>
  232. <ul class="metaInfo">
  233. </ul>
  234. </li>
  235. </ul>
  236. </div>
  237. <div class="sideToggler">
  238. <div id="ellipsis_UndoManager.undo" class="ellipsis_description"><p>Perform an undo operation on the document, reverting the last change.</p>
  239. </div>
  240. <div class="description"><p>Perform an undo operation on the document, reverting the last change.</p>
  241. <h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"><tr class="argumentRow "><td class="argName ">dontSelect</td><td class="argType" "><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Boolean" class="" title="Boolean" data-id="Boolean">Boolean</a></td><td class="argDescription "><p>Required. If <code>true</code>, doesn&#39;t select the range of where the change occured</p>
  242. </td></tr></table>
  243. </div>
  244. </div>
  245. </div>
  246. </div>
  247. </article>
  248. </div>
  249. <script defer src="./resources/javascripts/ux.js"></script>
  250. <script src="./resources/javascripts/clicker.js"></script>
  251. <script src="./resources/javascripts/jquery-scrollspy.js"></script>
  252. <script defer src="./resources/javascripts/disqus-ext.js"></script>
  253. <script defer src="./resources/javascripts/ga.js"></script>
  254. <div id="disqus_thread"></div>
  255. </div>