search.html 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295
  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">Search</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_Search.new" data-id="Search.new" class="memberLink"><a href="#Search.new" class="" title="Search.new (constructor)" data-id="Search.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_Search.find" data-id="Search.find" class="memberLink"><a href="#Search.find" class="" title="Search.find (class method)" data-id="Search.find">find</a>
  22. </li>
  23. <li id="dropdown_Search.findAll" data-id="Search.findAll" class="memberLink"><a href="#Search.findAll" class="" title="Search.findAll (class method)" data-id="Search.findAll">findAll</a>
  24. </li>
  25. <li id="dropdown_Search.getOptions" data-id="Search.getOptions" class="memberLink"><a href="#Search.getOptions" class="" title="Search.getOptions (class method)" data-id="Search.getOptions">getOptions</a>
  26. </li>
  27. <li id="dropdown_Search.replace" data-id="Search.replace" class="memberLink"><a href="#Search.replace" class="" title="Search.replace (class method)" data-id="Search.replace">replace</a>
  28. </li>
  29. <li id="dropdown_Search.set" data-id="Search.set" class="memberLink"><a href="#Search.set" class="" title="Search.set (class method)" data-id="Search.set">set</a>
  30. </li>
  31. <li id="dropdown_Search.setOptions" data-id="Search.setOptions" class="memberLink"><a href="#Search.setOptions" class="" title="Search.setOptions (class method)" data-id="Search.setOptions">setOptions</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="Search" data-title="Search (class)" class="article">
  55. <div class="section description">
  56. <div class="memberContent"><p>A class designed to handle all sorts of text searches within a <a href="document.html" class="link-short" title="Document (class)" data-id="Document"><code>Document</code></a>.</p>
  57. </div>
  58. </div>
  59. </article>
  60. <h3 class="sectionHeader">Constructors</h3>
  61. <article id="Search.new" data-title="Search.new (constructor)" class="article">
  62. <div class="section method">
  63. <div class="memberContent">
  64. <div class="title"><i id="Search.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="Search.new" class="member-name methodClicker">Search</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_Search.new" class="ellipsis_description"><p>Creates a new <code>Search</code> object. The following search options are avaliable:</p>
  77. </div>
  78. <div class="description"><p>Creates a new <code>Search</code> object. The following search options are avaliable:</p>
  79. <ul>
  80. <li><code>needle</code>: The string or regular expression you&#39;re looking for</li>
  81. <li><code>backwards</code>: Whether to search backwards from where cursor currently is. Defaults to <code>false</code>.</li>
  82. <li><code>wrap</code>: Whether to wrap the search back to the beginning when it hits the end. Defaults to <code>false</code>.</li>
  83. <li><code>caseSensitive</code>: Whether the search ought to be case-sensitive. Defaults to <code>false</code>.</li>
  84. <li><code>wholeWord</code>: Whether the search matches only on whole words. Defaults to <code>false</code>.</li>
  85. <li><code>range</code>: The <a href="range.html" class="link-short" title="Range (class)" data-id="Range"><code>Range</code></a> to search within. Set this to <code>null</code> for the whole document</li>
  86. <li><code>regExp</code>: Whether the search is a regular expression or not. Defaults to <code>false</code>.</li>
  87. <li><code>start</code>: The starting <a href="range.html" class="link-short" title="Range (class)" data-id="Range"><code>Range</code></a> or cursor position to begin the search</li>
  88. <li><code>skipCurrent</code>: Whether or not to include the current line in the search. Default to <code>false</code>.</li>
  89. </ul>
  90. </div>
  91. </div>
  92. </div>
  93. </div>
  94. </article>
  95. <h3 class="sectionHeader">Methods</h3>
  96. <article id="Search.find" data-title="Search.find (class method)" class="article">
  97. <div class="section method">
  98. <div class="memberContent">
  99. <div class="title"><i id="Search.find" class="methodToggle methodClicker inactive icon-caret-right"></i>
  100. <ul class="signatures">
  101. <li class="signature">
  102. <ul>
  103. <li class="signature-call"><span id="Search.find" class="member-name methodClicker"><span class="sigClassName">Search.</span><span class="sigMemberName">find</span></span>(<span class="sigArgList"><a href="edit_session.html" class="argument methodClicker" title="EditSession (class)" data-id="EditSession">EditSession</a> session</span>)
  104. <li class="signature-returns">
  105. <ul class="argument-types">
  106. <li class="argument-type"><a href="range.html" class="returnType " title="Range (class)" data-id="Range">Range</a></li>
  107. </ul>
  108. </li></li>
  109. </ul>
  110. <ul class="metaInfo">
  111. </ul>
  112. </li>
  113. </ul>
  114. </div>
  115. <div class="sideToggler">
  116. <div id="ellipsis_Search.find" class="ellipsis_description"><p>Searches for <code>options.needle</code>. If found, this method returns the <a href="range.html" class="link-short" title="Range (class)" data-id="Range"><code>Range</code></a> where the text first occurs. If <code>options.backwards</code> is <code>true</code>, the search goes backwards in the session.</p>
  117. </div>
  118. <div class="description"><p>Searches for <code>options.needle</code>. If found, this method returns the <a href="range.html" class="link-short" title="Range (class)" data-id="Range"><code>Range</code></a> where the text first occurs. If <code>options.backwards</code> is <code>true</code>, the search goes backwards in the session.</p>
  119. <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 search with</p>
  120. </td></tr></table>
  121. </div>
  122. </div>
  123. </div>
  124. </div>
  125. </article>
  126. <article id="Search.findAll" data-title="Search.findAll (class method)" class="article">
  127. <div class="section method">
  128. <div class="memberContent">
  129. <div class="title"><i id="Search.findAll" class="methodToggle methodClicker inactive icon-caret-right"></i>
  130. <ul class="signatures">
  131. <li class="signature">
  132. <ul>
  133. <li class="signature-call"><span id="Search.findAll" class="member-name methodClicker"><span class="sigClassName">Search.</span><span class="sigMemberName">findAll</span></span>(<span class="sigArgList"><a href="edit_session.html" class="argument methodClicker" title="EditSession (class)" data-id="EditSession">EditSession</a> session</span>)
  134. <li class="signature-returns">
  135. <ul class="argument-types">
  136. <li class="argument-type"><a href="range.html" class="returnType " title="Range (class)" data-id="Range">Range</a></li>
  137. </ul>
  138. </li></li>
  139. </ul>
  140. <ul class="metaInfo">
  141. </ul>
  142. </li>
  143. </ul>
  144. </div>
  145. <div class="sideToggler">
  146. <div id="ellipsis_Search.findAll" class="ellipsis_description"><p>Searches for all occurances <code>options.needle</code>. If found, this method returns an array of <a href="range.html" class="link-short" title="Range (class)" data-id="Range"><code>Range</code>s</a> where the text first occurs. If <code>options.backwards</code> is <code>true</code>, the search goes backwards in the session.</p>
  147. </div>
  148. <div class="description"><p>Searches for all occurances <code>options.needle</code>. If found, this method returns an array of <a href="range.html" class="link-short" title="Range (class)" data-id="Range"><code>Range</code>s</a> where the text first occurs. If <code>options.backwards</code> is <code>true</code>, the search goes backwards in the session.</p>
  149. <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 search with</p>
  150. </td></tr></table>
  151. </div>
  152. </div>
  153. </div>
  154. </div>
  155. </article>
  156. <article id="Search.getOptions" data-title="Search.getOptions (class method)" class="article">
  157. <div class="section method">
  158. <div class="memberContent">
  159. <div class="title"><i id="Search.getOptions" class="methodToggle methodClicker inactive icon-caret-right"></i>
  160. <ul class="signatures">
  161. <li class="signature">
  162. <ul>
  163. <li class="signature-call"><span id="Search.getOptions" class="member-name methodClicker"><span class="sigClassName">Search.</span><span class="sigMemberName">getOptions</span></span><span class="emptyArgumentList">()</span>
  164. <li class="signature-returns">
  165. <ul class="argument-types">
  166. <li class="argument-type"><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Object" class="returnType " title="Object" data-id="Object">Object</a></li>
  167. </ul>
  168. </li></li>
  169. </ul>
  170. <ul class="metaInfo">
  171. </ul>
  172. </li>
  173. </ul>
  174. </div>
  175. <div class="sideToggler">
  176. <div id="ellipsis_Search.getOptions" class="ellipsis_description"><p>Returns an object containing all the search options.</p>
  177. </div>
  178. <div class="description"><p>Returns an object containing all the search options.</p>
  179. </div>
  180. </div>
  181. </div>
  182. </div>
  183. </article>
  184. <article id="Search.replace" data-title="Search.replace (class method)" class="article">
  185. <div class="section method">
  186. <div class="memberContent">
  187. <div class="title"><i id="Search.replace" class="methodToggle methodClicker inactive icon-caret-right"></i>
  188. <ul class="signatures">
  189. <li class="signature">
  190. <ul>
  191. <li class="signature-call"><span id="Search.replace" class="member-name methodClicker"><span class="sigClassName">Search.</span><span class="sigMemberName">replace</span></span>(<span class="sigArgList"><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/String" class="argument methodClicker" title="String" data-id="String">String</a> input, <a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/String" class="argument methodClicker" title="String" data-id="String">String</a> replacement</span>)
  192. <li class="signature-returns">
  193. <ul class="argument-types">
  194. <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>
  195. </ul>
  196. </li></li>
  197. </ul>
  198. <ul class="metaInfo">
  199. </ul>
  200. </li>
  201. </ul>
  202. </div>
  203. <div class="sideToggler">
  204. <div id="ellipsis_Search.replace" class="ellipsis_description"><p>Searches for <code>options.needle</code> in <code>input</code>, and, if found, replaces it with <code>replacement</code>.</p>
  205. </div>
  206. <div class="description"><p>Searches for <code>options.needle</code> in <code>input</code>, and, if found, replaces it with <code>replacement</code>.</p>
  207. <h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"><tr class="argumentRow "><td class="argName ">input</td><td class="argType" "><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/String" class="" title="String" data-id="String">String</a></td><td class="argDescription "><p>Required. The text to search in</p>
  208. </td></tr><tr class="argumentRow "><td class="argName ">replacement</td><td class="argType" "><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/String" class="" title="String" data-id="String">String</a></td><td class="argDescription "><p>Required. The replacing text</p>
  209. <ul>
  210. <li>(String): If <code>options.regExp</code> is <code>true</code>, this function returns <code>input</code> with the replacement already made. Otherwise, this function just returns <code>replacement</code>.<br/>
  211. If <code>options.needle</code> was not found, this function returns <code>null</code>.</li>
  212. </ul>
  213. </td></tr></table>
  214. </div>
  215. </div>
  216. </div>
  217. </div>
  218. </article>
  219. <article id="Search.set" data-title="Search.set (class method)" class="article">
  220. <div class="section method">
  221. <div class="memberContent">
  222. <div class="title"><i id="Search.set" class="methodToggle methodClicker inactive icon-caret-right"></i>
  223. <ul class="signatures">
  224. <li class="signature">
  225. <ul>
  226. <li class="signature-call"><span id="Search.set" class="member-name methodClicker"><span class="sigClassName">Search.</span><span class="sigMemberName">set</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>)
  227. <li class="signature-returns">
  228. <ul class="argument-types">
  229. <li class="argument-type"><a href="search.html" class="returnType " title="Search (class)" data-id="Search">Search</a></li>
  230. </ul>
  231. </li></li>
  232. </ul>
  233. <ul class="metaInfo">
  234. <li><span class="label chainable">Chainable</span></li>
  235. </ul>
  236. </li>
  237. </ul>
  238. </div>
  239. <div class="sideToggler">
  240. <div id="ellipsis_Search.set" class="ellipsis_description"><p>Sets the search options via the <code>options</code> parameter.</p>
  241. </div>
  242. <div class="description"><p>Sets the search options via the <code>options</code> parameter.</p>
  243. <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. An object containing all the new search properties</p>
  244. </td></tr></table>
  245. </div>
  246. </div>
  247. </div>
  248. </div>
  249. </article>
  250. <article id="Search.setOptions" data-title="Search.setOptions (class method)" class="article">
  251. <div class="section method">
  252. <div class="memberContent">
  253. <div class="title"><i id="Search.setOptions" class="methodToggle methodClicker inactive icon-caret-right"></i>
  254. <ul class="signatures">
  255. <li class="signature">
  256. <ul>
  257. <li class="signature-call"><span id="Search.setOptions" class="member-name methodClicker"><span class="sigClassName">Search.</span><span class="sigMemberName">setOptions</span></span><span class="emptyArgumentList">()</span></li>
  258. </ul>
  259. <ul class="metaInfo">
  260. <li><span class="label undocumented">Undocumented</span></li>
  261. </ul>
  262. </li>
  263. </ul>
  264. </div>
  265. <div class="sideToggler">
  266. <div id="ellipsis_Search.setOptions" class="ellipsis_description">
  267. </div>
  268. <div class="description">
  269. </div>
  270. </div>
  271. </div>
  272. </div>
  273. </article>
  274. </div>
  275. <script defer src="./resources/javascripts/ux.js"></script>
  276. <script src="./resources/javascripts/clicker.js"></script>
  277. <script src="./resources/javascripts/jquery-scrollspy.js"></script>
  278. <script defer src="./resources/javascripts/disqus-ext.js"></script>
  279. <script defer src="./resources/javascripts/ga.js"></script>
  280. <div id="disqus_thread"></div>
  281. </div>