forked from ajaxorg/ace
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathbackground_tokenizer.html
More file actions
320 lines (300 loc) · 21.3 KB
/
background_tokenizer.html
File metadata and controls
320 lines (300 loc) · 21.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
<div id="documentation" class="span9">
<div class="classContent">
<div class="membersBackground"></div>
<div class=" members pos0">
<div class=" membersContent pos0">
<h1 class="memberHeader"><span class="name">BackgroundTokenizer</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="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Object" 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="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Object" 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="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="argument methodClicker" title="Number" data-id="Number">Number</a> firstRow, <a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" 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="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" 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="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" 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="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" 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="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" 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="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" 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="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" 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="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" 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="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" 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="emptyArgumentList">()</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>