token_iterator.html 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248
  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">TokenIterator</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_TokenIterator.new" data-id="TokenIterator.new" class="memberLink"><a href="#TokenIterator.new" class="" title="TokenIterator.new (constructor)" data-id="TokenIterator.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 (5)</span><b class="caret"></b></a>
  20. <ul class="dropdown-menu">
  21. <li id="dropdown_TokenIterator.getCurrentToken" data-id="TokenIterator.getCurrentToken" class="memberLink"><a href="#TokenIterator.getCurrentToken" class="" title="TokenIterator.getCurrentToken (class method)" data-id="TokenIterator.getCurrentToken">getCurrentToken</a>
  22. </li>
  23. <li id="dropdown_TokenIterator.getCurrentTokenColumn" data-id="TokenIterator.getCurrentTokenColumn" class="memberLink"><a href="#TokenIterator.getCurrentTokenColumn" class="" title="TokenIterator.getCurrentTokenColumn (class method)" data-id="TokenIterator.getCurrentTokenColumn">getCurrentTokenColumn</a>
  24. </li>
  25. <li id="dropdown_TokenIterator.getCurrentTokenRow" data-id="TokenIterator.getCurrentTokenRow" class="memberLink"><a href="#TokenIterator.getCurrentTokenRow" class="" title="TokenIterator.getCurrentTokenRow (class method)" data-id="TokenIterator.getCurrentTokenRow">getCurrentTokenRow</a>
  26. </li>
  27. <li id="dropdown_TokenIterator.stepBackward" data-id="TokenIterator.stepBackward" class="memberLink"><a href="#TokenIterator.stepBackward" class="" title="TokenIterator.stepBackward (class method)" data-id="TokenIterator.stepBackward">stepBackward</a>
  28. </li>
  29. <li id="dropdown_TokenIterator.stepForward" data-id="TokenIterator.stepForward" class="memberLink"><a href="#TokenIterator.stepForward" class="" title="TokenIterator.stepForward (class method)" data-id="TokenIterator.stepForward">stepForward</a>
  30. </li>
  31. </ul>
  32. </li>
  33. <li data-dropdown="dropdown" class="dropdown">
  34. <ul class="dropdown-menu">
  35. </ul>
  36. </li>
  37. <li data-dropdown="dropdown" class="dropdown">
  38. <ul class="dropdown-menu">
  39. </ul>
  40. </li>
  41. <li data-dropdown="dropdown" class="dropdown">
  42. <ul class="dropdown-menu">
  43. </ul>
  44. </li>
  45. <li data-dropdown="dropdown" class="dropdown">
  46. <ul class="dropdown-menu">
  47. </ul>
  48. </li>
  49. </ul>
  50. </div>
  51. </div>
  52. <article id="TokenIterator" data-title="TokenIterator (class)" class="article">
  53. <div class="section description">
  54. <div class="memberContent"><p>This class provides an essay way to treat the document as a stream of tokens, and provides methods to iterate over these tokens.</p>
  55. </div>
  56. </div>
  57. </article>
  58. <h3 class="sectionHeader">Constructors</h3>
  59. <article id="TokenIterator.new" data-title="TokenIterator.new (constructor)" class="article">
  60. <div class="section method">
  61. <div class="memberContent">
  62. <div class="title"><i id="TokenIterator.new" class="methodToggle methodClicker inactive icon-caret-right"></i>
  63. <ul class="signatures">
  64. <li class="signature">
  65. <ul>
  66. <li class="signature-call"><span class="constructorIdentifier">new </span><span id="TokenIterator.new" class="member-name methodClicker">TokenIterator</span>(<span class="sigArgList"><a href="edit_session.html" class="argument methodClicker" title="EditSession (class)" data-id="EditSession">EditSession</a> session, <a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="argument methodClicker" title="Number" data-id="Number">Number</a> initialRow, <a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="argument methodClicker" title="Number" data-id="Number">Number</a> initialColumn</span>)</li>
  67. </ul>
  68. <ul class="metaInfo">
  69. </ul>
  70. </li>
  71. </ul>
  72. </div>
  73. <div class="sideToggler">
  74. <div id="ellipsis_TokenIterator.new" class="ellipsis_description"><p>Creates a new token iterator object. The inital token index is set to the provided row and column coordinates.</p>
  75. </div>
  76. <div class="description"><p>Creates a new token iterator object. The inital token index is set to the provided row and column coordinates.</p>
  77. <h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"><tr class="argumentRow "><td class="argName ">session</td><td class="argType" "><a href="edit_session.html" class="" title="EditSession (class)" data-id="EditSession">EditSession</a></td><td class="argDescription "><p>Required. The session to associate with</p>
  78. </td></tr><tr class="argumentRow "><td class="argName ">initialRow</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 the tokenizing at</p>
  79. </td></tr><tr class="argumentRow "><td class="argName ">initialColumn</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 column to start the tokenizing at</p>
  80. </td></tr></table>
  81. </div>
  82. </div>
  83. </div>
  84. </div>
  85. </article>
  86. <h3 class="sectionHeader">Methods</h3>
  87. <article id="TokenIterator.getCurrentToken" data-title="TokenIterator.getCurrentToken (class method)" class="article">
  88. <div class="section method">
  89. <div class="memberContent">
  90. <div class="title"><i id="TokenIterator.getCurrentToken" class="methodToggle methodClicker inactive icon-caret-right"></i>
  91. <ul class="signatures">
  92. <li class="signature">
  93. <ul>
  94. <li class="signature-call"><span id="TokenIterator.getCurrentToken" class="member-name methodClicker"><span class="sigClassName">TokenIterator.</span><span class="sigMemberName">getCurrentToken</span></span><span class="emptyArgumentList">()</span>
  95. <li class="signature-returns">
  96. <ul class="argument-types">
  97. <li class="argument-type"><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/String" class="returnType " title="String" data-id="String">String</a></li>
  98. </ul>
  99. </li></li>
  100. </ul>
  101. <ul class="metaInfo">
  102. </ul>
  103. </li>
  104. </ul>
  105. </div>
  106. <div class="sideToggler">
  107. <div id="ellipsis_TokenIterator.getCurrentToken" class="ellipsis_description"><p>Returns the current tokenized string.</p>
  108. </div>
  109. <div class="description"><p>Returns the current tokenized string.</p>
  110. </div>
  111. </div>
  112. </div>
  113. </div>
  114. </article>
  115. <article id="TokenIterator.getCurrentTokenColumn" data-title="TokenIterator.getCurrentTokenColumn (class method)" class="article">
  116. <div class="section method">
  117. <div class="memberContent">
  118. <div class="title"><i id="TokenIterator.getCurrentTokenColumn" class="methodToggle methodClicker inactive icon-caret-right"></i>
  119. <ul class="signatures">
  120. <li class="signature">
  121. <ul>
  122. <li class="signature-call"><span id="TokenIterator.getCurrentTokenColumn" class="member-name methodClicker"><span class="sigClassName">TokenIterator.</span><span class="sigMemberName">getCurrentTokenColumn</span></span><span class="emptyArgumentList">()</span>
  123. <li class="signature-returns">
  124. <ul class="argument-types">
  125. <li class="argument-type"><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="returnType " title="Number" data-id="Number">Number</a></li>
  126. </ul>
  127. </li></li>
  128. </ul>
  129. <ul class="metaInfo">
  130. </ul>
  131. </li>
  132. </ul>
  133. </div>
  134. <div class="sideToggler">
  135. <div id="ellipsis_TokenIterator.getCurrentTokenColumn" class="ellipsis_description"><p>Returns the current column.</p>
  136. </div>
  137. <div class="description"><p>Returns the current column.</p>
  138. </div>
  139. </div>
  140. </div>
  141. </div>
  142. </article>
  143. <article id="TokenIterator.getCurrentTokenRow" data-title="TokenIterator.getCurrentTokenRow (class method)" class="article">
  144. <div class="section method">
  145. <div class="memberContent">
  146. <div class="title"><i id="TokenIterator.getCurrentTokenRow" class="methodToggle methodClicker inactive icon-caret-right"></i>
  147. <ul class="signatures">
  148. <li class="signature">
  149. <ul>
  150. <li class="signature-call"><span id="TokenIterator.getCurrentTokenRow" class="member-name methodClicker"><span class="sigClassName">TokenIterator.</span><span class="sigMemberName">getCurrentTokenRow</span></span><span class="emptyArgumentList">()</span>
  151. <li class="signature-returns">
  152. <ul class="argument-types">
  153. <li class="argument-type"><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="returnType " title="Number" data-id="Number">Number</a></li>
  154. </ul>
  155. </li></li>
  156. </ul>
  157. <ul class="metaInfo">
  158. </ul>
  159. </li>
  160. </ul>
  161. </div>
  162. <div class="sideToggler">
  163. <div id="ellipsis_TokenIterator.getCurrentTokenRow" class="ellipsis_description"><p>Returns the current row.</p>
  164. </div>
  165. <div class="description"><p>Returns the current row.</p>
  166. </div>
  167. </div>
  168. </div>
  169. </div>
  170. </article>
  171. <article id="TokenIterator.stepBackward" data-title="TokenIterator.stepBackward (class method)" class="article">
  172. <div class="section method">
  173. <div class="memberContent">
  174. <div class="title"><i id="TokenIterator.stepBackward" class="methodToggle methodClicker inactive icon-caret-right"></i>
  175. <ul class="signatures">
  176. <li class="signature">
  177. <ul>
  178. <li class="signature-call"><span id="TokenIterator.stepBackward" class="member-name methodClicker"><span class="sigClassName">TokenIterator.</span><span class="sigMemberName">stepBackward</span></span><span class="emptyArgumentList">()</span>
  179. <li class="signature-returns">
  180. <ul class="argument-types">
  181. <li class="argument-type"><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/String" class="returnType " title="String" data-id="String">String</a></li>
  182. </ul>
  183. </li></li>
  184. </ul>
  185. <ul class="metaInfo">
  186. </ul>
  187. </li>
  188. </ul>
  189. </div>
  190. <div class="sideToggler">
  191. <div id="ellipsis_TokenIterator.stepBackward" class="ellipsis_description"><p>Tokenizes all the items from the current point to the row prior in the document.</p>
  192. </div>
  193. <div class="description"><p>Tokenizes all the items from the current point to the row prior in the document.</p>
  194. </div>
  195. </div>
  196. </div>
  197. </div>
  198. </article>
  199. <article id="TokenIterator.stepForward" data-title="TokenIterator.stepForward (class method)" class="article">
  200. <div class="section method">
  201. <div class="memberContent">
  202. <div class="title"><i id="TokenIterator.stepForward" class="methodToggle methodClicker inactive icon-caret-right"></i>
  203. <ul class="signatures">
  204. <li class="signature">
  205. <ul>
  206. <li class="signature-call"><span id="TokenIterator.stepForward" class="member-name methodClicker"><span class="sigClassName">TokenIterator.</span><span class="sigMemberName">stepForward</span></span><span class="emptyArgumentList">()</span>
  207. <li class="signature-returns">
  208. <ul class="argument-types">
  209. <li class="argument-type"><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/String" class="returnType " title="String" data-id="String">String</a></li>
  210. </ul>
  211. </li></li>
  212. </ul>
  213. <ul class="metaInfo">
  214. </ul>
  215. </li>
  216. </ul>
  217. </div>
  218. <div class="sideToggler">
  219. <div id="ellipsis_TokenIterator.stepForward" class="ellipsis_description"><p>Tokenizes all the items from the current point until the next row in the document. If the current point is at the end of the file, this function returns <code>null</code>. Otherwise, it returns the tokenized string.</p>
  220. </div>
  221. <div class="description"><p>Tokenizes all the items from the current point until the next row in the document. If the current point is at the end of the file, this function returns <code>null</code>. Otherwise, it returns the tokenized string.</p>
  222. </div>
  223. </div>
  224. </div>
  225. </div>
  226. </article>
  227. </div>
  228. <script defer src="./resources/javascripts/ux.js"></script>
  229. <script src="./resources/javascripts/clicker.js"></script>
  230. <script src="./resources/javascripts/jquery-scrollspy.js"></script>
  231. <script defer src="./resources/javascripts/disqus-ext.js"></script>
  232. <script defer src="./resources/javascripts/ga.js"></script>
  233. <div id="disqus_thread"></div>
  234. </div>