mirror of
https://github.com/AdaCore/ace.git
synced 2026-02-12 13:03:02 -08:00
40 lines
22 KiB
HTML
40 lines
22 KiB
HTML
<!DOCTYPE html><!--[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]--><html xmlns="http://www.w3.org/1999/xhtml"><head><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"><title>BackgroundTokenizer - Ace API</title><meta name="generator" content="c9-doc-build"><meta name="description" content="Ace API documentation for the online code editor."><meta name="author" content="Garen J. Torikian"><meta name="viewport" content="width=device-width,initial-scale=1"><link rel="stylesheet" href="./resources/csses/bootstrap.min.css"><link rel="stylesheet" href="./resources/csses/prettify.css"><link rel="stylesheet" href="./resources/csses/ace_api.css"><link href="./resources/images/favicon.ico" rel="icon" type="image/x-icon"><script src="./resources/javascripts/jquery.js"></script><script src="./resources/javascripts/clicker.js"></script><script src="./resources/javascripts/jquery.collapse.js"></script><script src="./resources/javascripts/jquery.cookie.js"></script><script src="./resources/javascripts/bootstrap-dropdown.js"></script><script src="./resources/javascripts/jquery-scrollspy.js"></script><script script src="./resources/javascripts/prettify-extension.js"></script></head><body><div class="navbar navbar-fixed-top"><div class="navbar-inner"><div id="topSection" class="container"><span class="brand"></span><ul class="nav topLinks"><li id="ace_site"><a href="../index.html">Ace</a></li><li id="ace_api" class="active"><a href="index.html">Ace API Reference</a></li></ul><form id="searchbox" action="" class="navbar-search pull-right"> <input name="query" type="text" placeholder="Search the API" title="Search across all the documentation" class="search-query span3"></form></div></div></div><div id="nonFooter"><div id="wrapper"><div class="content"><div class="row centerpiece"><div id="sidebarContainer" class="span3"><div id="sidebar"><div id="well"><h3>Ace Reference</h3><div class="swirl_divider"> </div><ul class="menu"><li><div class="menu-item"><a href="ace.html" class="menuLink namespace">Ace</a></div></li><li><div class="menu-item"><a href="anchor.html" class="menuLink namespace">Anchor</a></div></li><li><div class="menu-item"><a href="background_tokenizer.html" class="menuLink namespace">BackgroundTokenizer </a></div></li><li><div class="menu-item"><a href="document.html" class="menuLink namespace">Document </a></div></li><li><div class="menu-item"><a href="edit_session.html" class="menuLink namespace">EditSession </a></div></li><li><div class="menu-item"><a href="editor.html" class="menuLink namespace">Editor</a></div></li><li><div class="menu-item"><a href="range.html" class="menuLink namespace">Range</a></div></li><li><div class="menu-item"><a href="scrollbar.html" class="menuLink namespace">Scrollbar</a></div></li><li><div class="menu-item"><a href="search.html" class="menuLink namespace">Search </a></div></li><li><div class="menu-item"><a href="selection.html" class="menuLink namespace">Selection </a></div></li><li><div class="menu-item"><a href="token_iterator.html" class="menuLink namespace">TokenIterator</a></div></li><li><div class="menu-item"><a href="tokenizer.html" class="menuLink namespace">Tokenizer</a></div></li><li><div class="menu-item"><a href="undomanager.html" class="menuLink namespace">UndoManager</a></div></li><li><div class="menu-item"><a href="virtual_renderer.html" class="menuLink namespace">VirtualRenderer</a></div></li></ul></div></div></div><div id="mainContent" class="span9"><div id="documentation"><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 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 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 data-id="BackgroundTokenizer.fireUpdateEvent" class="memberLink"><a href="#BackgroundTokenizer.fireUpdateEvent" class="" title="BackgroundTokenizer.fireUpdateEvent (class method)" data-id="BackgroundTokenizer.fireUpdateEvent">fireUpdateEvent</a></li><li data-id="BackgroundTokenizer.getState" class="memberLink"><a href="#BackgroundTokenizer.getState" class="" title="BackgroundTokenizer.getState (class method)" data-id="BackgroundTokenizer.getState">getState</a></li><li data-id="BackgroundTokenizer.getTokens" class="memberLink"><a href="#BackgroundTokenizer.getTokens" class="" title="BackgroundTokenizer.getTokens (class method)" data-id="BackgroundTokenizer.getTokens">getTokens</a></li><li data-id="BackgroundTokenizer.setDocument" class="memberLink"><a href="#BackgroundTokenizer.setDocument" class="" title="BackgroundTokenizer.setDocument (class method)" data-id="BackgroundTokenizer.setDocument">setDocument</a></li><li data-id="BackgroundTokenizer.setTokenizer" class="memberLink"><a href="#BackgroundTokenizer.setTokenizer" class="" title="BackgroundTokenizer.setTokenizer (class method)" data-id="BackgroundTokenizer.setTokenizer">setTokenizer</a></li><li data-id="BackgroundTokenizer.start" class="memberLink"><a href="#BackgroundTokenizer.start" class="" title="BackgroundTokenizer.start (class method)" data-id="BackgroundTokenizer.start">start</a></li><li 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#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"><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#Tokenizer" class="argument methodClicker" title="Tokenizer (class)" data-id="Tokenizer">Tokenizer</a> tokenizer, <a href="editor.html#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><h3 id="BackgroundTokenizer.new" class="methodToggle methodClicker inactive"> </h3><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#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="editor.html#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"><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><h3 id="BackgroundTokenizer.event.update" class="methodToggle methodClicker inactive"> </h3><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"><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><h3 id="BackgroundTokenizer.fireUpdateEvent" class="methodToggle methodClicker inactive"> </h3><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"><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><h3 id="BackgroundTokenizer.getState" class="methodToggle methodClicker inactive"> </h3><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"><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><h3 id="BackgroundTokenizer.getTokens" class="methodToggle methodClicker inactive"> </h3><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"><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#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><h3 id="BackgroundTokenizer.setDocument" class="methodToggle methodClicker inactive"> </h3><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#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"><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#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><h3 id="BackgroundTokenizer.setTokenizer" class="methodToggle methodClicker inactive"> </h3><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#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"><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><h3 id="BackgroundTokenizer.start" class="methodToggle methodClicker inactive"> </h3><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"><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><h3 id="BackgroundTokenizer.stop" class="methodToggle methodClicker inactive"> </h3><div class="description"><p>Stops tokenizing.</p>
|
|
</div></div></div></div></article></div></div><div id="disqus_thread"></div></div></div></div></div><div class="push"></div></div><div id="footer"><div class="footerInner"><div class="footer-text pull-right"> <p><a href="http://www.c9.io">About Cloud9</a> | Ace & Cloud9 IDE are © <a href="http://ajax.org">Ajax.org</a> 2012</p></div></div></div><!-- scripts concatenated and minified via ant build script--><script defer src="./resources/javascripts/plugins.js"></script>
|
|
<script defer src="./resources/javascripts/prettify.js"></script>
|
|
<script defer src="./resources/javascripts/prettify-extension.js"></script>
|
|
<script defer src="./resources/javascripts/ux.js"></script>
|
|
<script defer src="./resources/javascripts/disqus-ext.js"></script>
|
|
<script defer src="./resources/javascripts/ga.js"></script><!-- end scripts--><!--[if lt IE 7]><script src="//ajax.googleapis.com/ajax/libs/chrome-frame/1.0.3/CFInstall.min.js"></script><script>window.attachEvent('onload',function(){CFInstall.check({mode:'overlay'})})
|
|
|
|
</script><![endif]--></body></html> |