background_tokenizer.html 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320
  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">BackgroundTokenizer</span>
  7. </h1>
  8. <ul data-tabs="tabs" class="nav tabs pos0">
  9. <li data-dropdown="dropdown" class="dropdown"><a href="#" data-toggle="dropdown" class="dropdown-toggle"><span>Events (1)</span><b class="caret"></b></a>
  10. <ul class="dropdown-menu">
  11. <li id="dropdown_BackgroundTokenizer.event.update" data-id="BackgroundTokenizer.event.update" class="memberLink"><a href="#BackgroundTokenizer.event.update" class="" title="BackgroundTokenizer.event.update (event)" data-id="BackgroundTokenizer.event.update">update</a>
  12. </li>
  13. </ul>
  14. </li>
  15. <li data-dropdown="dropdown" class="dropdown"><a href="#" data-toggle="dropdown" class="dropdown-toggle"><span>Constructors (1)</span><b class="caret"></b></a>
  16. <ul class="dropdown-menu">
  17. <li id="dropdown_BackgroundTokenizer.new" data-id="BackgroundTokenizer.new" class="memberLink"><a href="#BackgroundTokenizer.new" class="" title="BackgroundTokenizer.new (constructor)" data-id="BackgroundTokenizer.new">new</a>
  18. </li>
  19. </ul>
  20. </li>
  21. <li data-dropdown="dropdown" class="dropdown"><a href="#" data-toggle="dropdown" class="dropdown-toggle"><span>Functions (7)</span><b class="caret"></b></a>
  22. <ul class="dropdown-menu">
  23. <li id="dropdown_BackgroundTokenizer.fireUpdateEvent" data-id="BackgroundTokenizer.fireUpdateEvent" class="memberLink"><a href="#BackgroundTokenizer.fireUpdateEvent" class="" title="BackgroundTokenizer.fireUpdateEvent (class method)" data-id="BackgroundTokenizer.fireUpdateEvent">fireUpdateEvent</a>
  24. </li>
  25. <li id="dropdown_BackgroundTokenizer.getState" data-id="BackgroundTokenizer.getState" class="memberLink"><a href="#BackgroundTokenizer.getState" class="" title="BackgroundTokenizer.getState (class method)" data-id="BackgroundTokenizer.getState">getState</a>
  26. </li>
  27. <li id="dropdown_BackgroundTokenizer.getTokens" data-id="BackgroundTokenizer.getTokens" class="memberLink"><a href="#BackgroundTokenizer.getTokens" class="" title="BackgroundTokenizer.getTokens (class method)" data-id="BackgroundTokenizer.getTokens">getTokens</a>
  28. </li>
  29. <li id="dropdown_BackgroundTokenizer.setDocument" data-id="BackgroundTokenizer.setDocument" class="memberLink"><a href="#BackgroundTokenizer.setDocument" class="" title="BackgroundTokenizer.setDocument (class method)" data-id="BackgroundTokenizer.setDocument">setDocument</a>
  30. </li>
  31. <li id="dropdown_BackgroundTokenizer.setTokenizer" data-id="BackgroundTokenizer.setTokenizer" class="memberLink"><a href="#BackgroundTokenizer.setTokenizer" class="" title="BackgroundTokenizer.setTokenizer (class method)" data-id="BackgroundTokenizer.setTokenizer">setTokenizer</a>
  32. </li>
  33. <li id="dropdown_BackgroundTokenizer.start" data-id="BackgroundTokenizer.start" class="memberLink"><a href="#BackgroundTokenizer.start" class="" title="BackgroundTokenizer.start (class method)" data-id="BackgroundTokenizer.start">start</a>
  34. </li>
  35. <li id="dropdown_BackgroundTokenizer.stop" data-id="BackgroundTokenizer.stop" class="memberLink"><a href="#BackgroundTokenizer.stop" class="" title="BackgroundTokenizer.stop (class method)" data-id="BackgroundTokenizer.stop">stop</a>
  36. </li>
  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. <li data-dropdown="dropdown" class="dropdown">
  52. <ul class="dropdown-menu">
  53. </ul>
  54. </li>
  55. </ul>
  56. </div>
  57. </div>
  58. <article id="BackgroundTokenizer" data-title="BackgroundTokenizer (class)" class="article">
  59. <div class="section description">
  60. <div class="memberContent"><p>Tokenizes the current <a href="document.html" class="link-short" title="Document (class)" data-id="Document"><code>Document</code></a> in the background, and caches the tokenized rows for future use. </p>
  61. <p>If a certain row is changed, everything below that row is re-tokenized.</p>
  62. </div>
  63. </div>
  64. </article>
  65. <h3 class="sectionHeader">Constructors</h3>
  66. <article id="BackgroundTokenizer.new" data-title="BackgroundTokenizer.new (constructor)" class="article">
  67. <div class="section method">
  68. <div class="memberContent">
  69. <div class="title"><i id="BackgroundTokenizer.new" class="methodToggle methodClicker inactive icon-caret-right"></i>
  70. <ul class="signatures">
  71. <li class="signature">
  72. <ul>
  73. <li class="signature-call"><span class="constructorIdentifier">new </span><span id="BackgroundTokenizer.new" class="member-name methodClicker">BackgroundTokenizer</span>(<span class="sigArgList"><a href="tokenizer.html" class="argument methodClicker" title="Tokenizer (class)" data-id="Tokenizer">Tokenizer</a> tokenizer, <a href="editor.html" class="argument methodClicker" title="Editor (class)" data-id="Editor">Editor</a> editor</span>)</li>
  74. </ul>
  75. <ul class="metaInfo">
  76. </ul>
  77. </li>
  78. </ul>
  79. </div>
  80. <div class="sideToggler">
  81. <div id="ellipsis_BackgroundTokenizer.new" class="ellipsis_description"><p>Creates a new <code>BackgroundTokenizer</code> object.</p>
  82. </div>
  83. <div class="description"><p>Creates a new <code>BackgroundTokenizer</code> object.</p>
  84. <h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"><tr class="argumentRow "><td class="argName ">tokenizer</td><td class="argType" "><a href="tokenizer.html" class="" title="Tokenizer (class)" data-id="Tokenizer">Tokenizer</a></td><td class="argDescription "><p>Required. The tokenizer to use</p>
  85. </td></tr><tr class="argumentRow "><td class="argName ">editor</td><td class="argType" "><a href="editor.html" class="" title="Editor (class)" data-id="Editor">Editor</a></td><td class="argDescription "><p>Required. The editor to associate with</p>
  86. </td></tr></table>
  87. </div>
  88. </div>
  89. </div>
  90. </div>
  91. </article>
  92. <h3 class="sectionHeader">Events</h3>
  93. <article id="BackgroundTokenizer.event.update" data-title="BackgroundTokenizer.event.update (event)" class="article">
  94. <div class="section method">
  95. <div class="memberContent">
  96. <div class="title"><i id="BackgroundTokenizer.event.update" class="methodToggle methodClicker inactive icon-caret-right"></i>
  97. <ul class="signatures">
  98. <li class="signature">
  99. <ul>
  100. <li class="signature-call"><span class="eventObjName">BackgroundTokenizer</span><span class="eventListenerStart">.on("</span><span id="BackgroundTokenizer.event.update" class="member-name eventMember methodClicker">update</span><span class="eventListenerClose">", </span><span class="eventFunctionOpen">function(</span><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Object" class="argument methodClicker" title="Object" data-id="Object">Object</a> e<span class="eventFunctionClose">))</span></li>
  101. </ul>
  102. <ul class="metaInfo">
  103. </ul>
  104. </li>
  105. </ul>
  106. </div>
  107. <div class="sideToggler">
  108. <div id="ellipsis_BackgroundTokenizer.event.update" class="ellipsis_description"><p>Fires whenever the background tokeniziers between a range of rows are going to be updated.</p>
  109. </div>
  110. <div class="description"><p>Fires whenever the background tokeniziers between a range of rows are going to be updated.</p>
  111. <h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"><tr class="argumentRow "><td class="argName ">e</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. An object containing two properties, <code>first</code> and <code>last</code>, which indicate the rows of the region being updated.</p>
  112. </td></tr></table>
  113. </div>
  114. </div>
  115. </div>
  116. </div>
  117. </article>
  118. <h3 class="sectionHeader">Methods</h3>
  119. <article id="BackgroundTokenizer.fireUpdateEvent" data-title="BackgroundTokenizer.fireUpdateEvent (class method)" class="article">
  120. <div class="section method">
  121. <div class="memberContent">
  122. <div class="title"><i id="BackgroundTokenizer.fireUpdateEvent" class="methodToggle methodClicker inactive icon-caret-right"></i>
  123. <ul class="signatures">
  124. <li class="signature">
  125. <ul>
  126. <li class="signature-call"><span id="BackgroundTokenizer.fireUpdateEvent" class="member-name methodClicker"><span class="sigClassName">BackgroundTokenizer.</span><span class="sigMemberName">fireUpdateEvent</span></span>(<span class="sigArgList"><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="argument methodClicker" title="Number" data-id="Number">Number</a> firstRow, <a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="argument methodClicker" title="Number" data-id="Number">Number</a> lastRow</span>)</li>
  127. </ul>
  128. <ul class="metaInfo">
  129. </ul>
  130. </li>
  131. </ul>
  132. </div>
  133. <div class="sideToggler">
  134. <div id="ellipsis_BackgroundTokenizer.fireUpdateEvent" class="ellipsis_description"><p>Emits the <code>&#39;update&#39;</code> event. <code>firstRow</code> and <code>lastRow</code> are used to define the boundaries of the region to be updated.</p>
  135. </div>
  136. <div class="description"><p>Emits the <code>&#39;update&#39;</code> event. <code>firstRow</code> and <code>lastRow</code> are used to define the boundaries of the region to be updated.</p>
  137. <h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"><tr class="argumentRow "><td class="argName ">firstRow</td><td class="argType" "><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="" title="Number" data-id="Number">Number</a></td><td class="argDescription "><p>Required. The starting row region</p>
  138. </td></tr><tr class="argumentRow "><td class="argName ">lastRow</td><td class="argType" "><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="" title="Number" data-id="Number">Number</a></td><td class="argDescription "><p>Required. The final row region</p>
  139. </td></tr></table>
  140. </div>
  141. </div>
  142. </div>
  143. </div>
  144. </article>
  145. <article id="BackgroundTokenizer.getState" data-title="BackgroundTokenizer.getState (class method)" class="article">
  146. <div class="section method">
  147. <div class="memberContent">
  148. <div class="title"><i id="BackgroundTokenizer.getState" class="methodToggle methodClicker inactive icon-caret-right"></i>
  149. <ul class="signatures">
  150. <li class="signature">
  151. <ul>
  152. <li class="signature-call"><span id="BackgroundTokenizer.getState" class="member-name methodClicker"><span class="sigClassName">BackgroundTokenizer.</span><span class="sigMemberName">getState</span></span>(<span class="sigArgList"><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="argument methodClicker" title="Number" data-id="Number">Number</a> row</span>)</li>
  153. </ul>
  154. <ul class="metaInfo">
  155. </ul>
  156. </li>
  157. </ul>
  158. </div>
  159. <div class="sideToggler">
  160. <div id="ellipsis_BackgroundTokenizer.getState" class="ellipsis_description"><p>Returns the state of tokenization at the end of a row.</p>
  161. </div>
  162. <div class="description"><p>Returns the state of tokenization at the end of a row.</p>
  163. <h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"><tr class="argumentRow "><td class="argName ">row</td><td class="argType" "><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="" title="Number" data-id="Number">Number</a></td><td class="argDescription "><p>Required. The row to get state at</p>
  164. </td></tr></table>
  165. </div>
  166. </div>
  167. </div>
  168. </div>
  169. </article>
  170. <article id="BackgroundTokenizer.getTokens" data-title="BackgroundTokenizer.getTokens (class method)" class="article">
  171. <div class="section method">
  172. <div class="memberContent">
  173. <div class="title"><i id="BackgroundTokenizer.getTokens" 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="BackgroundTokenizer.getTokens" class="member-name methodClicker"><span class="sigClassName">BackgroundTokenizer.</span><span class="sigMemberName">getTokens</span></span>(<span class="sigArgList"><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="argument methodClicker" title="Number" data-id="Number">Number</a> row</span>)</li>
  178. </ul>
  179. <ul class="metaInfo">
  180. </ul>
  181. </li>
  182. </ul>
  183. </div>
  184. <div class="sideToggler">
  185. <div id="ellipsis_BackgroundTokenizer.getTokens" class="ellipsis_description"><p>Gives list of tokens of the row. (tokens are cached)</p>
  186. </div>
  187. <div class="description"><p>Gives list of tokens of the row. (tokens are cached)</p>
  188. <h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"><tr class="argumentRow "><td class="argName ">row</td><td class="argType" "><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="" title="Number" data-id="Number">Number</a></td><td class="argDescription "><p>Required. The row to get tokens at</p>
  189. </td></tr></table>
  190. </div>
  191. </div>
  192. </div>
  193. </div>
  194. </article>
  195. <article id="BackgroundTokenizer.setDocument" data-title="BackgroundTokenizer.setDocument (class method)" class="article">
  196. <div class="section method">
  197. <div class="memberContent">
  198. <div class="title"><i id="BackgroundTokenizer.setDocument" 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="BackgroundTokenizer.setDocument" class="member-name methodClicker"><span class="sigClassName">BackgroundTokenizer.</span><span class="sigMemberName">setDocument</span></span>(<span class="sigArgList"><a href="document.html" class="argument methodClicker" title="Document (class)" data-id="Document">Document</a> doc</span>)</li>
  203. </ul>
  204. <ul class="metaInfo">
  205. </ul>
  206. </li>
  207. </ul>
  208. </div>
  209. <div class="sideToggler">
  210. <div id="ellipsis_BackgroundTokenizer.setDocument" class="ellipsis_description"><p>Sets a new document to associate with this object.</p>
  211. </div>
  212. <div class="description"><p>Sets a new document to associate with this object.</p>
  213. <h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"><tr class="argumentRow "><td class="argName ">doc</td><td class="argType" "><a href="document.html" class="" title="Document (class)" data-id="Document">Document</a></td><td class="argDescription "><p>Required. The new document to associate with</p>
  214. </td></tr></table>
  215. </div>
  216. </div>
  217. </div>
  218. </div>
  219. </article>
  220. <article id="BackgroundTokenizer.setTokenizer" data-title="BackgroundTokenizer.setTokenizer (class method)" class="article">
  221. <div class="section method">
  222. <div class="memberContent">
  223. <div class="title"><i id="BackgroundTokenizer.setTokenizer" class="methodToggle methodClicker inactive icon-caret-right"></i>
  224. <ul class="signatures">
  225. <li class="signature">
  226. <ul>
  227. <li class="signature-call"><span id="BackgroundTokenizer.setTokenizer" class="member-name methodClicker"><span class="sigClassName">BackgroundTokenizer.</span><span class="sigMemberName">setTokenizer</span></span>(<span class="sigArgList"><a href="tokenizer.html" class="argument methodClicker" title="Tokenizer (class)" data-id="Tokenizer">Tokenizer</a> tokenizer</span>)</li>
  228. </ul>
  229. <ul class="metaInfo">
  230. </ul>
  231. </li>
  232. </ul>
  233. </div>
  234. <div class="sideToggler">
  235. <div id="ellipsis_BackgroundTokenizer.setTokenizer" class="ellipsis_description"><p>Sets a new tokenizer for this object.</p>
  236. </div>
  237. <div class="description"><p>Sets a new tokenizer for this object.</p>
  238. <h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"><tr class="argumentRow "><td class="argName ">tokenizer</td><td class="argType" "><a href="tokenizer.html" class="" title="Tokenizer (class)" data-id="Tokenizer">Tokenizer</a></td><td class="argDescription "><p>Required. The new tokenizer to use</p>
  239. </td></tr></table>
  240. </div>
  241. </div>
  242. </div>
  243. </div>
  244. </article>
  245. <article id="BackgroundTokenizer.start" data-title="BackgroundTokenizer.start (class method)" class="article">
  246. <div class="section method">
  247. <div class="memberContent">
  248. <div class="title"><i id="BackgroundTokenizer.start" class="methodToggle methodClicker inactive icon-caret-right"></i>
  249. <ul class="signatures">
  250. <li class="signature">
  251. <ul>
  252. <li class="signature-call"><span id="BackgroundTokenizer.start" class="member-name methodClicker"><span class="sigClassName">BackgroundTokenizer.</span><span class="sigMemberName">start</span></span>(<span class="sigArgList"><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="argument methodClicker" title="Number" data-id="Number">Number</a> startRow</span>)</li>
  253. </ul>
  254. <ul class="metaInfo">
  255. </ul>
  256. </li>
  257. </ul>
  258. </div>
  259. <div class="sideToggler">
  260. <div id="ellipsis_BackgroundTokenizer.start" class="ellipsis_description"><p>Starts tokenizing at the row indicated.</p>
  261. </div>
  262. <div class="description"><p>Starts tokenizing at the row indicated.</p>
  263. <h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"><tr class="argumentRow "><td class="argName ">startRow</td><td class="argType" "><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="" title="Number" data-id="Number">Number</a></td><td class="argDescription "><p>Required. The row to start at</p>
  264. </td></tr></table>
  265. </div>
  266. </div>
  267. </div>
  268. </div>
  269. </article>
  270. <article id="BackgroundTokenizer.stop" data-title="BackgroundTokenizer.stop (class method)" class="article">
  271. <div class="section method">
  272. <div class="memberContent">
  273. <div class="title"><i id="BackgroundTokenizer.stop" class="methodToggle methodClicker inactive icon-caret-right"></i>
  274. <ul class="signatures">
  275. <li class="signature">
  276. <ul>
  277. <li class="signature-call"><span id="BackgroundTokenizer.stop" class="member-name methodClicker"><span class="sigClassName">BackgroundTokenizer.</span><span class="sigMemberName">stop</span></span><span class="emptyArgumentList">()</span></li>
  278. </ul>
  279. <ul class="metaInfo">
  280. </ul>
  281. </li>
  282. </ul>
  283. </div>
  284. <div class="sideToggler">
  285. <div id="ellipsis_BackgroundTokenizer.stop" class="ellipsis_description"><p>Stops tokenizing.</p>
  286. </div>
  287. <div class="description"><p>Stops tokenizing.</p>
  288. </div>
  289. </div>
  290. </div>
  291. </div>
  292. </article>
  293. </div>
  294. <script defer src="./resources/javascripts/ux.js"></script>
  295. <script src="./resources/javascripts/clicker.js"></script>
  296. <script src="./resources/javascripts/jquery-scrollspy.js"></script>
  297. <script defer src="./resources/javascripts/disqus-ext.js"></script>
  298. <script defer src="./resources/javascripts/ga.js"></script>
  299. <div id="disqus_thread"></div>
  300. </div>