Harutyun Amirjanyan
commit
0446771809
51 changed files with 17690 additions and 3463 deletions
90
api/ace.html
90
api/ace.html
|
|
@ -1,5 +1,85 @@
|
|||
<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">Ace<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"><ul class="dropdown-menu"></ul></li><li data-dropdown="dropdown" class="dropdown"><a href="#" data-toggle="dropdown" class="dropdown-toggle"><span>Functions (1)</span><b class="caret"></b></a><ul class="dropdown-menu"><li id="dropdown_Ace.edit" data-id="Ace.edit" class="memberLink"><a href="#Ace.edit" class="" title="Ace.edit (class method)" data-id="Ace.edit">edit</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="Ace" data-title="Ace (class)" class="article"><div class="section description"><div class="memberContent"><p>The main class required to set up an Ace instance in the browser.</p>
|
||||
</div></div></article><h3 class="sectionHeader">Methods</h3><article id="Ace.edit" data-title="Ace.edit (class method)" class="article"><div class="section method"><div class="memberContent"><div class="title"><i id="Ace.edit" class="methodToggle methodClicker inactive icon-caret-right"></i><ul class="signatures"><li class="signature"><ul><li class="signature-call"><span id="Ace.edit" class="member-name methodClicker"><span class="sigClassName">Ace.</span><span class="sigMemberName">edit</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> | <a href="https://developer.mozilla.org/en/DOM/element" class="argument methodClicker" title="DOMElement" data-id="DOMElement">DOMElement</a> el</span>)<li class="signature-returns"><ul class="argument-types"><li class="argument-type"><a href="#nav=api&api=editor" class="returnType " title="Editor (class)" data-id="Editor">Editor</a></li></ul></li></li></ul><ul class="metaInfo"></ul></li></ul></div><div class="sideToggler"><div id="ellipsis_Ace.edit" class="ellipsis_description"><p>This method embeds the Ace editor into the DOM, at the element provided by <code>el</code>.</p>
|
||||
</div><div class="description"><p>This method embeds the Ace editor into the DOM, at the element provided by <code>el</code>.</p>
|
||||
<h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"><tr class="argumentRow "><td class="argName ">el</td><td class="argType" "><a href="http://www.nodemanual.org/latest/js_doc/String.html" class="" title="String" data-id="String">String</a> | <a href="https://developer.mozilla.org/en/DOM/element" class="" title="DOMElement" data-id="DOMElement">DOMElement</a></td><td class="argDescription "><p>Required. Either the id of an element, or the element itself</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>
|
||||
|
||||
<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">Ace<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">
|
||||
<ul class="dropdown-menu">
|
||||
</ul>
|
||||
</li>
|
||||
<li data-dropdown="dropdown" class="dropdown"><a href="#" data-toggle="dropdown" class="dropdown-toggle"><span>Functions (1)</span><b class="caret"></b></a>
|
||||
<ul class="dropdown-menu">
|
||||
<li id="dropdown_Ace.edit" data-id="Ace.edit" class="memberLink"><a href="#Ace.edit" class="" title="Ace.edit (class method)" data-id="Ace.edit">edit</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="Ace" data-title="Ace (class)" class="article">
|
||||
<div class="section description">
|
||||
<div class="memberContent"><p>The main class required to set up an Ace instance in the browser.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</article>
|
||||
<h3 class="sectionHeader">Methods</h3>
|
||||
<article id="Ace.edit" data-title="Ace.edit (class method)" class="article">
|
||||
<div class="section method">
|
||||
<div class="memberContent">
|
||||
<div class="title"><i id="Ace.edit" class="methodToggle methodClicker inactive icon-caret-right"></i>
|
||||
<ul class="signatures">
|
||||
<li class="signature">
|
||||
<ul>
|
||||
<li class="signature-call"><span id="Ace.edit" class="member-name methodClicker"><span class="sigClassName">Ace.</span><span class="sigMemberName">edit</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> | <a href="https://developer.mozilla.org/en/DOM/element" class="argument methodClicker" title="DOMElement" data-id="DOMElement">DOMElement</a> el</span>)</li>
|
||||
</ul>
|
||||
<ul class="metaInfo">
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sideToggler">
|
||||
<div id="ellipsis_Ace.edit" class="ellipsis_description"><p>Embeds the Ace editor into the DOM, at the element provided by <code>el</code>.</p>
|
||||
|
||||
</div>
|
||||
<div class="description"><p>Embeds the Ace editor into the DOM, at the element provided by <code>el</code>.</p>
|
||||
|
||||
<h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"><tr class="argumentRow "><td class="argName ">el</td><td class="argType" "><a href="http://www.nodemanual.org/latest/js_doc/String.html" class="" title="String" data-id="String">String</a> | <a href="https://developer.mozilla.org/en/DOM/element" class="" title="DOMElement" data-id="DOMElement">DOMElement</a></td><td class="argDescription "><p>Required. Either the id of an element, or the element itself</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>
|
||||
304
api/anchor.html
304
api/anchor.html
|
|
@ -1,33 +1,275 @@
|
|||
<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>
|
||||
|
||||
<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 (6)</span><b class="caret"></b></a>
|
||||
<ul class="dropdown-menu">
|
||||
<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.onChange" data-id="Anchor.onChange" class="memberLink"><a href="#Anchor.onChange" class="" title="Anchor.onChange (class method)" data-id="Anchor.onChange">onChange</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="document.html" 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="document.html" 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>Both of these objects have a <code>row</code> and <code>column</code> property corresponding to the position.</p>
|
||||
</li>
|
||||
<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><code>old</code>: An object describing the old Anchor position</li>
|
||||
<li><code>value</code>: An object describing the new Anchor position</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>'change'</code> event listener is removed.</p>
|
||||
</div><div class="description"><p>When called, the <code>'change'</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>
|
||||
</td></tr></table>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</article>
|
||||
<h3 class="sectionHeader">Methods</h3>
|
||||
<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></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>'change'</code> event listener is removed.</p>
|
||||
|
||||
</div>
|
||||
<div class="description"><p>When called, the <code>'change'</code> event listener is removed.</p>
|
||||
|
||||
<h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"></table>
|
||||
</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>
|
||||
<li class="signature-returns">
|
||||
<ul class="argument-types">
|
||||
<li class="argument-type"><a href="document.html" 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>
|
||||
|
||||
<h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"></table>
|
||||
</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>
|
||||
<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>
|
||||
|
||||
<h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"></table>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</article>
|
||||
<article id="Anchor.onChange" data-title="Anchor.onChange (class method)" class="article">
|
||||
<div class="section method">
|
||||
<div class="memberContent">
|
||||
<div class="title"><i id="Anchor.onChange" class="methodToggle methodClicker inactive icon-caret-right"></i>
|
||||
<ul class="signatures">
|
||||
<li class="signature">
|
||||
<ul>
|
||||
<li class="signature-call"><span id="Anchor.onChange" class="member-name methodClicker"><span class="sigClassName">Anchor.</span><span class="sigMemberName">onChange</span></span></li>
|
||||
</ul>
|
||||
<ul class="metaInfo">
|
||||
<li><span class="label incomplete">Incomplete</span></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sideToggler">
|
||||
<div id="ellipsis_Anchor.onChange" class="ellipsis_description">
|
||||
</div>
|
||||
<div class="description">
|
||||
</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>
|
||||
|
|
@ -1,30 +1,321 @@
|
|||
<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">BackgroundTokenizer<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_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></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_BackgroundTokenizer.new" data-id="BackgroundTokenizer.new" class="memberLink"><a href="#BackgroundTokenizer.new" class="" title="BackgroundTokenizer.new (constructor)" data-id="BackgroundTokenizer.new">new</a></li></ul></li><li data-dropdown="dropdown" class="dropdown"><a href="#" data-toggle="dropdown" class="dropdown-toggle"><span>Functions (7)</span><b class="caret"></b></a><ul class="dropdown-menu"><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></li><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></li><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></li><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></li><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></li><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></li><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></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="BackgroundTokenizer" data-title="BackgroundTokenizer (class)" class="article"><div class="section description"><div class="memberContent"><p>Tokenizes the current <a href="#nav=api&api=document" class="link-short" title="Document (class)" data-id="Document"><code>Document</code></a> in the background, and caches the tokenized rows for future use. If a certain row is changed, everything below that row is re-tokenized.</p>
|
||||
</div></div></article><h3 class="sectionHeader">Constructors</h3><article id="BackgroundTokenizer.new" data-title="BackgroundTokenizer.new (constructor)" class="article"><div class="section method"><div class="memberContent"><div class="title"><i id="BackgroundTokenizer.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="BackgroundTokenizer.new" class="member-name methodClicker">BackgroundTokenizer</span>(<span class="sigArgList"><a href="#nav=api&api=tokenizer" class="argument methodClicker" title="Tokenizer (class)" data-id="Tokenizer">Tokenizer</a> tokenizer, <a href="#nav=api&api=editor" class="argument methodClicker" title="Editor (class)" data-id="Editor">Editor</a> editor</span>)</li></ul><ul class="metaInfo"></ul></li></ul></div><div class="sideToggler"><div id="ellipsis_BackgroundTokenizer.new" class="ellipsis_description"><p>Creates a new <code>BackgroundTokenizer</code> object.</p>
|
||||
</div><div class="description"><p>Creates a new <code>BackgroundTokenizer</code> object.</p>
|
||||
<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="#nav=api&api=tokenizer" class="" title="Tokenizer (class)" data-id="Tokenizer">Tokenizer</a></td><td class="argDescription "><p>Required. The tokenizer to use</p>
|
||||
</td></tr><tr class="argumentRow "><td class="argName ">editor</td><td class="argType" "><a href="#nav=api&api=editor" class="" title="Editor (class)" data-id="Editor">Editor</a></td><td class="argDescription "><p>Required. The editor to associate with</p>
|
||||
</td></tr></table></div></div></div></div></article><h3 class="sectionHeader">Events</h3><article id="BackgroundTokenizer.event.update" data-title="BackgroundTokenizer.event.update (event)" class="article"><div class="section method"><div class="memberContent"><div class="title"><i id="BackgroundTokenizer.event.update" class="methodToggle methodClicker inactive icon-caret-right"></i><ul class="signatures"><li class="signature"><ul><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="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_BackgroundTokenizer.event.update" class="ellipsis_description"><p>Fires whenever the background tokeniziers between a range of rows are going to be updated.</p>
|
||||
</div><div class="description"><p>Fires whenever the background tokeniziers between a range of rows are going to be updated.</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 two properties, <code>first</code> and <code>last</code>, which indicate the rows of the region being updated.</p>
|
||||
</td></tr></table></div></div></div></div></article><h3 class="sectionHeader">Methods</h3><article id="BackgroundTokenizer.fireUpdateEvent" data-title="BackgroundTokenizer.fireUpdateEvent (class method)" class="article"><div class="section method"><div class="memberContent"><div class="title"><i id="BackgroundTokenizer.fireUpdateEvent" class="methodToggle methodClicker inactive icon-caret-right"></i><ul class="signatures"><li class="signature"><ul><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="http://www.nodemanual.org/latest/js_doc/Number.html" class="argument methodClicker" title="Number" data-id="Number">Number</a> firstRow, <a href="http://www.nodemanual.org/latest/js_doc/Number.html" class="argument methodClicker" title="Number" data-id="Number">Number</a> lastRow</span>)</li></ul><ul class="metaInfo"></ul></li></ul></div><div class="sideToggler"><div id="ellipsis_BackgroundTokenizer.fireUpdateEvent" class="ellipsis_description"><p>Emits the <code>'update'</code> event. <code>firstRow</code> and <code>lastRow</code> are used to define the boundaries of the region to be updated.</p>
|
||||
</div><div class="description"><p>Emits the <code>'update'</code> event. <code>firstRow</code> and <code>lastRow</code> are used to define the boundaries of the region to be updated.</p>
|
||||
<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="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 region</p>
|
||||
</td></tr><tr class="argumentRow "><td class="argName ">lastRow</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 final row region</p>
|
||||
</td></tr></table></div></div></div></div></article><article id="BackgroundTokenizer.getState" data-title="BackgroundTokenizer.getState (class method)" class="article"><div class="section method"><div class="memberContent"><div class="title"><i id="BackgroundTokenizer.getState" class="methodToggle methodClicker inactive icon-caret-right"></i><ul class="signatures"><li class="signature"><ul><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="http://www.nodemanual.org/latest/js_doc/Number.html" class="argument methodClicker" title="Number" data-id="Number">Number</a> row</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_BackgroundTokenizer.getState" class="ellipsis_description"><p>Returns the state of tokenization at the end of a row.</p>
|
||||
</div><div class="description"><p>Returns the state of tokenization at the end of a row.</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 to get state at</p>
|
||||
</td></tr></table></div></div></div></div></article><article id="BackgroundTokenizer.getTokens" data-title="BackgroundTokenizer.getTokens (class method)" class="article"><div class="section method"><div class="memberContent"><div class="title"><i id="BackgroundTokenizer.getTokens" class="methodToggle methodClicker inactive icon-caret-right"></i><ul class="signatures"><li class="signature"><ul><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="http://www.nodemanual.org/latest/js_doc/Number.html" class="argument methodClicker" title="Number" data-id="Number">Number</a> row</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_BackgroundTokenizer.getTokens" class="ellipsis_description"><p>Gives list of tokens of the row. (tokens are cached)</p>
|
||||
</div><div class="description"><p>Gives list of tokens of the row. (tokens are cached)</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 to get tokens at</p>
|
||||
</td></tr></table></div></div></div></div></article><article id="BackgroundTokenizer.setDocument" data-title="BackgroundTokenizer.setDocument (class method)" class="article"><div class="section method"><div class="memberContent"><div class="title"><i id="BackgroundTokenizer.setDocument" class="methodToggle methodClicker inactive icon-caret-right"></i><ul class="signatures"><li class="signature"><ul><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="#nav=api&api=document" class="argument methodClicker" title="Document (class)" data-id="Document">Document</a> doc</span>)</li></ul><ul class="metaInfo"></ul></li></ul></div><div class="sideToggler"><div id="ellipsis_BackgroundTokenizer.setDocument" class="ellipsis_description"><p>Sets a new document to associate with this object.</p>
|
||||
</div><div class="description"><p>Sets a new document to associate with this object.</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 new document to associate with</p>
|
||||
</td></tr></table></div></div></div></div></article><article id="BackgroundTokenizer.setTokenizer" data-title="BackgroundTokenizer.setTokenizer (class method)" class="article"><div class="section method"><div class="memberContent"><div class="title"><i id="BackgroundTokenizer.setTokenizer" class="methodToggle methodClicker inactive icon-caret-right"></i><ul class="signatures"><li class="signature"><ul><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="#nav=api&api=tokenizer" class="argument methodClicker" title="Tokenizer (class)" data-id="Tokenizer">Tokenizer</a> tokenizer</span>)</li></ul><ul class="metaInfo"></ul></li></ul></div><div class="sideToggler"><div id="ellipsis_BackgroundTokenizer.setTokenizer" class="ellipsis_description"><p>Sets a new tokenizer for this object.</p>
|
||||
</div><div class="description"><p>Sets a new tokenizer for this object.</p>
|
||||
<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="#nav=api&api=tokenizer" class="" title="Tokenizer (class)" data-id="Tokenizer">Tokenizer</a></td><td class="argDescription "><p>Required. The new tokenizer to use</p>
|
||||
</td></tr></table></div></div></div></div></article><article id="BackgroundTokenizer.start" data-title="BackgroundTokenizer.start (class method)" class="article"><div class="section method"><div class="memberContent"><div class="title"><i id="BackgroundTokenizer.start" class="methodToggle methodClicker inactive icon-caret-right"></i><ul class="signatures"><li class="signature"><ul><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="http://www.nodemanual.org/latest/js_doc/Number.html" class="argument methodClicker" title="Number" data-id="Number">Number</a> startRow</span>)</li></ul><ul class="metaInfo"></ul></li></ul></div><div class="sideToggler"><div id="ellipsis_BackgroundTokenizer.start" class="ellipsis_description"><p>Starts tokenizing at the row indicated.</p>
|
||||
</div><div class="description"><p>Starts tokenizing at the row indicated.</p>
|
||||
<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="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 to start at</p>
|
||||
</td></tr></table></div></div></div></div></article><article id="BackgroundTokenizer.stop" data-title="BackgroundTokenizer.stop (class method)" class="article"><div class="section method"><div class="memberContent"><div class="title"><i id="BackgroundTokenizer.stop" class="methodToggle methodClicker inactive icon-caret-right"></i><ul class="signatures"><li class="signature"><ul><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="sigArgList"></span>)</li></ul><ul class="metaInfo"></ul></li></ul></div><div class="sideToggler"><div id="ellipsis_BackgroundTokenizer.stop" class="ellipsis_description"><p>Stops tokenizing.</p>
|
||||
</div><div class="description"><p>Stops tokenizing.</p>
|
||||
</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>
|
||||
|
||||
<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">BackgroundTokenizer<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_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>
|
||||
</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_BackgroundTokenizer.new" data-id="BackgroundTokenizer.new" class="memberLink"><a href="#BackgroundTokenizer.new" class="" title="BackgroundTokenizer.new (constructor)" data-id="BackgroundTokenizer.new">new</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li data-dropdown="dropdown" class="dropdown"><a href="#" data-toggle="dropdown" class="dropdown-toggle"><span>Functions (7)</span><b class="caret"></b></a>
|
||||
<ul class="dropdown-menu">
|
||||
<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>
|
||||
</li>
|
||||
<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>
|
||||
</li>
|
||||
<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>
|
||||
</li>
|
||||
<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>
|
||||
</li>
|
||||
<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>
|
||||
</li>
|
||||
<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>
|
||||
</li>
|
||||
<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>
|
||||
</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="BackgroundTokenizer" data-title="BackgroundTokenizer (class)" class="article">
|
||||
<div class="section description">
|
||||
<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>
|
||||
<p>If a certain row is changed, everything below that row is re-tokenized.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</article>
|
||||
<h3 class="sectionHeader">Constructors</h3>
|
||||
<article id="BackgroundTokenizer.new" data-title="BackgroundTokenizer.new (constructor)" class="article">
|
||||
<div class="section method">
|
||||
<div class="memberContent">
|
||||
<div class="title"><i id="BackgroundTokenizer.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="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>
|
||||
</ul>
|
||||
<ul class="metaInfo">
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sideToggler">
|
||||
<div id="ellipsis_BackgroundTokenizer.new" class="ellipsis_description"><p>Creates a new <code>BackgroundTokenizer</code> object.</p>
|
||||
|
||||
</div>
|
||||
<div class="description"><p>Creates a new <code>BackgroundTokenizer</code> object.</p>
|
||||
|
||||
<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>
|
||||
</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>
|
||||
</td></tr></table>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</article>
|
||||
<h3 class="sectionHeader">Events</h3>
|
||||
<article id="BackgroundTokenizer.event.update" data-title="BackgroundTokenizer.event.update (event)" class="article">
|
||||
<div class="section method">
|
||||
<div class="memberContent">
|
||||
<div class="title"><i id="BackgroundTokenizer.event.update" class="methodToggle methodClicker inactive icon-caret-right"></i>
|
||||
<ul class="signatures">
|
||||
<li class="signature">
|
||||
<ul>
|
||||
<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="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_BackgroundTokenizer.event.update" class="ellipsis_description"><p>Fires whenever the background tokeniziers between a range of rows are going to be updated.</p>
|
||||
|
||||
</div>
|
||||
<div class="description"><p>Fires whenever the background tokeniziers between a range of rows are going to be updated.</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 two properties, <code>first</code> and <code>last</code>, which indicate the rows of the region being updated.</p>
|
||||
</td></tr></table>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</article>
|
||||
<h3 class="sectionHeader">Methods</h3>
|
||||
<article id="BackgroundTokenizer.fireUpdateEvent" data-title="BackgroundTokenizer.fireUpdateEvent (class method)" class="article">
|
||||
<div class="section method">
|
||||
<div class="memberContent">
|
||||
<div class="title"><i id="BackgroundTokenizer.fireUpdateEvent" class="methodToggle methodClicker inactive icon-caret-right"></i>
|
||||
<ul class="signatures">
|
||||
<li class="signature">
|
||||
<ul>
|
||||
<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="http://www.nodemanual.org/latest/js_doc/Number.html" class="argument methodClicker" title="Number" data-id="Number">Number</a> firstRow, <a href="http://www.nodemanual.org/latest/js_doc/Number.html" class="argument methodClicker" title="Number" data-id="Number">Number</a> lastRow</span>)</li>
|
||||
</ul>
|
||||
<ul class="metaInfo">
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sideToggler">
|
||||
<div id="ellipsis_BackgroundTokenizer.fireUpdateEvent" class="ellipsis_description"><p>Emits the <code>'update'</code> event. <code>firstRow</code> and <code>lastRow</code> are used to define the boundaries of the region to be updated.</p>
|
||||
|
||||
</div>
|
||||
<div class="description"><p>Emits the <code>'update'</code> event. <code>firstRow</code> and <code>lastRow</code> are used to define the boundaries of the region to be updated.</p>
|
||||
|
||||
<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="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 region</p>
|
||||
</td></tr><tr class="argumentRow "><td class="argName ">lastRow</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 final row region</p>
|
||||
</td></tr></table>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</article>
|
||||
<article id="BackgroundTokenizer.getState" data-title="BackgroundTokenizer.getState (class method)" class="article">
|
||||
<div class="section method">
|
||||
<div class="memberContent">
|
||||
<div class="title"><i id="BackgroundTokenizer.getState" class="methodToggle methodClicker inactive icon-caret-right"></i>
|
||||
<ul class="signatures">
|
||||
<li class="signature">
|
||||
<ul>
|
||||
<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="http://www.nodemanual.org/latest/js_doc/Number.html" class="argument methodClicker" title="Number" data-id="Number">Number</a> row</span>)</li>
|
||||
</ul>
|
||||
<ul class="metaInfo">
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sideToggler">
|
||||
<div id="ellipsis_BackgroundTokenizer.getState" class="ellipsis_description"><p>Returns the state of tokenization at the end of a row.</p>
|
||||
|
||||
</div>
|
||||
<div class="description"><p>Returns the state of tokenization at the end of a row.</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 to get state at</p>
|
||||
</td></tr></table>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</article>
|
||||
<article id="BackgroundTokenizer.getTokens" data-title="BackgroundTokenizer.getTokens (class method)" class="article">
|
||||
<div class="section method">
|
||||
<div class="memberContent">
|
||||
<div class="title"><i id="BackgroundTokenizer.getTokens" class="methodToggle methodClicker inactive icon-caret-right"></i>
|
||||
<ul class="signatures">
|
||||
<li class="signature">
|
||||
<ul>
|
||||
<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="http://www.nodemanual.org/latest/js_doc/Number.html" class="argument methodClicker" title="Number" data-id="Number">Number</a> row</span>)</li>
|
||||
</ul>
|
||||
<ul class="metaInfo">
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sideToggler">
|
||||
<div id="ellipsis_BackgroundTokenizer.getTokens" class="ellipsis_description"><p>Gives list of tokens of the row. (tokens are cached)</p>
|
||||
|
||||
</div>
|
||||
<div class="description"><p>Gives list of tokens of the row. (tokens are cached)</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 to get tokens at</p>
|
||||
</td></tr></table>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</article>
|
||||
<article id="BackgroundTokenizer.setDocument" data-title="BackgroundTokenizer.setDocument (class method)" class="article">
|
||||
<div class="section method">
|
||||
<div class="memberContent">
|
||||
<div class="title"><i id="BackgroundTokenizer.setDocument" class="methodToggle methodClicker inactive icon-caret-right"></i>
|
||||
<ul class="signatures">
|
||||
<li class="signature">
|
||||
<ul>
|
||||
<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>
|
||||
</ul>
|
||||
<ul class="metaInfo">
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sideToggler">
|
||||
<div id="ellipsis_BackgroundTokenizer.setDocument" class="ellipsis_description"><p>Sets a new document to associate with this object.</p>
|
||||
|
||||
</div>
|
||||
<div class="description"><p>Sets a new document to associate with this object.</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="document.html" class="" title="Document (class)" data-id="Document">Document</a></td><td class="argDescription "><p>Required. The new document to associate with</p>
|
||||
</td></tr></table>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</article>
|
||||
<article id="BackgroundTokenizer.setTokenizer" data-title="BackgroundTokenizer.setTokenizer (class method)" class="article">
|
||||
<div class="section method">
|
||||
<div class="memberContent">
|
||||
<div class="title"><i id="BackgroundTokenizer.setTokenizer" class="methodToggle methodClicker inactive icon-caret-right"></i>
|
||||
<ul class="signatures">
|
||||
<li class="signature">
|
||||
<ul>
|
||||
<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>
|
||||
</ul>
|
||||
<ul class="metaInfo">
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sideToggler">
|
||||
<div id="ellipsis_BackgroundTokenizer.setTokenizer" class="ellipsis_description"><p>Sets a new tokenizer for this object.</p>
|
||||
|
||||
</div>
|
||||
<div class="description"><p>Sets a new tokenizer for this object.</p>
|
||||
|
||||
<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>
|
||||
</td></tr></table>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</article>
|
||||
<article id="BackgroundTokenizer.start" data-title="BackgroundTokenizer.start (class method)" class="article">
|
||||
<div class="section method">
|
||||
<div class="memberContent">
|
||||
<div class="title"><i id="BackgroundTokenizer.start" class="methodToggle methodClicker inactive icon-caret-right"></i>
|
||||
<ul class="signatures">
|
||||
<li class="signature">
|
||||
<ul>
|
||||
<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="http://www.nodemanual.org/latest/js_doc/Number.html" class="argument methodClicker" title="Number" data-id="Number">Number</a> startRow</span>)</li>
|
||||
</ul>
|
||||
<ul class="metaInfo">
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sideToggler">
|
||||
<div id="ellipsis_BackgroundTokenizer.start" class="ellipsis_description"><p>Starts tokenizing at the row indicated.</p>
|
||||
|
||||
</div>
|
||||
<div class="description"><p>Starts tokenizing at the row indicated.</p>
|
||||
|
||||
<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="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 to start at</p>
|
||||
</td></tr></table>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</article>
|
||||
<article id="BackgroundTokenizer.stop" data-title="BackgroundTokenizer.stop (class method)" class="article">
|
||||
<div class="section method">
|
||||
<div class="memberContent">
|
||||
<div class="title"><i id="BackgroundTokenizer.stop" class="methodToggle methodClicker inactive icon-caret-right"></i>
|
||||
<ul class="signatures">
|
||||
<li class="signature">
|
||||
<ul>
|
||||
<li class="signature-call"><span id="BackgroundTokenizer.stop" class="member-name methodClicker"><span class="sigClassName">BackgroundTokenizer.</span><span class="sigMemberName">stop</span></span></li>
|
||||
</ul>
|
||||
<ul class="metaInfo">
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sideToggler">
|
||||
<div id="ellipsis_BackgroundTokenizer.stop" class="ellipsis_description"><p>Stops tokenizing.</p>
|
||||
|
||||
</div>
|
||||
<div class="description"><p>Stops tokenizing.</p>
|
||||
|
||||
<h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"></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>
|
||||
|
|
@ -1,5 +1,55 @@
|
|||
<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">CommandManager<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_CommandManager.new" data-id="CommandManager.new" class="memberLink"><a href="#CommandManager.new" class="" title="CommandManager.new (constructor)" data-id="CommandManager.new">new</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><li data-dropdown="dropdown" class="dropdown"><ul class="dropdown-menu"></ul></li></ul></div></div><article id="CommandManager" data-title="CommandManager (class)" class="article"></article><h3 class="sectionHeader">Constructors</h3><article id="CommandManager.new" data-title="CommandManager.new (constructor)" class="article"><div class="section method"><div class="memberContent"><div class="title"><i id="CommandManager.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="CommandManager.new" class="member-name methodClicker">CommandManager</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> platform, <a href="http://www.nodemanual.org/latest/js_doc/Array.html" class="argument methodClicker" title="Array" data-id="Array">Array</a> commands</span>)</li></ul><ul class="metaInfo"></ul></li></ul></div><div class="sideToggler"><div id="ellipsis_CommandManager.new" class="ellipsis_description"><p>TODO</p>
|
||||
</div><div class="description"><p>TODO</p>
|
||||
<h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"><tr class="argumentRow "><td class="argName ">platform</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. Identifier for the platform; must be either <code>'mac'</code> or <code>'win'</code></p>
|
||||
</td></tr><tr class="argumentRow "><td class="argName ">commands</td><td class="argType" "><a href="http://www.nodemanual.org/latest/js_doc/Array.html" class="" title="Array" data-id="Array">Array</a></td><td class="argDescription "><p>Required. A list of commands</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>
|
||||
|
||||
<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">CommandManager<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">
|
||||
<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>
|
||||
<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="CommandManager" data-title="CommandManager (class)" class="article">
|
||||
<div class="section description">
|
||||
<div class="memberContent"><p>new CommandManager(platform, commands)</p>
|
||||
|
||||
</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>
|
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
4788
api/editor.html
4788
api/editor.html
File diff suppressed because one or more lines are too long
|
|
@ -1,4 +1,12 @@
|
|||
|
||||
<div id="documentation" class="span8"><h1>Ace API Reference</h1>
|
||||
<p>Welcome to the Ace API Reference Guide. Ace is a standalone code editor written in JavaScript that you can embed onto any website. We're used in a bunch of places already, like GitHub, Google, and Facebook.</p>
|
||||
<p>On the left, you'll find a list of all of our currently documented classes. There are plenty more to do, but these represent the "core" set. For more information on how to work with Ace, check out the <a href="http://ace.ajax.org">main Ace website</a>.</p>
|
||||
<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>
|
||||
|
||||
<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>
|
||||
|
|
@ -1,24 +1,299 @@
|
|||
<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">PlaceHolder<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 (2)</span><b class="caret"></b></a><ul class="dropdown-menu"><li id="dropdown_PlaceHolder.event.onCursorChange" data-id="PlaceHolder.event.onCursorChange" class="memberLink"><a href="#PlaceHolder.event.onCursorChange" class="" title="PlaceHolder.event.onCursorChange (event)" data-id="PlaceHolder.event.onCursorChange">onCursorChange</a></li><li id="dropdown_PlaceHolder.event.onUpdate" data-id="PlaceHolder.event.onUpdate" class="memberLink"><a href="#PlaceHolder.event.onUpdate" class="" title="PlaceHolder.event.onUpdate (event)" data-id="PlaceHolder.event.onUpdate">onUpdate</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_PlaceHolder.new" data-id="PlaceHolder.new" class="memberLink"><a href="#PlaceHolder.new" class="" title="PlaceHolder.new (constructor)" data-id="PlaceHolder.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_PlaceHolder.cancel" data-id="PlaceHolder.cancel" class="memberLink"><a href="#PlaceHolder.cancel" class="" title="PlaceHolder.cancel (class method)" data-id="PlaceHolder.cancel">cancel</a></li><li id="dropdown_PlaceHolder.detach" data-id="PlaceHolder.detach" class="memberLink"><a href="#PlaceHolder.detach" class="" title="PlaceHolder.detach (class method)" data-id="PlaceHolder.detach">detach</a></li><li id="dropdown_PlaceHolder.hideOtherMarkers" data-id="PlaceHolder.hideOtherMarkers" class="memberLink"><a href="#PlaceHolder.hideOtherMarkers" class="" title="PlaceHolder.hideOtherMarkers (class method)" data-id="PlaceHolder.hideOtherMarkers">hideOtherMarkers</a></li><li id="dropdown_PlaceHolder.setup" data-id="PlaceHolder.setup" class="memberLink"><a href="#PlaceHolder.setup" class="" title="PlaceHolder.setup (class method)" data-id="PlaceHolder.setup">setup</a></li><li id="dropdown_PlaceHolder.showOtherMarkers" data-id="PlaceHolder.showOtherMarkers" class="memberLink"><a href="#PlaceHolder.showOtherMarkers" class="" title="PlaceHolder.showOtherMarkers (class method)" data-id="PlaceHolder.showOtherMarkers">showOtherMarkers</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="PlaceHolder" data-title="PlaceHolder (class)" class="article"><div class="section description"><div class="memberContent"><p>TODO</p>
|
||||
</div></div></article><h3 class="sectionHeader">Constructors</h3><article id="PlaceHolder.new" data-title="PlaceHolder.new (constructor)" class="article"><div class="section method"><div class="memberContent"><div class="title"><i id="PlaceHolder.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="PlaceHolder.new" class="member-name methodClicker">PlaceHolder</span>(<span class="sigArgList"><a href="#nav=api&api=document" class="argument methodClicker" title="Document (class)" data-id="Document">Document</a> session, <a href="http://www.nodemanual.org/latest/js_doc/Number.html" class="argument methodClicker" title="Number" data-id="Number">Number</a> length, <a href="http://www.nodemanual.org/latest/js_doc/Number.html" class="argument methodClicker" title="Number" data-id="Number">Number</a> pos, <a href="http://www.nodemanual.org/latest/js_doc/String.html" class="argument methodClicker" title="String" data-id="String">String</a> others, <a href="http://www.nodemanual.org/latest/js_doc/String.html" class="argument methodClicker" title="String" data-id="String">String</a> mainClass, <a href="http://www.nodemanual.org/latest/js_doc/String.html" class="argument methodClicker" title="String" data-id="String">String</a> othersClass</span>)</li></ul><ul class="metaInfo"></ul></li></ul></div><div class="sideToggler"><div id="ellipsis_PlaceHolder.new" class="ellipsis_description"><p>TODO</p>
|
||||
</div><div class="description"><p>TODO</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=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 ">length</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 ">pos</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><tr class="argumentRow "><td class="argName ">others</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. </p>
|
||||
</td></tr><tr class="argumentRow "><td class="argName ">mainClass</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. </p>
|
||||
</td></tr><tr class="argumentRow "><td class="argName ">othersClass</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. </p>
|
||||
</td></tr></table></div></div></div></div></article><h3 class="sectionHeader">Events</h3><article id="PlaceHolder.event.onCursorChange" data-title="PlaceHolder.event.onCursorChange (event)" class="article"><div class="section method"><div class="memberContent"><div class="title"><i id="PlaceHolder.event.onCursorChange" class="methodToggle methodClicker inactive icon-caret-right"></i><ul class="signatures"><li class="signature"><ul><li class="signature-call"><span class="eventObjName">PlaceHolder</span><span class="eventListenerStart">.on("</span><span id="PlaceHolder.event.onCursorChange" class="member-name eventMember methodClicker">onCursorChange</span><span class="eventListenerClose">", </span><span class="eventFunctionOpen">function(</span>e<span class="eventFunctionClose">))</span></li></ul><ul class="metaInfo"></ul></li></ul></div><div class="sideToggler"><div id="ellipsis_PlaceHolder.event.onCursorChange" class="ellipsis_description"><p>Emitted when the cursor changes.</p>
|
||||
</div><div class="description"><p>Emitted when the cursor changes.</p>
|
||||
</div></div></div></div></article><article id="PlaceHolder.event.onUpdate" data-title="PlaceHolder.event.onUpdate (event)" class="article"><div class="section method"><div class="memberContent"><div class="title"><i id="PlaceHolder.event.onUpdate" class="methodToggle methodClicker inactive icon-caret-right"></i><ul class="signatures"><li class="signature"><ul><li class="signature-call"><span class="eventObjName">PlaceHolder</span><span class="eventListenerStart">.on("</span><span id="PlaceHolder.event.onUpdate" class="member-name eventMember methodClicker">onUpdate</span><span class="eventListenerClose">", </span><span class="eventFunctionOpen">function(</span>e<span class="eventFunctionClose">))</span></li></ul><ul class="metaInfo"></ul></li></ul></div><div class="sideToggler"><div id="ellipsis_PlaceHolder.event.onUpdate" class="ellipsis_description"><p>Emitted when the place holder updates.</p>
|
||||
</div><div class="description"><p>Emitted when the place holder updates.</p>
|
||||
</div></div></div></div></article><h3 class="sectionHeader">Methods</h3><article id="PlaceHolder.cancel" data-title="PlaceHolder.cancel (class method)" class="article"><div class="section method"><div class="memberContent"><div class="title"><i id="PlaceHolder.cancel" class="methodToggle methodClicker inactive icon-caret-right"></i><ul class="signatures"><li class="signature"><ul><li class="signature-call"><span id="PlaceHolder.cancel" class="member-name methodClicker"><span class="sigClassName">PlaceHolder.</span><span class="sigMemberName">cancel</span></span>(<span class="sigArgList"></span>)</li></ul><ul class="metaInfo"></ul></li></ul></div><div class="sideToggler"><div id="ellipsis_PlaceHolder.cancel" class="ellipsis_description"><p>TODO</p>
|
||||
</div><div class="description"><p>TODO</p>
|
||||
</div></div></div></div></article><article id="PlaceHolder.detach" data-title="PlaceHolder.detach (class method)" class="article"><div class="section method"><div class="memberContent"><div class="title"><i id="PlaceHolder.detach" class="methodToggle methodClicker inactive icon-caret-right"></i><ul class="signatures"><li class="signature"><ul><li class="signature-call"><span id="PlaceHolder.detach" class="member-name methodClicker"><span class="sigClassName">PlaceHolder.</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_PlaceHolder.detach" class="ellipsis_description"><p>TODO</p>
|
||||
</div><div class="description"><p>TODO</p>
|
||||
</div></div></div></div></article><article id="PlaceHolder.hideOtherMarkers" data-title="PlaceHolder.hideOtherMarkers (class method)" class="article"><div class="section method"><div class="memberContent"><div class="title"><i id="PlaceHolder.hideOtherMarkers" class="methodToggle methodClicker inactive icon-caret-right"></i><ul class="signatures"><li class="signature"><ul><li class="signature-call"><span id="PlaceHolder.hideOtherMarkers" class="member-name methodClicker"><span class="sigClassName">PlaceHolder.</span><span class="sigMemberName">hideOtherMarkers</span></span>(<span class="sigArgList"></span>)</li></ul><ul class="metaInfo"></ul></li></ul></div><div class="sideToggler"><div id="ellipsis_PlaceHolder.hideOtherMarkers" class="ellipsis_description"><p>Hides all over markers in the <a href="#nav=api&api=edit_session" class="link-short" title="EditSession (class)" data-id="EditSession"><code>EditSession</code></a> that are not the currently selected one.</p>
|
||||
</div><div class="description"><p>Hides all over markers in the <a href="#nav=api&api=edit_session" class="link-short" title="EditSession (class)" data-id="EditSession"><code>EditSession</code></a> that are not the currently selected one.</p>
|
||||
</div></div></div></div></article><article id="PlaceHolder.setup" data-title="PlaceHolder.setup (class method)" class="article"><div class="section method"><div class="memberContent"><div class="title"><i id="PlaceHolder.setup" class="methodToggle methodClicker inactive icon-caret-right"></i><ul class="signatures"><li class="signature"><ul><li class="signature-call"><span id="PlaceHolder.setup" class="member-name methodClicker"><span class="sigClassName">PlaceHolder.</span><span class="sigMemberName">setup</span></span>(<span class="sigArgList"></span>)</li></ul><ul class="metaInfo"></ul></li></ul></div><div class="sideToggler"><div id="ellipsis_PlaceHolder.setup" class="ellipsis_description"><p>TODO</p>
|
||||
</div><div class="description"><p>TODO</p>
|
||||
</div></div></div></div></article><article id="PlaceHolder.showOtherMarkers" data-title="PlaceHolder.showOtherMarkers (class method)" class="article"><div class="section method"><div class="memberContent"><div class="title"><i id="PlaceHolder.showOtherMarkers" class="methodToggle methodClicker inactive icon-caret-right"></i><ul class="signatures"><li class="signature"><ul><li class="signature-call"><span id="PlaceHolder.showOtherMarkers" class="member-name methodClicker"><span class="sigClassName">PlaceHolder.</span><span class="sigMemberName">showOtherMarkers</span></span>(<span class="sigArgList"></span>)</li></ul><ul class="metaInfo"></ul></li></ul></div><div class="sideToggler"><div id="ellipsis_PlaceHolder.showOtherMarkers" class="ellipsis_description"><p>TODO</p>
|
||||
</div><div class="description"><p>TODO</p>
|
||||
</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>
|
||||
|
||||
<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">PlaceHolder<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_PlaceHolder.new" data-id="PlaceHolder.new" class="memberLink"><a href="#PlaceHolder.new" class="" title="PlaceHolder.new (constructor)" data-id="PlaceHolder.new">new</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li data-dropdown="dropdown" class="dropdown"><a href="#" data-toggle="dropdown" class="dropdown-toggle"><span>Functions (7)</span><b class="caret"></b></a>
|
||||
<ul class="dropdown-menu">
|
||||
<li id="dropdown_PlaceHolder.cancel" data-id="PlaceHolder.cancel" class="memberLink"><a href="#PlaceHolder.cancel" class="" title="PlaceHolder.cancel (class method)" data-id="PlaceHolder.cancel">cancel</a>
|
||||
</li>
|
||||
<li id="dropdown_PlaceHolder.detach" data-id="PlaceHolder.detach" class="memberLink"><a href="#PlaceHolder.detach" class="" title="PlaceHolder.detach (class method)" data-id="PlaceHolder.detach">detach</a>
|
||||
</li>
|
||||
<li id="dropdown_PlaceHolder.hideOtherMarkers" data-id="PlaceHolder.hideOtherMarkers" class="memberLink"><a href="#PlaceHolder.hideOtherMarkers" class="" title="PlaceHolder.hideOtherMarkers (class method)" data-id="PlaceHolder.hideOtherMarkers">hideOtherMarkers</a>
|
||||
</li>
|
||||
<li id="dropdown_PlaceHolder.onCursorChange" data-id="PlaceHolder.onCursorChange" class="memberLink"><a href="#PlaceHolder.onCursorChange" class="" title="PlaceHolder.onCursorChange (class method)" data-id="PlaceHolder.onCursorChange">onCursorChange</a>
|
||||
</li>
|
||||
<li id="dropdown_PlaceHolder.onUpdate" data-id="PlaceHolder.onUpdate" class="memberLink"><a href="#PlaceHolder.onUpdate" class="" title="PlaceHolder.onUpdate (class method)" data-id="PlaceHolder.onUpdate">onUpdate</a>
|
||||
</li>
|
||||
<li id="dropdown_PlaceHolder.setup" data-id="PlaceHolder.setup" class="memberLink"><a href="#PlaceHolder.setup" class="" title="PlaceHolder.setup (class method)" data-id="PlaceHolder.setup">setup</a>
|
||||
</li>
|
||||
<li id="dropdown_PlaceHolder.showOtherMarkers" data-id="PlaceHolder.showOtherMarkers" class="memberLink"><a href="#PlaceHolder.showOtherMarkers" class="" title="PlaceHolder.showOtherMarkers (class method)" data-id="PlaceHolder.showOtherMarkers">showOtherMarkers</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="PlaceHolder" data-title="PlaceHolder (class)" class="article">
|
||||
</article>
|
||||
<h3 class="sectionHeader">Constructors</h3>
|
||||
<article id="PlaceHolder.new" data-title="PlaceHolder.new (constructor)" class="article">
|
||||
<div class="section method">
|
||||
<div class="memberContent">
|
||||
<div class="title"><i id="PlaceHolder.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="PlaceHolder.new" class="member-name methodClicker">PlaceHolder</span></li>
|
||||
</ul>
|
||||
<ul class="metaInfo">
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sideToggler">
|
||||
<div id="ellipsis_PlaceHolder.new" class="ellipsis_description"><ul>
|
||||
<li>session (Document): The document to associate with the anchor</li>
|
||||
<li>length (Number): The starting row position</li>
|
||||
<li>pos (Number): The starting column position</li>
|
||||
<li>others (String):</li>
|
||||
<li>mainClass (String):</li>
|
||||
<li>othersClass (String):</li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
<div class="description"><ul>
|
||||
<li>session (Document): The document to associate with the anchor</li>
|
||||
<li>length (Number): The starting row position</li>
|
||||
<li>pos (Number): The starting column position</li>
|
||||
<li>others (String):</li>
|
||||
<li>mainClass (String):</li>
|
||||
<li>othersClass (String):</li>
|
||||
</ul>
|
||||
|
||||
<h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"></table>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</article>
|
||||
<h3 class="sectionHeader">Methods</h3>
|
||||
<article id="PlaceHolder.cancel" data-title="PlaceHolder.cancel (class method)" class="article">
|
||||
<div class="section method">
|
||||
<div class="memberContent">
|
||||
<div class="title"><i id="PlaceHolder.cancel" class="methodToggle methodClicker inactive icon-caret-right"></i>
|
||||
<ul class="signatures">
|
||||
<li class="signature">
|
||||
<ul>
|
||||
<li class="signature-call"><span id="PlaceHolder.cancel" class="member-name methodClicker"><span class="sigClassName">PlaceHolder.</span><span class="sigMemberName">cancel</span></span></li>
|
||||
</ul>
|
||||
<ul class="metaInfo">
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sideToggler">
|
||||
<div id="ellipsis_PlaceHolder.cancel" class="ellipsis_description"><p>PlaceHolder.cancel()</p>
|
||||
|
||||
</div>
|
||||
<div class="description"><p>PlaceHolder.cancel()</p>
|
||||
<p>TODO</p>
|
||||
|
||||
<h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"></table>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</article>
|
||||
<article id="PlaceHolder.detach" data-title="PlaceHolder.detach (class method)" class="article">
|
||||
<div class="section method">
|
||||
<div class="memberContent">
|
||||
<div class="title"><i id="PlaceHolder.detach" class="methodToggle methodClicker inactive icon-caret-right"></i>
|
||||
<ul class="signatures">
|
||||
<li class="signature">
|
||||
<ul>
|
||||
<li class="signature-call"><span id="PlaceHolder.detach" class="member-name methodClicker"><span class="sigClassName">PlaceHolder.</span><span class="sigMemberName">detach</span></span></li>
|
||||
</ul>
|
||||
<ul class="metaInfo">
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sideToggler">
|
||||
<div id="ellipsis_PlaceHolder.detach" class="ellipsis_description"><p>PlaceHolder.detach()</p>
|
||||
|
||||
</div>
|
||||
<div class="description"><p>PlaceHolder.detach()</p>
|
||||
<p>TODO</p>
|
||||
|
||||
<h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"></table>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</article>
|
||||
<article id="PlaceHolder.hideOtherMarkers" data-title="PlaceHolder.hideOtherMarkers (class method)" class="article">
|
||||
<div class="section method">
|
||||
<div class="memberContent">
|
||||
<div class="title"><i id="PlaceHolder.hideOtherMarkers" class="methodToggle methodClicker inactive icon-caret-right"></i>
|
||||
<ul class="signatures">
|
||||
<li class="signature">
|
||||
<ul>
|
||||
<li class="signature-call"><span id="PlaceHolder.hideOtherMarkers" class="member-name methodClicker"><span class="sigClassName">PlaceHolder.</span><span class="sigMemberName">hideOtherMarkers</span></span></li>
|
||||
</ul>
|
||||
<ul class="metaInfo">
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sideToggler">
|
||||
<div id="ellipsis_PlaceHolder.hideOtherMarkers" class="ellipsis_description"><p>PlaceHolder.hideOtherMarkers()</p>
|
||||
|
||||
</div>
|
||||
<div class="description"><p>PlaceHolder.hideOtherMarkers()</p>
|
||||
<p>Hides all over markers in the <a href="edit_session.html" class="link-short" title="EditSession (class)" data-id="EditSession"><code>EditSession</code></a> that are not the currently selected one.</p>
|
||||
|
||||
<h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"></table>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</article>
|
||||
<article id="PlaceHolder.onCursorChange" data-title="PlaceHolder.onCursorChange (class method)" class="article">
|
||||
<div class="section method">
|
||||
<div class="memberContent">
|
||||
<div class="title"><i id="PlaceHolder.onCursorChange" class="methodToggle methodClicker inactive icon-caret-right"></i>
|
||||
<ul class="signatures">
|
||||
<li class="signature">
|
||||
<ul>
|
||||
<li class="signature-call"><span id="PlaceHolder.onCursorChange" class="member-name methodClicker"><span class="sigClassName">PlaceHolder.</span><span class="sigMemberName">onCursorChange</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> event</span>)</li>
|
||||
</ul>
|
||||
<ul class="metaInfo">
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sideToggler">
|
||||
<div id="ellipsis_PlaceHolder.onCursorChange" class="ellipsis_description"><p>PlaceHolder@onCursorChange(e)</p>
|
||||
|
||||
</div>
|
||||
<div class="description"><p>PlaceHolder@onCursorChange(e)</p>
|
||||
<p>Emitted when the cursor changes.</p>
|
||||
|
||||
<h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"><tr class="argumentRow "><td class="argName ">event</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. </p>
|
||||
</td></tr></table>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</article>
|
||||
<article id="PlaceHolder.onUpdate" data-title="PlaceHolder.onUpdate (class method)" class="article">
|
||||
<div class="section method">
|
||||
<div class="memberContent">
|
||||
<div class="title"><i id="PlaceHolder.onUpdate" class="methodToggle methodClicker inactive icon-caret-right"></i>
|
||||
<ul class="signatures">
|
||||
<li class="signature">
|
||||
<ul>
|
||||
<li class="signature-call"><span id="PlaceHolder.onUpdate" class="member-name methodClicker"><span class="sigClassName">PlaceHolder.</span><span class="sigMemberName">onUpdate</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> event</span>)</li>
|
||||
</ul>
|
||||
<ul class="metaInfo">
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sideToggler">
|
||||
<div id="ellipsis_PlaceHolder.onUpdate" class="ellipsis_description"><p>PlaceHolder@onUpdate(e)</p>
|
||||
|
||||
</div>
|
||||
<div class="description"><p>PlaceHolder@onUpdate(e)</p>
|
||||
<p>Emitted when the place holder updates.</p>
|
||||
|
||||
<h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"><tr class="argumentRow "><td class="argName ">event</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. </p>
|
||||
</td></tr></table>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</article>
|
||||
<article id="PlaceHolder.setup" data-title="PlaceHolder.setup (class method)" class="article">
|
||||
<div class="section method">
|
||||
<div class="memberContent">
|
||||
<div class="title"><i id="PlaceHolder.setup" class="methodToggle methodClicker inactive icon-caret-right"></i>
|
||||
<ul class="signatures">
|
||||
<li class="signature">
|
||||
<ul>
|
||||
<li class="signature-call"><span id="PlaceHolder.setup" class="member-name methodClicker"><span class="sigClassName">PlaceHolder.</span><span class="sigMemberName">setup</span></span></li>
|
||||
</ul>
|
||||
<ul class="metaInfo">
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sideToggler">
|
||||
<div id="ellipsis_PlaceHolder.setup" class="ellipsis_description"><p>PlaceHolder.setup()</p>
|
||||
|
||||
</div>
|
||||
<div class="description"><p>PlaceHolder.setup()</p>
|
||||
<p>TODO</p>
|
||||
|
||||
<h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"></table>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</article>
|
||||
<article id="PlaceHolder.showOtherMarkers" data-title="PlaceHolder.showOtherMarkers (class method)" class="article">
|
||||
<div class="section method">
|
||||
<div class="memberContent">
|
||||
<div class="title"><i id="PlaceHolder.showOtherMarkers" class="methodToggle methodClicker inactive icon-caret-right"></i>
|
||||
<ul class="signatures">
|
||||
<li class="signature">
|
||||
<ul>
|
||||
<li class="signature-call"><span id="PlaceHolder.showOtherMarkers" class="member-name methodClicker"><span class="sigClassName">PlaceHolder.</span><span class="sigMemberName">showOtherMarkers</span></span></li>
|
||||
</ul>
|
||||
<ul class="metaInfo">
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sideToggler">
|
||||
<div id="ellipsis_PlaceHolder.showOtherMarkers" class="ellipsis_description"><p>PlaceHolder.showOtherMarkers()</p>
|
||||
|
||||
</div>
|
||||
<div class="description"><p>PlaceHolder.showOtherMarkers()</p>
|
||||
<p>TODO</p>
|
||||
|
||||
<h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"></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>
|
||||
1259
api/range.html
1259
api/range.html
File diff suppressed because one or more lines are too long
|
|
@ -1,3 +1,55 @@
|
|||
<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">RenderLoop<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_RenderLoop.new" data-id="RenderLoop.new" class="memberLink"><a href="#RenderLoop.new" class="" title="RenderLoop.new (constructor)" data-id="RenderLoop.new">new</a></li></ul></li><li data-dropdown="dropdown" class="dropdown"><a href="#" data-toggle="dropdown" class="dropdown-toggle"><span>Functions (1)</span><b class="caret"></b></a><ul class="dropdown-menu"><li id="dropdown_RenderLoop.schedule" data-id="RenderLoop.schedule" class="memberLink"><a href="#RenderLoop.schedule" class="" title="RenderLoop.schedule (class method)" data-id="RenderLoop.schedule">schedule</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="RenderLoop" data-title="RenderLoop (class)" class="article"><div class="section description"><div class="memberContent"><p>Batches changes (that force something to be redrawn) in the background.</p>
|
||||
</div></div></article><h3 class="sectionHeader">Constructors</h3><article id="RenderLoop.new" data-title="RenderLoop.new (constructor)" class="article"><div class="section method"><div class="memberContent"><div class="title"><i id="RenderLoop.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="RenderLoop.new" class="member-name methodClicker">RenderLoop</span>(<span class="sigArgList">onRender, win</span>)</li></ul><ul class="metaInfo"><li><span class="label internal">Internal</span></li></ul></li></ul></div><div class="sideToggler"><div id="ellipsis_RenderLoop.new" class="ellipsis_description"></div><div class="description"></div></div></div></div></article><h3 class="sectionHeader">Methods</h3><article id="RenderLoop.schedule" data-title="RenderLoop.schedule (class method)" class="article"><div class="section method"><div class="memberContent"><div class="title"><i id="RenderLoop.schedule" class="methodToggle methodClicker inactive icon-caret-right"></i><ul class="signatures"><li class="signature"><ul><li class="signature-call"><span id="RenderLoop.schedule" class="member-name methodClicker"><span class="sigClassName">RenderLoop.</span><span class="sigMemberName">schedule</span></span>(<span class="sigArgList"><a href="http://www.nodemanual.org/latest/js_doc/Array.html" class="argument methodClicker" title="Array" data-id="Array">Array</a> change</span>)</li></ul><ul class="metaInfo"><li><span class="label internal">Internal</span></li></ul></li></ul></div><div class="sideToggler"><div id="ellipsis_RenderLoop.schedule" 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 ">change</td><td class="argType" "><a href="http://www.nodemanual.org/latest/js_doc/Array.html" class="" title="Array" data-id="Array">Array</a></td><td class="argDescription "><p>Required. </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>
|
||||
|
||||
<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">RenderLoop<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">
|
||||
<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>
|
||||
<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="RenderLoop" data-title="RenderLoop (class)" class="article">
|
||||
<div class="section description">
|
||||
<div class="memberContent"><p>Batches changes (that force something to be redrawn) in the background.</p>
|
||||
|
||||
</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>
|
||||
|
|
@ -707,7 +707,7 @@ li.signature {
|
|||
.eventObjName {
|
||||
font-style: italic;
|
||||
}
|
||||
.eventListenerStart, .eventFunctionOpen, .eventFunctionClose {
|
||||
.eventListenerStart, .eventListenerClose, .eventFunctionOpen, .eventFunctionClose {
|
||||
color: #999999;
|
||||
}
|
||||
.eventMember {
|
||||
|
|
|
|||
|
|
@ -22,7 +22,7 @@ $(function () {
|
|||
if (query) {
|
||||
input.value = "";
|
||||
input.blur();
|
||||
var url = "https://www.google.com/search?q=" + encodeURIComponent("site:ace.ajax.org/api" + " " + query);
|
||||
var url = "https://www.google.com/search?q=" + encodeURIComponent("site:ace.ajax.org" + " " + query);
|
||||
window.open(url);
|
||||
}
|
||||
return false;
|
||||
|
|
|
|||
|
|
@ -1,19 +1,262 @@
|
|||
<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">ScrollBar<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_ScrollBar.event.scroll" data-id="ScrollBar.event.scroll" class="memberLink"><a href="#ScrollBar.event.scroll" class="" title="ScrollBar.event.scroll (event)" data-id="ScrollBar.event.scroll">scroll</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_ScrollBar.new" data-id="ScrollBar.new" class="memberLink"><a href="#ScrollBar.new" class="" title="ScrollBar.new (constructor)" data-id="ScrollBar.new">new</a></li></ul></li><li data-dropdown="dropdown" class="dropdown"><a href="#" data-toggle="dropdown" class="dropdown-toggle"><span>Functions (4)</span><b class="caret"></b></a><ul class="dropdown-menu"><li id="dropdown_ScrollBar.getWidth" data-id="ScrollBar.getWidth" class="memberLink"><a href="#ScrollBar.getWidth" class="" title="ScrollBar.getWidth (class method)" data-id="ScrollBar.getWidth">getWidth</a></li><li id="dropdown_ScrollBar.setHeight" data-id="ScrollBar.setHeight" class="memberLink"><a href="#ScrollBar.setHeight" class="" title="ScrollBar.setHeight (class method)" data-id="ScrollBar.setHeight">setHeight</a></li><li id="dropdown_ScrollBar.setInnerHeight" data-id="ScrollBar.setInnerHeight" class="memberLink"><a href="#ScrollBar.setInnerHeight" class="" title="ScrollBar.setInnerHeight (class method)" data-id="ScrollBar.setInnerHeight">setInnerHeight</a></li><li id="dropdown_ScrollBar.setScrollTop" data-id="ScrollBar.setScrollTop" class="memberLink"><a href="#ScrollBar.setScrollTop" class="" title="ScrollBar.setScrollTop (class method)" data-id="ScrollBar.setScrollTop">setScrollTop</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="ScrollBar" data-title="ScrollBar (class)" class="article"><div class="section description"><div class="memberContent"><p>A set of methods for setting and retrieving the editor's scrollbar.</p>
|
||||
</div></div></article><h3 class="sectionHeader">Constructors</h3><article id="ScrollBar.new" data-title="ScrollBar.new (constructor)" class="article"><div class="section method"><div class="memberContent"><div class="title"><i id="ScrollBar.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="ScrollBar.new" class="member-name methodClicker">ScrollBar</span>(<span class="sigArgList"><a href="https://developer.mozilla.org/en/DOM/element" class="argument methodClicker" title="DOMElement" data-id="DOMElement">DOMElement</a> parent</span>)</li></ul><ul class="metaInfo"></ul></li></ul></div><div class="sideToggler"><div id="ellipsis_ScrollBar.new" class="ellipsis_description"><p>Creates a new <code>ScrollBar</code>. <code>parent</code> is the owner of the scroll bar.</p>
|
||||
</div><div class="description"><p>Creates a new <code>ScrollBar</code>. <code>parent</code> is the owner of the scroll bar.</p>
|
||||
<h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"><tr class="argumentRow "><td class="argName ">parent</td><td class="argType" "><a href="https://developer.mozilla.org/en/DOM/element" class="" title="DOMElement" data-id="DOMElement">DOMElement</a></td><td class="argDescription "><p>Required. A DOM element </p>
|
||||
</td></tr></table></div></div></div></div></article><h3 class="sectionHeader">Events</h3><article id="ScrollBar.event.scroll" data-title="ScrollBar.event.scroll (event)" class="article"><div class="section method"><div class="memberContent"><div class="title"><i id="ScrollBar.event.scroll" class="methodToggle methodClicker inactive icon-caret-right"></i><ul class="signatures"><li class="signature"><ul><li class="signature-call"><span class="eventObjName">ScrollBar</span><span class="eventListenerStart">.on("</span><span id="ScrollBar.event.scroll" class="member-name eventMember methodClicker">scroll</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_ScrollBar.event.scroll" class="ellipsis_description"><p>Emitted when the scroll bar, well, scrolls.</p>
|
||||
</div><div class="description"><p>Emitted when the scroll bar, well, scrolls.</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. Contains one property, <code>"data"</code>, which indicates the current scroll top position</p>
|
||||
</td></tr></table></div></div></div></div></article><h3 class="sectionHeader">Methods</h3><article id="ScrollBar.getWidth" data-title="ScrollBar.getWidth (class method)" class="article"><div class="section method"><div class="memberContent"><div class="title"><i id="ScrollBar.getWidth" class="methodToggle methodClicker inactive icon-caret-right"></i><ul class="signatures"><li class="signature"><ul><li class="signature-call"><span id="ScrollBar.getWidth" class="member-name methodClicker"><span class="sigClassName">ScrollBar.</span><span class="sigMemberName">getWidth</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/Number.html" class="returnType " title="Number" data-id="Number">Number</a></li></ul></li></li></ul><ul class="metaInfo"></ul></li></ul></div><div class="sideToggler"><div id="ellipsis_ScrollBar.getWidth" class="ellipsis_description"><p>Returns the width of the scroll bar.</p>
|
||||
</div><div class="description"><p>Returns the width of the scroll bar.</p>
|
||||
</div></div></div></div></article><article id="ScrollBar.setHeight" data-title="ScrollBar.setHeight (class method)" class="article"><div class="section method"><div class="memberContent"><div class="title"><i id="ScrollBar.setHeight" class="methodToggle methodClicker inactive icon-caret-right"></i><ul class="signatures"><li class="signature"><ul><li class="signature-call"><span id="ScrollBar.setHeight" class="member-name methodClicker"><span class="sigClassName">ScrollBar.</span><span class="sigMemberName">setHeight</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> height</span>)</li></ul><ul class="metaInfo"></ul></li></ul></div><div class="sideToggler"><div id="ellipsis_ScrollBar.setHeight" class="ellipsis_description"><p>Sets the height of the scroll bar, in pixels.</p>
|
||||
</div><div class="description"><p>Sets the height of the scroll bar, in pixels.</p>
|
||||
<h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"><tr class="argumentRow "><td class="argName ">height</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 new height</p>
|
||||
</td></tr></table></div></div></div></div></article><article id="ScrollBar.setInnerHeight" data-title="ScrollBar.setInnerHeight (class method)" class="article"><div class="section method"><div class="memberContent"><div class="title"><i id="ScrollBar.setInnerHeight" class="methodToggle methodClicker inactive icon-caret-right"></i><ul class="signatures"><li class="signature"><ul><li class="signature-call"><span id="ScrollBar.setInnerHeight" class="member-name methodClicker"><span class="sigClassName">ScrollBar.</span><span class="sigMemberName">setInnerHeight</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> height</span>)</li></ul><ul class="metaInfo"></ul></li></ul></div><div class="sideToggler"><div id="ellipsis_ScrollBar.setInnerHeight" class="ellipsis_description"><p>Sets the inner height of the scroll bar, in pixels.</p>
|
||||
</div><div class="description"><p>Sets the inner height of the scroll bar, in pixels.</p>
|
||||
<h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"><tr class="argumentRow "><td class="argName ">height</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 new inner height</p>
|
||||
</td></tr></table></div></div></div></div></article><article id="ScrollBar.setScrollTop" data-title="ScrollBar.setScrollTop (class method)" class="article"><div class="section method"><div class="memberContent"><div class="title"><i id="ScrollBar.setScrollTop" class="methodToggle methodClicker inactive icon-caret-right"></i><ul class="signatures"><li class="signature"><ul><li class="signature-call"><span id="ScrollBar.setScrollTop" class="member-name methodClicker"><span class="sigClassName">ScrollBar.</span><span class="sigMemberName">setScrollTop</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> scrollTop</span>)</li></ul><ul class="metaInfo"></ul></li></ul></div><div class="sideToggler"><div id="ellipsis_ScrollBar.setScrollTop" class="ellipsis_description"><p>Sets the scroll top of the scroll bar.</p>
|
||||
</div><div class="description"><p>Sets the scroll top of the scroll bar.</p>
|
||||
<h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"><tr class="argumentRow "><td class="argName ">scrollTop</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 new scroll top</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>
|
||||
|
||||
<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">ScrollBar<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_ScrollBar.event.scroll" data-id="ScrollBar.event.scroll" class="memberLink"><a href="#ScrollBar.event.scroll" class="" title="ScrollBar.event.scroll (event)" data-id="ScrollBar.event.scroll">scroll</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_ScrollBar.new" data-id="ScrollBar.new" class="memberLink"><a href="#ScrollBar.new" class="" title="ScrollBar.new (constructor)" data-id="ScrollBar.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_ScrollBar.getWidth" data-id="ScrollBar.getWidth" class="memberLink"><a href="#ScrollBar.getWidth" class="" title="ScrollBar.getWidth (class method)" data-id="ScrollBar.getWidth">getWidth</a>
|
||||
</li>
|
||||
<li id="dropdown_ScrollBar.onScroll" data-id="ScrollBar.onScroll" class="memberLink"><a href="#ScrollBar.onScroll" class="" title="ScrollBar.onScroll (class method)" data-id="ScrollBar.onScroll">onScroll</a>
|
||||
</li>
|
||||
<li id="dropdown_ScrollBar.setHeight" data-id="ScrollBar.setHeight" class="memberLink"><a href="#ScrollBar.setHeight" class="" title="ScrollBar.setHeight (class method)" data-id="ScrollBar.setHeight">setHeight</a>
|
||||
</li>
|
||||
<li id="dropdown_ScrollBar.setInnerHeight" data-id="ScrollBar.setInnerHeight" class="memberLink"><a href="#ScrollBar.setInnerHeight" class="" title="ScrollBar.setInnerHeight (class method)" data-id="ScrollBar.setInnerHeight">setInnerHeight</a>
|
||||
</li>
|
||||
<li id="dropdown_ScrollBar.setScrollTop" data-id="ScrollBar.setScrollTop" class="memberLink"><a href="#ScrollBar.setScrollTop" class="" title="ScrollBar.setScrollTop (class method)" data-id="ScrollBar.setScrollTop">setScrollTop</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="ScrollBar" data-title="ScrollBar (class)" class="article">
|
||||
<div class="section description">
|
||||
<div class="memberContent"><p>A set of methods for setting and retrieving the editor's scrollbar.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</article>
|
||||
<h3 class="sectionHeader">Constructors</h3>
|
||||
<article id="ScrollBar.new" data-title="ScrollBar.new (constructor)" class="article">
|
||||
<div class="section method">
|
||||
<div class="memberContent">
|
||||
<div class="title"><i id="ScrollBar.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="ScrollBar.new" class="member-name methodClicker">ScrollBar</span>(<span class="sigArgList"><a href="https://developer.mozilla.org/en/DOM/element" class="argument methodClicker" title="DOMElement" data-id="DOMElement">DOMElement</a> parent</span>)</li>
|
||||
</ul>
|
||||
<ul class="metaInfo">
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sideToggler">
|
||||
<div id="ellipsis_ScrollBar.new" class="ellipsis_description"><p>Creates a new <code>ScrollBar</code>. <code>parent</code> is the owner of the scroll bar.</p>
|
||||
|
||||
</div>
|
||||
<div class="description"><p>Creates a new <code>ScrollBar</code>. <code>parent</code> is the owner of the scroll bar.</p>
|
||||
|
||||
<h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"><tr class="argumentRow "><td class="argName ">parent</td><td class="argType" "><a href="https://developer.mozilla.org/en/DOM/element" class="" title="DOMElement" data-id="DOMElement">DOMElement</a></td><td class="argDescription "><p>Required. A DOM element</p>
|
||||
</td></tr></table>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</article>
|
||||
<h3 class="sectionHeader">Events</h3>
|
||||
<article id="ScrollBar.event.scroll" data-title="ScrollBar.event.scroll (event)" class="article">
|
||||
<div class="section method">
|
||||
<div class="memberContent">
|
||||
<div class="title"><i id="ScrollBar.event.scroll" class="methodToggle methodClicker inactive icon-caret-right"></i>
|
||||
<ul class="signatures">
|
||||
<li class="signature">
|
||||
<ul>
|
||||
<li class="signature-call"><span class="eventObjName">ScrollBar</span><span class="eventListenerStart">.on("</span><span id="ScrollBar.event.scroll" class="member-name eventMember methodClicker">scroll</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_ScrollBar.event.scroll" class="ellipsis_description"><p>Emitted when the scroll bar, well, scrolls.</p>
|
||||
|
||||
</div>
|
||||
<div class="description"><p>Emitted when the scroll bar, well, scrolls.</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. Contains one property, <code>"data"</code>, which indicates the current scroll top position</p>
|
||||
</td></tr></table>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</article>
|
||||
<h3 class="sectionHeader">Methods</h3>
|
||||
<article id="ScrollBar.getWidth" data-title="ScrollBar.getWidth (class method)" class="article">
|
||||
<div class="section method">
|
||||
<div class="memberContent">
|
||||
<div class="title"><i id="ScrollBar.getWidth" class="methodToggle methodClicker inactive icon-caret-right"></i>
|
||||
<ul class="signatures">
|
||||
<li class="signature">
|
||||
<ul>
|
||||
<li class="signature-call"><span id="ScrollBar.getWidth" class="member-name methodClicker"><span class="sigClassName">ScrollBar.</span><span class="sigMemberName">getWidth</span></span>
|
||||
<li class="signature-returns">
|
||||
<ul class="argument-types">
|
||||
<li class="argument-type"><a href="http://www.nodemanual.org/latest/js_doc/Number.html" class="returnType " title="Number" data-id="Number">Number</a></li>
|
||||
</ul>
|
||||
</li></li>
|
||||
</ul>
|
||||
<ul class="metaInfo">
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sideToggler">
|
||||
<div id="ellipsis_ScrollBar.getWidth" class="ellipsis_description"><p>Returns the width of the scroll bar.</p>
|
||||
|
||||
</div>
|
||||
<div class="description"><p>Returns the width of the scroll bar.</p>
|
||||
|
||||
<h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"></table>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</article>
|
||||
<article id="ScrollBar.onScroll" data-title="ScrollBar.onScroll (class method)" class="article">
|
||||
<div class="section method">
|
||||
<div class="memberContent">
|
||||
<div class="title"><i id="ScrollBar.onScroll" class="methodToggle methodClicker inactive icon-caret-right"></i>
|
||||
<ul class="signatures">
|
||||
<li class="signature">
|
||||
<ul>
|
||||
<li class="signature-call"><span id="ScrollBar.onScroll" class="member-name methodClicker"><span class="sigClassName">ScrollBar.</span><span class="sigMemberName">onScroll</span></span></li>
|
||||
</ul>
|
||||
<ul class="metaInfo">
|
||||
<li><span class="label incomplete">Incomplete</span></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sideToggler">
|
||||
<div id="ellipsis_ScrollBar.onScroll" class="ellipsis_description">
|
||||
</div>
|
||||
<div class="description">
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</article>
|
||||
<article id="ScrollBar.setHeight" data-title="ScrollBar.setHeight (class method)" class="article">
|
||||
<div class="section method">
|
||||
<div class="memberContent">
|
||||
<div class="title"><i id="ScrollBar.setHeight" class="methodToggle methodClicker inactive icon-caret-right"></i>
|
||||
<ul class="signatures">
|
||||
<li class="signature">
|
||||
<ul>
|
||||
<li class="signature-call"><span id="ScrollBar.setHeight" class="member-name methodClicker"><span class="sigClassName">ScrollBar.</span><span class="sigMemberName">setHeight</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> height</span>)</li>
|
||||
</ul>
|
||||
<ul class="metaInfo">
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sideToggler">
|
||||
<div id="ellipsis_ScrollBar.setHeight" class="ellipsis_description"><p>Sets the height of the scroll bar, in pixels.</p>
|
||||
|
||||
</div>
|
||||
<div class="description"><p>Sets the height of the scroll bar, in pixels.</p>
|
||||
|
||||
<h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"><tr class="argumentRow "><td class="argName ">height</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 new height</p>
|
||||
</td></tr></table>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</article>
|
||||
<article id="ScrollBar.setInnerHeight" data-title="ScrollBar.setInnerHeight (class method)" class="article">
|
||||
<div class="section method">
|
||||
<div class="memberContent">
|
||||
<div class="title"><i id="ScrollBar.setInnerHeight" class="methodToggle methodClicker inactive icon-caret-right"></i>
|
||||
<ul class="signatures">
|
||||
<li class="signature">
|
||||
<ul>
|
||||
<li class="signature-call"><span id="ScrollBar.setInnerHeight" class="member-name methodClicker"><span class="sigClassName">ScrollBar.</span><span class="sigMemberName">setInnerHeight</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> height</span>)</li>
|
||||
</ul>
|
||||
<ul class="metaInfo">
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sideToggler">
|
||||
<div id="ellipsis_ScrollBar.setInnerHeight" class="ellipsis_description"><p>Sets the inner height of the scroll bar, in pixels.</p>
|
||||
|
||||
</div>
|
||||
<div class="description"><p>Sets the inner height of the scroll bar, in pixels.</p>
|
||||
|
||||
<h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"><tr class="argumentRow "><td class="argName ">height</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 new inner height</p>
|
||||
</td></tr></table>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</article>
|
||||
<article id="ScrollBar.setScrollTop" data-title="ScrollBar.setScrollTop (class method)" class="article">
|
||||
<div class="section method">
|
||||
<div class="memberContent">
|
||||
<div class="title"><i id="ScrollBar.setScrollTop" class="methodToggle methodClicker inactive icon-caret-right"></i>
|
||||
<ul class="signatures">
|
||||
<li class="signature">
|
||||
<ul>
|
||||
<li class="signature-call"><span id="ScrollBar.setScrollTop" class="member-name methodClicker"><span class="sigClassName">ScrollBar.</span><span class="sigMemberName">setScrollTop</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> scrollTop</span>)</li>
|
||||
</ul>
|
||||
<ul class="metaInfo">
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sideToggler">
|
||||
<div id="ellipsis_ScrollBar.setScrollTop" class="ellipsis_description"><p>Sets the scroll top of the scroll bar.</p>
|
||||
|
||||
</div>
|
||||
<div class="description"><p>Sets the scroll top of the scroll bar.</p>
|
||||
|
||||
<h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"><tr class="argumentRow "><td class="argName ">scrollTop</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 new scroll top</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>
|
||||
305
api/search.html
305
api/search.html
|
|
@ -1,35 +1,292 @@
|
|||
<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>
|
||||
|
||||
<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.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>
|
||||
<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>
|
||||
</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="document.html" 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></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'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>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>
|
||||
<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>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>
|
||||
<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>
|
||||
|
||||
<h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"></table>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</article>
|
||||
<h3 class="sectionHeader">Methods</h3>
|
||||
<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="edit_session.html" 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="range.html" 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="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>
|
||||
|
||||
</div>
|
||||
<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>
|
||||
|
||||
<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>
|
||||
</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="edit_session.html" class="argument methodClicker" title="EditSession (class)" data-id="EditSession">EditSession</a> session</span>)</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="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>
|
||||
|
||||
</div>
|
||||
<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>
|
||||
|
||||
<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>
|
||||
</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>
|
||||
<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>
|
||||
|
||||
<h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"></table>
|
||||
</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>
|
||||
<ul>
|
||||
<li>If <code>options.needle</code> was not found, this function returns <code>null</code>.</li>
|
||||
<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/>
|
||||
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>
|
||||
</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.html" class="returnType " title="Search (class)" data-id="Search">Search</a></li>
|
||||
</ul>
|
||||
</li></li>
|
||||
</ul>
|
||||
<ul class="metaInfo">
|
||||
<li><span class="label chainable">Chainable</span></li>
|
||||
</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>
|
||||
<article id="Search.setOptions" data-title="Search.setOptions (class method)" class="article">
|
||||
<div class="section method">
|
||||
<div class="memberContent">
|
||||
<div class="title"><i id="Search.setOptions" class="methodToggle methodClicker inactive icon-caret-right"></i>
|
||||
<ul class="signatures">
|
||||
<li class="signature">
|
||||
<ul>
|
||||
<li class="signature-call"><span id="Search.setOptions" class="member-name methodClicker"><span class="sigClassName">Search.</span><span class="sigMemberName">setOptions</span></span></li>
|
||||
</ul>
|
||||
<ul class="metaInfo">
|
||||
<li><span class="label incomplete">Incomplete</span></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sideToggler">
|
||||
<div id="ellipsis_Search.setOptions" class="ellipsis_description">
|
||||
</div>
|
||||
<div class="description">
|
||||
</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>
|
||||
1698
api/selection.html
1698
api/selection.html
File diff suppressed because one or more lines are too long
678
api/split.html
678
api/split.html
File diff suppressed because one or more lines are too long
|
|
@ -1,18 +1,248 @@
|
|||
<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">TokenIterator<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_TokenIterator.new" data-id="TokenIterator.new" class="memberLink"><a href="#TokenIterator.new" class="" title="TokenIterator.new (constructor)" data-id="TokenIterator.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_TokenIterator.getCurrentToken" data-id="TokenIterator.getCurrentToken" class="memberLink"><a href="#TokenIterator.getCurrentToken" class="" title="TokenIterator.getCurrentToken (class method)" data-id="TokenIterator.getCurrentToken">getCurrentToken</a></li><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></li><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></li><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></li><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></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="TokenIterator" data-title="TokenIterator (class)" class="article"><div class="section description"><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>
|
||||
</div></div></article><h3 class="sectionHeader">Constructors</h3><article id="TokenIterator.new" data-title="TokenIterator.new (constructor)" class="article"><div class="section method"><div class="memberContent"><div class="title"><i id="TokenIterator.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="TokenIterator.new" class="member-name methodClicker">TokenIterator</span>(<span class="sigArgList"><a href="#nav=api&api=edit_session" class="argument methodClicker" title="EditSession (class)" data-id="EditSession">EditSession</a> session, <a href="http://www.nodemanual.org/latest/js_doc/Number.html" class="argument methodClicker" title="Number" data-id="Number">Number</a> initialRow, <a href="http://www.nodemanual.org/latest/js_doc/Number.html" class="argument methodClicker" title="Number" data-id="Number">Number</a> initialColumn</span>)</li></ul><ul class="metaInfo"></ul></li></ul></div><div class="sideToggler"><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>
|
||||
</div><div class="description"><p>Creates a new token iterator object. The inital token index is set to the provided row and column coordinates.</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 associate with</p>
|
||||
</td></tr><tr class="argumentRow "><td class="argName ">initialRow</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 to start the tokenizing at</p>
|
||||
</td></tr><tr class="argumentRow "><td class="argName ">initialColumn</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 to start the tokenizing at</p>
|
||||
</td></tr></table></div></div></div></div></article><h3 class="sectionHeader">Methods</h3><article id="TokenIterator.getCurrentToken" data-title="TokenIterator.getCurrentToken (class method)" class="article"><div class="section method"><div class="memberContent"><div class="title"><i id="TokenIterator.getCurrentToken" class="methodToggle methodClicker inactive icon-caret-right"></i><ul class="signatures"><li class="signature"><ul><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="sigArgList"></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_TokenIterator.getCurrentToken" class="ellipsis_description"><p>Returns the current tokenized string.</p>
|
||||
</div><div class="description"><p>Returns the current tokenized string.</p>
|
||||
</div></div></div></div></article><article id="TokenIterator.getCurrentTokenColumn" data-title="TokenIterator.getCurrentTokenColumn (class method)" class="article"><div class="section method"><div class="memberContent"><div class="title"><i id="TokenIterator.getCurrentTokenColumn" class="methodToggle methodClicker inactive icon-caret-right"></i><ul class="signatures"><li class="signature"><ul><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="sigArgList"></span>)<li class="signature-returns"><ul class="argument-types"><li class="argument-type"><a href="http://www.nodemanual.org/latest/js_doc/Number.html" class="returnType " title="Number" data-id="Number">Number</a></li></ul></li></li></ul><ul class="metaInfo"></ul></li></ul></div><div class="sideToggler"><div id="ellipsis_TokenIterator.getCurrentTokenColumn" class="ellipsis_description"><p>Returns the current column.</p>
|
||||
</div><div class="description"><p>Returns the current column.</p>
|
||||
</div></div></div></div></article><article id="TokenIterator.getCurrentTokenRow" data-title="TokenIterator.getCurrentTokenRow (class method)" class="article"><div class="section method"><div class="memberContent"><div class="title"><i id="TokenIterator.getCurrentTokenRow" class="methodToggle methodClicker inactive icon-caret-right"></i><ul class="signatures"><li class="signature"><ul><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="sigArgList"></span>)<li class="signature-returns"><ul class="argument-types"><li class="argument-type"><a href="http://www.nodemanual.org/latest/js_doc/Number.html" class="returnType " title="Number" data-id="Number">Number</a></li></ul></li></li></ul><ul class="metaInfo"></ul></li></ul></div><div class="sideToggler"><div id="ellipsis_TokenIterator.getCurrentTokenRow" class="ellipsis_description"><p>Returns the current row.</p>
|
||||
</div><div class="description"><p>Returns the current row.</p>
|
||||
</div></div></div></div></article><article id="TokenIterator.stepBackward" data-title="TokenIterator.stepBackward (class method)" class="article"><div class="section method"><div class="memberContent"><div class="title"><i id="TokenIterator.stepBackward" class="methodToggle methodClicker inactive icon-caret-right"></i><ul class="signatures"><li class="signature"><ul><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="sigArgList"></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_TokenIterator.stepBackward" class="ellipsis_description"><p>Tokenizes all the items from the current point to the row prior in the document.</p>
|
||||
</div><div class="description"><p>Tokenizes all the items from the current point to the row prior in the document.</p>
|
||||
<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 the current point is not at the top of the file, this function returns <code>null</code>. Otherwise, it returns an array of the tokenized strings.</p>
|
||||
</td></tr></table></div></div></div></div></article><article id="TokenIterator.stepForward" data-title="TokenIterator.stepForward (class method)" class="article"><div class="section method"><div class="memberContent"><div class="title"><i id="TokenIterator.stepForward" class="methodToggle methodClicker inactive icon-caret-right"></i><ul class="signatures"><li class="signature"><ul><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="sigArgList"></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_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>
|
||||
</div><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>
|
||||
</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>
|
||||
|
||||
<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">TokenIterator<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_TokenIterator.new" data-id="TokenIterator.new" class="memberLink"><a href="#TokenIterator.new" class="" title="TokenIterator.new (constructor)" data-id="TokenIterator.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_TokenIterator.getCurrentToken" data-id="TokenIterator.getCurrentToken" class="memberLink"><a href="#TokenIterator.getCurrentToken" class="" title="TokenIterator.getCurrentToken (class method)" data-id="TokenIterator.getCurrentToken">getCurrentToken</a>
|
||||
</li>
|
||||
<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>
|
||||
</li>
|
||||
<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>
|
||||
</li>
|
||||
<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>
|
||||
</li>
|
||||
<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>
|
||||
</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="TokenIterator" data-title="TokenIterator (class)" class="article">
|
||||
<div class="section description">
|
||||
<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>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</article>
|
||||
<h3 class="sectionHeader">Constructors</h3>
|
||||
<article id="TokenIterator.new" data-title="TokenIterator.new (constructor)" class="article">
|
||||
<div class="section method">
|
||||
<div class="memberContent">
|
||||
<div class="title"><i id="TokenIterator.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="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="http://www.nodemanual.org/latest/js_doc/Number.html" class="argument methodClicker" title="Number" data-id="Number">Number</a> initialRow, <a href="http://www.nodemanual.org/latest/js_doc/Number.html" class="argument methodClicker" title="Number" data-id="Number">Number</a> initialColumn</span>)</li>
|
||||
</ul>
|
||||
<ul class="metaInfo">
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sideToggler">
|
||||
<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>
|
||||
|
||||
</div>
|
||||
<div class="description"><p>Creates a new token iterator object. The inital token index is set to the provided row and column coordinates.</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="edit_session.html" class="" title="EditSession (class)" data-id="EditSession">EditSession</a></td><td class="argDescription "><p>Required. The session to associate with</p>
|
||||
</td></tr><tr class="argumentRow "><td class="argName ">initialRow</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 to start the tokenizing at</p>
|
||||
</td></tr><tr class="argumentRow "><td class="argName ">initialColumn</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 to start the tokenizing at</p>
|
||||
</td></tr></table>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</article>
|
||||
<h3 class="sectionHeader">Methods</h3>
|
||||
<article id="TokenIterator.getCurrentToken" data-title="TokenIterator.getCurrentToken (class method)" class="article">
|
||||
<div class="section method">
|
||||
<div class="memberContent">
|
||||
<div class="title"><i id="TokenIterator.getCurrentToken" class="methodToggle methodClicker inactive icon-caret-right"></i>
|
||||
<ul class="signatures">
|
||||
<li class="signature">
|
||||
<ul>
|
||||
<li class="signature-call"><span id="TokenIterator.getCurrentToken" class="member-name methodClicker"><span class="sigClassName">TokenIterator.</span><span class="sigMemberName">getCurrentToken</span></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_TokenIterator.getCurrentToken" class="ellipsis_description"><p>Returns the current tokenized string.</p>
|
||||
|
||||
</div>
|
||||
<div class="description"><p>Returns the current tokenized string.</p>
|
||||
|
||||
<h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"></table>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</article>
|
||||
<article id="TokenIterator.getCurrentTokenColumn" data-title="TokenIterator.getCurrentTokenColumn (class method)" class="article">
|
||||
<div class="section method">
|
||||
<div class="memberContent">
|
||||
<div class="title"><i id="TokenIterator.getCurrentTokenColumn" class="methodToggle methodClicker inactive icon-caret-right"></i>
|
||||
<ul class="signatures">
|
||||
<li class="signature">
|
||||
<ul>
|
||||
<li class="signature-call"><span id="TokenIterator.getCurrentTokenColumn" class="member-name methodClicker"><span class="sigClassName">TokenIterator.</span><span class="sigMemberName">getCurrentTokenColumn</span></span>
|
||||
<li class="signature-returns">
|
||||
<ul class="argument-types">
|
||||
<li class="argument-type"><a href="http://www.nodemanual.org/latest/js_doc/Number.html" class="returnType " title="Number" data-id="Number">Number</a></li>
|
||||
</ul>
|
||||
</li></li>
|
||||
</ul>
|
||||
<ul class="metaInfo">
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sideToggler">
|
||||
<div id="ellipsis_TokenIterator.getCurrentTokenColumn" class="ellipsis_description"><p>Returns the current column.</p>
|
||||
|
||||
</div>
|
||||
<div class="description"><p>Returns the current column.</p>
|
||||
|
||||
<h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"></table>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</article>
|
||||
<article id="TokenIterator.getCurrentTokenRow" data-title="TokenIterator.getCurrentTokenRow (class method)" class="article">
|
||||
<div class="section method">
|
||||
<div class="memberContent">
|
||||
<div class="title"><i id="TokenIterator.getCurrentTokenRow" class="methodToggle methodClicker inactive icon-caret-right"></i>
|
||||
<ul class="signatures">
|
||||
<li class="signature">
|
||||
<ul>
|
||||
<li class="signature-call"><span id="TokenIterator.getCurrentTokenRow" class="member-name methodClicker"><span class="sigClassName">TokenIterator.</span><span class="sigMemberName">getCurrentTokenRow</span></span>
|
||||
<li class="signature-returns">
|
||||
<ul class="argument-types">
|
||||
<li class="argument-type"><a href="http://www.nodemanual.org/latest/js_doc/Number.html" class="returnType " title="Number" data-id="Number">Number</a></li>
|
||||
</ul>
|
||||
</li></li>
|
||||
</ul>
|
||||
<ul class="metaInfo">
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sideToggler">
|
||||
<div id="ellipsis_TokenIterator.getCurrentTokenRow" class="ellipsis_description"><p>Returns the current row.</p>
|
||||
|
||||
</div>
|
||||
<div class="description"><p>Returns the current row.</p>
|
||||
|
||||
<h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"></table>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</article>
|
||||
<article id="TokenIterator.stepBackward" data-title="TokenIterator.stepBackward (class method)" class="article">
|
||||
<div class="section method">
|
||||
<div class="memberContent">
|
||||
<div class="title"><i id="TokenIterator.stepBackward" class="methodToggle methodClicker inactive icon-caret-right"></i>
|
||||
<ul class="signatures">
|
||||
<li class="signature">
|
||||
<ul>
|
||||
<li class="signature-call"><span id="TokenIterator.stepBackward" class="member-name methodClicker"><span class="sigClassName">TokenIterator.</span><span class="sigMemberName">stepBackward</span></span></li>
|
||||
</ul>
|
||||
<ul class="metaInfo">
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sideToggler">
|
||||
<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>
|
||||
|
||||
</div>
|
||||
<div class="description"><p>Tokenizes all the items from the current point to the row prior in the document.</p>
|
||||
|
||||
<h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"></table>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</article>
|
||||
<article id="TokenIterator.stepForward" data-title="TokenIterator.stepForward (class method)" class="article">
|
||||
<div class="section method">
|
||||
<div class="memberContent">
|
||||
<div class="title"><i id="TokenIterator.stepForward" class="methodToggle methodClicker inactive icon-caret-right"></i>
|
||||
<ul class="signatures">
|
||||
<li class="signature">
|
||||
<ul>
|
||||
<li class="signature-call"><span id="TokenIterator.stepForward" class="member-name methodClicker"><span class="sigClassName">TokenIterator.</span><span class="sigMemberName">stepForward</span></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_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>
|
||||
|
||||
</div>
|
||||
<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>
|
||||
|
||||
<h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"></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>
|
||||
|
|
@ -1,8 +1,122 @@
|
|||
<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">Tokenizer<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_Tokenizer.new" data-id="Tokenizer.new" class="memberLink"><a href="#Tokenizer.new" class="" title="Tokenizer.new (constructor)" data-id="Tokenizer.new">new</a></li></ul></li><li data-dropdown="dropdown" class="dropdown"><a href="#" data-toggle="dropdown" class="dropdown-toggle"><span>Functions (1)</span><b class="caret"></b></a><ul class="dropdown-menu"><li id="dropdown_Tokenizer.getLineTokens" data-id="Tokenizer.getLineTokens" class="memberLink"><a href="#Tokenizer.getLineTokens" class="" title="Tokenizer.getLineTokens (class method)" data-id="Tokenizer.getLineTokens">getLineTokens</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="Tokenizer" data-title="Tokenizer (class)" class="article"><div class="section description"><div class="memberContent"><p>This class takes a set of highlighting rules, and creates a tokenizer out of them. For more information, see <a href="https://github.com/ajaxorg/ace/wiki/Creating-or-Extending-an-Edit-Mode#wiki-extendingTheHighlighter">the wiki on extending highlighters</a>.</p>
|
||||
</div></div></article><h3 class="sectionHeader">Constructors</h3><article id="Tokenizer.new" data-title="Tokenizer.new (constructor)" class="article"><div class="section method"><div class="memberContent"><div class="title"><i id="Tokenizer.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="Tokenizer.new" class="member-name methodClicker">Tokenizer</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> rules, <a href="http://www.nodemanual.org/latest/js_doc/String.html" class="argument methodClicker" title="String" data-id="String">String</a> flag</span>)</li></ul><ul class="metaInfo"></ul></li></ul></div><div class="sideToggler"><div id="ellipsis_Tokenizer.new" class="ellipsis_description"><p>Constructs a new tokenizer based on the given rules and flags.</p>
|
||||
</div><div class="description"><p>Constructs a new tokenizer based on the given rules and flags.</p>
|
||||
<h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"><tr class="argumentRow "><td class="argName ">rules</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. The highlighting rules</p>
|
||||
</td></tr><tr class="argumentRow "><td class="argName ">flag</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. Any additional regular expression flags to pass (like "i" for case insensitive)</p>
|
||||
</td></tr></table></div></div></div></div></article><h3 class="sectionHeader">Methods</h3><article id="Tokenizer.getLineTokens" data-title="Tokenizer.getLineTokens (class method)" class="article"><div class="section method"><div class="memberContent"><div class="title"><i id="Tokenizer.getLineTokens" class="methodToggle methodClicker inactive icon-caret-right"></i><ul class="signatures"><li class="signature"><ul><li class="signature-call"><span id="Tokenizer.getLineTokens" class="member-name methodClicker"><span class="sigClassName">Tokenizer.</span><span class="sigMemberName">getLineTokens</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_Tokenizer.getLineTokens" class="ellipsis_description"><p>Returns an object containing two properties: <code>tokens</code>, which contains all the tokens; and <code>state</code>, the current state.</p>
|
||||
</div><div class="description"><p>Returns an object containing two properties: <code>tokens</code>, which contains all the tokens; and <code>state</code>, the current state.</p>
|
||||
</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>
|
||||
|
||||
<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">Tokenizer<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_Tokenizer.new" data-id="Tokenizer.new" class="memberLink"><a href="#Tokenizer.new" class="" title="Tokenizer.new (constructor)" data-id="Tokenizer.new">new</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li data-dropdown="dropdown" class="dropdown"><a href="#" data-toggle="dropdown" class="dropdown-toggle"><span>Functions (1)</span><b class="caret"></b></a>
|
||||
<ul class="dropdown-menu">
|
||||
<li id="dropdown_Tokenizer.getLineTokens" data-id="Tokenizer.getLineTokens" class="memberLink"><a href="#Tokenizer.getLineTokens" class="" title="Tokenizer.getLineTokens (class method)" data-id="Tokenizer.getLineTokens">getLineTokens</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="Tokenizer" data-title="Tokenizer (class)" class="article">
|
||||
<div class="section description">
|
||||
<div class="memberContent"><p>This class takes a set of highlighting rules, and creates a tokenizer out of them. For more information, see <a href="https://github.com/ajaxorg/ace/wiki/Creating-or-Extending-an-Edit-Mode#wiki-extendingTheHighlighter">the wiki on extending highlighters</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</article>
|
||||
<h3 class="sectionHeader">Constructors</h3>
|
||||
<article id="Tokenizer.new" data-title="Tokenizer.new (constructor)" class="article">
|
||||
<div class="section method">
|
||||
<div class="memberContent">
|
||||
<div class="title"><i id="Tokenizer.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="Tokenizer.new" class="member-name methodClicker">Tokenizer</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> rules, <a href="http://www.nodemanual.org/latest/js_doc/String.html" class="argument methodClicker" title="String" data-id="String">String</a> flag</span>)</li>
|
||||
</ul>
|
||||
<ul class="metaInfo">
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sideToggler">
|
||||
<div id="ellipsis_Tokenizer.new" class="ellipsis_description"><p>Constructs a new tokenizer based on the given rules and flags.</p>
|
||||
|
||||
</div>
|
||||
<div class="description"><p>Constructs a new tokenizer based on the given rules and flags.</p>
|
||||
|
||||
<h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"><tr class="argumentRow "><td class="argName ">rules</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. The highlighting rules</p>
|
||||
</td></tr><tr class="argumentRow "><td class="argName ">flag</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. Any additional regular expression flags to pass (like "i" for case insensitive)</p>
|
||||
</td></tr></table>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</article>
|
||||
<h3 class="sectionHeader">Methods</h3>
|
||||
<article id="Tokenizer.getLineTokens" data-title="Tokenizer.getLineTokens (class method)" class="article">
|
||||
<div class="section method">
|
||||
<div class="memberContent">
|
||||
<div class="title"><i id="Tokenizer.getLineTokens" class="methodToggle methodClicker inactive icon-caret-right"></i>
|
||||
<ul class="signatures">
|
||||
<li class="signature">
|
||||
<ul>
|
||||
<li class="signature-call"><span id="Tokenizer.getLineTokens" class="member-name methodClicker"><span class="sigClassName">Tokenizer.</span><span class="sigMemberName">getLineTokens</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> line, <a href="http://www.nodemanual.org/latest/js_doc/Object.html" class="argument methodClicker" title="Object" data-id="Object">Object</a> startState</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_Tokenizer.getLineTokens" class="ellipsis_description"><p>Returns an object containing two properties: <code>tokens</code>, which contains all the tokens; and <code>state</code>, the current state.</p>
|
||||
|
||||
</div>
|
||||
<div class="description"><p>Returns an object containing two properties: <code>tokens</code>, which contains all the tokens; and <code>state</code>, the current state.</p>
|
||||
|
||||
<h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"><tr class="argumentRow "><td class="argName ">line</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. </p>
|
||||
</td></tr><tr class="argumentRow "><td class="argName ">startState</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. </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>
|
||||
|
|
@ -1,23 +1,275 @@
|
|||
<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">UndoManager<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_UndoManager.new" data-id="UndoManager.new" class="memberLink"><a href="#UndoManager.new" class="" title="UndoManager.new (constructor)" data-id="UndoManager.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_UndoManager.execute" data-id="UndoManager.execute" class="memberLink"><a href="#UndoManager.execute" class="" title="UndoManager.execute (class method)" data-id="UndoManager.execute">execute</a></li><li id="dropdown_UndoManager.hasRedo" data-id="UndoManager.hasRedo" class="memberLink"><a href="#UndoManager.hasRedo" class="" title="UndoManager.hasRedo (class method)" data-id="UndoManager.hasRedo">hasRedo</a></li><li id="dropdown_UndoManager.hasUndo" data-id="UndoManager.hasUndo" class="memberLink"><a href="#UndoManager.hasUndo" class="" title="UndoManager.hasUndo (class method)" data-id="UndoManager.hasUndo">hasUndo</a></li><li id="dropdown_UndoManager.redo" data-id="UndoManager.redo" class="memberLink"><a href="#UndoManager.redo" class="" title="UndoManager.redo (class method)" data-id="UndoManager.redo">redo</a></li><li id="dropdown_UndoManager.reset" data-id="UndoManager.reset" class="memberLink"><a href="#UndoManager.reset" class="" title="UndoManager.reset (class method)" data-id="UndoManager.reset">reset</a></li><li id="dropdown_UndoManager.undo" data-id="UndoManager.undo" class="memberLink"><a href="#UndoManager.undo" class="" title="UndoManager.undo (class method)" data-id="UndoManager.undo">undo</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="UndoManager" data-title="UndoManager (class)" class="article"><div class="section description"><div class="memberContent"><p>This object maintains the undo stack for an <a href="#nav=api&api=edit_session" class="link-short" title="EditSession (class)" data-id="EditSession"><code>EditSession</code></a>.</p>
|
||||
</div></div></article><h3 class="sectionHeader">Constructors</h3><article id="UndoManager.new" data-title="UndoManager.new (constructor)" class="article"><div class="section method"><div class="memberContent"><div class="title"><i id="UndoManager.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="UndoManager.new" class="member-name methodClicker">UndoManager</span>(<span class="sigArgList"></span>)</li></ul><ul class="metaInfo"></ul></li></ul></div><div class="sideToggler"><div id="ellipsis_UndoManager.new" class="ellipsis_description"><p>Resets the current undo state and creates a new <code>UndoManager</code>.</p>
|
||||
</div><div class="description"><p>Resets the current undo state and creates a new <code>UndoManager</code>.</p>
|
||||
</div></div></div></div></article><h3 class="sectionHeader">Methods</h3><article id="UndoManager.execute" data-title="UndoManager.execute (class method)" class="article"><div class="section method"><div class="memberContent"><div class="title"><i id="UndoManager.execute" class="methodToggle methodClicker inactive icon-caret-right"></i><ul class="signatures"><li class="signature"><ul><li class="signature-call"><span id="UndoManager.execute" class="member-name methodClicker"><span class="sigClassName">UndoManager.</span><span class="sigMemberName">execute</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"><span class="returnType " title="UndoManager.execute (class method)">Void</span></li></ul></li></li></ul><ul class="metaInfo"></ul></li></ul></div><div class="sideToggler"><div id="ellipsis_UndoManager.execute" class="ellipsis_description"><p>Provides a means for implementing your own undo manager. <code>options</code> has one property, <code>args</code>, an <a href="http://www.nodemanual.org/latest/js_doc/Array.html" class="link-short" title="<code>Array</code>" data-id="<code>Array</code>"><code>Array</code></a>, with two elements:</p>
|
||||
</div><div class="description"><p>Provides a means for implementing your own undo manager. <code>options</code> has one property, <code>args</code>, an <a href="http://www.nodemanual.org/latest/js_doc/Array.html" class="link-short" title="<code>Array</code>" data-id="<code>Array</code>"><code>Array</code></a>, with two elements:</p>
|
||||
|
||||
<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">UndoManager<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_UndoManager.new" data-id="UndoManager.new" class="memberLink"><a href="#UndoManager.new" class="" title="UndoManager.new (constructor)" data-id="UndoManager.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_UndoManager.execute" data-id="UndoManager.execute" class="memberLink"><a href="#UndoManager.execute" class="" title="UndoManager.execute (class method)" data-id="UndoManager.execute">execute</a>
|
||||
</li>
|
||||
<li id="dropdown_UndoManager.hasRedo" data-id="UndoManager.hasRedo" class="memberLink"><a href="#UndoManager.hasRedo" class="" title="UndoManager.hasRedo (class method)" data-id="UndoManager.hasRedo">hasRedo</a>
|
||||
</li>
|
||||
<li id="dropdown_UndoManager.hasUndo" data-id="UndoManager.hasUndo" class="memberLink"><a href="#UndoManager.hasUndo" class="" title="UndoManager.hasUndo (class method)" data-id="UndoManager.hasUndo">hasUndo</a>
|
||||
</li>
|
||||
<li id="dropdown_UndoManager.redo" data-id="UndoManager.redo" class="memberLink"><a href="#UndoManager.redo" class="" title="UndoManager.redo (class method)" data-id="UndoManager.redo">redo</a>
|
||||
</li>
|
||||
<li id="dropdown_UndoManager.reset" data-id="UndoManager.reset" class="memberLink"><a href="#UndoManager.reset" class="" title="UndoManager.reset (class method)" data-id="UndoManager.reset">reset</a>
|
||||
</li>
|
||||
<li id="dropdown_UndoManager.undo" data-id="UndoManager.undo" class="memberLink"><a href="#UndoManager.undo" class="" title="UndoManager.undo (class method)" data-id="UndoManager.undo">undo</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="UndoManager" data-title="UndoManager (class)" class="article">
|
||||
<div class="section description">
|
||||
<div class="memberContent"><p>This object maintains the undo stack for an <a href="edit_session.html" class="link-short" title="EditSession (class)" data-id="EditSession"><code>EditSession</code></a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</article>
|
||||
<h3 class="sectionHeader">Constructors</h3>
|
||||
<article id="UndoManager.new" data-title="UndoManager.new (constructor)" class="article">
|
||||
<div class="section method">
|
||||
<div class="memberContent">
|
||||
<div class="title"><i id="UndoManager.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="UndoManager.new" class="member-name methodClicker">UndoManager</span></li>
|
||||
</ul>
|
||||
<ul class="metaInfo">
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sideToggler">
|
||||
<div id="ellipsis_UndoManager.new" class="ellipsis_description"><p>Resets the current undo state and creates a new <code>UndoManager</code>.</p>
|
||||
|
||||
</div>
|
||||
<div class="description"><p>Resets the current undo state and creates a new <code>UndoManager</code>.</p>
|
||||
|
||||
<h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"></table>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</article>
|
||||
<h3 class="sectionHeader">Methods</h3>
|
||||
<article id="UndoManager.execute" data-title="UndoManager.execute (class method)" class="article">
|
||||
<div class="section method">
|
||||
<div class="memberContent">
|
||||
<div class="title"><i id="UndoManager.execute" class="methodToggle methodClicker inactive icon-caret-right"></i>
|
||||
<ul class="signatures">
|
||||
<li class="signature">
|
||||
<ul>
|
||||
<li class="signature-call"><span id="UndoManager.execute" class="member-name methodClicker"><span class="sigClassName">UndoManager.</span><span class="sigMemberName">execute</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>
|
||||
</ul>
|
||||
<ul class="metaInfo">
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sideToggler">
|
||||
<div id="ellipsis_UndoManager.execute" class="ellipsis_description"><p>Provides a means for implementing your own undo manager. <code>options</code> has one property, <code>args</code>, an <a href="http://www.nodemanual.org/latest/js_doc/Array.html" class="link-short" title="<code>Array</code>" data-id="<code>Array</code>"><code>Array</code></a>, with two elements:</p>
|
||||
|
||||
</div>
|
||||
<div class="description"><p>Provides a means for implementing your own undo manager. <code>options</code> has one property, <code>args</code>, an <a href="http://www.nodemanual.org/latest/js_doc/Array.html" class="link-short" title="<code>Array</code>" data-id="<code>Array</code>"><code>Array</code></a>, with two elements:</p>
|
||||
<ul>
|
||||
<li><code>args[0]</code> is an array of deltas</li>
|
||||
<li><code>args[1]</code> is the document to associate with</li>
|
||||
</ul>
|
||||
<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. Contains additional properties</p>
|
||||
</td></tr></table></div></div></div></div></article><article id="UndoManager.hasRedo" data-title="UndoManager.hasRedo (class method)" class="article"><div class="section method"><div class="memberContent"><div class="title"><i id="UndoManager.hasRedo" class="methodToggle methodClicker inactive icon-caret-right"></i><ul class="signatures"><li class="signature"><ul><li class="signature-call"><span id="UndoManager.hasRedo" class="member-name methodClicker"><span class="sigClassName">UndoManager.</span><span class="sigMemberName">hasRedo</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/Boolean.html" class="returnType " title="Boolean" data-id="Boolean">Boolean</a></li></ul></li></li></ul><ul class="metaInfo"></ul></li></ul></div><div class="sideToggler"><div id="ellipsis_UndoManager.hasRedo" class="ellipsis_description"><p>Returns <code>true</code> if there are redo operations left to perform.</p>
|
||||
</div><div class="description"><p>Returns <code>true</code> if there are redo operations left to perform.</p>
|
||||
</div></div></div></div></article><article id="UndoManager.hasUndo" data-title="UndoManager.hasUndo (class method)" class="article"><div class="section method"><div class="memberContent"><div class="title"><i id="UndoManager.hasUndo" class="methodToggle methodClicker inactive icon-caret-right"></i><ul class="signatures"><li class="signature"><ul><li class="signature-call"><span id="UndoManager.hasUndo" class="member-name methodClicker"><span class="sigClassName">UndoManager.</span><span class="sigMemberName">hasUndo</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/Boolean.html" class="returnType " title="Boolean" data-id="Boolean">Boolean</a></li></ul></li></li></ul><ul class="metaInfo"></ul></li></ul></div><div class="sideToggler"><div id="ellipsis_UndoManager.hasUndo" class="ellipsis_description"><p>Returns <code>true</code> if there are undo operations left to perform.</p>
|
||||
</div><div class="description"><p>Returns <code>true</code> if there are undo operations left to perform.</p>
|
||||
</div></div></div></div></article><article id="UndoManager.redo" data-title="UndoManager.redo (class method)" class="article"><div class="section method"><div class="memberContent"><div class="title"><i id="UndoManager.redo" class="methodToggle methodClicker inactive icon-caret-right"></i><ul class="signatures"><li class="signature"><ul><li class="signature-call"><span id="UndoManager.redo" class="member-name methodClicker"><span class="sigClassName">UndoManager.</span><span class="sigMemberName">redo</span></span>(<span class="sigArgList"><a href="http://www.nodemanual.org/latest/js_doc/Boolean.html" class="argument methodClicker" title="Boolean" data-id="Boolean">Boolean</a> dontSelect</span>)<li class="signature-returns"><ul class="argument-types"><li class="argument-type"><span class="returnType " title="UndoManager.redo (class method)">Void</span></li></ul></li></li></ul><ul class="metaInfo"></ul></li></ul></div><div class="sideToggler"><div id="ellipsis_UndoManager.redo" class="ellipsis_description"><p>Perform a redo operation on the document, reimplementing the last change.</p>
|
||||
</div><div class="description"><p>Perform a redo operation on the document, reimplementing the last change.</p>
|
||||
<h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"><tr class="argumentRow "><td class="argName ">dontSelect</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. If <code>true</code>, doesn't select the range of where the change occured</p>
|
||||
</td></tr></table></div></div></div></div></article><article id="UndoManager.reset" data-title="UndoManager.reset (class method)" class="article"><div class="section method"><div class="memberContent"><div class="title"><i id="UndoManager.reset" class="methodToggle methodClicker inactive icon-caret-right"></i><ul class="signatures"><li class="signature"><ul><li class="signature-call"><span id="UndoManager.reset" class="member-name methodClicker"><span class="sigClassName">UndoManager.</span><span class="sigMemberName">reset</span></span>(<span class="sigArgList"></span>)<li class="signature-returns"><ul class="argument-types"><li class="argument-type"><span class="returnType " title="UndoManager.reset (class method)">Void</span></li></ul></li></li></ul><ul class="metaInfo"></ul></li></ul></div><div class="sideToggler"><div id="ellipsis_UndoManager.reset" class="ellipsis_description"><p>Destroys the stack of undo and redo redo operations.</p>
|
||||
</div><div class="description"><p>Destroys the stack of undo and redo redo operations.</p>
|
||||
</div></div></div></div></article><article id="UndoManager.undo" data-title="UndoManager.undo (class method)" class="article"><div class="section method"><div class="memberContent"><div class="title"><i id="UndoManager.undo" class="methodToggle methodClicker inactive icon-caret-right"></i><ul class="signatures"><li class="signature"><ul><li class="signature-call"><span id="UndoManager.undo" class="member-name methodClicker"><span class="sigClassName">UndoManager.</span><span class="sigMemberName">undo</span></span>(<span class="sigArgList"><a href="http://www.nodemanual.org/latest/js_doc/Boolean.html" class="argument methodClicker" title="Boolean" data-id="Boolean">Boolean</a> dontSelect</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_UndoManager.undo" class="ellipsis_description"><p>Perform an undo operation on the document, reverting the last change. Returns the range of the undo.</p>
|
||||
</div><div class="description"><p>Perform an undo operation on the document, reverting the last change. Returns the range of the undo.</p>
|
||||
<h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"><tr class="argumentRow "><td class="argName ">dontSelect</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. If <code>true</code>, doesn't select the range of where the change occured</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>
|
||||
|
||||
<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. Contains additional properties</p>
|
||||
</td></tr></table>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</article>
|
||||
<article id="UndoManager.hasRedo" data-title="UndoManager.hasRedo (class method)" class="article">
|
||||
<div class="section method">
|
||||
<div class="memberContent">
|
||||
<div class="title"><i id="UndoManager.hasRedo" class="methodToggle methodClicker inactive icon-caret-right"></i>
|
||||
<ul class="signatures">
|
||||
<li class="signature">
|
||||
<ul>
|
||||
<li class="signature-call"><span id="UndoManager.hasRedo" class="member-name methodClicker"><span class="sigClassName">UndoManager.</span><span class="sigMemberName">hasRedo</span></span>
|
||||
<li class="signature-returns">
|
||||
<ul class="argument-types">
|
||||
<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">
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sideToggler">
|
||||
<div id="ellipsis_UndoManager.hasRedo" class="ellipsis_description"><p>Returns <code>true</code> if there are redo operations left to perform.</p>
|
||||
|
||||
</div>
|
||||
<div class="description"><p>Returns <code>true</code> if there are redo operations left to perform.</p>
|
||||
|
||||
<h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"></table>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</article>
|
||||
<article id="UndoManager.hasUndo" data-title="UndoManager.hasUndo (class method)" class="article">
|
||||
<div class="section method">
|
||||
<div class="memberContent">
|
||||
<div class="title"><i id="UndoManager.hasUndo" class="methodToggle methodClicker inactive icon-caret-right"></i>
|
||||
<ul class="signatures">
|
||||
<li class="signature">
|
||||
<ul>
|
||||
<li class="signature-call"><span id="UndoManager.hasUndo" class="member-name methodClicker"><span class="sigClassName">UndoManager.</span><span class="sigMemberName">hasUndo</span></span>
|
||||
<li class="signature-returns">
|
||||
<ul class="argument-types">
|
||||
<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">
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sideToggler">
|
||||
<div id="ellipsis_UndoManager.hasUndo" class="ellipsis_description"><p>Returns <code>true</code> if there are undo operations left to perform.</p>
|
||||
|
||||
</div>
|
||||
<div class="description"><p>Returns <code>true</code> if there are undo operations left to perform.</p>
|
||||
|
||||
<h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"></table>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</article>
|
||||
<article id="UndoManager.redo" data-title="UndoManager.redo (class method)" class="article">
|
||||
<div class="section method">
|
||||
<div class="memberContent">
|
||||
<div class="title"><i id="UndoManager.redo" class="methodToggle methodClicker inactive icon-caret-right"></i>
|
||||
<ul class="signatures">
|
||||
<li class="signature">
|
||||
<ul>
|
||||
<li class="signature-call"><span id="UndoManager.redo" class="member-name methodClicker"><span class="sigClassName">UndoManager.</span><span class="sigMemberName">redo</span></span>(<span class="sigArgList"><a href="http://www.nodemanual.org/latest/js_doc/Boolean.html" class="argument methodClicker" title="Boolean" data-id="Boolean">Boolean</a> dontSelect</span>)</li>
|
||||
</ul>
|
||||
<ul class="metaInfo">
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sideToggler">
|
||||
<div id="ellipsis_UndoManager.redo" class="ellipsis_description"><p>Perform a redo operation on the document, reimplementing the last change.</p>
|
||||
|
||||
</div>
|
||||
<div class="description"><p>Perform a redo operation on the document, reimplementing the last change.</p>
|
||||
|
||||
<h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"><tr class="argumentRow "><td class="argName ">dontSelect</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. If <code>true</code>, doesn't select the range of where the change occured</p>
|
||||
</td></tr></table>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</article>
|
||||
<article id="UndoManager.reset" data-title="UndoManager.reset (class method)" class="article">
|
||||
<div class="section method">
|
||||
<div class="memberContent">
|
||||
<div class="title"><i id="UndoManager.reset" class="methodToggle methodClicker inactive icon-caret-right"></i>
|
||||
<ul class="signatures">
|
||||
<li class="signature">
|
||||
<ul>
|
||||
<li class="signature-call"><span id="UndoManager.reset" class="member-name methodClicker"><span class="sigClassName">UndoManager.</span><span class="sigMemberName">reset</span></span></li>
|
||||
</ul>
|
||||
<ul class="metaInfo">
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sideToggler">
|
||||
<div id="ellipsis_UndoManager.reset" class="ellipsis_description"><p>Destroys the stack of undo and redo redo operations.</p>
|
||||
|
||||
</div>
|
||||
<div class="description"><p>Destroys the stack of undo and redo redo operations.</p>
|
||||
|
||||
<h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"></table>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</article>
|
||||
<article id="UndoManager.undo" data-title="UndoManager.undo (class method)" class="article">
|
||||
<div class="section method">
|
||||
<div class="memberContent">
|
||||
<div class="title"><i id="UndoManager.undo" class="methodToggle methodClicker inactive icon-caret-right"></i>
|
||||
<ul class="signatures">
|
||||
<li class="signature">
|
||||
<ul>
|
||||
<li class="signature-call"><span id="UndoManager.undo" class="member-name methodClicker"><span class="sigClassName">UndoManager.</span><span class="sigMemberName">undo</span></span>(<span class="sigArgList"><a href="http://www.nodemanual.org/latest/js_doc/Boolean.html" class="argument methodClicker" title="Boolean" data-id="Boolean">Boolean</a> dontSelect</span>)
|
||||
<li class="signature-returns">
|
||||
<ul class="argument-types">
|
||||
<li class="argument-type"><a href="range.html" 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_UndoManager.undo" class="ellipsis_description"><p>Perform an undo operation on the document, reverting the last change.</p>
|
||||
|
||||
</div>
|
||||
<div class="description"><p>Perform an undo operation on the document, reverting the last change.</p>
|
||||
|
||||
<h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"><tr class="argumentRow "><td class="argName ">dontSelect</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. If <code>true</code>, doesn't select the range of where the change occured</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>
|
||||
File diff suppressed because one or more lines are too long
|
|
@ -2,9 +2,11 @@ var fs = require("fs");
|
|||
var path = require("path");
|
||||
var panino = require("panino");
|
||||
var srcPath = __dirname + "/../lib/ace";
|
||||
var buildType = process.argv.splice(2)[0];
|
||||
|
||||
var options = {
|
||||
title : "Ace API",
|
||||
parseType : "jsd",
|
||||
linkFormat : function(linkHtml) {
|
||||
var href = linkHtml.href;
|
||||
var o = href.match(/(.+)\.html(#.+)/);
|
||||
|
|
@ -32,9 +34,8 @@ var options = {
|
|||
skin : "./resources/ace/templates/layout.jade",
|
||||
assets : "./resources/ace/skeleton",
|
||||
additionalObjs : "./additionalObjs.json",
|
||||
exclude : ["**/*_test.js", "**/mode/**", "**/test/**", "**/theme/**", "**/worker/**"],
|
||||
index : "./index.md",
|
||||
disableTests: true
|
||||
exclude : ["**/*_test.js", "**/mode/**", "default_commands.js", "multi_select_commands.js", "**/test/**", "**/theme/**", "**/worker/**"],
|
||||
index : "./index.md"
|
||||
};
|
||||
|
||||
files = [srcPath];
|
||||
|
|
@ -45,7 +46,7 @@ panino.parse(files, options, function (err, ast) {
|
|||
process.exit(1);
|
||||
}
|
||||
|
||||
panino.render('html', ast, options, function (err) {
|
||||
panino.render(buildType || 'html', ast, options, function (err) {
|
||||
if (err) {
|
||||
console.error(err);
|
||||
process.exit(1);
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
"name": "ace-api",
|
||||
"version": "0.1.0",
|
||||
"dependencies": {
|
||||
"panino" : ">=2.0.8",
|
||||
"panino" : ">=2.2.0",
|
||||
"asset-smasher": "0.2.0"
|
||||
}
|
||||
}
|
||||
|
|
@ -707,7 +707,7 @@ li.signature {
|
|||
.eventObjName {
|
||||
font-style: italic;
|
||||
}
|
||||
.eventListenerStart, .eventFunctionOpen, .eventFunctionClose {
|
||||
.eventListenerStart, .eventListenerClose, .eventFunctionOpen, .eventFunctionClose {
|
||||
color: #999999;
|
||||
}
|
||||
.eventMember {
|
||||
|
|
|
|||
|
|
@ -22,7 +22,7 @@ $(function () {
|
|||
if (query) {
|
||||
input.value = "";
|
||||
input.blur();
|
||||
var url = "https://www.google.com/search?q=" + encodeURIComponent("site:ace.ajax.org/api" + " " + query);
|
||||
var url = "https://www.google.com/search?q=" + encodeURIComponent("site:ace.ajax.org" + " " + query);
|
||||
window.open(url);
|
||||
}
|
||||
return false;
|
||||
|
|
|
|||
|
|
@ -1,59 +0,0 @@
|
|||
div#well
|
||||
form(id='searchbox', action='', class='navbar-search')
|
||||
input(class='search-query span3', name='query', type='text', placeholder="Search the API", title="Search across all the documentation")
|
||||
|
||||
ul.menu
|
||||
li
|
||||
div.menu-item
|
||||
a(class="menuLink namespace", href="ace.html#nav=api") Ace
|
||||
li
|
||||
div.menu-item
|
||||
a(class="menuLink namespace", href="anchor.html#nav=api") Anchor
|
||||
li
|
||||
div.menu-item
|
||||
a(class="menuLink namespace", href="background_tokenizer.html#nav=api") BackgroundTokenizer
|
||||
li
|
||||
div.menu-item
|
||||
a(class="menuLink namespace", href="document.html#nav=api") Document
|
||||
li
|
||||
div.menu-item
|
||||
a(class="menuLink namespace", href="edit_session.html#nav=api") EditSession
|
||||
li
|
||||
div.menu-item
|
||||
a(class="menuLink namespace", href="editor.html#nav=api") Editor
|
||||
|
||||
//- probably not needing doc a(class="menuLink namespace", href="multi_select.html#nav=api") MultiSelect
|
||||
|
||||
//- not actually doc'ed yet a(class="menuLink namespace", href="placeholder.html#nav=api") PlaceHolder
|
||||
|
||||
li
|
||||
div.menu-item
|
||||
a(class="menuLink namespace", href="range.html#nav=api") Range
|
||||
|
||||
//- not actually doc'ed yet a(class="menuLink namespace", href="renderloop.html#nav=api") RenderLoop
|
||||
|
||||
|
||||
li
|
||||
div.menu-item
|
||||
a(class="menuLink namespace", href="scrollbar.html#nav=api") Scrollbar
|
||||
li
|
||||
div.menu-item
|
||||
a(class="menuLink namespace", href="search.html#nav=api") Search
|
||||
li
|
||||
div.menu-item
|
||||
a(class="menuLink namespace", href="selection.html#nav=api") Selection
|
||||
|
||||
//- not actually doc'ed yet a(class="menuLink namespace", href="split.html#nav=api") Split
|
||||
|
||||
li
|
||||
div.menu-item
|
||||
a(class="menuLink namespace", href="token_iterator.html#nav=api") TokenIterator
|
||||
li
|
||||
div.menu-item
|
||||
a(class="menuLink namespace", href="tokenizer.html#nav=api") Tokenizer
|
||||
li
|
||||
div.menu-item
|
||||
a(class="menuLink namespace", href="undomanager.html#nav=api") UndoManager
|
||||
li
|
||||
div.menu-item
|
||||
a(class="menuLink namespace", href="virtual_renderer.html#nav=api") VirtualRenderer
|
||||
|
|
@ -1,4 +1,4 @@
|
|||
include ../../common_layout
|
||||
include common_layout
|
||||
include lib
|
||||
|
||||
#documentation.span8
|
||||
|
|
|
|||
|
|
@ -12,149 +12,110 @@ mixin article(obj, parents)
|
|||
if typeof obj === 'string'
|
||||
obj = list[obj]
|
||||
|
||||
title = obj.path + (obj.type ? ' (' + obj.type + ')' : '')
|
||||
article.article(id=obj.path, data-title=title)
|
||||
if obj.type === 'section' || obj.type === 'namespace' || obj.type === 'class' || obj.type === 'mixin'
|
||||
if (obj.private !== true && obj.name.charAt(0) !== "$")
|
||||
title = obj.path + (obj.type ? ' (' + obj.type + ')' : '')
|
||||
article.article(id=obj.path, data-title=title)
|
||||
if obj.type === 'section' || obj.type === 'namespace' || obj.type === 'class' || obj.type === 'mixin'
|
||||
|
||||
if obj.stability
|
||||
mixin markdown(">" + obj.stability)
|
||||
if obj.stability
|
||||
mixin markdown(">" + obj.stability)
|
||||
|
||||
if obj.description
|
||||
.section.description
|
||||
.memberContent
|
||||
mixin markdown(obj.description)
|
||||
|
||||
collection = obj.children.filter(function(x){return x.type === 'namespace'});
|
||||
if collection.length
|
||||
.section.namespaces
|
||||
//
|
||||
h3 Namespaces
|
||||
if obj.description
|
||||
.section.description
|
||||
.memberContent
|
||||
mixin short_description_list(collection)
|
||||
|
||||
collection = obj.children.filter(function(x){return x.type === 'mixin'});
|
||||
if collection.length
|
||||
.section.mixins
|
||||
//
|
||||
h3 Mixins
|
||||
.memberContent
|
||||
mixin short_description_list(collection)
|
||||
|
||||
if obj.type === 'class'
|
||||
|
||||
if obj.superclass
|
||||
.section.superclass
|
||||
// h3
|
||||
Superclass
|
||||
.memberContent
|
||||
mixin link(obj.superclass)
|
||||
|
||||
if obj.subclasses.length
|
||||
.section.subclasses
|
||||
// h3
|
||||
Subclasses
|
||||
.memberContent
|
||||
mixin links(obj.subclasses)
|
||||
|
||||
if obj.included_mixins
|
||||
.section.mixins
|
||||
// h3
|
||||
Includes
|
||||
.memberContent
|
||||
mixin links(obj.included_mixins)
|
||||
|
||||
collection = obj.children.filter(function(x){return x.type === 'utility'})
|
||||
if collection.length
|
||||
.section.utilities
|
||||
// h3
|
||||
Utilities
|
||||
.memberContent
|
||||
mixin links(collection)
|
||||
|
||||
else
|
||||
|
||||
.section.method
|
||||
.memberContent
|
||||
if obj.signatures
|
||||
div.title
|
||||
i(id='#{obj.path}', class='methodToggle methodClicker inactive icon-caret-right')
|
||||
ul.signatures
|
||||
-var loops = 0;
|
||||
for sig in obj.signatures
|
||||
li.signature
|
||||
ul
|
||||
li.signature-call!= signature(obj, sig, ["methodClicker"])
|
||||
if sig.returns
|
||||
li.signature-returns
|
||||
ul.argument-types
|
||||
for ret in sig.returns
|
||||
li.argument-type!= returnLink(obj, ret, [])
|
||||
-if (loops == 0)
|
||||
-loops = 1 // ensure that we only print ONE meta info UL per signature (some methods have multiple signatures)
|
||||
ul.metaInfo
|
||||
if obj.readonly
|
||||
li
|
||||
span.label.read-only Read-Only
|
||||
if obj.chainable
|
||||
li
|
||||
span.label.chainable Chainable
|
||||
if obj.internal
|
||||
li
|
||||
span.label.internal Internal
|
||||
if obj.deprecated
|
||||
li
|
||||
span.label.deprecated
|
||||
| Deprecated
|
||||
if obj.deprecated.from
|
||||
| (since #{obj.deprecated.from})
|
||||
if obj.deprecated.off
|
||||
| and will be removed on #{obj.deprecated.off}
|
||||
if obj.alias_of
|
||||
li
|
||||
span.label.alias.single
|
||||
| Aliased as:
|
||||
!= link(obj.alias_of)
|
||||
else if obj.aliases.length
|
||||
li
|
||||
span.label.alias.multiple
|
||||
| Aliased as:
|
||||
for alias in obj.aliases
|
||||
mixin link(alias)
|
||||
|
||||
if obj.related_to
|
||||
li
|
||||
span.label.related-to
|
||||
| Related to:
|
||||
obj.related_to
|
||||
|
||||
div.sideToggler
|
||||
|
||||
div(id='ellipsis_#{obj.path}', class='ellipsis_description')
|
||||
mixin markdown(obj.short_description)
|
||||
|
||||
|
||||
div.description
|
||||
|
||||
mixin markdown(obj.description)
|
||||
|
||||
else
|
||||
.section.method
|
||||
.memberContent
|
||||
if obj.signatures
|
||||
div.title
|
||||
i(id='#{obj.path}', class='methodToggle methodClicker inactive icon-caret-right')
|
||||
ul.signatures
|
||||
-var loops = 0;
|
||||
for sig in obj.signatures
|
||||
li.signature
|
||||
ul
|
||||
li.signature-call!= signature(obj, sig, ["methodClicker"])
|
||||
if sig.returns
|
||||
li.signature-returns
|
||||
ul.argument-types
|
||||
for ret in sig.returns
|
||||
li.argument-type!= returnLink(obj, ret, [])
|
||||
-if (loops == 0)
|
||||
-loops = 1 // ensure that we only print ONE meta info UL per signature (some methods have multiple signatures)
|
||||
ul.metaInfo
|
||||
if obj.incomplete
|
||||
li
|
||||
span.label.incomplete Incomplete
|
||||
if obj.experimental
|
||||
li
|
||||
span.label.experimental Experimental
|
||||
if obj.readonly
|
||||
li
|
||||
span.label.read-only Read-Only
|
||||
if obj.chainable
|
||||
li
|
||||
span.label.chainable Chainable
|
||||
if obj.internal
|
||||
li
|
||||
span.label.internal Internal
|
||||
if obj.deprecated
|
||||
li
|
||||
span.label.deprecated
|
||||
| Deprecated
|
||||
if obj.deprecated.from
|
||||
| (since #{obj.deprecated.from})
|
||||
if obj.deprecated.off
|
||||
| and will be removed on #{obj.deprecated.off}
|
||||
if obj.alias_of
|
||||
li
|
||||
span.label.alias.single
|
||||
| Aliased as:
|
||||
!= link(obj.alias_of)
|
||||
else if obj.aliases.length
|
||||
li
|
||||
span.label.alias.multiple
|
||||
| Aliased as:
|
||||
ul.alias
|
||||
for alias in obj.aliases
|
||||
li
|
||||
mixin link(alias)
|
||||
|
||||
if obj.bound && ~obj.bound.indexOf('#')
|
||||
p.note.methodized
|
||||
| This method can be called <em>either</em> as an
|
||||
!= link(obj.bound, ['link-short'], 'instance method')
|
||||
| <em>or</em> as a generic method. If calling as generic, pass the instance in as the first argument.
|
||||
else if obj.bound && !~obj.bound.indexOf('#')
|
||||
p.note.functionalized
|
||||
| This method can be called <em>either</em> as an instance method <em>or</em> as a
|
||||
!= link(obj.bound, ['link-short'], 'generic method')
|
||||
|. If calling as generic, pass the instance in as the first argument.
|
||||
if obj.related_to
|
||||
li
|
||||
span.label.related-to
|
||||
| Related to
|
||||
mixin link(obj.related_to, ["relatedToLink"])
|
||||
|
||||
div.sideToggler
|
||||
|
||||
if obj.arguments
|
||||
h4 Arguments
|
||||
!= argumentTable(obj.arguments, ["argument-list", "table", "table-striped", "table-bordered"])
|
||||
div(id='ellipsis_#{obj.path}', class='ellipsis_description')
|
||||
mixin markdown(obj.short_description)
|
||||
|
||||
if obj.returns
|
||||
h4 Returns
|
||||
!= returnTable(obj.returns, ["return-list", "table", "table-striped", "table-bordered"])
|
||||
|
||||
div.description
|
||||
|
||||
mixin markdown(obj.description)
|
||||
|
||||
if obj.bound && ~obj.bound.indexOf('#')
|
||||
p.note.methodized
|
||||
| This method can be called <em>either</em> as an
|
||||
!= link(obj.bound, ['link-short'], 'instance method')
|
||||
| <em>or</em> as a generic method. If calling as generic, pass the instance in as the first argument.
|
||||
else if obj.bound && !~obj.bound.indexOf('#')
|
||||
p.note.functionalized
|
||||
| This method can be called <em>either</em> as an instance method <em>or</em> as a
|
||||
!= link(obj.bound, ['link-short'], 'generic method')
|
||||
|. If calling as generic, pass the instance in as the first argument.
|
||||
|
||||
if obj.arguments
|
||||
h4 Arguments
|
||||
!= argumentTable(obj.arguments, ["argument-list", "table", "table-striped", "table-bordered"])
|
||||
|
||||
if obj.returns
|
||||
h4 Returns
|
||||
!= returnTable(obj.returns, ["return-list", "table", "table-striped", "table-bordered"])
|
||||
|
||||
//- children
|
||||
for child in obj.children.filter(function(x){return x.type === 'section'})
|
||||
|
|
@ -231,8 +192,9 @@ mixin render_starting_tabs(obj, pos)
|
|||
b.caret
|
||||
ul.dropdown-menu
|
||||
for m in members
|
||||
li(id='dropdown_#{m.path}', data-id='#{m.path}', class='memberLink')
|
||||
mixin link(m, [], true)
|
||||
if (m.private !== true && m.name.charAt(0) !== "$")
|
||||
li(id='dropdown_#{m.path}', data-id='#{m.path}', class='memberLink')
|
||||
mixin link(m, [], true)
|
||||
-methodSection = constructorSection = propertySection = eventSection = false;
|
||||
mixin article(obj, [])
|
||||
|
||||
|
|
|
|||
|
|
@ -1,57 +0,0 @@
|
|||
-var dirPrefix = "./";
|
||||
-var sitePrefix = "../doc/site/";
|
||||
-var landingPage = 'false'
|
||||
-var versions = []
|
||||
|
||||
mixin doctype
|
||||
!!! 5
|
||||
|
||||
<!--[if lt IE 7]> <html class="no-js ie6 oldie" lang="en"> <![endif]-->
|
||||
<!--[if IE 7]> <html class="no-js ie7 oldie" lang="en"> <![endif]-->
|
||||
<!--[if IE 8]> <html class="no-js ie8 oldie" lang="en"> <![endif]-->
|
||||
<!--[if gt IE 8]><!--> <html class="no-js" lang="en"> <!--<![endif]-->
|
||||
|
||||
mixin head
|
||||
meta(http-equiv='Content-Type', content='text/html; charset=UTF-8')
|
||||
|
||||
-if (isIndex)
|
||||
title #{title}
|
||||
-else
|
||||
title #{classId} - #{title}
|
||||
|
||||
meta(name="generator", content="panino-doc-build")
|
||||
meta(name="description", content="Ace API documentation for the online code editor")
|
||||
meta(name="author", content="Garen J. Torikian")
|
||||
|
||||
script(src="#{dirPrefix}resources/javascripts/jquery.js")
|
||||
script(src='#{sitePrefix}/js/main.js')
|
||||
link(rel='stylesheet', media='all and (max-device-width: 480px)', href='doc/site/iphone.css')
|
||||
link(rel='stylesheet', media='all and (min-device-width: 481px) and (max-device-width: 1024px)', href='doc/site/iphone.css')
|
||||
link(href='#{dirPrefix}resources/ace/skeleton/images/favicon.ico', rel='icon', type='image/x-icon')
|
||||
|
||||
link(rel="stylesheet", href="#{dirPrefix}resources/csses/bootstrap.min.css")
|
||||
link(href='#{sitePrefix}/style.css', rel='stylesheet', type='text/css')
|
||||
link(rel="stylesheet", href="#{dirPrefix}resources/csses/ace_api.css")
|
||||
link(rel="stylesheet", href="#{dirPrefix}resources/csses/font-awesome.css")
|
||||
|
||||
link(href="#{dirPrefix}resources/images/favicon.ico", rel="icon", type="image/x-icon")
|
||||
|
||||
script(src='#{dirPrefix}resources/javascripts/bbq.js')
|
||||
script(src="#{dirPrefix}resources/javascripts/jquery.collapse.js")
|
||||
script(src="#{dirPrefix}resources/javascripts/jquery.cookie.js")
|
||||
script(src="#{dirPrefix}resources/javascripts/bootstrap.js")
|
||||
|
||||
|
||||
mixin endingScripts
|
||||
script(defer, src="#{dirPrefix}resources/javascripts/ux.js")
|
||||
script(src="#{dirPrefix}resources/javascripts/clicker.js")
|
||||
script(src="#{dirPrefix}resources/javascripts/jquery-scrollspy.js")
|
||||
script(defer, src="#{dirPrefix}resources/javascripts/disqus-ext.js")
|
||||
script(defer, src="#{dirPrefix}resources/javascripts/ga.js")
|
||||
|
||||
mixin identifyBuild(tree, type)
|
||||
landingPage = 'true'
|
||||
-dirPrefix = './'
|
||||
|
||||
mixin markdown(text, inline)
|
||||
!= markdown(text, inline)
|
||||
|
|
@ -16,6 +16,7 @@
|
|||
<script src="http://use.edgefonts.net/source-code-pro.js"></script>
|
||||
<!--DEVEL-->
|
||||
|
||||
<link href="./doc/resources/ace/skeleton/images/favicon.ico" rel="icon" type="image/x-icon">
|
||||
<!--PACKAGE
|
||||
<link rel="stylesheet" href="kitchen-sink/styles.css" type="text/css" media="screen" charset="utf-8">
|
||||
<script src="http://use.edgefonts.net/source-code-pro.js"></script>
|
||||
|
|
|
|||
|
|
@ -29,11 +29,9 @@
|
|||
* ***** END LICENSE BLOCK ***** */
|
||||
|
||||
/**
|
||||
* class Ace
|
||||
*
|
||||
* The main class required to set up an Ace instance in the browser.
|
||||
*
|
||||
*
|
||||
* @class Ace
|
||||
**/
|
||||
|
||||
define(function(require, exports, module) {
|
||||
|
|
@ -57,11 +55,9 @@ require("./placeholder");
|
|||
require("./mode/folding/fold_mode");
|
||||
exports.config = require("./config");
|
||||
/**
|
||||
* Ace.edit(el) -> Editor
|
||||
* - el (String | DOMElement): Either the id of an element, or the element itself
|
||||
*
|
||||
* This method embeds the Ace editor into the DOM, at the element provided by `el`.
|
||||
*
|
||||
* Embeds the Ace editor into the DOM, at the element provided by `el`.
|
||||
* @param {String | DOMElement} el Either the id of an element, or the element itself
|
||||
*
|
||||
**/
|
||||
exports.edit = function(el) {
|
||||
if (typeof(el) == "string") {
|
||||
|
|
|
|||
|
|
@ -35,20 +35,20 @@ var oop = require("./lib/oop");
|
|||
var EventEmitter = require("./lib/event_emitter").EventEmitter;
|
||||
|
||||
/**
|
||||
* class Anchor
|
||||
*
|
||||
* Defines the floating pointer in the document. Whenever text is inserted or deleted before the cursor, the position of the cursor is updated
|
||||
*
|
||||
* Defines the floating pointer in the document. Whenever text is inserted or deleted before the cursor, the position of the cursor is updated.
|
||||
*
|
||||
* @class Anchor
|
||||
**/
|
||||
|
||||
/**
|
||||
* new Anchor(doc, row, column)
|
||||
* - doc (Document): The document to associate with the anchor
|
||||
* - row (Number): The starting row position
|
||||
* - column (Number): The starting column position
|
||||
*
|
||||
* Creates a new `Anchor` and associates it with a document.
|
||||
*
|
||||
* @param {Document} doc The document to associate with the anchor
|
||||
* @param {Number} row The starting row position
|
||||
* @param {Number} column The starting column position
|
||||
*
|
||||
* @constructor
|
||||
**/
|
||||
|
||||
var Anchor = exports.Anchor = function(doc, row, column) {
|
||||
|
|
@ -68,10 +68,8 @@ var Anchor = exports.Anchor = function(doc, row, column) {
|
|||
oop.implement(this, EventEmitter);
|
||||
|
||||
/**
|
||||
* Anchor.getPosition() -> Object
|
||||
*
|
||||
* Returns an object identifying the `row` and `column` position of the current anchor.
|
||||
*
|
||||
* @returns {Object}
|
||||
**/
|
||||
|
||||
this.getPosition = function() {
|
||||
|
|
@ -79,10 +77,9 @@ var Anchor = exports.Anchor = function(doc, row, column) {
|
|||
};
|
||||
|
||||
/**
|
||||
* Anchor.getDocument() -> Document
|
||||
*
|
||||
*
|
||||
* Returns the current document.
|
||||
*
|
||||
* @returns {Document}
|
||||
**/
|
||||
|
||||
this.getDocument = function() {
|
||||
|
|
@ -90,15 +87,17 @@ var Anchor = exports.Anchor = function(doc, row, column) {
|
|||
};
|
||||
|
||||
/**
|
||||
* Anchor@change(e)
|
||||
* - e (Object): An object containing information about the anchor position. It has two properties:
|
||||
* `old`: An object describing the old Anchor position
|
||||
* `value`: An object describing the new Anchor position
|
||||
Both of these objects have a `row` and `column` property corresponding to the position.
|
||||
*
|
||||
* Fires whenever the anchor position changes.
|
||||
*
|
||||
* Both of these objects have a `row` and `column` property corresponding to the position.
|
||||
*
|
||||
* Events that can trigger this function include [[Anchor.setPosition `setPosition()`]].
|
||||
*
|
||||
* @event change
|
||||
* @param {Object} e An object containing information about the anchor position. It has two properties:
|
||||
* - `old`: An object describing the old Anchor position
|
||||
* - `value`: An object describing the new Anchor position
|
||||
*
|
||||
*
|
||||
**/
|
||||
|
||||
|
|
@ -168,12 +167,12 @@ var Anchor = exports.Anchor = function(doc, row, column) {
|
|||
};
|
||||
|
||||
/**
|
||||
* Anchor.setPosition(row, column, noClip)
|
||||
* - row (Number): The row index to move the anchor to
|
||||
* - column (Number): The column index to move the anchor to
|
||||
* - noClip (Boolean): Identifies if you want the position to be clipped
|
||||
*
|
||||
* Sets the anchor position to the specified row and column. If `noClip` is `true`, the position is not clipped.
|
||||
* @param {Number} row The row index to move the anchor to
|
||||
* @param {Number} column The column index to move the anchor to
|
||||
* @param {Boolean} noClip Identifies if you want the position to be clipped
|
||||
*
|
||||
*
|
||||
*
|
||||
**/
|
||||
|
||||
|
|
@ -206,8 +205,6 @@ var Anchor = exports.Anchor = function(doc, row, column) {
|
|||
};
|
||||
|
||||
/**
|
||||
* Anchor.detach()
|
||||
*
|
||||
* When called, the `'change'` event listener is removed.
|
||||
*
|
||||
**/
|
||||
|
|
@ -216,15 +213,14 @@ var Anchor = exports.Anchor = function(doc, row, column) {
|
|||
this.document.removeEventListener("change", this.$onChange);
|
||||
};
|
||||
|
||||
/** internal, hide
|
||||
* Anchor.clipPositionToDocument(row, column)
|
||||
* - row (Number): The row index to clip the anchor to
|
||||
* - column (Number): The column index to clip the anchor to
|
||||
*
|
||||
/**
|
||||
* Clips the anchor position to the specified row and column.
|
||||
* @param {Number} row The row index to clip the anchor to
|
||||
* @param {Number} column The column index to clip the anchor to
|
||||
*
|
||||
*
|
||||
*
|
||||
**/
|
||||
|
||||
this.$clipPositionToDocument = function(row, column) {
|
||||
var pos = {};
|
||||
|
||||
|
|
|
|||
|
|
@ -38,20 +38,23 @@ var EventEmitter = require("./lib/event_emitter").EventEmitter;
|
|||
var MAX_LINE_LENGTH = 5000;
|
||||
|
||||
/**
|
||||
* class BackgroundTokenizer
|
||||
*
|
||||
*
|
||||
* Tokenizes the current [[Document `Document`]] in the background, and caches the tokenized rows for future use. If a certain row is changed, everything below that row is re-tokenized.
|
||||
* Tokenizes the current [[Document `Document`]] in the background, and caches the tokenized rows for future use.
|
||||
*
|
||||
* If a certain row is changed, everything below that row is re-tokenized.
|
||||
*
|
||||
* @class BackgroundTokenizer
|
||||
**/
|
||||
|
||||
/**
|
||||
* new BackgroundTokenizer(tokenizer, editor)
|
||||
* - tokenizer (Tokenizer): The tokenizer to use
|
||||
* - editor (Editor): The editor to associate with
|
||||
*
|
||||
* Creates a new `BackgroundTokenizer` object.
|
||||
* @param {Tokenizer} tokenizer The tokenizer to use
|
||||
* @param {Editor} editor The editor to associate with
|
||||
*
|
||||
*
|
||||
*
|
||||
*
|
||||
* @constructor
|
||||
**/
|
||||
|
||||
var BackgroundTokenizer = function(tokenizer, editor) {
|
||||
|
|
@ -98,11 +101,10 @@ var BackgroundTokenizer = function(tokenizer, editor) {
|
|||
oop.implement(this, EventEmitter);
|
||||
|
||||
/**
|
||||
* BackgroundTokenizer.setTokenizer(tokenizer)
|
||||
* - tokenizer (Tokenizer): The new tokenizer to use
|
||||
*
|
||||
* Sets a new tokenizer for this object.
|
||||
*
|
||||
* @param {Tokenizer} tokenizer The new tokenizer to use
|
||||
*
|
||||
**/
|
||||
this.setTokenizer = function(tokenizer) {
|
||||
this.tokenizer = tokenizer;
|
||||
|
|
@ -113,11 +115,8 @@ var BackgroundTokenizer = function(tokenizer, editor) {
|
|||
};
|
||||
|
||||
/**
|
||||
* BackgroundTokenizer.setDocument(doc)
|
||||
* - doc (Document): The new document to associate with
|
||||
*
|
||||
* Sets a new document to associate with this object.
|
||||
*
|
||||
* @param {Document} doc The new document to associate with
|
||||
**/
|
||||
this.setDocument = function(doc) {
|
||||
this.doc = doc;
|
||||
|
|
@ -127,19 +126,17 @@ var BackgroundTokenizer = function(tokenizer, editor) {
|
|||
this.stop();
|
||||
};
|
||||
|
||||
/**
|
||||
* BackgroundTokenizer.fireUpdateEvent(firstRow, lastRow)
|
||||
* - firstRow (Number): The starting row region
|
||||
* - lastRow (Number): The final row region
|
||||
*
|
||||
* Emits the `'update'` event. `firstRow` and `lastRow` are used to define the boundaries of the region to be updated.
|
||||
/**
|
||||
* Fires whenever the background tokeniziers between a range of rows are going to be updated.
|
||||
*
|
||||
* @event update
|
||||
* @param {Object} e An object containing two properties, `first` and `last`, which indicate the rows of the region being updated.
|
||||
*
|
||||
**/
|
||||
/**
|
||||
* BackgroundTokenizer@update(e)
|
||||
* - e (Object): An object containing two properties, `first` and `last`, which indicate the rows of the region being updated.
|
||||
*
|
||||
* Fires whenever the background tokeniziers between a range of rows are going to be updated.
|
||||
/**
|
||||
* Emits the `'update'` event. `firstRow` and `lastRow` are used to define the boundaries of the region to be updated.
|
||||
* @param {Number} firstRow The starting row region
|
||||
* @param {Number} lastRow The final row region
|
||||
*
|
||||
**/
|
||||
this.fireUpdateEvent = function(firstRow, lastRow) {
|
||||
|
|
@ -151,11 +148,10 @@ var BackgroundTokenizer = function(tokenizer, editor) {
|
|||
};
|
||||
|
||||
/**
|
||||
* BackgroundTokenizer.start(startRow)
|
||||
* - startRow (Number): The row to start at
|
||||
*
|
||||
* Starts tokenizing at the row indicated.
|
||||
*
|
||||
* @param {Number} startRow The row to start at
|
||||
*
|
||||
**/
|
||||
this.start = function(startRow) {
|
||||
this.currentLine = Math.min(startRow || 0, this.currentLine, this.doc.getLength());
|
||||
|
|
@ -194,8 +190,6 @@ var BackgroundTokenizer = function(tokenizer, editor) {
|
|||
};
|
||||
|
||||
/**
|
||||
* BackgroundTokenizer.stop()
|
||||
*
|
||||
* Stops tokenizing.
|
||||
*
|
||||
**/
|
||||
|
|
@ -206,10 +200,11 @@ var BackgroundTokenizer = function(tokenizer, editor) {
|
|||
};
|
||||
|
||||
/**
|
||||
* BackgroundTokenizer.getTokens(row) -> [Object]
|
||||
* - row (Number): The row to get tokens at
|
||||
*
|
||||
* Gives list of tokens of the row. (tokens are cached)
|
||||
*
|
||||
* @param {Number} row The row to get tokens at
|
||||
*
|
||||
*
|
||||
*
|
||||
**/
|
||||
this.getTokens = function(row) {
|
||||
|
|
@ -217,10 +212,9 @@ var BackgroundTokenizer = function(tokenizer, editor) {
|
|||
};
|
||||
|
||||
/**
|
||||
* BackgroundTokenizer.getState(row) -> String
|
||||
* - row (Number): The row to get state at
|
||||
*
|
||||
* [Returns the state of tokenization at the end of a row.]{: #BackgroundTokenizer.getState}
|
||||
*
|
||||
* @param {Number} row The row to get state at
|
||||
**/
|
||||
this.getState = function(row) {
|
||||
if (this.currentLine == row)
|
||||
|
|
|
|||
|
|
@ -6,19 +6,17 @@ var HashHandler = require("../keyboard/hash_handler").HashHandler;
|
|||
var EventEmitter = require("../lib/event_emitter").EventEmitter;
|
||||
|
||||
/**
|
||||
* class CommandManager
|
||||
* @class CommandManager
|
||||
*
|
||||
*
|
||||
*
|
||||
*
|
||||
**/
|
||||
|
||||
/**
|
||||
* new CommandManager(platform, commands)
|
||||
* - platform (String): Identifier for the platform; must be either `'mac'` or `'win'`
|
||||
* - commands (Array): A list of commands
|
||||
* @param {String} platform Identifier for the platform; must be either `'mac'` or `'win'`
|
||||
* @param {Array} commands A list of commands
|
||||
*
|
||||
* TODO
|
||||
*
|
||||
*
|
||||
*
|
||||
**/
|
||||
|
|
|
|||
|
|
@ -37,19 +37,18 @@ var Range = require("./range").Range;
|
|||
var Anchor = require("./anchor").Anchor;
|
||||
|
||||
/**
|
||||
* class Document
|
||||
*
|
||||
* Contains the text of the document. Document can be attached to several [[EditSession `EditSession`]]s. At its core, `Document`s are just an array of strings, with each row in the document matching up to the array index.
|
||||
*
|
||||
* Contains the text of the document. Document can be attached to several [[EditSession `EditSession`]]s.
|
||||
*
|
||||
* At its core, `Document`s are just an array of strings, with each row in the document matching up to the array index.
|
||||
*
|
||||
* @class Document
|
||||
**/
|
||||
|
||||
/**
|
||||
* new Document([text])
|
||||
* - text (String | Array): The starting text
|
||||
*
|
||||
*
|
||||
* Creates a new `Document`. If `text` is included, the `Document` contains those strings; otherwise, it's empty.
|
||||
*
|
||||
* @param {String | Array} text The starting text
|
||||
* @constructor
|
||||
**/
|
||||
|
||||
var Document = function(text) {
|
||||
|
|
@ -71,10 +70,9 @@ var Document = function(text) {
|
|||
oop.implement(this, EventEmitter);
|
||||
|
||||
/**
|
||||
* Document.setValue(text) -> Void
|
||||
* - text (String): The text to use
|
||||
*
|
||||
* Replaces all the lines in the current `Document` with the value of `text`.
|
||||
*
|
||||
* @param {String} text The text to use
|
||||
**/
|
||||
this.setValue = function(text) {
|
||||
var len = this.getLength();
|
||||
|
|
@ -83,8 +81,6 @@ var Document = function(text) {
|
|||
};
|
||||
|
||||
/**
|
||||
* Document.getValue() -> String
|
||||
*
|
||||
* Returns all the lines in the document as a single string, split by the new line character.
|
||||
**/
|
||||
this.getValue = function() {
|
||||
|
|
@ -92,23 +88,23 @@ var Document = function(text) {
|
|||
};
|
||||
|
||||
/**
|
||||
* Document.createAnchor(row, column) -> Anchor
|
||||
* - row (Number): The row number to use
|
||||
* - column (Number): The column number to use
|
||||
*
|
||||
* Creates a new `Anchor` to define a floating point in the document.
|
||||
* @param {Number} row The row number to use
|
||||
* @param {Number} column The column number to use
|
||||
*
|
||||
*
|
||||
**/
|
||||
this.createAnchor = function(row, column) {
|
||||
return new Anchor(this, row, column);
|
||||
};
|
||||
|
||||
/** internal, hide
|
||||
* Document.$split(text) -> [String]
|
||||
* - text (String): The text to work with
|
||||
* + ([String]): A String array, with each index containing a piece of the original `text` string.
|
||||
*
|
||||
/**
|
||||
* Splits a string of text on any newline (`\n`) or carriage-return ('\r') characters.
|
||||
*
|
||||
* @method $split
|
||||
* @param {String} text The text to work with
|
||||
* @returns {String} A String array, with each index containing a piece of the original `text` string.
|
||||
*
|
||||
*
|
||||
**/
|
||||
|
||||
|
|
@ -123,11 +119,7 @@ var Document = function(text) {
|
|||
};
|
||||
|
||||
|
||||
/** internal, hide
|
||||
* Document.$detectNewLine(text) -> Void
|
||||
*
|
||||
*
|
||||
**/
|
||||
|
||||
this.$detectNewLine = function(text) {
|
||||
var match = text.match(/^.*?(\r\n|\r|\n)/m);
|
||||
if (match) {
|
||||
|
|
@ -138,14 +130,13 @@ var Document = function(text) {
|
|||
};
|
||||
|
||||
/**
|
||||
* Document.getNewLineCharacter() -> String
|
||||
* + (String): If `newLineMode == windows`, `\r\n` is returned.<br/>
|
||||
* If `newLineMode == unix`, `\n` is returned.<br/>
|
||||
* Returns the newline character that's being used, depending on the value of `newLineMode`.
|
||||
* @returns {String} If `newLineMode == windows`, `\r\n` is returned.
|
||||
* If `newLineMode == unix`, `\n` is returned.
|
||||
* If `newLineMode == auto`, the value of `autoNewLine` is returned.
|
||||
*
|
||||
* Returns the newline character that's being used, depending on the value of `newLineMode`.
|
||||
*
|
||||
*
|
||||
*
|
||||
*
|
||||
**/
|
||||
this.getNewLineCharacter = function() {
|
||||
|
|
@ -164,10 +155,10 @@ var Document = function(text) {
|
|||
this.$autoNewLine = "\n";
|
||||
this.$newLineMode = "auto";
|
||||
/**
|
||||
* Document.setNewLineMode(newLineMode) -> Void
|
||||
* - newLineMode(String): [The newline mode to use; can be either `windows`, `unix`, or `auto`]{: #Document.setNewLineMode.param}
|
||||
*
|
||||
* [Sets the new line mode.]{: #Document.setNewLineMode.desc}
|
||||
* @param {String} newLineMode [The newline mode to use; can be either `windows`, `unix`, or `auto`]{: #Document.setNewLineMode.param}
|
||||
*
|
||||
*
|
||||
**/
|
||||
this.setNewLineMode = function(newLineMode) {
|
||||
if (this.$newLineMode === newLineMode)
|
||||
|
|
@ -177,20 +168,18 @@ var Document = function(text) {
|
|||
};
|
||||
|
||||
/**
|
||||
* Document.getNewLineMode() -> String
|
||||
*
|
||||
* [Returns the type of newlines being used; either `windows`, `unix`, or `auto`]{: #Document.getNewLineMode}
|
||||
*
|
||||
* @returns String
|
||||
**/
|
||||
this.getNewLineMode = function() {
|
||||
return this.$newLineMode;
|
||||
};
|
||||
|
||||
/**
|
||||
* Document.isNewLine(text) -> Boolean
|
||||
* - text (String): The text to check
|
||||
*
|
||||
* Returns `true` if `text` is a newline character (either `\r\n`, `\r`, or `\n`).
|
||||
* @param {String} text The text to check
|
||||
*
|
||||
*
|
||||
*
|
||||
**/
|
||||
this.isNewLine = function(text) {
|
||||
|
|
@ -198,10 +187,10 @@ var Document = function(text) {
|
|||
};
|
||||
|
||||
/**
|
||||
* Document.getLine(row) -> String
|
||||
* - row (Number): The row index to retrieve
|
||||
*
|
||||
* Returns a verbatim copy of the given line as it is in the document
|
||||
* @param {Number} row The row index to retrieve
|
||||
*
|
||||
*
|
||||
*
|
||||
**/
|
||||
this.getLine = function(row) {
|
||||
|
|
@ -209,11 +198,11 @@ var Document = function(text) {
|
|||
};
|
||||
|
||||
/**
|
||||
* Document.getLines(firstRow, lastRow) -> [String]
|
||||
* - firstRow (Number): The first row index to retrieve
|
||||
* - lastRow (Number): The final row index to retrieve
|
||||
*
|
||||
* Returns an array of strings of the rows between `firstRow` and `lastRow`. This function is inclusive of `lastRow`.
|
||||
* @param {Number} firstRow The first row index to retrieve
|
||||
* @param {Number} lastRow The final row index to retrieve
|
||||
*
|
||||
*
|
||||
*
|
||||
**/
|
||||
this.getLines = function(firstRow, lastRow) {
|
||||
|
|
@ -221,8 +210,6 @@ var Document = function(text) {
|
|||
};
|
||||
|
||||
/**
|
||||
* Document.getAllLines() -> [String]
|
||||
*
|
||||
* Returns all lines in the document as string array. Warning: The caller should not modify this array!
|
||||
**/
|
||||
this.getAllLines = function() {
|
||||
|
|
@ -230,8 +217,6 @@ var Document = function(text) {
|
|||
};
|
||||
|
||||
/**
|
||||
* Document.getLength() -> Number
|
||||
*
|
||||
* Returns the number of rows in the document.
|
||||
**/
|
||||
this.getLength = function() {
|
||||
|
|
@ -239,10 +224,10 @@ var Document = function(text) {
|
|||
};
|
||||
|
||||
/**
|
||||
* Document.getTextRange(range) -> String
|
||||
* - range (Range): The range to work with
|
||||
*
|
||||
* [Given a range within the document, this function returns all the text within that range as a single string.]{: #Document.getTextRange.desc}
|
||||
* @param {Range} range The range to work with
|
||||
*
|
||||
*
|
||||
**/
|
||||
this.getTextRange = function(range) {
|
||||
if (range.start.row == range.end.row) {
|
||||
|
|
@ -257,11 +242,6 @@ var Document = function(text) {
|
|||
}
|
||||
};
|
||||
|
||||
/** internal, hide
|
||||
* Document.$clipPosition(position) -> Number
|
||||
*
|
||||
*
|
||||
**/
|
||||
this.$clipPosition = function(position) {
|
||||
var length = this.getLength();
|
||||
if (position.row >= length) {
|
||||
|
|
@ -272,13 +252,13 @@ var Document = function(text) {
|
|||
};
|
||||
|
||||
/**
|
||||
* Document.insert(position, text) -> Number
|
||||
* - position (Number): The position to start inserting at
|
||||
* - text (String): A chunk of text to insert
|
||||
* + (Number): The position of the last line of `text`. If the length of `text` is 0, this function simply returns `position`.
|
||||
* Inserts a block of `text` and the indicated `position`.
|
||||
*
|
||||
* @param {Number} position The position to start inserting at
|
||||
* @param {String} text A chunk of text to insert
|
||||
* @returns {Number} The position of the last line of `text`. If the length of `text` is 0, this function simply returns `position`.
|
||||
*
|
||||
*
|
||||
*
|
||||
**/
|
||||
this.insert = function(position, text) {
|
||||
if (!text || text.length === 0)
|
||||
|
|
@ -304,22 +284,6 @@ var Document = function(text) {
|
|||
};
|
||||
|
||||
/**
|
||||
* Document.insertLines(row, lines) -> Object
|
||||
* - row (Number): The index of the row to insert at
|
||||
* - lines (Array): An array of strings
|
||||
* + (Object): Returns an object containing the final row and column, like this:<br/>
|
||||
* ```{row: endRow, column: 0}```<br/>
|
||||
* If `lines` is empty, this function returns an object containing the current row, and column, like this:<br/>
|
||||
* ```{row: row, column: 0}```
|
||||
*
|
||||
* Inserts the elements in `lines` into the document, starting at the row index given by `row`. This method also triggers the `'change'` event.
|
||||
*
|
||||
*
|
||||
**/
|
||||
/**
|
||||
* Document@change(e)
|
||||
* - e (Object): Contains at least one property called `"action"`. `"action"` indicates the action that triggered the change. Each action also has a set of additional properties.
|
||||
*
|
||||
* Fires whenever the document changes.
|
||||
*
|
||||
* Several methods trigger different `"change"` events. Below is a list of each action type, followed by each property that's also available:
|
||||
|
|
@ -338,7 +302,27 @@ var Document = function(text) {
|
|||
* * `range`: the [[Range]] of the change within the document
|
||||
* * `text`: the text that's being removed
|
||||
*
|
||||
* @event change
|
||||
* @param {Object} e Contains at least one property called `"action"`. `"action"` indicates the action that triggered the change. Each action also has a set of additional properties.
|
||||
*
|
||||
**/
|
||||
/**
|
||||
* Inserts the elements in `lines` into the document, starting at the row index given by `row`. This method also triggers the `'change'` event.
|
||||
* @param {Number} row The index of the row to insert at
|
||||
* @param {Array} lines An array of strings
|
||||
* @returns {Object} Contains the final row and column, like this:
|
||||
* ```
|
||||
* {row: endRow, column: 0}
|
||||
* ```
|
||||
* If `lines` is empty, this function returns an object containing the current row, and column, like this:
|
||||
* ```
|
||||
* {row: row, column: 0}
|
||||
* ```
|
||||
*
|
||||
*
|
||||
*
|
||||
*
|
||||
**/
|
||||
this.insertLines = function(row, lines) {
|
||||
if (lines.length == 0)
|
||||
return {row: row, column: 0};
|
||||
|
|
@ -365,15 +349,13 @@ var Document = function(text) {
|
|||
};
|
||||
|
||||
/**
|
||||
* Document.insertNewLine(position) -> Object
|
||||
* - position (String): The position to insert at
|
||||
* + (Object): Returns an object containing the final row and column, like this:<br/>
|
||||
* ```{row: endRow, column: 0}```
|
||||
*
|
||||
* Inserts a new line into the document at the current row's `position`. This method also triggers the `'change'` event.
|
||||
*
|
||||
*
|
||||
*
|
||||
* @param {String} position The position to insert at
|
||||
* @returns {Object} Returns an object containing the final row and column, like this:<br/>
|
||||
* ```
|
||||
* {row: endRow, column: 0}
|
||||
* ```
|
||||
*
|
||||
**/
|
||||
this.insertNewLine = function(position) {
|
||||
position = this.$clipPosition(position);
|
||||
|
|
@ -398,17 +380,16 @@ var Document = function(text) {
|
|||
};
|
||||
|
||||
/**
|
||||
* Document.insertInLine(position, text) -> Object | Number
|
||||
* - position (Number): The position to insert at
|
||||
* - text (String): A chunk of text
|
||||
* + (Object): Returns an object containing the final row and column, like this:<br/>
|
||||
* ```{row: endRow, column: 0}```
|
||||
* + (Number): If `text` is empty, this function returns the value of `position`
|
||||
*
|
||||
* Inserts `text` into the `position` at the current row. This method also triggers the `'change'` event.
|
||||
*
|
||||
*
|
||||
*
|
||||
* @param {Number} position The position to insert at
|
||||
* @param {String} text A chunk of text
|
||||
* @returns {Object} Returns an object containing the final row and column, like this:
|
||||
* ```
|
||||
* {row: endRow, column: 0}
|
||||
* ```
|
||||
* @returns {Number} If `text` is empty, this function returns the value of `position`
|
||||
*
|
||||
*
|
||||
**/
|
||||
this.insertInLine = function(position, text) {
|
||||
if (text.length == 0)
|
||||
|
|
@ -435,12 +416,10 @@ var Document = function(text) {
|
|||
};
|
||||
|
||||
/**
|
||||
* Document.remove(range) -> Object
|
||||
* - range (Range): A specified Range to remove
|
||||
* + (Object): Returns the new `start` property of the range, which contains `startRow` and `startColumn`. If `range` is empty, this function returns the unmodified value of `range.start`.
|
||||
*
|
||||
* Removes the `range` from the document.
|
||||
*
|
||||
* @param {Range} range A specified Range to remove
|
||||
* @returns {Object} Returns the new `start` property of the range, which contains `startRow` and `startColumn`. If `range` is empty, this function returns the unmodified value of `range.start`.
|
||||
*
|
||||
*
|
||||
**/
|
||||
this.remove = function(range) {
|
||||
|
|
@ -476,13 +455,11 @@ var Document = function(text) {
|
|||
};
|
||||
|
||||
/**
|
||||
* Document.removeInLine(row, startColumn, endColumn) -> Object
|
||||
* - row (Number): The row to remove from
|
||||
* - startColumn (Number): The column to start removing at
|
||||
* - endColumn (Number): The column to stop removing at
|
||||
* + (Object): Returns an object containing `startRow` and `startColumn`, indicating the new row and column values.<br/>If `startColumn` is equal to `endColumn`, this function returns nothing.
|
||||
*
|
||||
* Removes the specified columns from the `row`. This method also triggers the `'change'` event.
|
||||
* @param {Number} row The row to remove from
|
||||
* @param {Number} startColumn The column to start removing at
|
||||
* @param {Number} endColumn The column to stop removing at
|
||||
* @returns {Object} Returns an object containing `startRow` and `startColumn`, indicating the new row and column values.<br/>If `startColumn` is equal to `endColumn`, this function returns nothing.
|
||||
*
|
||||
*
|
||||
**/
|
||||
|
|
@ -506,12 +483,10 @@ var Document = function(text) {
|
|||
};
|
||||
|
||||
/**
|
||||
* Document.removeLines(firstRow, lastRow) -> [String]
|
||||
* - firstRow (Number): The first row to be removed
|
||||
* - lastRow (Number): The last row to be removed
|
||||
* + ([String]): Returns all the removed lines.
|
||||
*
|
||||
* Removes a range of full lines. This method also triggers the `'change'` event.
|
||||
* @param {Number} firstRow The first row to be removed
|
||||
* @param {Number} lastRow The last row to be removed
|
||||
* @returns {[String]} Returns all the removed lines.
|
||||
*
|
||||
*
|
||||
**/
|
||||
|
|
@ -530,11 +505,9 @@ var Document = function(text) {
|
|||
};
|
||||
|
||||
/**
|
||||
* Document.removeNewLine(row) -> Void
|
||||
* - row (Number): The row to check
|
||||
*
|
||||
* Removes the new line between `row` and the row immediately following it. This method also triggers the `'change'` event.
|
||||
*
|
||||
* @param {Number} row The row to check
|
||||
*
|
||||
**/
|
||||
this.removeNewLine = function(row) {
|
||||
var firstLine = this.getLine(row);
|
||||
|
|
@ -554,15 +527,14 @@ var Document = function(text) {
|
|||
};
|
||||
|
||||
/**
|
||||
* Document.replace(range, text) -> Object
|
||||
* - range (Range): A specified Range to replace
|
||||
* - text (String): The new text to use as a replacement
|
||||
* + (Object): Returns an object containing the final row and column, like this:
|
||||
* Replaces a range in the document with the new `text`.
|
||||
* @param {Range} range A specified Range to replace
|
||||
* @param {String} text The new text to use as a replacement
|
||||
* @returns {Object} Returns an object containing the final row and column, like this:
|
||||
* {row: endRow, column: 0}
|
||||
* If the text and range are empty, this function returns an object containing the current `range.start` value.
|
||||
* If the text is the exact same as what currently exists, this function returns an object containing the current `range.end` value.
|
||||
*
|
||||
* Replaces a range in the document with the new `text`.
|
||||
*
|
||||
**/
|
||||
this.replace = function(range, text) {
|
||||
|
|
@ -586,8 +558,6 @@ var Document = function(text) {
|
|||
};
|
||||
|
||||
/**
|
||||
* Document.applyDeltas(deltas) -> Void
|
||||
*
|
||||
* Applies all the changes previously accumulated. These can be either `'includeText'`, `'insertLines'`, `'removeText'`, and `'removeLines'`.
|
||||
**/
|
||||
this.applyDeltas = function(deltas) {
|
||||
|
|
@ -607,8 +577,6 @@ var Document = function(text) {
|
|||
};
|
||||
|
||||
/**
|
||||
* Document.revertDeltas(deltas) -> Void
|
||||
*
|
||||
* Reverts any changes previously applied. These can be either `'includeText'`, `'insertLines'`, `'removeText'`, and `'removeLines'`.
|
||||
**/
|
||||
this.revertDeltas = function(deltas) {
|
||||
|
|
|
|||
File diff suppressed because it is too large
Load diff
File diff suppressed because it is too large
Load diff
|
|
@ -324,7 +324,7 @@ var EditSession = require("./edit_session").EditSession;
|
|||
var Editor = require("./editor").Editor;
|
||||
(function() {
|
||||
|
||||
/** extension
|
||||
/**
|
||||
* Editor.updateSelectionMarkers()
|
||||
*
|
||||
* Updates the cursor and marker layers.
|
||||
|
|
@ -334,7 +334,7 @@ var Editor = require("./editor").Editor;
|
|||
this.renderer.updateBackMarkers();
|
||||
};
|
||||
|
||||
/** extension
|
||||
/**
|
||||
* Editor.addSelectionMarker(orientedRange) -> Range
|
||||
* - orientedRange (Range): A range containing a cursor
|
||||
*
|
||||
|
|
@ -352,7 +352,7 @@ var Editor = require("./editor").Editor;
|
|||
return orientedRange;
|
||||
};
|
||||
|
||||
/** extension
|
||||
/**
|
||||
* Editor.removeSelectionMarker(range)
|
||||
* - range (Range): The selection range added with [[Editor.addSelectionMarker `addSelectionMarker()`]].
|
||||
*
|
||||
|
|
@ -440,7 +440,7 @@ var Editor = require("./editor").Editor;
|
|||
e.preventDefault();
|
||||
};
|
||||
|
||||
/** extension
|
||||
/**
|
||||
* Editor.forEachSelection(cmd, args)
|
||||
* - cmd (String): The command to execute
|
||||
* - args (String): Any arguments for the command
|
||||
|
|
@ -477,7 +477,7 @@ var Editor = require("./editor").Editor;
|
|||
this.onSelectionChange();
|
||||
};
|
||||
|
||||
/** extension
|
||||
/**
|
||||
* Editor.exitMultiSelectMode() -> Void
|
||||
*
|
||||
* Removes all the selections except the last added one.
|
||||
|
|
@ -528,7 +528,7 @@ var Editor = require("./editor").Editor;
|
|||
}
|
||||
};
|
||||
|
||||
/** extension
|
||||
/**
|
||||
* Editor.findAll(needle, options, additive) -> Number
|
||||
* - needle (String): The text to find
|
||||
* - options (Object): The search options
|
||||
|
|
@ -559,14 +559,14 @@ var Editor = require("./editor").Editor;
|
|||
return ranges.length;
|
||||
};
|
||||
|
||||
// commands
|
||||
/** extension
|
||||
* Editor.selectMoreLines(dir, skip)
|
||||
* - dir (Number): The direction of lines to select: -1 for up, 1 for down
|
||||
* - skip (Boolean): If `true`, removes the active selection range
|
||||
*
|
||||
/**
|
||||
* Adds a cursor above or below the active cursor.
|
||||
**/
|
||||
*
|
||||
* @param {Number} dir The direction of lines to select: -1 for up, 1 for down
|
||||
* @param {Boolean} skip If `true`, removes the active selection range
|
||||
*
|
||||
* @method Editor.selectMoreLines
|
||||
*/
|
||||
this.selectMoreLines = function(dir, skip) {
|
||||
var range = this.selection.toOrientedRange();
|
||||
var isBackwards = range.cursor == range.end;
|
||||
|
|
@ -646,7 +646,7 @@ var Editor = require("./editor").Editor;
|
|||
range.start.row = tmp.start.row;
|
||||
range.start.column = tmp.start.column;
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
/** extension
|
||||
* Editor.selectMore(dir, skip)
|
||||
|
|
|
|||
|
|
@ -35,14 +35,12 @@ var EventEmitter = require("./lib/event_emitter").EventEmitter;
|
|||
var oop = require("./lib/oop");
|
||||
|
||||
/**
|
||||
* class PlaceHolder
|
||||
*
|
||||
* TODO
|
||||
* @class PlaceHolder
|
||||
*
|
||||
*
|
||||
**/
|
||||
|
||||
/**
|
||||
* new PlaceHolder(session, length, pos, others, mainClass, othersClass)
|
||||
* - session (Document): The document to associate with the anchor
|
||||
* - length (Number): The starting row position
|
||||
* - pos (Number): The starting column position
|
||||
|
|
@ -50,8 +48,8 @@ var oop = require("./lib/oop");
|
|||
* - mainClass (String):
|
||||
* - othersClass (String):
|
||||
*
|
||||
* TODO
|
||||
*
|
||||
*
|
||||
* @constructor
|
||||
**/
|
||||
|
||||
var PlaceHolder = function(session, length, pos, others, mainClass, othersClass) {
|
||||
|
|
|
|||
334
lib/ace/range.js
334
lib/ace/range.js
|
|
@ -32,21 +32,21 @@ define(function(require, exports, module) {
|
|||
"use strict";
|
||||
|
||||
/**
|
||||
* class Range
|
||||
*
|
||||
*
|
||||
* This object is used in various places to indicate a region within the editor. To better visualize how this works, imagine a rectangle. Each quadrant of the rectangle is analogus to a range, as ranges contain a starting row and starting column, and an ending row, and ending column.
|
||||
*
|
||||
* @class Range
|
||||
**/
|
||||
|
||||
/**
|
||||
* new Range(startRow, startColumn, endRow, endColumn)
|
||||
* - startRow (Number): The starting row
|
||||
* - startColumn (Number): The starting column
|
||||
* - endRow (Number): The ending row
|
||||
* - endColumn (Number): The ending column
|
||||
*
|
||||
* Creates a new `Range` object with the given starting and ending row and column points.
|
||||
* @param {Number} startRow The starting row
|
||||
* @param {Number} startColumn The starting column
|
||||
* @param {Number} endRow The ending row
|
||||
* @param {Number} endColumn The ending column
|
||||
*
|
||||
*
|
||||
* @constructor
|
||||
**/
|
||||
var Range = function(startRow, startColumn, endRow, endColumn) {
|
||||
this.start = {
|
||||
|
|
@ -62,11 +62,11 @@ var Range = function(startRow, startColumn, endRow, endColumn) {
|
|||
|
||||
(function() {
|
||||
/**
|
||||
* Range.isEqual(range) -> Boolean
|
||||
* - range (Range): A range to check against
|
||||
*
|
||||
* Returns `true` if and only if the starting row and column, and ending tow and column, are equivalent to those given by `range`.
|
||||
* @param {Range} range A range to check against
|
||||
*
|
||||
*
|
||||
* @return Boolean
|
||||
**/
|
||||
this.isEqual = function(range) {
|
||||
return this.start.row == range.start.row &&
|
||||
|
|
@ -76,38 +76,42 @@ var Range = function(startRow, startColumn, endRow, endColumn) {
|
|||
};
|
||||
|
||||
/**
|
||||
* Range.toString() -> String
|
||||
*
|
||||
*
|
||||
* Returns a string containing the range's row and column information, given like this:
|
||||
*
|
||||
* ```
|
||||
* [start.row/start.column] -> [end.row/end.column]
|
||||
*
|
||||
* ```
|
||||
* @return String
|
||||
**/
|
||||
this.toString = function() {
|
||||
return ("Range: [" + this.start.row + "/" + this.start.column +
|
||||
"] -> [" + this.end.row + "/" + this.end.column + "]");
|
||||
};
|
||||
|
||||
/** related to: Range.compare
|
||||
* Range.contains(row, column) -> Boolean
|
||||
* - row (Number): A row to check for
|
||||
* - column (Number): A column to check for
|
||||
/**
|
||||
*
|
||||
* Returns `true` if the `row` and `column` provided are within the given range. This can better be expressed as returning `true` if:
|
||||
*
|
||||
* ```javascript
|
||||
* this.start.row <= row <= this.end.row &&
|
||||
* this.start.column <= column <= this.end.column
|
||||
*
|
||||
* ```
|
||||
* @param {Number} row A row to check for
|
||||
* @param {Number} column A column to check for
|
||||
* @returns {Boolean}
|
||||
* @related Range.compare
|
||||
**/
|
||||
|
||||
this.contains = function(row, column) {
|
||||
return this.compare(row, column) == 0;
|
||||
};
|
||||
|
||||
/** related to: Range.compare
|
||||
* Range.compareRange(range) -> Number
|
||||
* - range (Range): A range to compare with
|
||||
* + (Number): This method returns one of the following numbers:<br/>
|
||||
/**
|
||||
* Compares `this` range (A) with another range (B).
|
||||
* @param {Range} range A range to compare with
|
||||
*
|
||||
*
|
||||
* @related Range.compare
|
||||
* @returns {Number} This method returns one of the following numbers:<br/>
|
||||
* <br/>
|
||||
* * `-2`: (B) is in front of (A), and doesn't intersect with (A)<br/>
|
||||
* * `-1`: (B) begins before (A) but ends inside of (A)<br/>
|
||||
|
|
@ -115,9 +119,6 @@ var Range = function(startRow, startColumn, endRow, endColumn) {
|
|||
* * `+1`: (B) begins inside of (A) but ends outside of (A)<br/>
|
||||
* * `+2`: (B) is after (A) and doesn't intersect with (A)<br/>
|
||||
* * `42`: FTW state: (B) ends in (A) but starts outside of (A)
|
||||
*
|
||||
* Compares `this` range (A) with another range (B).
|
||||
*
|
||||
**/
|
||||
this.compareRange = function(range) {
|
||||
var cmp,
|
||||
|
|
@ -146,12 +147,16 @@ var Range = function(startRow, startColumn, endRow, endColumn) {
|
|||
return 0;
|
||||
}
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
/** related to: Range.compare
|
||||
* Range.comparePoint(p) -> Number
|
||||
* - p (Range): A point to compare with
|
||||
* + (Number): This method returns one of the following numbers:<br/>
|
||||
/**
|
||||
*
|
||||
* Checks the row and column points of `p` with the row and column points of the calling range.
|
||||
*
|
||||
* @param {Range} p A point to compare with
|
||||
*
|
||||
* @related Range.compare
|
||||
* @returns {Number} This method returns one of the following numbers:<br/>
|
||||
* * `0` if the two points are exactly equal<br/>
|
||||
* * `-1` if `p.row` is less then the calling range<br/>
|
||||
* * `1` if `p.row` is greater than the calling range<br/>
|
||||
|
|
@ -163,70 +168,66 @@ var Range = function(startRow, startColumn, endRow, endColumn) {
|
|||
* If the ending row of the calling range is equal to `p.row`, and:<br/>
|
||||
* * `p.column` is less than or equal to the calling range's ending column, this returns `0`<br/>
|
||||
* * Otherwise, it returns 1<br/>
|
||||
*
|
||||
* Checks the row and column points of `p` with the row and column points of the calling range.
|
||||
*
|
||||
*
|
||||
*
|
||||
**/
|
||||
this.comparePoint = function(p) {
|
||||
return this.compare(p.row, p.column);
|
||||
}
|
||||
};
|
||||
|
||||
/** related to: Range.comparePoint
|
||||
* Range.containsRange(range) -> Boolean
|
||||
* - range (Range): A range to compare with
|
||||
*
|
||||
/**
|
||||
* Checks the start and end points of `range` and compares them to the calling range. Returns `true` if the `range` is contained within the caller's range.
|
||||
* @param {Range} range A range to compare with
|
||||
*
|
||||
* @returns {Boolean}
|
||||
* @related Range.comparePoint
|
||||
*
|
||||
**/
|
||||
this.containsRange = function(range) {
|
||||
return this.comparePoint(range.start) == 0 && this.comparePoint(range.end) == 0;
|
||||
}
|
||||
};
|
||||
|
||||
/**
|
||||
* Range.intersects(range) -> Boolean
|
||||
* - range (Range): A range to compare with
|
||||
*
|
||||
* Returns `true` if passed in `range` intersects with the one calling this method.
|
||||
* @param {Range} range A range to compare with
|
||||
*
|
||||
*
|
||||
* @returns {Boolean}
|
||||
**/
|
||||
this.intersects = function(range) {
|
||||
var cmp = this.compareRange(range);
|
||||
return (cmp == -1 || cmp == 0 || cmp == 1);
|
||||
}
|
||||
};
|
||||
|
||||
/**
|
||||
* Range.isEnd(row, column) -> Boolean
|
||||
* - row (Number): A row point to compare with
|
||||
* - column (Number): A column point to compare with
|
||||
*
|
||||
* Returns `true` if the caller's ending row point is the same as `row`, and if the caller's ending column is the same as `column`.
|
||||
* @param {Number} row A row point to compare with
|
||||
* @param {Number} column A column point to compare with
|
||||
*
|
||||
*
|
||||
* @returns {Boolean}
|
||||
**/
|
||||
this.isEnd = function(row, column) {
|
||||
return this.end.row == row && this.end.column == column;
|
||||
}
|
||||
};
|
||||
|
||||
/**
|
||||
* Range.isStart(row, column) -> Boolean
|
||||
* - row (Number): A row point to compare with
|
||||
* - column (Number): A column point to compare with
|
||||
*
|
||||
* Returns `true` if the caller's starting row point is the same as `row`, and if the caller's starting column is the same as `column`.
|
||||
* @param {Number} row A row point to compare with
|
||||
* @param {Number} column A column point to compare with
|
||||
*
|
||||
*
|
||||
* @returns {Boolean}
|
||||
**/
|
||||
this.isStart = function(row, column) {
|
||||
return this.start.row == row && this.start.column == column;
|
||||
}
|
||||
};
|
||||
|
||||
/**
|
||||
* Range.setStart(row, column)
|
||||
* - row (Number): A row point to set
|
||||
* - column (Number): A column point to set
|
||||
*
|
||||
* Sets the starting row and column for the range.
|
||||
* @param {Number} row A row point to set
|
||||
* @param {Number} column A column point to set
|
||||
*
|
||||
*
|
||||
*
|
||||
**/
|
||||
this.setStart = function(row, column) {
|
||||
if (typeof row == "object") {
|
||||
|
|
@ -236,14 +237,14 @@ var Range = function(startRow, startColumn, endRow, endColumn) {
|
|||
this.start.row = row;
|
||||
this.start.column = column;
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
/**
|
||||
* Range.setEnd(row, column)
|
||||
* - row (Number): A row point to set
|
||||
* - column (Number): A column point to set
|
||||
*
|
||||
* Sets the starting row and column for the range.
|
||||
* @param {Number} row A row point to set
|
||||
* @param {Number} column A column point to set
|
||||
*
|
||||
*
|
||||
*
|
||||
**/
|
||||
this.setEnd = function(row, column) {
|
||||
|
|
@ -254,15 +255,16 @@ var Range = function(startRow, startColumn, endRow, endColumn) {
|
|||
this.end.row = row;
|
||||
this.end.column = column;
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
/** related to: Range.compare
|
||||
* Range.inside(row, column) -> Boolean
|
||||
* - row (Number): A row point to compare with
|
||||
* - column (Number): A column point to compare with
|
||||
*
|
||||
/**
|
||||
* Returns `true` if the `row` and `column` are within the given range.
|
||||
* @param {Number} row A row point to compare with
|
||||
* @param {Number} column A column point to compare with
|
||||
*
|
||||
*
|
||||
* @returns {Boolean}
|
||||
* @related Range.compare
|
||||
**/
|
||||
this.inside = function(row, column) {
|
||||
if (this.compare(row, column) == 0) {
|
||||
|
|
@ -273,15 +275,16 @@ var Range = function(startRow, startColumn, endRow, endColumn) {
|
|||
}
|
||||
}
|
||||
return false;
|
||||
}
|
||||
};
|
||||
|
||||
/** related to: Range.compare
|
||||
* Range.insideStart(row, column) -> Boolean
|
||||
* - row (Number): A row point to compare with
|
||||
* - column (Number): A column point to compare with
|
||||
*
|
||||
/**
|
||||
* Returns `true` if the `row` and `column` are within the given range's starting points.
|
||||
* @param {Number} row A row point to compare with
|
||||
* @param {Number} column A column point to compare with
|
||||
*
|
||||
*
|
||||
* @returns {Boolean}
|
||||
* @related Range.compare
|
||||
**/
|
||||
this.insideStart = function(row, column) {
|
||||
if (this.compare(row, column) == 0) {
|
||||
|
|
@ -292,15 +295,17 @@ var Range = function(startRow, startColumn, endRow, endColumn) {
|
|||
}
|
||||
}
|
||||
return false;
|
||||
}
|
||||
};
|
||||
|
||||
/** related to: Range.compare
|
||||
* Range.insideEnd(row, column) -> Boolean
|
||||
* - row (Number): A row point to compare with
|
||||
* - column (Number): A column point to compare with
|
||||
*
|
||||
/**
|
||||
* Returns `true` if the `row` and `column` are within the given range's ending points.
|
||||
* @param {Number} row A row point to compare with
|
||||
* @param {Number} column A column point to compare with
|
||||
*
|
||||
*
|
||||
* @returns {Boolean}
|
||||
* @related Range.compare
|
||||
*
|
||||
**/
|
||||
this.insideEnd = function(row, column) {
|
||||
if (this.compare(row, column) == 0) {
|
||||
|
|
@ -311,28 +316,26 @@ var Range = function(startRow, startColumn, endRow, endColumn) {
|
|||
}
|
||||
}
|
||||
return false;
|
||||
}
|
||||
};
|
||||
|
||||
/**
|
||||
* Range.compare(row, column) -> Number
|
||||
* - row (Number): A row point to compare with
|
||||
* - column (Number): A column point to compare with
|
||||
* + (Number): This method returns one of the following numbers:<br/>
|
||||
* * `0` if the two points are exactly equal <br/>
|
||||
* * `-1` if `p.row` is less then the calling range <br/>
|
||||
* * `1` if `p.row` is greater than the calling range <br/>
|
||||
* Checks the row and column points with the row and column points of the calling range.
|
||||
* @param {Number} row A row point to compare with
|
||||
* @param {Number} column A column point to compare with
|
||||
*
|
||||
*
|
||||
* @returns {Number} This method returns one of the following numbers:<br/>
|
||||
* `0` if the two points are exactly equal <br/>
|
||||
* `-1` if `p.row` is less then the calling range <br/>
|
||||
* `1` if `p.row` is greater than the calling range <br/>
|
||||
* <br/>
|
||||
* If the starting row of the calling range is equal to `p.row`, and: <br/>
|
||||
* * `p.column` is greater than or equal to the calling range's starting column, this returns `0`<br/>
|
||||
* * Otherwise, it returns -1<br/>
|
||||
* `p.column` is greater than or equal to the calling range's starting column, this returns `0`<br/>
|
||||
* Otherwise, it returns -1<br/>
|
||||
* <br/>
|
||||
* If the ending row of the calling range is equal to `p.row`, and: <br/>
|
||||
* * `p.column` is less than or equal to the calling range's ending column, this returns `0` <br/>
|
||||
* * Otherwise, it returns 1
|
||||
*
|
||||
* Checks the row and column points with the row and column points of the calling range.
|
||||
*
|
||||
*
|
||||
* `p.column` is less than or equal to the calling range's ending column, this returns `0` <br/>
|
||||
* Otherwise, it returns 1
|
||||
**/
|
||||
this.compare = function(row, column) {
|
||||
if (!this.isMultiLine()) {
|
||||
|
|
@ -357,26 +360,25 @@ var Range = function(startRow, startColumn, endRow, endColumn) {
|
|||
};
|
||||
|
||||
/**
|
||||
* Range.compareStart(row, column) -> Number
|
||||
* - row (Number): A row point to compare with
|
||||
* - column (Number): A column point to compare with
|
||||
* + (Number): This method returns one of the following numbers:<br/>
|
||||
* Checks the row and column points with the row and column points of the calling range.
|
||||
* @param {Number} row A row point to compare with
|
||||
* @param {Number} column A column point to compare with
|
||||
*
|
||||
*
|
||||
*
|
||||
* @returns {Number} This method returns one of the following numbers:<br/>
|
||||
* <br/>
|
||||
* * `0` if the two points are exactly equal<br/>
|
||||
* * `-1` if `p.row` is less then the calling range<br/>
|
||||
* * `1` if `p.row` is greater than the calling range, or if `isStart` is `true`.<br/>
|
||||
* `0` if the two points are exactly equal<br/>
|
||||
* `-1` if `p.row` is less then the calling range<br/>
|
||||
* `1` if `p.row` is greater than the calling range, or if `isStart` is `true`.<br/>
|
||||
* <br/>
|
||||
* If the starting row of the calling range is equal to `p.row`, and:<br/>
|
||||
* * `p.column` is greater than or equal to the calling range's starting column, this returns `0`<br/>
|
||||
* * Otherwise, it returns -1<br/>
|
||||
* `p.column` is greater than or equal to the calling range's starting column, this returns `0`<br/>
|
||||
* Otherwise, it returns -1<br/>
|
||||
* <br/>
|
||||
* If the ending row of the calling range is equal to `p.row`, and:<br/>
|
||||
* * `p.column` is less than or equal to the calling range's ending column, this returns `0`<br/>
|
||||
* * Otherwise, it returns 1
|
||||
*
|
||||
* Checks the row and column points with the row and column points of the calling range.
|
||||
*
|
||||
*
|
||||
* `p.column` is less than or equal to the calling range's ending column, this returns `0`<br/>
|
||||
* Otherwise, it returns 1
|
||||
*
|
||||
**/
|
||||
this.compareStart = function(row, column) {
|
||||
|
|
@ -385,51 +387,47 @@ var Range = function(startRow, startColumn, endRow, endColumn) {
|
|||
} else {
|
||||
return this.compare(row, column);
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
/**
|
||||
* Range.compareEnd(row, column) -> Number
|
||||
* - row (Number): A row point to compare with
|
||||
* - column (Number): A column point to compare with
|
||||
* + (Number): This method returns one of the following numbers:<br/>
|
||||
* * `0` if the two points are exactly equal<br/>
|
||||
* * `-1` if `p.row` is less then the calling range<br/>
|
||||
* * `1` if `p.row` is greater than the calling range, or if `isEnd` is `true.<br/>
|
||||
* Checks the row and column points with the row and column points of the calling range.
|
||||
* @param {Number} row A row point to compare with
|
||||
* @param {Number} column A column point to compare with
|
||||
*
|
||||
*
|
||||
* @returns {Number} This method returns one of the following numbers:<br/>
|
||||
* `0` if the two points are exactly equal<br/>
|
||||
* `-1` if `p.row` is less then the calling range<br/>
|
||||
* `1` if `p.row` is greater than the calling range, or if `isEnd` is `true.<br/>
|
||||
* <br/>
|
||||
* If the starting row of the calling range is equal to `p.row`, and:<br/>
|
||||
* * `p.column` is greater than or equal to the calling range's starting column, this returns `0`<br/>
|
||||
* * Otherwise, it returns -1<br/>
|
||||
* `p.column` is greater than or equal to the calling range's starting column, this returns `0`<br/>
|
||||
* Otherwise, it returns -1<br/>
|
||||
*<br/>
|
||||
* If the ending row of the calling range is equal to `p.row`, and:<br/>
|
||||
* * `p.column` is less than or equal to the calling range's ending column, this returns `0`<br/>
|
||||
* * Otherwise, it returns 1
|
||||
*
|
||||
* Checks the row and column points with the row and column points of the calling range.
|
||||
*
|
||||
*
|
||||
**/
|
||||
* `p.column` is less than or equal to the calling range's ending column, this returns `0`<br/>
|
||||
* Otherwise, it returns 1
|
||||
*/
|
||||
this.compareEnd = function(row, column) {
|
||||
if (this.end.row == row && this.end.column == column) {
|
||||
return 1;
|
||||
} else {
|
||||
return this.compare(row, column);
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
/**
|
||||
* Range.compareInside(row, column) -> Number
|
||||
* - row (Number): A row point to compare with
|
||||
* - column (Number): A column point to compare with
|
||||
* + (Number): This method returns one of the following numbers:<br/>
|
||||
* Checks the row and column points with the row and column points of the calling range.
|
||||
* @param {Number} row A row point to compare with
|
||||
* @param {Number} column A column point to compare with
|
||||
*
|
||||
*
|
||||
* @returns {Number} This method returns one of the following numbers:<br/>
|
||||
* * `1` if the ending row of the calling range is equal to `row`, and the ending column of the calling range is equal to `column`<br/>
|
||||
* * `-1` if the starting row of the calling range is equal to `row`, and the starting column of the calling range is equal to `column`<br/>
|
||||
* <br/>
|
||||
* Otherwise, it returns the value after calling [[Range.compare `compare()`]].
|
||||
*
|
||||
* Checks the row and column points with the row and column points of the calling range.
|
||||
*
|
||||
*
|
||||
*
|
||||
**/
|
||||
this.compareInside = function(row, column) {
|
||||
if (this.end.row == row && this.end.column == column) {
|
||||
|
|
@ -439,15 +437,15 @@ var Range = function(startRow, startColumn, endRow, endColumn) {
|
|||
} else {
|
||||
return this.compare(row, column);
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
/**
|
||||
* Range.clipRows(firstRow, lastRow) -> Range
|
||||
* - firstRow (Number): The starting row
|
||||
* - lastRow (Number): The ending row
|
||||
*
|
||||
* Returns the part of the current `Range` that occurs within the boundaries of `firstRow` and `lastRow` as a new `Range` object.
|
||||
* @param {Number} firstRow The starting row
|
||||
* @param {Number} lastRow The ending row
|
||||
*
|
||||
*
|
||||
* @returns {Range}
|
||||
**/
|
||||
this.clipRows = function(firstRow, lastRow) {
|
||||
if (this.end.row > lastRow) {
|
||||
|
|
@ -481,12 +479,12 @@ var Range = function(startRow, startColumn, endRow, endColumn) {
|
|||
};
|
||||
|
||||
/**
|
||||
* Range.extend(row, column) -> Range
|
||||
* - row (Number): A new row to extend to
|
||||
* - column (Number): A new column to extend to
|
||||
*
|
||||
* Changes the row and column points for the calling range for both the starting and ending points. This method returns that range with a new row.
|
||||
* Changes the row and column points for the calling range for both the starting and ending points.
|
||||
* @param {Number} row A new row to extend to
|
||||
* @param {Number} column A new column to extend to
|
||||
*
|
||||
*
|
||||
* @returns {Range} The original range with the new row
|
||||
**/
|
||||
this.extend = function(row, column) {
|
||||
var cmp = this.compare(row, column);
|
||||
|
|
@ -506,30 +504,27 @@ var Range = function(startRow, startColumn, endRow, endColumn) {
|
|||
};
|
||||
|
||||
/**
|
||||
* Range.isMultiLine() -> Boolean
|
||||
*
|
||||
* Returns true if the range spans across multiple lines.
|
||||
*
|
||||
*
|
||||
* Returns `true` if the range spans across multiple lines.
|
||||
* @returns {Boolean}
|
||||
**/
|
||||
this.isMultiLine = function() {
|
||||
return (this.start.row !== this.end.row);
|
||||
};
|
||||
|
||||
/**
|
||||
* Range.clone() -> Range
|
||||
*
|
||||
*
|
||||
* Returns a duplicate of the calling range.
|
||||
*
|
||||
* @returns {Range}
|
||||
**/
|
||||
this.clone = function() {
|
||||
return Range.fromPoints(this.start, this.end);
|
||||
};
|
||||
|
||||
/**
|
||||
* Range.collapseRows() -> Range
|
||||
*
|
||||
* Returns a range containing the starting and ending rows of the original range, but with a column value of `0`.
|
||||
*
|
||||
* @returns {Range}
|
||||
**/
|
||||
this.collapseRows = function() {
|
||||
if (this.end.column == 0)
|
||||
|
|
@ -539,10 +534,11 @@ var Range = function(startRow, startColumn, endRow, endColumn) {
|
|||
};
|
||||
|
||||
/**
|
||||
* Range.toScreenRange(session) -> Range
|
||||
* - session (EditSession): The `EditSession` to retrieve coordinates from
|
||||
*
|
||||
* Given the current `Range`, this function converts those starting and ending points into screen positions, and then returns a new `Range` object.
|
||||
* @param {EditSession} session The `EditSession` to retrieve coordinates from
|
||||
*
|
||||
*
|
||||
* @returns {Range}
|
||||
**/
|
||||
this.toScreenRange = function(session) {
|
||||
var screenPosStart =
|
||||
|
|
@ -559,12 +555,12 @@ var Range = function(startRow, startColumn, endRow, endColumn) {
|
|||
}).call(Range.prototype);
|
||||
|
||||
/**
|
||||
* Range.fromPoints(start, end) -> Range
|
||||
* - start (Range): A starting point to use
|
||||
* - end (Range): An ending point to use
|
||||
*
|
||||
* Creates and returns a new `Range` based on the row and column of the given parameters.
|
||||
*
|
||||
* @param {Range} start A starting point to use
|
||||
* @param {Range} end An ending point to use
|
||||
*
|
||||
*
|
||||
* @returns {Range}
|
||||
**/
|
||||
Range.fromPoints = function(start, end) {
|
||||
return new Range(start.row, start.column, end.row, end.column);
|
||||
|
|
|
|||
|
|
@ -33,19 +33,14 @@ define(function(require, exports, module) {
|
|||
|
||||
var event = require("./lib/event");
|
||||
|
||||
/** internal, hide
|
||||
* class RenderLoop
|
||||
/**
|
||||
*
|
||||
*
|
||||
* Batches changes (that force something to be redrawn) in the background.
|
||||
*
|
||||
* @class RenderLoop
|
||||
**/
|
||||
|
||||
/** internal, hide
|
||||
* new RenderLoop(onRender, win)
|
||||
*
|
||||
*
|
||||
*
|
||||
**/
|
||||
|
||||
var RenderLoop = function(onRender, win) {
|
||||
this.onRender = onRender;
|
||||
this.pending = false;
|
||||
|
|
@ -55,12 +50,7 @@ var RenderLoop = function(onRender, win) {
|
|||
|
||||
(function() {
|
||||
|
||||
/** internal, hide
|
||||
* RenderLoop.schedule(change)
|
||||
* - change (Array):
|
||||
*
|
||||
*
|
||||
**/
|
||||
|
||||
this.schedule = function(change) {
|
||||
//this.onRender(change);
|
||||
//return;
|
||||
|
|
|
|||
|
|
@ -37,18 +37,20 @@ var event = require("./lib/event");
|
|||
var EventEmitter = require("./lib/event_emitter").EventEmitter;
|
||||
|
||||
/**
|
||||
* class ScrollBar
|
||||
*
|
||||
*
|
||||
* A set of methods for setting and retrieving the editor's scrollbar.
|
||||
*
|
||||
* @class ScrollBar
|
||||
**/
|
||||
|
||||
/**
|
||||
* new ScrollBar(parent)
|
||||
* - parent (DOMElement): A DOM element
|
||||
*
|
||||
* Creates a new `ScrollBar`. `parent` is the owner of the scroll bar.
|
||||
* @param {DOMElement} parent A DOM element
|
||||
*
|
||||
*
|
||||
*
|
||||
*
|
||||
* @constructor
|
||||
**/
|
||||
var ScrollBar = function(parent) {
|
||||
this.element = dom.createElement("div");
|
||||
|
|
@ -75,10 +77,11 @@ var ScrollBar = function(parent) {
|
|||
oop.implement(this, EventEmitter);
|
||||
|
||||
/**
|
||||
* ScrollBar@scroll(e)
|
||||
* - e (Object): Contains one property, `"data"`, which indicates the current scroll top position
|
||||
*
|
||||
* Emitted when the scroll bar, well, scrolls.
|
||||
* @event scroll
|
||||
* @param {Object} e Contains one property, `"data"`, which indicates the current scroll top position
|
||||
*
|
||||
*
|
||||
*
|
||||
**/
|
||||
this.onScroll = function() {
|
||||
|
|
@ -86,20 +89,19 @@ var ScrollBar = function(parent) {
|
|||
};
|
||||
|
||||
/**
|
||||
* ScrollBar.getWidth() -> Number
|
||||
*
|
||||
*
|
||||
* Returns the width of the scroll bar.
|
||||
*
|
||||
* @returns {Number}
|
||||
**/
|
||||
this.getWidth = function() {
|
||||
return this.width;
|
||||
};
|
||||
|
||||
/**
|
||||
* ScrollBar.setHeight(height)
|
||||
* - height (Number): The new height
|
||||
*
|
||||
* Sets the height of the scroll bar, in pixels.
|
||||
* @param {Number} height The new height
|
||||
*
|
||||
*
|
||||
*
|
||||
**/
|
||||
this.setHeight = function(height) {
|
||||
|
|
@ -107,25 +109,26 @@ var ScrollBar = function(parent) {
|
|||
};
|
||||
|
||||
/**
|
||||
* ScrollBar.setInnerHeight(height)
|
||||
* - height (Number): The new inner height
|
||||
*
|
||||
* Sets the inner height of the scroll bar, in pixels.
|
||||
* @param {Number} height The new inner height
|
||||
*
|
||||
*
|
||||
*
|
||||
**/
|
||||
this.setInnerHeight = function(height) {
|
||||
this.inner.style.height = height + "px";
|
||||
};
|
||||
|
||||
/**
|
||||
* ScrollBar.setScrollTop(scrollTop)
|
||||
* - scrollTop (Number): The new scroll top
|
||||
*
|
||||
* Sets the scroll top of the scroll bar.
|
||||
*
|
||||
**/
|
||||
|
||||
// TODO: on chrome 17+ for small zoom levels after calling this function
|
||||
// this.element.scrollTop != scrollTop which makes page to scroll up.
|
||||
/**
|
||||
* Sets the scroll top of the scroll bar.
|
||||
* @param {Number} scrollTop The new scroll top
|
||||
*
|
||||
*
|
||||
*
|
||||
**/
|
||||
this.setScrollTop = function(scrollTop) {
|
||||
this.element.scrollTop = scrollTop;
|
||||
};
|
||||
|
|
|
|||
|
|
@ -36,28 +36,29 @@ var oop = require("./lib/oop");
|
|||
var Range = require("./range").Range;
|
||||
|
||||
/**
|
||||
* class Search
|
||||
* @class Search
|
||||
*
|
||||
* A class designed to handle all sorts of text searches within a [[Document `Document`]].
|
||||
*
|
||||
**/
|
||||
|
||||
/**
|
||||
* new Search()
|
||||
*
|
||||
*
|
||||
* Creates a new `Search` object. The following search options are avaliable:
|
||||
*
|
||||
* * `needle`: The string or regular expression you're looking for
|
||||
* * `backwards`: Whether to search backwards from where cursor currently is. Defaults to `false`.
|
||||
* * `wrap`: Whether to wrap the search back to the beginning when it hits the end. Defaults to `false`.
|
||||
* * `caseSensitive`: Whether the search ought to be case-sensitive. Defaults to `false`.
|
||||
* * `wholeWord`: Whether the search matches only on whole words. Defaults to `false`.
|
||||
* * `range`: The [[Range]] to search within. Set this to `null` for the whole document
|
||||
* * `regExp`: Whether the search is a regular expression or not. Defaults to `false`.
|
||||
* * `start`: The starting [[Range]] or cursor position to begin the search
|
||||
* * `skipCurrent`: Whether or not to include the current line in the search. Default to `false`.
|
||||
*
|
||||
**/
|
||||
* - `needle`: The string or regular expression you're looking for
|
||||
* - `backwards`: Whether to search backwards from where cursor currently is. Defaults to `false`.
|
||||
* - `wrap`: Whether to wrap the search back to the beginning when it hits the end. Defaults to `false`.
|
||||
* - `caseSensitive`: Whether the search ought to be case-sensitive. Defaults to `false`.
|
||||
* - `wholeWord`: Whether the search matches only on whole words. Defaults to `false`.
|
||||
* - `range`: The [[Range]] to search within. Set this to `null` for the whole document
|
||||
* - `regExp`: Whether the search is a regular expression or not. Defaults to `false`.
|
||||
* - `start`: The starting [[Range]] or cursor position to begin the search
|
||||
* - `skipCurrent`: Whether or not to include the current line in the search. Default to `false`.
|
||||
*
|
||||
* @constructor
|
||||
**/
|
||||
|
||||
var Search = function() {
|
||||
this.$options = {};
|
||||
|
|
@ -65,11 +66,12 @@ var Search = function() {
|
|||
|
||||
(function() {
|
||||
/**
|
||||
* Search.set(options) -> Search
|
||||
* - options (Object): An object containing all the new search properties
|
||||
*
|
||||
* Sets the search options via the `options` parameter.
|
||||
* @param {Object} options An object containing all the new search properties
|
||||
*
|
||||
*
|
||||
* @returns {Search}
|
||||
* @chainable
|
||||
**/
|
||||
this.set = function(options) {
|
||||
oop.mixin(this.$options, options);
|
||||
|
|
@ -77,24 +79,27 @@ var Search = function() {
|
|||
};
|
||||
|
||||
/**
|
||||
* Search.getOptions() -> Object
|
||||
*
|
||||
* [Returns an object containing all the search options.]{: #Search.getOptions}
|
||||
*
|
||||
* @returns {Object}
|
||||
**/
|
||||
this.getOptions = function() {
|
||||
return lang.copyObject(this.$options);
|
||||
};
|
||||
|
||||
|
||||
/**
|
||||
* Sets the search options via the `options` parameter.
|
||||
* @param {Object} An object containing all the search propertie
|
||||
* @related Search.set
|
||||
**/
|
||||
this.setOptions = function(options) {
|
||||
this.$options = options;
|
||||
};
|
||||
/**
|
||||
* Search.find(session) -> Range
|
||||
* - session (EditSession): The session to search with
|
||||
*
|
||||
* Searches for `options.needle`. If found, this method returns the [[Range `Range`]] where the text first occurs. If `options.backwards` is `true`, the search goes backwards in the session.
|
||||
* @param {EditSession} session The session to search with
|
||||
*
|
||||
*
|
||||
* @returns {Range}
|
||||
**/
|
||||
this.find = function(session) {
|
||||
var iterator = this.$matchIterator(session, this.$options);
|
||||
|
|
@ -116,11 +121,11 @@ var Search = function() {
|
|||
};
|
||||
|
||||
/**
|
||||
* Search.findAll(session) -> [Range]
|
||||
* - session (EditSession): The session to search with
|
||||
*
|
||||
* Searches for all occurances `options.needle`. If found, this method returns an array of [[Range `Range`s]] where the text first occurs. If `options.backwards` is `true`, the search goes backwards in the session.
|
||||
* @param {EditSession} session The session to search with
|
||||
*
|
||||
*
|
||||
* @returns [Range]
|
||||
**/
|
||||
this.findAll = function(session) {
|
||||
var options = this.$options;
|
||||
|
|
@ -179,14 +184,14 @@ var Search = function() {
|
|||
};
|
||||
|
||||
/**
|
||||
* Search.replace(input, replacement) -> String
|
||||
* - input (String): The text to search in
|
||||
* - replacement (String): The replacing text
|
||||
* Searches for `options.needle` in `input`, and, if found, replaces it with `replacement`.
|
||||
* @param {String} input The text to search in
|
||||
* @param {String} replacement The replacing text
|
||||
* + (String): If `options.regExp` is `true`, this function returns `input` with the replacement already made. Otherwise, this function just returns `replacement`.<br/>
|
||||
* If `options.needle` was not found, this function returns `null`.
|
||||
*
|
||||
* Searches for `options.needle` in `input`, and, if found, replaces it with `replacement`.
|
||||
*
|
||||
*
|
||||
* @returns {String}
|
||||
**/
|
||||
this.replace = function(input, replacement) {
|
||||
var options = this.$options;
|
||||
|
|
@ -218,11 +223,6 @@ var Search = function() {
|
|||
return replacement;
|
||||
};
|
||||
|
||||
/** internal, hide
|
||||
* Search.$matchIterator(session) -> String | Boolean
|
||||
* - session (EditSession): The session to search with
|
||||
*
|
||||
**/
|
||||
this.$matchIterator = function(session, options) {
|
||||
var re = this.$assembleRegExp(options);
|
||||
if (!re)
|
||||
|
|
|
|||
|
|
@ -37,32 +37,37 @@ var EventEmitter = require("./lib/event_emitter").EventEmitter;
|
|||
var Range = require("./range").Range;
|
||||
|
||||
/**
|
||||
* class Selection
|
||||
*
|
||||
*
|
||||
* Contains the cursor position and the text selection of an edit session.
|
||||
*
|
||||
* The row/columns used in the selection are in document coordinates representing ths coordinates as thez appear in the document before applying soft wrap and folding.
|
||||
* @class Selection
|
||||
**/
|
||||
|
||||
|
||||
/**
|
||||
* new Selection(session)
|
||||
* - session (EditSession): The session to use
|
||||
*
|
||||
* Creates a new `Selection` object.
|
||||
*
|
||||
**/
|
||||
/**
|
||||
* Selection@changeCursor()
|
||||
*
|
||||
* Emitted when the cursor position changes.
|
||||
* @event changeCursor
|
||||
*
|
||||
*
|
||||
*
|
||||
**/
|
||||
/**
|
||||
* Selection@changeSelection()
|
||||
*
|
||||
* Emitted when the cursor selection changes.
|
||||
* @event changeSelection
|
||||
*
|
||||
*
|
||||
*
|
||||
**/
|
||||
/**
|
||||
* Creates a new `Selection` object.
|
||||
* @param {EditSession} session The session to use
|
||||
*
|
||||
*
|
||||
*
|
||||
* @constructor
|
||||
**/
|
||||
var Selection = function(session) {
|
||||
this.session = session;
|
||||
this.doc = session.getDocument();
|
||||
|
|
@ -91,9 +96,9 @@ var Selection = function(session) {
|
|||
oop.implement(this, EventEmitter);
|
||||
|
||||
/**
|
||||
* Selection.isEmpty() -> Boolean
|
||||
*
|
||||
*
|
||||
* Returns `true` if the selection is empty.
|
||||
* @returns {Boolean}
|
||||
**/
|
||||
this.isEmpty = function() {
|
||||
return (this.$isEmpty || (
|
||||
|
|
@ -102,10 +107,9 @@ var Selection = function(session) {
|
|||
));
|
||||
};
|
||||
|
||||
/** extension
|
||||
* Selection.isMultiLine() -> Boolean
|
||||
*
|
||||
/**
|
||||
* Returns `true` if the selection is a multi-line.
|
||||
* @returns {Boolean}
|
||||
**/
|
||||
this.isMultiLine = function() {
|
||||
if (this.isEmpty()) {
|
||||
|
|
@ -115,21 +119,20 @@ var Selection = function(session) {
|
|||
return this.getRange().isMultiLine();
|
||||
};
|
||||
|
||||
/** extension
|
||||
* Selection.getCursor() -> Number
|
||||
*
|
||||
/**
|
||||
* Gets the current position of the cursor.
|
||||
* @returns {Number}
|
||||
**/
|
||||
this.getCursor = function() {
|
||||
return this.lead.getPosition();
|
||||
};
|
||||
|
||||
/**
|
||||
* Selection.setSelectionAnchor(row, column)
|
||||
* - row (Number): The new row
|
||||
* - column (Number): The new column
|
||||
*
|
||||
* Sets the row and column position of the anchor. This function also emits the `'changeSelection'` event.
|
||||
* @param {Number} row The new row
|
||||
* @param {Number} column The new column
|
||||
*
|
||||
*
|
||||
**/
|
||||
this.setSelectionAnchor = function(row, column) {
|
||||
this.anchor.setPosition(row, column);
|
||||
|
|
@ -140,11 +143,9 @@ var Selection = function(session) {
|
|||
}
|
||||
};
|
||||
|
||||
/** related to: Anchor.getPosition
|
||||
* Selection.getSelectionAnchor() -> Object
|
||||
*
|
||||
/**
|
||||
* Returns an object containing the `row` and `column` of the calling selection anchor.
|
||||
*
|
||||
* @related Anchor.getPosition
|
||||
**/
|
||||
this.getSelectionAnchor = function() {
|
||||
if (this.$isEmpty)
|
||||
|
|
@ -154,19 +155,19 @@ var Selection = function(session) {
|
|||
};
|
||||
|
||||
/**
|
||||
* Selection.getSelectionLead() -> Object
|
||||
*
|
||||
*
|
||||
* Returns an object containing the `row` and `column` of the calling selection lead.
|
||||
* @returns {Object}
|
||||
**/
|
||||
this.getSelectionLead = function() {
|
||||
return this.lead.getPosition();
|
||||
};
|
||||
|
||||
/**
|
||||
* Selection.shiftSelection(columns)
|
||||
* - columns (Number): The number of columns to shift by
|
||||
*
|
||||
* Shifts the selection up (or down, if [[Selection.isBackwards `isBackwards()`]] is true) the given number of columns.
|
||||
* @param {Number} columns The number of columns to shift by
|
||||
*
|
||||
*
|
||||
*
|
||||
**/
|
||||
this.shiftSelection = function(columns) {
|
||||
|
|
@ -191,9 +192,8 @@ var Selection = function(session) {
|
|||
};
|
||||
|
||||
/**
|
||||
* Selection.isBackwards() -> Boolean
|
||||
*
|
||||
* Returns `true` if the selection is going backwards in the document.
|
||||
* @returns {Boolean}
|
||||
**/
|
||||
this.isBackwards = function() {
|
||||
var anchor = this.anchor;
|
||||
|
|
@ -202,9 +202,8 @@ var Selection = function(session) {
|
|||
};
|
||||
|
||||
/**
|
||||
* Selection.getRange() -> Range
|
||||
*
|
||||
* [Returns the [[Range]] for the selected text.]{: #Selection.getRange}
|
||||
* @returns {Range}
|
||||
**/
|
||||
this.getRange = function() {
|
||||
var anchor = this.anchor;
|
||||
|
|
@ -222,8 +221,6 @@ var Selection = function(session) {
|
|||
};
|
||||
|
||||
/**
|
||||
* Selection.clearSelection()
|
||||
*
|
||||
* [Empties the selection (by de-selecting it). This function also emits the `'changeSelection'` event.]{: #Selection.clearSelection}
|
||||
**/
|
||||
this.clearSelection = function() {
|
||||
|
|
@ -234,8 +231,6 @@ var Selection = function(session) {
|
|||
};
|
||||
|
||||
/**
|
||||
* Selection.selectAll()
|
||||
*
|
||||
* Selects all the text in the document.
|
||||
**/
|
||||
this.selectAll = function() {
|
||||
|
|
@ -245,12 +240,12 @@ var Selection = function(session) {
|
|||
};
|
||||
|
||||
/**
|
||||
* Selection.setSelectionRange(range, reverse)
|
||||
* - range (Range): The range of text to select
|
||||
* - reverse (Boolean): Indicates if the range should go backwards (`true`) or not
|
||||
*
|
||||
* Sets the selection to the provided range.
|
||||
* @param {Range} range The range of text to select
|
||||
* @param {Boolean} reverse Indicates if the range should go backwards (`true`) or not
|
||||
*
|
||||
*
|
||||
* @method setSelectionRange
|
||||
**/
|
||||
this.setRange =
|
||||
this.setSelectionRange = function(range, reverse) {
|
||||
|
|
@ -273,11 +268,11 @@ var Selection = function(session) {
|
|||
};
|
||||
|
||||
/**
|
||||
* Selection.selectTo(row, column)
|
||||
* - row (Number): The row to select to
|
||||
* - column (Number): The column to select to
|
||||
*
|
||||
* Moves the selection cursor to the indicated row and column.
|
||||
* @param {Number} row The row to select to
|
||||
* @param {Number} column The column to select to
|
||||
*
|
||||
*
|
||||
*
|
||||
**/
|
||||
this.selectTo = function(row, column) {
|
||||
|
|
@ -287,10 +282,10 @@ var Selection = function(session) {
|
|||
};
|
||||
|
||||
/**
|
||||
* Selection.selectToPosition(pos)
|
||||
* - pos (Object): An object containing the row and column
|
||||
*
|
||||
* Moves the selection cursor to the row and column indicated by `pos`.
|
||||
* @param {Object} pos An object containing the row and column
|
||||
*
|
||||
*
|
||||
*
|
||||
**/
|
||||
this.selectToPosition = function(pos) {
|
||||
|
|
@ -300,8 +295,7 @@ var Selection = function(session) {
|
|||
};
|
||||
|
||||
/**
|
||||
* Selection.selectUp()
|
||||
*
|
||||
*
|
||||
* Moves the selection up one row.
|
||||
**/
|
||||
this.selectUp = function() {
|
||||
|
|
@ -309,8 +303,7 @@ var Selection = function(session) {
|
|||
};
|
||||
|
||||
/**
|
||||
* Selection.selectDown()
|
||||
*
|
||||
*
|
||||
* Moves the selection down one row.
|
||||
**/
|
||||
this.selectDown = function() {
|
||||
|
|
@ -318,7 +311,7 @@ var Selection = function(session) {
|
|||
};
|
||||
|
||||
/**
|
||||
* Selection.selectRight()
|
||||
*
|
||||
*
|
||||
* Moves the selection right one column.
|
||||
**/
|
||||
|
|
@ -327,8 +320,7 @@ var Selection = function(session) {
|
|||
};
|
||||
|
||||
/**
|
||||
* Selection.selectLeft()
|
||||
*
|
||||
*
|
||||
* Moves the selection left one column.
|
||||
**/
|
||||
this.selectLeft = function() {
|
||||
|
|
@ -336,8 +328,7 @@ var Selection = function(session) {
|
|||
};
|
||||
|
||||
/**
|
||||
* Selection.selectLineStart()
|
||||
*
|
||||
*
|
||||
* Moves the selection to the beginning of the current line.
|
||||
**/
|
||||
this.selectLineStart = function() {
|
||||
|
|
@ -345,8 +336,7 @@ var Selection = function(session) {
|
|||
};
|
||||
|
||||
/**
|
||||
* Selection.selectLineEnd()
|
||||
*
|
||||
*
|
||||
* Moves the selection to the end of the current line.
|
||||
**/
|
||||
this.selectLineEnd = function() {
|
||||
|
|
@ -354,8 +344,7 @@ var Selection = function(session) {
|
|||
};
|
||||
|
||||
/**
|
||||
* Selection.selectFileEnd()
|
||||
*
|
||||
*
|
||||
* Moves the selection to the end of the file.
|
||||
**/
|
||||
this.selectFileEnd = function() {
|
||||
|
|
@ -363,8 +352,7 @@ var Selection = function(session) {
|
|||
};
|
||||
|
||||
/**
|
||||
* Selection.selectFileStart()
|
||||
*
|
||||
*
|
||||
* Moves the selection to the start of the file.
|
||||
**/
|
||||
this.selectFileStart = function() {
|
||||
|
|
@ -372,8 +360,7 @@ var Selection = function(session) {
|
|||
};
|
||||
|
||||
/**
|
||||
* Selection.selectWordRight()
|
||||
*
|
||||
*
|
||||
* Moves the selection to the first word on the right.
|
||||
**/
|
||||
this.selectWordRight = function() {
|
||||
|
|
@ -381,18 +368,16 @@ var Selection = function(session) {
|
|||
};
|
||||
|
||||
/**
|
||||
* Selection.selectWordLeft()
|
||||
*
|
||||
*
|
||||
* Moves the selection to the first word on the left.
|
||||
**/
|
||||
this.selectWordLeft = function() {
|
||||
this.$moveSelection(this.moveCursorWordLeft);
|
||||
};
|
||||
|
||||
/** related to: EditSession.getWordRange
|
||||
* Selection.selectWord()
|
||||
*
|
||||
/**
|
||||
* Moves the selection to highlight the entire word.
|
||||
* @related EditSession.getWordRange
|
||||
**/
|
||||
this.getWordRange = function(row, column) {
|
||||
if (typeof column == "undefined") {
|
||||
|
|
@ -402,15 +387,18 @@ var Selection = function(session) {
|
|||
}
|
||||
return this.session.getWordRange(row, column);
|
||||
};
|
||||
|
||||
|
||||
/**
|
||||
*
|
||||
* Selects an entire word boundary.
|
||||
**/
|
||||
this.selectWord = function() {
|
||||
this.setSelectionRange(this.getWordRange());
|
||||
};
|
||||
|
||||
/** related to: EditSession.getAWordRange
|
||||
* Selection.selectAWord()
|
||||
*
|
||||
/**
|
||||
* Selects a word, including its right whitespace.
|
||||
* @related EditSession.getAWordRange
|
||||
**/
|
||||
this.selectAWord = function() {
|
||||
var cursor = this.getCursor();
|
||||
|
|
@ -436,8 +424,6 @@ var Selection = function(session) {
|
|||
};
|
||||
|
||||
/**
|
||||
* Selection.selectLine()
|
||||
*
|
||||
* Selects the entire line.
|
||||
**/
|
||||
this.selectLine = function() {
|
||||
|
|
@ -445,8 +431,7 @@ var Selection = function(session) {
|
|||
};
|
||||
|
||||
/**
|
||||
* Selection.moveCursorUp()
|
||||
*
|
||||
*
|
||||
* Moves the cursor up one row.
|
||||
**/
|
||||
this.moveCursorUp = function() {
|
||||
|
|
@ -454,8 +439,7 @@ var Selection = function(session) {
|
|||
};
|
||||
|
||||
/**
|
||||
* Selection.moveCursorDown()
|
||||
*
|
||||
*
|
||||
* Moves the cursor down one row.
|
||||
**/
|
||||
this.moveCursorDown = function() {
|
||||
|
|
@ -463,8 +447,7 @@ var Selection = function(session) {
|
|||
};
|
||||
|
||||
/**
|
||||
* Selection.moveCursorLeft()
|
||||
*
|
||||
*
|
||||
* Moves the cursor left one column.
|
||||
**/
|
||||
this.moveCursorLeft = function() {
|
||||
|
|
@ -489,8 +472,7 @@ var Selection = function(session) {
|
|||
};
|
||||
|
||||
/**
|
||||
* Selection.moveCursorRight()
|
||||
*
|
||||
*
|
||||
* Moves the cursor right one column.
|
||||
**/
|
||||
this.moveCursorRight = function() {
|
||||
|
|
@ -515,8 +497,7 @@ var Selection = function(session) {
|
|||
};
|
||||
|
||||
/**
|
||||
* Selection.moveCursorLineStart()
|
||||
*
|
||||
*
|
||||
* Moves the cursor to the start of the line.
|
||||
**/
|
||||
this.moveCursorLineStart = function() {
|
||||
|
|
@ -548,8 +529,7 @@ var Selection = function(session) {
|
|||
};
|
||||
|
||||
/**
|
||||
* Selection.moveCursorLineEnd()
|
||||
*
|
||||
*
|
||||
* Moves the cursor to the end of the line.
|
||||
**/
|
||||
this.moveCursorLineEnd = function() {
|
||||
|
|
@ -568,8 +548,7 @@ var Selection = function(session) {
|
|||
};
|
||||
|
||||
/**
|
||||
* Selection.moveCursorFileEnd()
|
||||
*
|
||||
*
|
||||
* Moves the cursor to the end of the file.
|
||||
**/
|
||||
this.moveCursorFileEnd = function() {
|
||||
|
|
@ -579,8 +558,7 @@ var Selection = function(session) {
|
|||
};
|
||||
|
||||
/**
|
||||
* Selection.moveCursorFileStart()
|
||||
*
|
||||
*
|
||||
* Moves the cursor to the start of the file.
|
||||
**/
|
||||
this.moveCursorFileStart = function() {
|
||||
|
|
@ -588,8 +566,7 @@ var Selection = function(session) {
|
|||
};
|
||||
|
||||
/**
|
||||
* Selection.moveCursorLongWordRight()
|
||||
*
|
||||
*
|
||||
* Moves the cursor to the word on the right.
|
||||
**/
|
||||
this.moveCursorLongWordRight = function() {
|
||||
|
|
@ -635,8 +612,7 @@ var Selection = function(session) {
|
|||
};
|
||||
|
||||
/**
|
||||
* Selection.moveCursorLongWordLeft()
|
||||
*
|
||||
*
|
||||
* Moves the cursor to the word on the left.
|
||||
**/
|
||||
this.moveCursorLongWordLeft = function() {
|
||||
|
|
@ -788,12 +764,13 @@ var Selection = function(session) {
|
|||
this.moveCursorShortWordLeft();
|
||||
};
|
||||
|
||||
/** related to: EditSession.documentToScreenPosition
|
||||
* Selection.moveCursorBy(rows, chars)
|
||||
* - rows (Number): The number of rows to move by
|
||||
* - chars (Number): The number of characters to move by
|
||||
/**
|
||||
* Moves the cursor to position indicated by the parameters. Negative numbers move the cursor backwards in the document.
|
||||
* @param {Number} rows The number of rows to move by
|
||||
* @param {Number} chars The number of characters to move by
|
||||
*
|
||||
* Moves the cursor to position indicated by the parameters. Negative numbers move the cursor backwards in the document.
|
||||
*
|
||||
* @related EditSession.documentToScreenPosition
|
||||
**/
|
||||
this.moveCursorBy = function(rows, chars) {
|
||||
var screenPos = this.session.documentToScreenPosition(
|
||||
|
|
@ -815,22 +792,22 @@ var Selection = function(session) {
|
|||
};
|
||||
|
||||
/**
|
||||
* Selection.moveCursorToPosition(position)
|
||||
* - position (Object): The position to move to
|
||||
*
|
||||
* Moves the selection to the position indicated by its `row` and `column`.
|
||||
* @param {Object} position The position to move to
|
||||
*
|
||||
*
|
||||
**/
|
||||
this.moveCursorToPosition = function(position) {
|
||||
this.moveCursorTo(position.row, position.column);
|
||||
};
|
||||
|
||||
/**
|
||||
* Selection.moveCursorTo(row, column, keepDesiredColumn)
|
||||
* - row (Number): The row to move to
|
||||
* - column (Number): The column to move to
|
||||
* - keepDesiredColumn (Boolean): [If `true`, the cursor move does not respect the previous column]{: #preventUpdateBool}
|
||||
*
|
||||
* Moves the cursor to the row and column provided. [If `preventUpdateDesiredColumn` is `true`, then the cursor stays in the same column position as its original point.]{: #preventUpdateBoolDesc}
|
||||
* @param {Number} row The row to move to
|
||||
* @param {Number} column The column to move to
|
||||
* @param {Boolean} keepDesiredColumn [If `true`, the cursor move does not respect the previous column]{: #preventUpdateBool}
|
||||
*
|
||||
*
|
||||
**/
|
||||
this.moveCursorTo = function(row, column, keepDesiredColumn) {
|
||||
// Ensure the row/column is not inside of a fold.
|
||||
|
|
@ -849,12 +826,12 @@ var Selection = function(session) {
|
|||
};
|
||||
|
||||
/**
|
||||
* Selection.moveCursorToScreen(row, column, keepDesiredColumn)
|
||||
* - row (Number): The row to move to
|
||||
* - column (Number): The column to move to
|
||||
* - keepDesiredColumn (Boolean): {:preventUpdateBool}
|
||||
*
|
||||
* Moves the cursor to the screen position indicated by row and column. {:preventUpdateBoolDesc}
|
||||
* @param {Number} row The row to move to
|
||||
* @param {Number} column The column to move to
|
||||
* @param {Boolean} keepDesiredColumn {:preventUpdateBool}
|
||||
*
|
||||
*
|
||||
**/
|
||||
this.moveCursorToScreen = function(row, column, keepDesiredColumn) {
|
||||
var pos = this.session.screenToDocumentPosition(row, column);
|
||||
|
|
|
|||
109
lib/ace/split.js
109
lib/ace/split.js
|
|
@ -39,22 +39,13 @@ var Editor = require("./editor").Editor;
|
|||
var Renderer = require("./virtual_renderer").VirtualRenderer;
|
||||
var EditSession = require("./edit_session").EditSession;
|
||||
|
||||
/** internal, hide
|
||||
* class Split
|
||||
/**
|
||||
* @class Split
|
||||
*
|
||||
*
|
||||
*
|
||||
**/
|
||||
|
||||
/** internal, hide
|
||||
* new Split(container, theme, splits)
|
||||
* - container (Document): The document to associate with the split
|
||||
* - theme (String): The name of the initial theme
|
||||
* - splits (Number): The number of initial splits
|
||||
*
|
||||
*
|
||||
*
|
||||
**/
|
||||
|
||||
var Split = function(container, theme, splits) {
|
||||
this.BELOW = 1;
|
||||
|
|
@ -96,13 +87,6 @@ var Split = function(container, theme, splits) {
|
|||
return editor;
|
||||
};
|
||||
|
||||
/** internal, hide
|
||||
* Split.setSplits(splits) -> Void
|
||||
* - splits (Number): The new number of splits
|
||||
*
|
||||
*
|
||||
*
|
||||
**/
|
||||
this.setSplits = function(splits) {
|
||||
var editor;
|
||||
if (splits < 1) {
|
||||
|
|
@ -133,18 +117,16 @@ var Split = function(container, theme, splits) {
|
|||
};
|
||||
|
||||
/**
|
||||
* Split.getSplits() -> Number
|
||||
*
|
||||
*
|
||||
* Returns the number of splits.
|
||||
*
|
||||
* @returns {Number}
|
||||
**/
|
||||
this.getSplits = function() {
|
||||
return this.$splits;
|
||||
};
|
||||
|
||||
/**
|
||||
* Split.getEditor(idx) -> Editor
|
||||
* -idx (Number): The index of the editor you want
|
||||
* @param {Number} idx The index of the editor you want
|
||||
*
|
||||
* Returns the editor identified by the index `idx`.
|
||||
*
|
||||
|
|
@ -154,40 +136,36 @@ var Split = function(container, theme, splits) {
|
|||
};
|
||||
|
||||
/**
|
||||
* Split.getCurrentEditor() -> Editor
|
||||
*
|
||||
*
|
||||
* Returns the current editor.
|
||||
*
|
||||
* @returns {Editor}
|
||||
**/
|
||||
this.getCurrentEditor = function() {
|
||||
return this.$cEditor;
|
||||
};
|
||||
|
||||
/** related to: Editor.focus
|
||||
* Split.focus() -> Void
|
||||
*
|
||||
/**
|
||||
* Focuses the current editor.
|
||||
*
|
||||
* @related Editor.focus
|
||||
**/
|
||||
this.focus = function() {
|
||||
this.$cEditor.focus();
|
||||
};
|
||||
|
||||
/** related to: Editor.blur
|
||||
* Split.blur() -> Void
|
||||
*
|
||||
/**
|
||||
* Blurs the current editor.
|
||||
*
|
||||
* @related Editor.blur
|
||||
**/
|
||||
this.blur = function() {
|
||||
this.$cEditor.blur();
|
||||
};
|
||||
|
||||
/** related to: Editor.setTheme
|
||||
* Split.setTheme(theme) -> Void
|
||||
* - theme (String): The name of the theme to set
|
||||
/**
|
||||
*
|
||||
* @param {String} theme The name of the theme to set
|
||||
*
|
||||
* Sets a theme for each of the available editors.
|
||||
* @related Editor.setTheme
|
||||
**/
|
||||
this.setTheme = function(theme) {
|
||||
this.$editors.forEach(function(editor) {
|
||||
|
|
@ -195,11 +173,12 @@ var Split = function(container, theme, splits) {
|
|||
});
|
||||
};
|
||||
|
||||
/** internal, hide
|
||||
* Split.setKeyboardHandler(keybinding) -> Void
|
||||
* - keybinding (String):
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @param {String} keybinding
|
||||
*
|
||||
* Sets the keyboard handler for the editor.
|
||||
* @related editor.setKeyboardHandler
|
||||
**/
|
||||
this.setKeyboardHandler = function(keybinding) {
|
||||
this.$editors.forEach(function(editor) {
|
||||
|
|
@ -207,10 +186,10 @@ var Split = function(container, theme, splits) {
|
|||
});
|
||||
};
|
||||
|
||||
/** internal, hide
|
||||
* Split.forEach(callback, scope) -> Void
|
||||
* - callback (Function): A callback function to execute
|
||||
* - scope (String):
|
||||
/**
|
||||
*
|
||||
* @param {Function} callback A callback function to execute
|
||||
* @param {String} scope The default scope for the callback
|
||||
*
|
||||
* Executes `callback` on all of the available editors.
|
||||
*
|
||||
|
|
@ -219,14 +198,14 @@ var Split = function(container, theme, splits) {
|
|||
this.$editors.forEach(callback, scope);
|
||||
};
|
||||
|
||||
/** related to: Editor.setFontSize
|
||||
* Split.setFontSize(size) -> Void
|
||||
* - size (Number): The new font size
|
||||
|
||||
this.$fontSize = "";
|
||||
/**
|
||||
* @param {Number} size The new font size
|
||||
*
|
||||
* Sets the font size, in pixels, for all the available editors.
|
||||
*
|
||||
**/
|
||||
this.$fontSize = "";
|
||||
this.setFontSize = function(size) {
|
||||
this.$fontSize = size;
|
||||
this.forEach(function(editor) {
|
||||
|
|
@ -261,13 +240,13 @@ var Split = function(container, theme, splits) {
|
|||
return s;
|
||||
};
|
||||
|
||||
/** related to: Editor.setSession
|
||||
* Split.setSession(session, idx) -> Void
|
||||
* - session (EditSession): The new edit session
|
||||
* - idx (Number): The editor's index you're interested in
|
||||
/**
|
||||
*
|
||||
* @param {EditSession} session The new edit session
|
||||
* @param {Number} idx The editor's index you're interested in
|
||||
*
|
||||
* Sets a new [[EditSession `EditSession`]] for the indicated editor.
|
||||
*
|
||||
* @related Editor.setSession
|
||||
**/
|
||||
this.setSession = function(session, idx) {
|
||||
var editor;
|
||||
|
|
@ -295,19 +274,18 @@ var Split = function(container, theme, splits) {
|
|||
return session;
|
||||
};
|
||||
|
||||
/** internal, hide
|
||||
* Split.getOrientation() -> Number
|
||||
/**
|
||||
*
|
||||
* Returns the orientation.
|
||||
*
|
||||
* @returns Number
|
||||
**/
|
||||
this.getOrientation = function() {
|
||||
return this.$orientation;
|
||||
};
|
||||
|
||||
/** internal, hide
|
||||
* Split.setOrientation(oriantation) -> Void
|
||||
* - oriantation (Number):
|
||||
/**
|
||||
*
|
||||
* @param {Number} orientation The new orientation value
|
||||
*
|
||||
* Sets the orientation.
|
||||
*
|
||||
|
|
@ -320,11 +298,11 @@ var Split = function(container, theme, splits) {
|
|||
this.resize();
|
||||
};
|
||||
|
||||
/** internal
|
||||
/**
|
||||
* Split.resize() -> Void
|
||||
*
|
||||
*
|
||||
*
|
||||
* Resizes the editor.
|
||||
**/
|
||||
this.resize = function() {
|
||||
var width = this.$container.clientWidth;
|
||||
|
|
@ -356,12 +334,7 @@ var Split = function(container, theme, splits) {
|
|||
|
||||
}).call(Split.prototype);
|
||||
|
||||
/** internal
|
||||
* Split.UndoManagerProxy() -> Void
|
||||
*
|
||||
*
|
||||
*
|
||||
**/
|
||||
|
||||
function UndoManagerProxy(undoManager, session) {
|
||||
this.$u = undoManager;
|
||||
this.$doc = session;
|
||||
|
|
|
|||
|
|
@ -32,20 +32,19 @@ define(function(require, exports, module) {
|
|||
"use strict";
|
||||
|
||||
/**
|
||||
* class TokenIterator
|
||||
*
|
||||
*
|
||||
* This class provides an essay way to treat the document as a stream of tokens, and provides methods to iterate over these tokens.
|
||||
*
|
||||
* @class TokenIterator
|
||||
**/
|
||||
|
||||
/**
|
||||
* new TokenIterator(session, initialRow, initialColumn)
|
||||
* - session (EditSession): The session to associate with
|
||||
* - initialRow (Number): The row to start the tokenizing at
|
||||
* - initialColumn (Number): The column to start the tokenizing at
|
||||
*
|
||||
* Creates a new token iterator object. The inital token index is set to the provided row and column coordinates.
|
||||
* @param {EditSession} session The session to associate with
|
||||
* @param {Number} initialRow The row to start the tokenizing at
|
||||
* @param {Number} initialColumn The column to start the tokenizing at
|
||||
*
|
||||
* @constructor
|
||||
**/
|
||||
var TokenIterator = function(session, initialRow, initialColumn) {
|
||||
this.$session = session;
|
||||
|
|
@ -59,10 +58,9 @@ var TokenIterator = function(session, initialRow, initialColumn) {
|
|||
(function() {
|
||||
|
||||
/**
|
||||
* TokenIterator.stepBackward() -> [String]
|
||||
* + (String): If the current point is not at the top of the file, this function returns `null`. Otherwise, it returns an array of the tokenized strings.
|
||||
*
|
||||
* Tokenizes all the items from the current point to the row prior in the document.
|
||||
* @returns [String] If the current point is not at the top of the file, this function returns `null`. Otherwise, it returns an array of the tokenized strings.
|
||||
**/
|
||||
this.stepBackward = function() {
|
||||
this.$tokenIndex -= 1;
|
||||
|
|
@ -82,9 +80,9 @@ var TokenIterator = function(session, initialRow, initialColumn) {
|
|||
};
|
||||
|
||||
/**
|
||||
* TokenIterator.stepForward() -> String
|
||||
*
|
||||
* 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 `null`. Otherwise, it returns the tokenized string.
|
||||
* @returns {String}
|
||||
**/
|
||||
this.stepForward = function() {
|
||||
var rowCount = this.$session.getLength();
|
||||
|
|
@ -105,30 +103,27 @@ var TokenIterator = function(session, initialRow, initialColumn) {
|
|||
};
|
||||
|
||||
/**
|
||||
* TokenIterator.getCurrentToken() -> String
|
||||
*
|
||||
* Returns the current tokenized string.
|
||||
*
|
||||
* @returns {String}
|
||||
**/
|
||||
this.getCurrentToken = function () {
|
||||
return this.$rowTokens[this.$tokenIndex];
|
||||
};
|
||||
|
||||
/**
|
||||
* TokenIterator.getCurrentTokenRow() -> Number
|
||||
*
|
||||
* Returns the current row.
|
||||
*
|
||||
* @returns {Number}
|
||||
**/
|
||||
this.getCurrentTokenRow = function () {
|
||||
return this.$row;
|
||||
};
|
||||
|
||||
/**
|
||||
* TokenIterator.getCurrentTokenColumn() -> Number
|
||||
*
|
||||
* Returns the current column.
|
||||
*
|
||||
* @returns {Number}
|
||||
**/
|
||||
this.getCurrentTokenColumn = function() {
|
||||
var rowTokens = this.$rowTokens;
|
||||
|
|
|
|||
|
|
@ -32,19 +32,21 @@ define(function(require, exports, module) {
|
|||
"use strict";
|
||||
|
||||
/**
|
||||
* class Tokenizer
|
||||
*
|
||||
*
|
||||
* This class takes a set of highlighting rules, and creates a tokenizer out of them. For more information, see [the wiki on extending highlighters](https://github.com/ajaxorg/ace/wiki/Creating-or-Extending-an-Edit-Mode#wiki-extendingTheHighlighter).
|
||||
*
|
||||
* @class Tokenizer
|
||||
**/
|
||||
|
||||
/**
|
||||
* new Tokenizer(rules, flag)
|
||||
* - rules (Object): The highlighting rules
|
||||
* - flag (String): Any additional regular expression flags to pass (like "i" for case insensitive)
|
||||
*
|
||||
* Constructs a new tokenizer based on the given rules and flags.
|
||||
* @param {Object} rules The highlighting rules
|
||||
* @param {String} flag Any additional regular expression flags to pass (like "i" for case insensitive)
|
||||
*
|
||||
*
|
||||
*
|
||||
*
|
||||
* @constructor
|
||||
**/
|
||||
var Tokenizer = function(rules, flag) {
|
||||
flag = flag ? "g" + flag : "g";
|
||||
|
|
@ -92,9 +94,8 @@ var Tokenizer = function(rules, flag) {
|
|||
(function() {
|
||||
|
||||
/**
|
||||
* Tokenizer.getLineTokens() -> Object
|
||||
*
|
||||
* Returns an object containing two properties: `tokens`, which contains all the tokens; and `state`, the current state.
|
||||
* @returns {Object}
|
||||
**/
|
||||
this.getLineTokens = function(line, startState) {
|
||||
var currentState = startState || "start";
|
||||
|
|
|
|||
|
|
@ -32,16 +32,18 @@ define(function(require, exports, module) {
|
|||
"use strict";
|
||||
|
||||
/**
|
||||
* class UndoManager
|
||||
*
|
||||
*
|
||||
* This object maintains the undo stack for an [[EditSession `EditSession`]].
|
||||
*
|
||||
* @class UndoManager
|
||||
**/
|
||||
|
||||
/**
|
||||
* new UndoManager()
|
||||
*
|
||||
*
|
||||
* Resets the current undo state and creates a new `UndoManager`.
|
||||
*
|
||||
* @constructor
|
||||
**/
|
||||
var UndoManager = function() {
|
||||
this.reset();
|
||||
|
|
@ -50,13 +52,12 @@ var UndoManager = function() {
|
|||
(function() {
|
||||
|
||||
/**
|
||||
* UndoManager.execute(options) -> Void
|
||||
* - options (Object): Contains additional properties
|
||||
*
|
||||
* Provides a means for implementing your own undo manager. `options` has one property, `args`, an [[Array `Array`]], with two elements:
|
||||
*
|
||||
* * `args[0]` is an array of deltas
|
||||
* * `args[1]` is the document to associate with
|
||||
* - `args[0]` is an array of deltas
|
||||
* - `args[1]` is the document to associate with
|
||||
*
|
||||
* @param {Object} options Contains additional properties
|
||||
*
|
||||
**/
|
||||
this.execute = function(options) {
|
||||
|
|
@ -67,10 +68,11 @@ var UndoManager = function() {
|
|||
};
|
||||
|
||||
/**
|
||||
* UndoManager.undo(dontSelect) -> Range
|
||||
* - dontSelect (Boolean): {:dontSelect}
|
||||
* [Perform an undo operation on the document, reverting the last change.]{: #UndoManager.undo}
|
||||
* @param {Boolean} dontSelect {:dontSelect}
|
||||
*
|
||||
* [Perform an undo operation on the document, reverting the last change. Returns the range of the undo.]{: #UndoManager.undo}
|
||||
*
|
||||
* @returns {Range} The range of the undo.
|
||||
**/
|
||||
this.undo = function(dontSelect) {
|
||||
var deltas = this.$undoStack.pop();
|
||||
|
|
@ -84,10 +86,10 @@ var UndoManager = function() {
|
|||
};
|
||||
|
||||
/**
|
||||
* UndoManager.redo(dontSelect) -> Void
|
||||
* - dontSelect (Boolean): {:dontSelect}
|
||||
*
|
||||
* [Perform a redo operation on the document, reimplementing the last change.]{: #UndoManager.redo}
|
||||
* @param {Boolean} dontSelect {:dontSelect}
|
||||
*
|
||||
*
|
||||
**/
|
||||
this.redo = function(dontSelect) {
|
||||
var deltas = this.$redoStack.pop();
|
||||
|
|
@ -101,8 +103,7 @@ var UndoManager = function() {
|
|||
};
|
||||
|
||||
/**
|
||||
* UndoManager.reset() -> Void
|
||||
*
|
||||
*
|
||||
* Destroys the stack of undo and redo redo operations.
|
||||
**/
|
||||
this.reset = function() {
|
||||
|
|
@ -111,18 +112,18 @@ var UndoManager = function() {
|
|||
};
|
||||
|
||||
/**
|
||||
* UndoManager.hasUndo() -> Boolean
|
||||
*
|
||||
*
|
||||
* Returns `true` if there are undo operations left to perform.
|
||||
* @returns {Boolean}
|
||||
**/
|
||||
this.hasUndo = function() {
|
||||
return this.$undoStack.length > 0;
|
||||
};
|
||||
|
||||
/**
|
||||
* UndoManager.hasRedo() -> Boolean
|
||||
*
|
||||
*
|
||||
* Returns `true` if there are redo operations left to perform.
|
||||
* @returns {Boolean}
|
||||
**/
|
||||
this.hasRedo = function() {
|
||||
return this.$redoStack.length > 0;
|
||||
|
|
|
|||
|
|
@ -49,19 +49,21 @@ var editorCss = require("./requirejs/text!./css/editor.css");
|
|||
dom.importCssString(editorCss, "ace_editor");
|
||||
|
||||
/**
|
||||
* class VirtualRenderer
|
||||
*
|
||||
*
|
||||
* The class that is responsible for drawing everything you see on the screen!
|
||||
*
|
||||
* @class VirtualRenderer
|
||||
**/
|
||||
|
||||
/**
|
||||
* new VirtualRenderer(container, theme)
|
||||
* - container (DOMElement): The root element of the editor
|
||||
* - theme (String): The starting theme
|
||||
*
|
||||
* Constructs a new `VirtualRenderer` within the `container` specified, applying the given `theme`.
|
||||
* @param {DOMElement} container The root element of the editor
|
||||
* @param {String} theme The starting theme
|
||||
*
|
||||
*
|
||||
*
|
||||
*
|
||||
* @constructor
|
||||
**/
|
||||
|
||||
var VirtualRenderer = function(container, theme) {
|
||||
|
|
@ -196,9 +198,8 @@ var VirtualRenderer = function(container, theme) {
|
|||
};
|
||||
|
||||
/**
|
||||
* VirtualRenderer.setSession(session)
|
||||
*
|
||||
* Associates an [[EditSession `EditSession`]].
|
||||
* Associates the renderer with an [[EditSession `EditSession`]].
|
||||
**/
|
||||
this.setSession = function(session) {
|
||||
this.session = session;
|
||||
|
|
@ -215,11 +216,11 @@ var VirtualRenderer = function(container, theme) {
|
|||
};
|
||||
|
||||
/**
|
||||
* VirtualRenderer.updateLines(firstRow, lastRow)
|
||||
* - firstRow (Number): The first row to update
|
||||
* - lastRow (Number): The last row to update
|
||||
*
|
||||
* Triggers a partial update of the text, from the range given by the two parameters.
|
||||
* @param {Number} firstRow The first row to update
|
||||
* @param {Number} lastRow The last row to update
|
||||
*
|
||||
*
|
||||
**/
|
||||
this.updateLines = function(firstRow, lastRow) {
|
||||
if (lastRow === undefined)
|
||||
|
|
@ -248,8 +249,6 @@ var VirtualRenderer = function(container, theme) {
|
|||
};
|
||||
|
||||
/**
|
||||
* VirtualRenderer.updateText()
|
||||
*
|
||||
* Triggers a full update of the text, for all the rows.
|
||||
**/
|
||||
this.updateText = function() {
|
||||
|
|
@ -257,10 +256,10 @@ var VirtualRenderer = function(container, theme) {
|
|||
};
|
||||
|
||||
/**
|
||||
* VirtualRenderer.updateFull(force)
|
||||
* - force (Boolean): If `true`, forces the changes through
|
||||
*
|
||||
* Triggers a full update of all the layers, for all the rows.
|
||||
* @param {Boolean} force If `true`, forces the changes through
|
||||
*
|
||||
*
|
||||
**/
|
||||
this.updateFull = function(force) {
|
||||
if (force){
|
||||
|
|
@ -272,8 +271,7 @@ var VirtualRenderer = function(container, theme) {
|
|||
};
|
||||
|
||||
/**
|
||||
* VirtualRenderer.updateFontSize()
|
||||
*
|
||||
*
|
||||
* Updates the font size.
|
||||
**/
|
||||
this.updateFontSize = function() {
|
||||
|
|
@ -281,13 +279,13 @@ var VirtualRenderer = function(container, theme) {
|
|||
};
|
||||
|
||||
/**
|
||||
* VirtualRenderer.onResize(force, gutterWidth, width, height)
|
||||
* - force (Boolean): If `true`, recomputes the size, even if the height and width haven't changed
|
||||
* - gutterWidth (Number): The width of the gutter in pixels
|
||||
* - width (Number): The width of the editor in pixels
|
||||
* - height (Number): The hiehgt of the editor, in pixels
|
||||
*
|
||||
* [Triggers a resize of the editor.]{: #VirtualRenderer.onResize}
|
||||
* @param {Boolean} force If `true`, recomputes the size, even if the height and width haven't changed
|
||||
* @param {Number} gutterWidth The width of the gutter in pixels
|
||||
* @param {Number} width The width of the editor in pixels
|
||||
* @param {Number} height The hiehgt of the editor, in pixels
|
||||
*
|
||||
*
|
||||
**/
|
||||
this.onResize = function(force, gutterWidth, width, height) {
|
||||
var changes = this.CHANGE_SIZE;
|
||||
|
|
@ -339,8 +337,7 @@ var VirtualRenderer = function(container, theme) {
|
|||
};
|
||||
|
||||
/**
|
||||
* VirtualRenderer.adjustWrapLimit()
|
||||
*
|
||||
*
|
||||
* Adjusts the wrap limit, which is the number of characters that can fit within the width of the edit area on screen.
|
||||
**/
|
||||
this.adjustWrapLimit = function() {
|
||||
|
|
@ -350,10 +347,10 @@ var VirtualRenderer = function(container, theme) {
|
|||
};
|
||||
|
||||
/**
|
||||
* VirtualRenderer.setAnimatedScroll(shouldAnimate)
|
||||
* - shouldAnimate (Boolean): Set to `true` to show animated scrolls
|
||||
*
|
||||
* Identifies whether you want to have an animated scroll or not.
|
||||
* @param {Boolean} shouldAnimate Set to `true` to show animated scrolls
|
||||
*
|
||||
*
|
||||
*
|
||||
**/
|
||||
this.setAnimatedScroll = function(shouldAnimate){
|
||||
|
|
@ -361,19 +358,19 @@ var VirtualRenderer = function(container, theme) {
|
|||
};
|
||||
|
||||
/**
|
||||
* VirtualRenderer.getAnimatedScroll() -> Boolean
|
||||
*
|
||||
*
|
||||
* Returns whether an animated scroll happens or not.
|
||||
* @returns {Boolean}
|
||||
**/
|
||||
this.getAnimatedScroll = function() {
|
||||
return this.$animatedScroll;
|
||||
};
|
||||
|
||||
/**
|
||||
* VirtualRenderer.setShowInvisibles(showInvisibles)
|
||||
* - showInvisibles (Boolean): Set to `true` to show invisibles
|
||||
*
|
||||
* Identifies whether you want to show invisible characters or not.
|
||||
* @param {Boolean} showInvisibles Set to `true` to show invisibles
|
||||
*
|
||||
*
|
||||
*
|
||||
**/
|
||||
this.setShowInvisibles = function(showInvisibles) {
|
||||
|
|
@ -382,9 +379,9 @@ var VirtualRenderer = function(container, theme) {
|
|||
};
|
||||
|
||||
/**
|
||||
* VirtualRenderer.getShowInvisibles() -> Boolean
|
||||
*
|
||||
*
|
||||
* Returns whether invisible characters are being shown or not.
|
||||
* @returns {Boolean}
|
||||
**/
|
||||
this.getShowInvisibles = function() {
|
||||
return this.$textLayer.showInvisibles;
|
||||
|
|
@ -402,10 +399,10 @@ var VirtualRenderer = function(container, theme) {
|
|||
this.$showPrintMargin = true;
|
||||
|
||||
/**
|
||||
* VirtualRenderer.setShowPrintMargin(showPrintMargin)
|
||||
* - showPrintMargin (Boolean): Set to `true` to show the print margin
|
||||
*
|
||||
* Identifies whether you want to show the print margin or not.
|
||||
* @param {Boolean} showPrintMargin Set to `true` to show the print margin
|
||||
*
|
||||
*
|
||||
*
|
||||
**/
|
||||
this.setShowPrintMargin = function(showPrintMargin) {
|
||||
|
|
@ -414,9 +411,8 @@ var VirtualRenderer = function(container, theme) {
|
|||
};
|
||||
|
||||
/**
|
||||
* VirtualRenderer.getShowPrintMargin() -> Boolean
|
||||
*
|
||||
* Returns whetherthe print margin is being shown or not.
|
||||
* Returns whether the print margin is being shown or not.
|
||||
* @returns {Boolean}
|
||||
**/
|
||||
this.getShowPrintMargin = function() {
|
||||
return this.$showPrintMargin;
|
||||
|
|
@ -425,10 +421,10 @@ var VirtualRenderer = function(container, theme) {
|
|||
this.$printMarginColumn = 80;
|
||||
|
||||
/**
|
||||
* VirtualRenderer.setPrintMarginColumn(showPrintMargin)
|
||||
* - showPrintMargin (Boolean): Set to `true` to show the print margin column
|
||||
*
|
||||
* Identifies whether you want to show the print margin column or not.
|
||||
* @param {Boolean} showPrintMargin Set to `true` to show the print margin column
|
||||
*
|
||||
*
|
||||
*
|
||||
**/
|
||||
this.setPrintMarginColumn = function(showPrintMargin) {
|
||||
|
|
@ -437,28 +433,28 @@ var VirtualRenderer = function(container, theme) {
|
|||
};
|
||||
|
||||
/**
|
||||
* VirtualRenderer.getPrintMarginColumn() -> Boolean
|
||||
*
|
||||
*
|
||||
* Returns whether the print margin column is being shown or not.
|
||||
* @returns {Boolean}
|
||||
**/
|
||||
this.getPrintMarginColumn = function() {
|
||||
return this.$printMarginColumn;
|
||||
};
|
||||
|
||||
/**
|
||||
* VirtualRenderer.getShowGutter() -> Boolean
|
||||
*
|
||||
*
|
||||
* Returns `true` if the gutter is being shown.
|
||||
* @returns {Boolean}
|
||||
**/
|
||||
this.getShowGutter = function(){
|
||||
return this.showGutter;
|
||||
};
|
||||
|
||||
/**
|
||||
* VirtualRenderer.setShowGutter(show)
|
||||
* - show (Boolean): Set to `true` to show the gutter
|
||||
*
|
||||
* Identifies whether you want to show the gutter or not.
|
||||
* @param {Boolean} show Set to `true` to show the gutter
|
||||
*
|
||||
*
|
||||
**/
|
||||
this.setShowGutter = function(show){
|
||||
if(this.showGutter === show)
|
||||
|
|
@ -526,27 +522,27 @@ var VirtualRenderer = function(container, theme) {
|
|||
};
|
||||
|
||||
/**
|
||||
* VirtualRenderer.getContainerElement() -> DOMElement
|
||||
*
|
||||
*
|
||||
* Returns the root element containing this renderer.
|
||||
* @returns {DOMElement}
|
||||
**/
|
||||
this.getContainerElement = function() {
|
||||
return this.container;
|
||||
};
|
||||
|
||||
/**
|
||||
* VirtualRenderer.getMouseEventTarget() -> DOMElement
|
||||
*
|
||||
*
|
||||
* Returns the element that the mouse events are attached to
|
||||
* @returns {DOMElement}
|
||||
**/
|
||||
this.getMouseEventTarget = function() {
|
||||
return this.content;
|
||||
};
|
||||
|
||||
/**
|
||||
* VirtualRenderer.getTextAreaContainer() -> DOMElement
|
||||
*
|
||||
*
|
||||
* Returns the element to which the hidden text area is added.
|
||||
* @returns {DOMElement}
|
||||
**/
|
||||
this.getTextAreaContainer = function() {
|
||||
return this.container;
|
||||
|
|
@ -582,27 +578,27 @@ var VirtualRenderer = function(container, theme) {
|
|||
};
|
||||
|
||||
/**
|
||||
* VirtualRenderer.getFirstVisibleRow() -> Number
|
||||
*
|
||||
*
|
||||
* [Returns the index of the first visible row.]{: #VirtualRenderer.getFirstVisibleRow}
|
||||
* @returns {Number}
|
||||
**/
|
||||
this.getFirstVisibleRow = function() {
|
||||
return this.layerConfig.firstRow;
|
||||
};
|
||||
|
||||
/**
|
||||
* VirtualRenderer.getFirstFullyVisibleRow() -> Number
|
||||
*
|
||||
*
|
||||
* Returns the index of the first fully visible row. "Fully" here means that the characters in the row are not truncated; that the top and the bottom of the row are on the screen.
|
||||
* @returns {Number}
|
||||
**/
|
||||
this.getFirstFullyVisibleRow = function() {
|
||||
return this.layerConfig.firstRow + (this.layerConfig.offset === 0 ? 0 : 1);
|
||||
};
|
||||
|
||||
/**
|
||||
* VirtualRenderer.getLastFullyVisibleRow() -> Number
|
||||
*
|
||||
*
|
||||
* Returns the index of the last fully visible row. "Fully" here means that the characters in the row are not truncated; that the top and the bottom of the row are on the screen.
|
||||
* @returns {Number}
|
||||
**/
|
||||
this.getLastFullyVisibleRow = function() {
|
||||
var flint = Math.floor((this.layerConfig.height + this.layerConfig.offset) / this.layerConfig.lineHeight);
|
||||
|
|
@ -610,9 +606,9 @@ var VirtualRenderer = function(container, theme) {
|
|||
};
|
||||
|
||||
/**
|
||||
* VirtualRenderer.getLastVisibleRow() -> Number
|
||||
*
|
||||
*
|
||||
* [Returns the index of the last visible row.]{: #VirtualRenderer.getLastVisibleRow}
|
||||
* @returns {Number}
|
||||
**/
|
||||
this.getLastVisibleRow = function() {
|
||||
return this.layerConfig.lastRow;
|
||||
|
|
@ -621,10 +617,10 @@ var VirtualRenderer = function(container, theme) {
|
|||
this.$padding = null;
|
||||
|
||||
/**
|
||||
* VirtualRenderer.setPadding(padding)
|
||||
* - padding (Number): A new padding value (in pixels)
|
||||
*
|
||||
* Sets the padding for all the layers.
|
||||
* @param {Number} padding A new padding value (in pixels)
|
||||
*
|
||||
*
|
||||
*
|
||||
**/
|
||||
this.setPadding = function(padding) {
|
||||
|
|
@ -638,19 +634,19 @@ var VirtualRenderer = function(container, theme) {
|
|||
};
|
||||
|
||||
/**
|
||||
* VirtualRenderer.getHScrollBarAlwaysVisible() -> Boolean
|
||||
*
|
||||
*
|
||||
* Returns whether the horizontal scrollbar is set to be always visible.
|
||||
* @returns {Boolean}
|
||||
**/
|
||||
this.getHScrollBarAlwaysVisible = function() {
|
||||
return this.$horizScrollAlwaysVisible;
|
||||
};
|
||||
|
||||
/**
|
||||
* VirtualRenderer.setHScrollBarAlwaysVisible(alwaysVisible)
|
||||
* - alwaysVisible (Boolean): Set to `true` to make the horizontal scroll bar visible
|
||||
*
|
||||
* Identifies whether you want to show the horizontal scrollbar or not.
|
||||
* @param {Boolean} alwaysVisible Set to `true` to make the horizontal scroll bar visible
|
||||
*
|
||||
*
|
||||
**/
|
||||
this.setHScrollBarAlwaysVisible = function(alwaysVisible) {
|
||||
if (this.$horizScrollAlwaysVisible != alwaysVisible) {
|
||||
|
|
@ -862,8 +858,7 @@ var VirtualRenderer = function(container, theme) {
|
|||
};
|
||||
|
||||
/**
|
||||
* VirtualRenderer.updateFrontMarkers()
|
||||
*
|
||||
*
|
||||
* Schedules an update to all the front markers in the document.
|
||||
**/
|
||||
this.updateFrontMarkers = function() {
|
||||
|
|
@ -872,8 +867,7 @@ var VirtualRenderer = function(container, theme) {
|
|||
};
|
||||
|
||||
/**
|
||||
* VirtualRenderer.updateBackMarkers()
|
||||
*
|
||||
*
|
||||
* Schedules an update to all the back markers in the document.
|
||||
**/
|
||||
this.updateBackMarkers = function() {
|
||||
|
|
@ -881,27 +875,25 @@ var VirtualRenderer = function(container, theme) {
|
|||
this.$loop.schedule(this.CHANGE_MARKER_BACK);
|
||||
};
|
||||
|
||||
/** deprecated
|
||||
* VirtualRenderer.addGutterDecoration(row, className)
|
||||
*
|
||||
/**
|
||||
*
|
||||
* Deprecated; (moved to [[EditSession]])
|
||||
* @deprecated
|
||||
**/
|
||||
this.addGutterDecoration = function(row, className){
|
||||
this.$gutterLayer.addGutterDecoration(row, className);
|
||||
};
|
||||
|
||||
/** deprecated
|
||||
* VirtualRenderer.removeGutterDecoration(row, className)-> Void
|
||||
*
|
||||
/**
|
||||
* Deprecated; (moved to [[EditSession]])
|
||||
* @deprecated
|
||||
**/
|
||||
this.removeGutterDecoration = function(row, className){
|
||||
this.$gutterLayer.removeGutterDecoration(row, className);
|
||||
};
|
||||
|
||||
/**
|
||||
* VirtualRenderer.updateBreakpoints()
|
||||
*
|
||||
*
|
||||
* Redraw breakpoints.
|
||||
**/
|
||||
this.updateBreakpoints = function(rows) {
|
||||
|
|
@ -909,10 +901,11 @@ var VirtualRenderer = function(container, theme) {
|
|||
};
|
||||
|
||||
/**
|
||||
* VirtualRenderer.setAnnotations(annotations)
|
||||
* - annotations (Array): An array containing annotations
|
||||
*
|
||||
*
|
||||
* Sets annotations for the gutter.
|
||||
* @param {Array} annotations An array containing annotations
|
||||
*
|
||||
*
|
||||
**/
|
||||
this.setAnnotations = function(annotations) {
|
||||
this.$gutterLayer.setAnnotations(annotations);
|
||||
|
|
@ -920,8 +913,7 @@ var VirtualRenderer = function(container, theme) {
|
|||
};
|
||||
|
||||
/**
|
||||
* VirtualRenderer.updateCursor()
|
||||
*
|
||||
*
|
||||
* Updates the cursor icon.
|
||||
**/
|
||||
this.updateCursor = function() {
|
||||
|
|
@ -929,8 +921,7 @@ var VirtualRenderer = function(container, theme) {
|
|||
};
|
||||
|
||||
/**
|
||||
* VirtualRenderer.hideCursor()
|
||||
*
|
||||
*
|
||||
* Hides the cursor icon.
|
||||
**/
|
||||
this.hideCursor = function() {
|
||||
|
|
@ -938,8 +929,7 @@ var VirtualRenderer = function(container, theme) {
|
|||
};
|
||||
|
||||
/**
|
||||
* VirtualRenderer.showCursor()
|
||||
*
|
||||
*
|
||||
* Shows the cursor icon.
|
||||
**/
|
||||
this.showCursor = function() {
|
||||
|
|
@ -953,8 +943,7 @@ var VirtualRenderer = function(container, theme) {
|
|||
};
|
||||
|
||||
/**
|
||||
* VirtualRenderer.scrollCursorIntoView(cursor, offset)
|
||||
*
|
||||
*
|
||||
* Scrolls the cursor into the first visibile area of the editor
|
||||
**/
|
||||
this.scrollCursorIntoView = function(cursor, offset) {
|
||||
|
|
@ -988,47 +977,48 @@ var VirtualRenderer = function(container, theme) {
|
|||
}
|
||||
};
|
||||
|
||||
/** related to: EditSession.getScrollTop
|
||||
* VirtualRenderer.getScrollTop() -> Number
|
||||
*
|
||||
/**
|
||||
* {:EditSession.getScrollTop}
|
||||
* @related EditSession.getScrollTop
|
||||
* @returns {Number}
|
||||
**/
|
||||
this.getScrollTop = function() {
|
||||
return this.session.getScrollTop();
|
||||
};
|
||||
|
||||
/** related to: EditSession.getScrollLeft
|
||||
* VirtualRenderer.getScrollLeft() -> Number
|
||||
*
|
||||
/**
|
||||
* {:EditSession.getScrollLeft}
|
||||
* @related EditSession.getScrollLeft
|
||||
* @returns {Number}
|
||||
**/
|
||||
this.getScrollLeft = function() {
|
||||
return this.session.getScrollLeft();
|
||||
};
|
||||
|
||||
/**
|
||||
* VirtualRenderer.getScrollTopRow() -> Number
|
||||
*
|
||||
*
|
||||
* Returns the first visible row, regardless of whether it's fully visible or not.
|
||||
* @returns {Number}
|
||||
**/
|
||||
this.getScrollTopRow = function() {
|
||||
return this.scrollTop / this.lineHeight;
|
||||
};
|
||||
|
||||
/**
|
||||
* VirtualRenderer.getScrollBottomRow() -> Number
|
||||
*
|
||||
*
|
||||
* Returns the last visible row, regardless of whether it's fully visible or not.
|
||||
* @returns {Number}
|
||||
**/
|
||||
this.getScrollBottomRow = function() {
|
||||
return Math.max(0, Math.floor((this.scrollTop + this.$size.scrollerHeight) / this.lineHeight) - 1);
|
||||
};
|
||||
|
||||
/** related to: EditSession.setScrollTop
|
||||
* VirtualRenderer.scrollToRow(row)
|
||||
* - row (Number): A row id
|
||||
/**
|
||||
* Gracefully scrolls from the top of the editor to the row indicated.
|
||||
* @param {Number} row A row id
|
||||
*
|
||||
* Gracefully scrolls the top of the editor to the row indicated.
|
||||
*
|
||||
* @related EditSession.setScrollTop
|
||||
**/
|
||||
this.scrollToRow = function(row) {
|
||||
this.session.setScrollTop(row * this.lineHeight);
|
||||
|
|
@ -1063,13 +1053,13 @@ var VirtualRenderer = function(container, theme) {
|
|||
};
|
||||
|
||||
/**
|
||||
* VirtualRenderer.scrollToLine(line, center, animate, callback)
|
||||
* - line (Number): A line number
|
||||
* - center (Boolean): If `true`, centers the editor the to indicated line
|
||||
* - animate (Boolean): If `true` animates scrolling
|
||||
* - callback (Function): Function to be called after the animation has finished
|
||||
*
|
||||
* Gracefully scrolls the editor to the row indicated.
|
||||
* @param {Number} line A line number
|
||||
* @param {Boolean} center If `true`, centers the editor the to indicated line
|
||||
* @param {Boolean} animate If `true` animates scrolling
|
||||
* @param {Function} callback Function to be called after the animation has finished
|
||||
*
|
||||
*
|
||||
**/
|
||||
this.scrollToLine = function(line, center, animate, callback) {
|
||||
var pos = this.$cursorLayer.getPixelPosition({row: line, column: 0});
|
||||
|
|
@ -1113,11 +1103,11 @@ var VirtualRenderer = function(container, theme) {
|
|||
};
|
||||
|
||||
/**
|
||||
* VirtualRenderer.scrollToY(scrollTop) -> Number
|
||||
* - scrollTop (Number): The position to scroll to
|
||||
*
|
||||
* Scrolls the editor to the y pixel indicated.
|
||||
* @param {Number} scrollTop The position to scroll to
|
||||
*
|
||||
*
|
||||
* @returns {Number}
|
||||
**/
|
||||
this.scrollToY = function(scrollTop) {
|
||||
// after calling scrollBar.setScrollTop
|
||||
|
|
@ -1129,11 +1119,11 @@ var VirtualRenderer = function(container, theme) {
|
|||
};
|
||||
|
||||
/**
|
||||
* VirtualRenderer.scrollToX(scrollLeft) -> Number
|
||||
* - scrollLeft (Number): The position to scroll to
|
||||
*
|
||||
* Scrolls the editor to the x pixel indicated.
|
||||
* Scrolls the editor across the x-axis to the pixel indicated.
|
||||
* @param {Number} scrollLeft The position to scroll to
|
||||
*
|
||||
*
|
||||
* @returns {Number}
|
||||
**/
|
||||
this.scrollToX = function(scrollLeft) {
|
||||
if (scrollLeft < 0)
|
||||
|
|
@ -1145,11 +1135,11 @@ var VirtualRenderer = function(container, theme) {
|
|||
};
|
||||
|
||||
/**
|
||||
* VirtualRenderer.scrollBy(deltaX, deltaY)
|
||||
* - deltaX (Number): The x value to scroll by
|
||||
* - deltaY (Number): The y value to scroll by
|
||||
*
|
||||
* Scrolls the editor across both x- and y-axes.
|
||||
* @param {Number} deltaX The x value to scroll by
|
||||
* @param {Number} deltaY The y value to scroll by
|
||||
*
|
||||
*
|
||||
**/
|
||||
this.scrollBy = function(deltaX, deltaY) {
|
||||
deltaY && this.session.setScrollTop(this.session.getScrollTop() + deltaY);
|
||||
|
|
@ -1157,11 +1147,12 @@ var VirtualRenderer = function(container, theme) {
|
|||
};
|
||||
|
||||
/**
|
||||
* VirtualRenderer.isScrollableBy(deltaX, deltaY) -> Boolean
|
||||
* - deltaX (Number): The x value to scroll by
|
||||
* - deltaY (Number): The y value to scroll by
|
||||
*
|
||||
* Returns `true` if you can still scroll by either parameter; in other words, you haven't reached the end of the file or line.
|
||||
* @param {Number} deltaX The x value to scroll by
|
||||
* @param {Number} deltaY The y value to scroll by
|
||||
*
|
||||
*
|
||||
* @returns {Boolean}
|
||||
**/
|
||||
this.isScrollableBy = function(deltaX, deltaY) {
|
||||
if (deltaY < 0 && this.session.getScrollTop() > 0)
|
||||
|
|
@ -1195,13 +1186,13 @@ var VirtualRenderer = function(container, theme) {
|
|||
};
|
||||
|
||||
/**
|
||||
* VirtualRenderer.textToScreenCoordinates(row, column) -> Object
|
||||
* - row (Number): The document row position
|
||||
* - column (Number): The document column position
|
||||
*
|
||||
* Returns an object containing the `pageX` and `pageY` coordinates of the document position.
|
||||
* @param {Number} row The document row position
|
||||
* @param {Number} column The document column position
|
||||
*
|
||||
*
|
||||
*
|
||||
* @returns {Object}
|
||||
**/
|
||||
this.textToScreenCoordinates = function(row, column) {
|
||||
var canvasPos = this.scroller.getBoundingClientRect();
|
||||
|
|
@ -1217,8 +1208,7 @@ var VirtualRenderer = function(container, theme) {
|
|||
};
|
||||
|
||||
/**
|
||||
* VirtualRenderer.visualizeFocus()
|
||||
*
|
||||
*
|
||||
* Focuses the current container.
|
||||
**/
|
||||
this.visualizeFocus = function() {
|
||||
|
|
@ -1226,18 +1216,17 @@ var VirtualRenderer = function(container, theme) {
|
|||
};
|
||||
|
||||
/**
|
||||
* VirtualRenderer.visualizeBlur()
|
||||
*
|
||||
*
|
||||
* Blurs the current container.
|
||||
**/
|
||||
this.visualizeBlur = function() {
|
||||
dom.removeCssClass(this.container, "ace_focus");
|
||||
};
|
||||
|
||||
/** internal, hide
|
||||
* VirtualRenderer.showComposition(position)
|
||||
* - position (Number):
|
||||
/**
|
||||
* @param {Number} position
|
||||
*
|
||||
* @private
|
||||
**/
|
||||
this.showComposition = function(position) {
|
||||
if (!this.$composition)
|
||||
|
|
@ -1253,8 +1242,7 @@ var VirtualRenderer = function(container, theme) {
|
|||
};
|
||||
|
||||
/**
|
||||
* VirtualRenderer.setCompositionText(text)
|
||||
* - text (String): A string of text to use
|
||||
* @param {String} text A string of text to use
|
||||
*
|
||||
* Sets the inner text of the current composition to `text`.
|
||||
**/
|
||||
|
|
@ -1263,8 +1251,7 @@ var VirtualRenderer = function(container, theme) {
|
|||
};
|
||||
|
||||
/**
|
||||
* VirtualRenderer.hideComposition()
|
||||
*
|
||||
*
|
||||
* Hides the current composition.
|
||||
**/
|
||||
this.hideComposition = function() {
|
||||
|
|
@ -1285,10 +1272,10 @@ var VirtualRenderer = function(container, theme) {
|
|||
};
|
||||
|
||||
/**
|
||||
* VirtualRenderer.setTheme(theme)
|
||||
* - theme (String): The path to a theme
|
||||
*
|
||||
* [Sets a new theme for the editor. `theme` should exist, and be a directory path, like `ace/theme/textmate`.]{: #VirtualRenderer.setTheme}
|
||||
* @param {String} theme The path to a theme
|
||||
*
|
||||
*
|
||||
**/
|
||||
this.setTheme = function(theme) {
|
||||
var _self = this;
|
||||
|
|
@ -1346,9 +1333,8 @@ var VirtualRenderer = function(container, theme) {
|
|||
};
|
||||
|
||||
/**
|
||||
* VirtualRenderer.getTheme() -> String
|
||||
*
|
||||
* [Returns the path of the current theme.]{: #VirtualRenderer.getTheme}
|
||||
* @returns {String}
|
||||
**/
|
||||
this.getTheme = function() {
|
||||
return this.$themeValue;
|
||||
|
|
@ -1359,28 +1345,27 @@ var VirtualRenderer = function(container, theme) {
|
|||
// a certain mode that editor is in.
|
||||
|
||||
/**
|
||||
* VirtualRenderer.setStyle(style)
|
||||
* - style (String): A class name
|
||||
*
|
||||
* [Adds a new class, `style`, to the editor.]{: #VirtualRenderer.setStyle}
|
||||
* @param {String} style A class name
|
||||
*
|
||||
*
|
||||
**/
|
||||
this.setStyle = function setStyle(style, include) {
|
||||
dom.setCssClass(this.container, style, include != false);
|
||||
};
|
||||
|
||||
/**
|
||||
* VirtualRenderer.unsetStyle(style)
|
||||
* - style (String): A class name
|
||||
*
|
||||
* [Removes the class `style` from the editor.]{: #VirtualRenderer.unsetStyle}
|
||||
* @param {String} style A class name
|
||||
*
|
||||
*
|
||||
**/
|
||||
this.unsetStyle = function unsetStyle(style) {
|
||||
dom.removeCssClass(this.container, style);
|
||||
};
|
||||
|
||||
/**
|
||||
* VirtualRenderer.destroy()
|
||||
*
|
||||
*
|
||||
* Destroys the text and cursor layers for this renderer.
|
||||
**/
|
||||
this.destroy = function() {
|
||||
|
|
|
|||
|
|
@ -22,7 +22,7 @@
|
|||
padding: 0 20px;
|
||||
}
|
||||
</style>
|
||||
|
||||
<link href="../doc/resources/ace/skeleton/images/favicon.ico" rel="icon" type="image/x-icon">
|
||||
</head>
|
||||
<body>
|
||||
|
||||
|
|
|
|||
|
|
@ -7,6 +7,7 @@
|
|||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
<title>Ace Profile util</title>
|
||||
<link rel="stylesheet" href="demo/kitchen-sink/styles.css" type="text/css" media="screen" charset="utf-8">
|
||||
<link href="../doc/resources/ace/skeleton/images/favicon.ico" rel="icon" type="image/x-icon">
|
||||
</head>
|
||||
<body>
|
||||
<a href="http://ajaxorg.github.com/ace/" >
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue