ace/api/anchor.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">Anchor<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"><a href="#" data-toggle="dropdown" class="dropdown-toggle"><span>Events (1)</span><b class="caret"></b></a><ul class="dropdown-menu"><li id="dropdown_Anchor.event.change" data-id="Anchor.event.change" class="memberLink"><a href="#Anchor.event.change" class="" title="Anchor.event.change (event)" data-id="Anchor.event.change">change</a></li></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_Anchor.new" data-id="Anchor.new" class="memberLink"><a href="#Anchor.new" class="" title="Anchor.new (constructor)" data-id="Anchor.new">new</a></li></ul></li><li data-dropdown="dropdown" class="dropdown"><a href="#" data-toggle="dropdown" class="dropdown-toggle"><span>Functions (5)</span><b class="caret"></b></a><ul class="dropdown-menu"><li id="dropdown_Anchor.clipPositionToDocument" data-id="Anchor.clipPositionToDocument" class="memberLink"><a href="#Anchor.clipPositionToDocument" class="" title="Anchor.clipPositionToDocument (class method)" data-id="Anchor.clipPositionToDocument">clipPositionToDocument</a></li><li id="dropdown_Anchor.detach" data-id="Anchor.detach" class="memberLink"><a href="#Anchor.detach" class="" title="Anchor.detach (class method)" data-id="Anchor.detach">detach</a></li><li id="dropdown_Anchor.getDocument" data-id="Anchor.getDocument" class="memberLink"><a href="#Anchor.getDocument" class="" title="Anchor.getDocument (class method)" data-id="Anchor.getDocument">getDocument</a></li><li id="dropdown_Anchor.getPosition" data-id="Anchor.getPosition" class="memberLink"><a href="#Anchor.getPosition" class="" title="Anchor.getPosition (class method)" data-id="Anchor.getPosition">getPosition</a></li><li id="dropdown_Anchor.setPosition" data-id="Anchor.setPosition" class="memberLink"><a href="#Anchor.setPosition" class="" title="Anchor.setPosition (class method)" data-id="Anchor.setPosition">setPosition</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="Anchor" data-title="Anchor (class)" class="article"><div class="section description"><div class="memberContent"><p>Defines the floating pointer in the document. Whenever text is inserted or deleted before the cursor, the position of the cursor is updated</p>
</div></div></article><h3 class="sectionHeader">Constructors</h3><article id="Anchor.new" data-title="Anchor.new (constructor)" class="article"><div class="section method"><div class="memberContent"><div class="title"><i id="Anchor.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="Anchor.new" class="member-name methodClicker">Anchor</span>(<span class="sigArgList"><a href="#nav=api&api=document" class="argument methodClicker" title="Document (class)" data-id="Document">Document</a> doc, <a href="http://www.nodemanual.org/latest/js_doc/Number.html" class="argument methodClicker" title="Number" data-id="Number">Number</a> row, <a href="http://www.nodemanual.org/latest/js_doc/Number.html" class="argument methodClicker" title="Number" data-id="Number">Number</a> column</span>)</li></ul><ul class="metaInfo"></ul></li></ul></div><div class="sideToggler"><div id="ellipsis_Anchor.new" class="ellipsis_description"><p>Creates a new <code>Anchor</code> and associates it with a document.</p>
</div><div class="description"><p>Creates a new <code>Anchor</code> and associates it with a document.</p>
<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="#nav=api&api=document" class="" title="Document (class)" data-id="Document">Document</a></td><td class="argDescription "><p>Required.  The document to associate with the anchor</p>
</td></tr><tr class="argumentRow "><td class="argName ">row</td><td class="argType" "><a href="http://www.nodemanual.org/latest/js_doc/Number.html" class="" title="Number" data-id="Number">Number</a></td><td class="argDescription "><p>Required.  The starting row position</p>
</td></tr><tr class="argumentRow "><td class="argName ">column</td><td class="argType" "><a href="http://www.nodemanual.org/latest/js_doc/Number.html" class="" title="Number" data-id="Number">Number</a></td><td class="argDescription "><p>Required.  The starting column position</p>
</td></tr></table></div></div></div></div></article><h3 class="sectionHeader">Events</h3><article id="Anchor.event.change" data-title="Anchor.event.change (event)" class="article"><div class="section method"><div class="memberContent"><div class="title"><i id="Anchor.event.change" class="methodToggle methodClicker inactive icon-caret-right"></i><ul class="signatures"><li class="signature"><ul><li class="signature-call"><span class="eventObjName">Anchor</span><span class="eventListenerStart">.on("</span><span id="Anchor.event.change" class="member-name eventMember methodClicker">change</span><span class="eventListenerClose">", </span><span class="eventFunctionOpen">function(</span><a href="http://www.nodemanual.org/latest/js_doc/Object.html" class="argument methodClicker" title="Object" data-id="Object">Object</a> e<span class="eventFunctionClose">))</span></li></ul><ul class="metaInfo"></ul></li></ul></div><div class="sideToggler"><div id="ellipsis_Anchor.event.change" class="ellipsis_description"><p>Fires whenever the anchor position changes.</p>
</div><div class="description"><p>Fires whenever the anchor position changes.</p>
<p>Events that can trigger this function include <a href="#Anchor.setPosition" class="link-short" title="Anchor.setPosition (class method)" data-id="Anchor.setPosition"><code>setPosition()</code></a>.</p>
<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="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 information about the anchor position. It has two properties:</p>
<ul>
<li><p><code>old</code>: An object describing the old Anchor position</p>
</li>
<li><p><code>value</code>: An object describing the new Anchor position  </p>
<p>Both of these objects have a <code>row</code> and <code>column</code> property corresponding to the position.</p>
</li>
</ul>
</td></tr></table></div></div></div></div></article><h3 class="sectionHeader">Methods</h3><article id="Anchor.clipPositionToDocument" data-title="Anchor.clipPositionToDocument (class method)" class="article"><div class="section method"><div class="memberContent"><div class="title"><i id="Anchor.clipPositionToDocument" class="methodToggle methodClicker inactive icon-caret-right"></i><ul class="signatures"><li class="signature"><ul><li class="signature-call"><span id="Anchor.clipPositionToDocument" class="member-name methodClicker"><span class="sigClassName">Anchor.</span><span class="sigMemberName">clipPositionToDocument</span></span>(<span class="sigArgList"><a href="http://www.nodemanual.org/latest/js_doc/Number.html" class="argument methodClicker" title="Number" data-id="Number">Number</a> row, <a href="http://www.nodemanual.org/latest/js_doc/Number.html" class="argument methodClicker" title="Number" data-id="Number">Number</a> column</span>)</li></ul><ul class="metaInfo"><li><span class="label internal">Internal</span></li></ul></li></ul></div><div class="sideToggler"><div id="ellipsis_Anchor.clipPositionToDocument" class="ellipsis_description"><p>Clips the anchor position to the specified row and column.</p>
</div><div class="description"><p>Clips the anchor position to the specified row and column.</p>
<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="http://www.nodemanual.org/latest/js_doc/Number.html" class="" title="Number" data-id="Number">Number</a></td><td class="argDescription "><p>Required.  The row index to clip the anchor to</p>
</td></tr><tr class="argumentRow "><td class="argName ">column</td><td class="argType" "><a href="http://www.nodemanual.org/latest/js_doc/Number.html" class="" title="Number" data-id="Number">Number</a></td><td class="argDescription "><p>Required.  The column index to clip the anchor to</p>
</td></tr></table></div></div></div></div></article><article id="Anchor.detach" data-title="Anchor.detach (class method)" class="article"><div class="section method"><div class="memberContent"><div class="title"><i id="Anchor.detach" class="methodToggle methodClicker inactive icon-caret-right"></i><ul class="signatures"><li class="signature"><ul><li class="signature-call"><span id="Anchor.detach" class="member-name methodClicker"><span class="sigClassName">Anchor.</span><span class="sigMemberName">detach</span></span>(<span class="sigArgList"></span>)</li></ul><ul class="metaInfo"></ul></li></ul></div><div class="sideToggler"><div id="ellipsis_Anchor.detach" class="ellipsis_description"><p>When called, the <code>&#39;change&#39;</code> event listener is removed.</p>
</div><div class="description"><p>When called, the <code>&#39;change&#39;</code> event listener is removed.</p>
</div></div></div></div></article><article id="Anchor.getDocument" data-title="Anchor.getDocument (class method)" class="article"><div class="section method"><div class="memberContent"><div class="title"><i id="Anchor.getDocument" class="methodToggle methodClicker inactive icon-caret-right"></i><ul class="signatures"><li class="signature"><ul><li class="signature-call"><span id="Anchor.getDocument" class="member-name methodClicker"><span class="sigClassName">Anchor.</span><span class="sigMemberName">getDocument</span></span>(<span class="sigArgList"></span>)<li class="signature-returns"><ul class="argument-types"><li class="argument-type"><a href="#nav=api&api=document" class="returnType " title="Document (class)" data-id="Document">Document</a></li></ul></li></li></ul><ul class="metaInfo"></ul></li></ul></div><div class="sideToggler"><div id="ellipsis_Anchor.getDocument" class="ellipsis_description"><p>Returns the current document.</p>
</div><div class="description"><p>Returns the current document.</p>
</div></div></div></div></article><article id="Anchor.getPosition" data-title="Anchor.getPosition (class method)" class="article"><div class="section method"><div class="memberContent"><div class="title"><i id="Anchor.getPosition" class="methodToggle methodClicker inactive icon-caret-right"></i><ul class="signatures"><li class="signature"><ul><li class="signature-call"><span id="Anchor.getPosition" class="member-name methodClicker"><span class="sigClassName">Anchor.</span><span class="sigMemberName">getPosition</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_Anchor.getPosition" class="ellipsis_description"><p>Returns an object identifying the <code>row</code> and <code>column</code> position of the current anchor.</p>
</div><div class="description"><p>Returns an object identifying the <code>row</code> and <code>column</code> position of the current anchor.</p>
</div></div></div></div></article><article id="Anchor.setPosition" data-title="Anchor.setPosition (class method)" class="article"><div class="section method"><div class="memberContent"><div class="title"><i id="Anchor.setPosition" class="methodToggle methodClicker inactive icon-caret-right"></i><ul class="signatures"><li class="signature"><ul><li class="signature-call"><span id="Anchor.setPosition" class="member-name methodClicker"><span class="sigClassName">Anchor.</span><span class="sigMemberName">setPosition</span></span>(<span class="sigArgList"><a href="http://www.nodemanual.org/latest/js_doc/Number.html" class="argument methodClicker" title="Number" data-id="Number">Number</a> row, <a href="http://www.nodemanual.org/latest/js_doc/Number.html" class="argument methodClicker" title="Number" data-id="Number">Number</a> column, <a href="http://www.nodemanual.org/latest/js_doc/Boolean.html" class="argument methodClicker" title="Boolean" data-id="Boolean">Boolean</a> noClip</span>)</li></ul><ul class="metaInfo"></ul></li></ul></div><div class="sideToggler"><div id="ellipsis_Anchor.setPosition" class="ellipsis_description"><p>Sets the anchor position to the specified row and column. If <code>noClip</code> is <code>true</code>, the position is not clipped.</p>
</div><div class="description"><p>Sets the anchor position to the specified row and column. If <code>noClip</code> is <code>true</code>, the position is not clipped.</p>
<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="http://www.nodemanual.org/latest/js_doc/Number.html" class="" title="Number" data-id="Number">Number</a></td><td class="argDescription "><p>Required.  The row index to move the anchor to</p>
</td></tr><tr class="argumentRow "><td class="argName ">column</td><td class="argType" "><a href="http://www.nodemanual.org/latest/js_doc/Number.html" class="" title="Number" data-id="Number">Number</a></td><td class="argDescription "><p>Required.  The column index to move the anchor to</p>
</td></tr><tr class="argumentRow "><td class="argName ">noClip</td><td class="argType" "><a href="http://www.nodemanual.org/latest/js_doc/Boolean.html" class="" title="Boolean" data-id="Boolean">Boolean</a></td><td class="argDescription "><p>Required.  Identifies if you want the position to be clipped</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>