<divid="documentation"class="span8"><divclass="classContent"><divclass="membersBackground"></div><divclass=" members pos0"><divclass=" membersContent pos0"><h1class="memberHeader"><spanclass="name">BackgroundTokenizer<spanclass="editInC9"><ahref='http://c9.io/open/git/?url=git%3A%2F%2Fgithub.com%2Fajaxorg%2Face.git'title='Edit in Cloud9 IDE'>[edit]</a></span></span></h1><uldata-tabs="tabs"class="nav tabs pos0"><lidata-dropdown="dropdown"class="dropdown"><ahref="#"data-toggle="dropdown"class="dropdown-toggle"><span>Events (1)</span><bclass="caret"></b></a><ulclass="dropdown-menu"><liid="dropdown_BackgroundTokenizer.event.update"data-id="BackgroundTokenizer.event.update"class="memberLink"><ahref="#BackgroundTokenizer.event.update"class=""title="BackgroundTokenizer.event.update (event)"data-id="BackgroundTokenizer.event.update">update</a></li></ul></li><lidata-dropdown="dropdown"class="dropdown"><ahref="#"data-toggle="dropdown"class="dropdown-toggle"><span>Constructors (1)</span><bclass="caret"></b></a><ulclass="dropdown-menu"><liid="dropdown_BackgroundTokenizer.new"data-id="BackgroundTokenizer.new"class="memberLink"><ahref="#BackgroundTokenizer.new"class=""title="BackgroundTokenizer.new (constructor)"data-id="BackgroundTokenizer.new">new</a></li></ul></li><lidata-dropdown="dropdown"class="dropdown"><ahref="#"data-toggle="dropdown"class="dropdown-toggle"><span>Functions (7)</span><bclass="caret"></b></a><ulclass="dropdown-menu"><liid="dropdown_BackgroundTokenizer.fireUpdateEvent"data-id="BackgroundTokenizer.fireUpdateEvent"class="memberLink"><ahref="#BackgroundTokenizer.fireUpdateEvent"class=""title="BackgroundTokenizer.fireUpdateEvent (class method)"data-id="BackgroundTokenizer.fireUpdateEvent">fireUpdateEvent</a></li><liid="dropdown_BackgroundTokenizer.getState"data-id="BackgroundTokenizer.getState"class="memberLink"><ahref="#BackgroundTokenizer.getState"class=""title="BackgroundTokenizer.getState (class method)"data-id="BackgroundTokenizer.getState">getState</a></li><liid="dropdown_BackgroundTokenizer.getTokens"data-id="BackgroundTokenizer.getTokens"class="memberLink"><ahref="#BackgroundTokenizer.getTokens"class=""title="BackgroundTokenizer.getTokens (class method)"data-id="BackgroundTokenizer.getTokens">getTokens</a></li><liid="dropdown_BackgroundTokenizer.setDocument"data-id="BackgroundTokenizer.setDocument"class="memberLink"><ahref="#BackgroundTokenizer.setDocument"class=""title="BackgroundTokenizer.setDocument (class method)"data-id="BackgroundTokenizer.setDocument">setDocument</a></li><liid="dropdown_BackgroundTokenizer.setTokenizer"data-id="BackgroundTokenizer.setTokenizer"class="memberLink"><ahref="#BackgroundTokenizer.setTokenizer"class=""title="BackgroundTokenizer.setTokenizer (class method)"data-id="BackgroundTokenizer.setTokenizer">setTokenizer</a></li><liid="dropdown_BackgroundTokenizer.start"data-id="BackgroundTokenizer.start"class="memberLink"><ahref="#BackgroundTokenizer.start"class=""title="BackgroundTokenizer.start (class method)"data-id="BackgroundTokenizer.start">start</a></li><liid="dropdown_BackgroundTokenizer.stop"data-id="BackgroundTokenizer.stop"class="memberLink"><ahref="#BackgroundTokenizer.stop"class=""title="BackgroundTokenizer.stop (class method)"data-id="BackgroundTokenizer.stop">stop</a></li></ul></li><lidata-dropdown="dropdown"class="dropdown"><ulclass="dropdown-menu"></ul></li><lidata-dropdown="dropdown"class="dropdown"><ulclass="dropdown-menu"></ul></li><lidata-dropdown="dropdown"class="dropdown"><ulclass="dropdown-menu"></ul></li><lidata-dropdown="dropdown"class="dropdown"><ulclass="dropdown-menu"></ul></li></ul></div></div><articleid="BackgroundTokenizer"data-title="BackgroundTokenizer (class)"class="article"><divclass="section description"><divclass="memberContent"><p>Tokenizes the current <ahref="#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
</div></div></article><h3class="sectionHeader">Constructors</h3><articleid="BackgroundTokenizer.new"data-title="BackgroundTokenizer.new (constructor)"class="article"><divclass="section method"><divclass="memberContent"><divclass="title"><iid="BackgroundTokenizer.new"class="methodToggle methodClicker inactive icon-caret-right"></i><ulclass="signatures"><liclass="signature"><ul><liclass="signature-call"><spanclass="constructorIdentifier">new </span><spanid="BackgroundTokenizer.new"class="member-name methodClicker">BackgroundTokenizer</span>(<spanclass="sigArgList"><ahref="#nav=api&api=tokenizer"class="argument methodClicker"title="Tokenizer (class)"data-id="Tokenizer">Tokenizer</a> tokenizer, <ahref="#nav=api&api=editor"class="argument methodClicker"title="Editor (class)"data-id="Editor">Editor</a> editor</span>)</li></ul><ulclass="metaInfo"></ul></li></ul></div><divclass="sideToggler"><divid="ellipsis_BackgroundTokenizer.new"class="ellipsis_description"><p>Creates a new <code>BackgroundTokenizer</code> object.</p>
<h4>Arguments</h4><tableclass="argumentTable argument-list table table-striped table-bordered"><trclass="argumentRow "><tdclass="argName ">tokenizer</td><tdclass="argType""><ahref="#nav=api&api=tokenizer"class=""title="Tokenizer (class)"data-id="Tokenizer">Tokenizer</a></td><tdclass="argDescription "><p>Required. The tokenizer to use</p>
</td></tr><trclass="argumentRow "><tdclass="argName ">editor</td><tdclass="argType""><ahref="#nav=api&api=editor"class=""title="Editor (class)"data-id="Editor">Editor</a></td><tdclass="argDescription "><p>Required. The editor to associate with</p>
</td></tr></table></div></div></div></div></article><h3class="sectionHeader">Events</h3><articleid="BackgroundTokenizer.event.update"data-title="BackgroundTokenizer.event.update (event)"class="article"><divclass="section method"><divclass="memberContent"><divclass="title"><iid="BackgroundTokenizer.event.update"class="methodToggle methodClicker inactive icon-caret-right"></i><ulclass="signatures"><liclass="signature"><ul><liclass="signature-call"><spanclass="eventObjName">BackgroundTokenizer</span><spanclass="eventListenerStart">.on("</span><spanid="BackgroundTokenizer.event.update"class="member-name eventMember methodClicker">update</span><spanclass="eventListenerClose">", </span><spanclass="eventFunctionOpen">function(</span><ahref="http://www.nodemanual.org/latest/js_doc/Object.html"class="argument methodClicker"title="Object"data-id="Object">Object</a> e<spanclass="eventFunctionClose">))</span></li></ul><ulclass="metaInfo"></ul></li></ul></div><divclass="sideToggler"><divid="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><divclass="description"><p>Fires whenever the background tokeniziers between a range of rows are going to be updated.</p>
<h4>Arguments</h4><tableclass="argumentTable argument-list table table-striped table-bordered"><trclass="argumentRow "><tdclass="argName ">e</td><tdclass="argType""><ahref="http://www.nodemanual.org/latest/js_doc/Object.html"class=""title="Object"data-id="Object">Object</a></td><tdclass="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><h3class="sectionHeader">Methods</h3><articleid="BackgroundTokenizer.fireUpdateEvent"data-title="BackgroundTokenizer.fireUpdateEvent (class method)"class="article"><divclass="section method"><divclass="memberContent"><divclass="title"><iid="BackgroundTokenizer.fireUpdateEvent"class="methodToggle methodClicker inactive icon-caret-right"></i><ulclass="signatures"><liclass="signature"><ul><liclass="signature-call"><spanid="BackgroundTokenizer.fireUpdateEvent"class="member-name methodClicker"><spanclass="sigClassName">BackgroundTokenizer.</span><spanclass="sigMemberName">fireUpdateEvent</span></span>(<spanclass="sigArgList"><ahref="http://www.nodemanual.org/latest/js_doc/Number.html"class="argument methodClicker"title="Number"data-id="Number">Number</a> firstRow, <ahref="http://www.nodemanual.org/latest/js_doc/Number.html"class="argument methodClicker"title="Number"data-id="Number">Number</a> lastRow</span>)</li></ul><ulclass="metaInfo"></ul></li></ul></div><divclass="sideToggler"><divid="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><divclass="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>
</td></tr><trclass="argumentRow "><tdclass="argName ">lastRow</td><tdclass="argType""><ahref="http://www.nodemanual.org/latest/js_doc/Number.html"class=""title="Number"data-id="Number">Number</a></td><tdclass="argDescription "><p>Required. The final row region</p>
</td></tr></table></div></div></div></div></article><articleid="BackgroundTokenizer.getState"data-title="BackgroundTokenizer.getState (class method)"class="article"><divclass="section method"><divclass="memberContent"><divclass="title"><iid="BackgroundTokenizer.getState"class="methodToggle methodClicker inactive icon-caret-right"></i><ulclass="signatures"><liclass="signature"><ul><liclass="signature-call"><spanid="BackgroundTokenizer.getState"class="member-name methodClicker"><spanclass="sigClassName">BackgroundTokenizer.</span><spanclass="sigMemberName">getState</span></span>(<spanclass="sigArgList"><ahref="http://www.nodemanual.org/latest/js_doc/Number.html"class="argument methodClicker"title="Number"data-id="Number">Number</a> row</span>)<liclass="signature-returns"><ulclass="argument-types"><liclass="argument-type"><ahref="http://www.nodemanual.org/latest/js_doc/String.html"class="returnType "title="String"data-id="String">String</a></li></ul></li></li></ul><ulclass="metaInfo"></ul></li></ul></div><divclass="sideToggler"><divid="ellipsis_BackgroundTokenizer.getState"class="ellipsis_description"><p>Returns the state of tokenization at the end of a row.</p>
</div><divclass="description"><p>Returns the state of tokenization at the end of a row.</p>
<h4>Arguments</h4><tableclass="argumentTable argument-list table table-striped table-bordered"><trclass="argumentRow "><tdclass="argName ">row</td><tdclass="argType""><ahref="http://www.nodemanual.org/latest/js_doc/Number.html"class=""title="Number"data-id="Number">Number</a></td><tdclass="argDescription "><p>Required. The row to get state at</p>
</td></tr></table></div></div></div></div></article><articleid="BackgroundTokenizer.getTokens"data-title="BackgroundTokenizer.getTokens (class method)"class="article"><divclass="section method"><divclass="memberContent"><divclass="title"><iid="BackgroundTokenizer.getTokens"class="methodToggle methodClicker inactive icon-caret-right"></i><ulclass="signatures"><liclass="signature"><ul><liclass="signature-call"><spanid="BackgroundTokenizer.getTokens"class="member-name methodClicker"><spanclass="sigClassName">BackgroundTokenizer.</span><spanclass="sigMemberName">getTokens</span></span>(<spanclass="sigArgList"><ahref="http://www.nodemanual.org/latest/js_doc/Number.html"class="argument methodClicker"title="Number"data-id="Number">Number</a> row</span>)<liclass="signature-returns"><ulclass="argument-types"><liclass="argument-type">[ <ahref="http://www.nodemanual.org/latest/js_doc/Object.html"class="returnType "title="Object"data-id="Object">Object</a> ]</li></ul></li></li></ul><ulclass="metaInfo"></ul></li></ul></div><divclass="sideToggler"><divid="ellipsis_BackgroundTokenizer.getTokens"class="ellipsis_description"><p>Gives list of tokens of the row. (tokens are cached)</p>
</div><divclass="description"><p>Gives list of tokens of the row. (tokens are cached)</p>
<h4>Arguments</h4><tableclass="argumentTable argument-list table table-striped table-bordered"><trclass="argumentRow "><tdclass="argName ">row</td><tdclass="argType""><ahref="http://www.nodemanual.org/latest/js_doc/Number.html"class=""title="Number"data-id="Number">Number</a></td><tdclass="argDescription "><p>Required. The row to get tokens at</p>
</td></tr></table></div></div></div></div></article><articleid="BackgroundTokenizer.setDocument"data-title="BackgroundTokenizer.setDocument (class method)"class="article"><divclass="section method"><divclass="memberContent"><divclass="title"><iid="BackgroundTokenizer.setDocument"class="methodToggle methodClicker inactive icon-caret-right"></i><ulclass="signatures"><liclass="signature"><ul><liclass="signature-call"><spanid="BackgroundTokenizer.setDocument"class="member-name methodClicker"><spanclass="sigClassName">BackgroundTokenizer.</span><spanclass="sigMemberName">setDocument</span></span>(<spanclass="sigArgList"><ahref="#nav=api&api=document"class="argument methodClicker"title="Document (class)"data-id="Document">Document</a> doc</span>)</li></ul><ulclass="metaInfo"></ul></li></ul></div><divclass="sideToggler"><divid="ellipsis_BackgroundTokenizer.setDocument"class="ellipsis_description"><p>Sets a new document to associate with this object.</p>
<h4>Arguments</h4><tableclass="argumentTable argument-list table table-striped table-bordered"><trclass="argumentRow "><tdclass="argName ">doc</td><tdclass="argType""><ahref="#nav=api&api=document"class=""title="Document (class)"data-id="Document">Document</a></td><tdclass="argDescription "><p>Required. The new document to associate with</p>
</td></tr></table></div></div></div></div></article><articleid="BackgroundTokenizer.setTokenizer"data-title="BackgroundTokenizer.setTokenizer (class method)"class="article"><divclass="section method"><divclass="memberContent"><divclass="title"><iid="BackgroundTokenizer.setTokenizer"class="methodToggle methodClicker inactive icon-caret-right"></i><ulclass="signatures"><liclass="signature"><ul><liclass="signature-call"><spanid="BackgroundTokenizer.setTokenizer"class="member-name methodClicker"><spanclass="sigClassName">BackgroundTokenizer.</span><spanclass="sigMemberName">setTokenizer</span></span>(<spanclass="sigArgList"><ahref="#nav=api&api=tokenizer"class="argument methodClicker"title="Tokenizer (class)"data-id="Tokenizer">Tokenizer</a> tokenizer</span>)</li></ul><ulclass="metaInfo"></ul></li></ul></div><divclass="sideToggler"><divid="ellipsis_BackgroundTokenizer.setTokenizer"class="ellipsis_description"><p>Sets a new tokenizer for this object.</p>
<h4>Arguments</h4><tableclass="argumentTable argument-list table table-striped table-bordered"><trclass="argumentRow "><tdclass="argName ">tokenizer</td><tdclass="argType""><ahref="#nav=api&api=tokenizer"class=""title="Tokenizer (class)"data-id="Tokenizer">Tokenizer</a></td><tdclass="argDescription "><p>Required. The new tokenizer to use</p>