ace/api/search.html

<div id="documentation" class="span8"><div class="classContent"><div class="membersBackground"></div><div class=" members pos0"><div class=" membersContent pos0"><h1 class="memberHeader"><span class="name">Search<span class="editInC9"> <a href='http://c9.io/open/git/?url=git%3A%2F%2Fgithub.com%2Fajaxorg%2Face.git' title='Edit in Cloud9 IDE'>[edit]</a></span></span></h1><ul data-tabs="tabs" class="nav tabs pos0"><li data-dropdown="dropdown" class="dropdown"><ul class="dropdown-menu"></ul></li><li data-dropdown="dropdown" class="dropdown"><a href="#" data-toggle="dropdown" class="dropdown-toggle"><span>Constructors (1)</span><b class="caret"></b></a><ul class="dropdown-menu"><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></li></ul></li><li data-dropdown="dropdown" class="dropdown"><a href="#" data-toggle="dropdown" class="dropdown-toggle"><span>Functions (6)</span><b class="caret"></b></a><ul class="dropdown-menu"><li id="dropdown_Search.$matchIterator" data-id="Search.$matchIterator" class="memberLink"><a href="#Search.$matchIterator" class="" title="Search.$matchIterator (class method)" data-id="Search.$matchIterator">$matchIterator</a></li><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></li><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></li><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></li><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></li><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></li></ul></li><li data-dropdown="dropdown" class="dropdown"><ul class="dropdown-menu"></ul></li><li data-dropdown="dropdown" class="dropdown"><ul class="dropdown-menu"></ul></li><li data-dropdown="dropdown" class="dropdown"><ul class="dropdown-menu"></ul></li><li data-dropdown="dropdown" class="dropdown"><ul class="dropdown-menu"></ul></li></ul></div></div><article id="Search" data-title="Search (class)" class="article"><div class="section description"><div class="memberContent"><p>A class designed to handle all sorts of text searches within a <a href="#nav=api&api=document" class="link-short" title="Document (class)" data-id="Document"><code>Document</code></a>.</p>
</div></div></article><h3 class="sectionHeader">Constructors</h3><article id="Search.new" data-title="Search.new (constructor)" class="article"><div class="section method"><div class="memberContent"><div class="title"><i id="Search.new" class="methodToggle methodClicker inactive icon-caret-right"></i><ul class="signatures"><li class="signature"><ul><li class="signature-call"><span class="constructorIdentifier">new </span><span id="Search.new" class="member-name methodClicker">Search</span>(<span class="sigArgList"></span>)</li></ul><ul class="metaInfo"></ul></li></ul></div><div class="sideToggler"><div id="ellipsis_Search.new" class="ellipsis_description"><p>Creates a new <code>Search</code> object. The following search options are avaliable:</p>
</div><div class="description"><p>Creates a new <code>Search</code> object. The following search options are avaliable:</p>
<ul>
<li><code>needle</code>: The string or regular expression you&#39;re looking for</li>
<li><code>backwards</code>: Whether to search backwards from where cursor currently is. Defaults to <code>false</code>.</li>
<li><code>wrap</code>: Whether to wrap the search back to the beginning when it hits the end. Defaults to <code>false</code>.</li>
<li><code>caseSensitive</code>: Whether the search ought to be case-sensitive. Defaults to <code>false</code>.</li>
<li><code>wholeWord</code>: Whether the search matches only on whole words. Defaults to <code>false</code>.</li>
<li><code>range</code>: The <a href="#nav=api&api=range" 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>
<li><code>regExp</code>: Whether the search is a regular expression or not. Defaults to <code>false</code>.</li>
<li><code>start</code>: The starting <a href="#nav=api&api=range" class="link-short" title="Range (class)" data-id="Range"><code>Range</code></a> or cursor position to begin the search</li>
<li><code>skipCurrent</code>: Whether or not to include the current line in the search. Default to <code>false</code>.</li>
</ul>
</div></div></div></div></article><h3 class="sectionHeader">Methods</h3><article id="Search.$matchIterator" data-title="Search.$matchIterator (class method)" class="article"><div class="section method"><div class="memberContent"><div class="title"><i id="Search.$matchIterator" class="methodToggle methodClicker inactive icon-caret-right"></i><ul class="signatures"><li class="signature"><ul><li class="signature-call"><span id="Search.$matchIterator" class="member-name methodClicker"><span class="sigClassName">Search.</span><span class="sigMemberName">$matchIterator</span></span>(<span class="sigArgList"><a href="#nav=api&api=edit_session" class="argument methodClicker" title="EditSession (class)" data-id="EditSession">EditSession</a> session</span>)<li class="signature-returns"><ul class="argument-types"><li class="argument-type"><a href="http://www.nodemanual.org/latest/js_doc/String.html" class="returnType " title="String" data-id="String">String</a></li><li class="argument-type"><a href="http://www.nodemanual.org/latest/js_doc/Boolean.html" class="returnType " title="Boolean" data-id="Boolean">Boolean</a></li></ul></li></li></ul><ul class="metaInfo"><li><span class="label internal">Internal</span></li></ul></li></ul></div><div class="sideToggler"><div id="ellipsis_Search.$matchIterator" class="ellipsis_description"></div><div class="description"><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="#nav=api&api=edit_session" class="" title="EditSession (class)" data-id="EditSession">EditSession</a></td><td class="argDescription "><p>Required.  The session to search with</p>
</td></tr></table></div></div></div></div></article><article id="Search.find" data-title="Search.find (class method)" class="article"><div class="section method"><div class="memberContent"><div class="title"><i id="Search.find" class="methodToggle methodClicker inactive icon-caret-right"></i><ul class="signatures"><li class="signature"><ul><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="#nav=api&api=edit_session" class="argument methodClicker" title="EditSession (class)" data-id="EditSession">EditSession</a> session</span>)<li class="signature-returns"><ul class="argument-types"><li class="argument-type"><a href="#nav=api&api=range" class="returnType " title="Range (class)" data-id="Range">Range</a></li></ul></li></li></ul><ul class="metaInfo"></ul></li></ul></div><div class="sideToggler"><div id="ellipsis_Search.find" class="ellipsis_description"><p>Searches for <code>options.needle</code>. If found, this method returns the <a href="#nav=api&api=range" 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>
</div><div class="description"><p>Searches for <code>options.needle</code>. If found, this method returns the <a href="#nav=api&api=range" 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>
<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="#nav=api&api=edit_session" class="" title="EditSession (class)" data-id="EditSession">EditSession</a></td><td class="argDescription "><p>Required.  The session to search with</p>
</td></tr></table></div></div></div></div></article><article id="Search.findAll" data-title="Search.findAll (class method)" class="article"><div class="section method"><div class="memberContent"><div class="title"><i id="Search.findAll" class="methodToggle methodClicker inactive icon-caret-right"></i><ul class="signatures"><li class="signature"><ul><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="#nav=api&api=edit_session" class="argument methodClicker" title="EditSession (class)" data-id="EditSession">EditSession</a> session</span>)<li class="signature-returns"><ul class="argument-types"><li class="argument-type">[ <a href="#nav=api&api=range" class="returnType " title="Range (class)" data-id="Range">Range</a> ]</li></ul></li></li></ul><ul class="metaInfo"></ul></li></ul></div><div class="sideToggler"><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="#nav=api&api=range" 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>
</div><div class="description"><p>Searches for all occurances <code>options.needle</code>. If found, this method returns an array of <a href="#nav=api&api=range" 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>
<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="#nav=api&api=edit_session" class="" title="EditSession (class)" data-id="EditSession">EditSession</a></td><td class="argDescription "><p>Required.  The session to search with</p>
</td></tr></table></div></div></div></div></article><article id="Search.getOptions" data-title="Search.getOptions (class method)" class="article"><div class="section method"><div class="memberContent"><div class="title"><i id="Search.getOptions" class="methodToggle methodClicker inactive icon-caret-right"></i><ul class="signatures"><li class="signature"><ul><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="sigArgList"></span>)<li class="signature-returns"><ul class="argument-types"><li class="argument-type"><a href="http://www.nodemanual.org/latest/js_doc/Object.html" class="returnType " title="Object" data-id="Object">Object</a></li></ul></li></li></ul><ul class="metaInfo"></ul></li></ul></div><div class="sideToggler"><div id="ellipsis_Search.getOptions" class="ellipsis_description"><p>Returns an object containing all the search options.</p>
</div><div class="description"><p>Returns an object containing all the search options.</p>
</div></div></div></div></article><article id="Search.replace" data-title="Search.replace (class method)" class="article"><div class="section method"><div class="memberContent"><div class="title"><i id="Search.replace" class="methodToggle methodClicker inactive icon-caret-right"></i><ul class="signatures"><li class="signature"><ul><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="http://www.nodemanual.org/latest/js_doc/String.html" class="argument methodClicker" title="String" data-id="String">String</a> input, <a href="http://www.nodemanual.org/latest/js_doc/String.html" class="argument methodClicker" title="String" data-id="String">String</a> replacement</span>)<li class="signature-returns"><ul class="argument-types"><li class="argument-type"><a href="http://www.nodemanual.org/latest/js_doc/String.html" class="returnType " title="String" data-id="String">String</a></li></ul></li></li></ul><ul class="metaInfo"></ul></li></ul></div><div class="sideToggler"><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>
</div><div class="description"><p>Searches for <code>options.needle</code> in <code>input</code>, and, if found, replaces it with <code>replacement</code>.</p>
<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="http://www.nodemanual.org/latest/js_doc/String.html" class="" title="String" data-id="String">String</a></td><td class="argDescription "><p>Required.  The text to search in</p>
</td></tr><tr class="argumentRow "><td class="argName ">replacement</td><td class="argType" "><a href="http://www.nodemanual.org/latest/js_doc/String.html" class="" title="String" data-id="String">String</a></td><td class="argDescription "><p>Required.  The replacing text</p>
</td></tr></table><h4>Returns</h4><table class="returnTable return-list table table-striped table-bordered"><tr class=" "><td class="returnType "><a href="http://www.nodemanual.org/latest/js_doc/String.html" class="" title="String" data-id="String">String</a></td><td class="returnDescription "><p> 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/></p>
<ul>
<li>If <code>options.needle</code> was not found, this function returns <code>null</code>.</li>
</ul>
</td></tr></table></div></div></div></div></article><article id="Search.set" data-title="Search.set (class method)" class="article"><div class="section method"><div class="memberContent"><div class="title"><i id="Search.set" class="methodToggle methodClicker inactive icon-caret-right"></i><ul class="signatures"><li class="signature"><ul><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="http://www.nodemanual.org/latest/js_doc/Object.html" class="argument methodClicker" title="Object" data-id="Object">Object</a> options</span>)<li class="signature-returns"><ul class="argument-types"><li class="argument-type"><a href="#Search" class="returnType " title="Search (class)" data-id="Search">Search</a></li></ul></li></li></ul><ul class="metaInfo"></ul></li></ul></div><div class="sideToggler"><div id="ellipsis_Search.set" class="ellipsis_description"><p>Sets the search options via the <code>options</code> parameter.</p>
</div><div class="description"><p>Sets the search options via the <code>options</code> parameter.</p>
<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="http://www.nodemanual.org/latest/js_doc/Object.html" class="" title="Object" data-id="Object">Object</a></td><td class="argDescription "><p>Required.  An object containing all the new search properties</p>
</td></tr></table></div></div></div></div></article></div><script defer src="./resources/javascripts/ux.js"></script><script src="./resources/javascripts/clicker.js"></script><script src="./resources/javascripts/jquery-scrollspy.js"></script><script defer src="./resources/javascripts/disqus-ext.js"></script><script defer src="./resources/javascripts/ga.js"></script><div id="disqus_thread"></div></div>