/usr/share/doc/libautocomplete-java/api/org/fife/ui/autocomplete/DefaultCompletionProvider.html is in libautocomplete-java-doc 2.5.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_25) on Mon Oct 21 18:54:33 UTC 2013 -->
<title>DefaultCompletionProvider</title>
<meta name="date" content="2013-10-21">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="DefaultCompletionProvider";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../org/fife/ui/autocomplete/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/fife/ui/autocomplete/CompletionXMLParser.html" title="class in org.fife.ui.autocomplete"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/fife/ui/autocomplete/DescWindowCallback.html" title="interface in org.fife.ui.autocomplete"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/fife/ui/autocomplete/DefaultCompletionProvider.html" target="_top">Frames</a></li>
<li><a href="DefaultCompletionProvider.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li><a href="#nested_classes_inherited_from_class_org.fife.ui.autocomplete.AbstractCompletionProvider">Nested</a> | </li>
<li><a href="#field_summary">Field</a> | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field_detail">Field</a> | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.fife.ui.autocomplete</div>
<h2 title="Class DefaultCompletionProvider" class="title">Class DefaultCompletionProvider</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../org/fife/ui/autocomplete/CompletionProviderBase.html" title="class in org.fife.ui.autocomplete">org.fife.ui.autocomplete.CompletionProviderBase</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../org/fife/ui/autocomplete/AbstractCompletionProvider.html" title="class in org.fife.ui.autocomplete">org.fife.ui.autocomplete.AbstractCompletionProvider</a></li>
<li>
<ul class="inheritance">
<li>org.fife.ui.autocomplete.DefaultCompletionProvider</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../org/fife/ui/autocomplete/CompletionProvider.html" title="interface in org.fife.ui.autocomplete">CompletionProvider</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">DefaultCompletionProvider</span>
extends <a href="../../../../org/fife/ui/autocomplete/AbstractCompletionProvider.html" title="class in org.fife.ui.autocomplete">AbstractCompletionProvider</a></pre>
<div class="block">A basic completion provider implementation. This provider has no
understanding of language semantics. It simply checks the text entered up
to the caret position for a match against known completions. This is all
that is needed in the majority of cases.</div>
<dl><dt><span class="strong">Version:</span></dt>
<dd>1.0</dd>
<dt><span class="strong">Author:</span></dt>
<dd>Robert Futrell</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested_class_summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="nested_classes_inherited_from_class_org.fife.ui.autocomplete.AbstractCompletionProvider">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from class org.fife.ui.autocomplete.<a href="../../../../org/fife/ui/autocomplete/AbstractCompletionProvider.html" title="class in org.fife.ui.autocomplete">AbstractCompletionProvider</a></h3>
<code><a href="../../../../org/fife/ui/autocomplete/AbstractCompletionProvider.CaseInsensitiveComparator.html" title="class in org.fife.ui.autocomplete">AbstractCompletionProvider.CaseInsensitiveComparator</a></code></li>
</ul>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="file:///usr/share/doc/default-jdk-doc/api/javax/swing/text/Segment.html?is-external=true" title="class or interface in javax.swing.text">Segment</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/fife/ui/autocomplete/DefaultCompletionProvider.html#seg">seg</a></strong></code> </td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_org.fife.ui.autocomplete.AbstractCompletionProvider">
<!-- -->
</a>
<h3>Fields inherited from class org.fife.ui.autocomplete.<a href="../../../../org/fife/ui/autocomplete/AbstractCompletionProvider.html" title="class in org.fife.ui.autocomplete">AbstractCompletionProvider</a></h3>
<code><a href="../../../../org/fife/ui/autocomplete/AbstractCompletionProvider.html#comparator">comparator</a>, <a href="../../../../org/fife/ui/autocomplete/AbstractCompletionProvider.html#completions">completions</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_org.fife.ui.autocomplete.CompletionProviderBase">
<!-- -->
</a>
<h3>Fields inherited from class org.fife.ui.autocomplete.<a href="../../../../org/fife/ui/autocomplete/CompletionProviderBase.html" title="class in org.fife.ui.autocomplete">CompletionProviderBase</a></h3>
<code><a href="../../../../org/fife/ui/autocomplete/CompletionProviderBase.html#EMPTY_STRING">EMPTY_STRING</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../org/fife/ui/autocomplete/DefaultCompletionProvider.html#DefaultCompletionProvider()">DefaultCompletionProvider</a></strong>()</code>
<div class="block">Constructor.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../org/fife/ui/autocomplete/DefaultCompletionProvider.html#DefaultCompletionProvider(java.lang.String[])">DefaultCompletionProvider</a></strong>(<a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] words)</code>
<div class="block">Creates a completion provider that provides completion for a simple
list of words.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/fife/ui/autocomplete/DefaultCompletionProvider.html#getAlreadyEnteredText(javax.swing.text.JTextComponent)">getAlreadyEnteredText</a></strong>(<a href="file:///usr/share/doc/default-jdk-doc/api/javax/swing/text/JTextComponent.html?is-external=true" title="class or interface in javax.swing.text">JTextComponent</a> comp)</code>
<div class="block">Returns the text just before the current caret position that could be
the start of something auto-completable.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/fife/ui/autocomplete/Completion.html" title="interface in org.fife.ui.autocomplete">Completion</a>></code></td>
<td class="colLast"><code><strong><a href="../../../../org/fife/ui/autocomplete/DefaultCompletionProvider.html#getCompletionsAt(javax.swing.text.JTextComponent, java.awt.Point)">getCompletionsAt</a></strong>(<a href="file:///usr/share/doc/default-jdk-doc/api/javax/swing/text/JTextComponent.html?is-external=true" title="class or interface in javax.swing.text">JTextComponent</a> tc,
<a href="file:///usr/share/doc/default-jdk-doc/api/java/awt/Point.html?is-external=true" title="class or interface in java.awt">Point</a> p)</code>
<div class="block">Returns the completions that have been entered at the specified visual
location.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/fife/ui/autocomplete/ParameterizedCompletion.html" title="interface in org.fife.ui.autocomplete">ParameterizedCompletion</a>></code></td>
<td class="colLast"><code><strong><a href="../../../../org/fife/ui/autocomplete/DefaultCompletionProvider.html#getParameterizedCompletions(javax.swing.text.JTextComponent)">getParameterizedCompletions</a></strong>(<a href="file:///usr/share/doc/default-jdk-doc/api/javax/swing/text/JTextComponent.html?is-external=true" title="class or interface in javax.swing.text">JTextComponent</a> tc)</code>
<div class="block">Returns a list of parameterized completions that have been entered
at the current caret position of a text component (and thus can have
their completion choices displayed).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/fife/ui/autocomplete/DefaultCompletionProvider.html#init()">init</a></strong>()</code>
<div class="block">Initializes this completion provider.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/fife/ui/autocomplete/DefaultCompletionProvider.html#isValidChar(char)">isValidChar</a></strong>(char ch)</code>
<div class="block">Returns whether the specified character is valid in an auto-completion.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/fife/ui/autocomplete/DefaultCompletionProvider.html#loadFromXML(java.io.File)">loadFromXML</a></strong>(<a href="file:///usr/share/doc/default-jdk-doc/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> file)</code>
<div class="block">Loads completions from an XML file.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/fife/ui/autocomplete/DefaultCompletionProvider.html#loadFromXML(java.io.InputStream)">loadFromXML</a></strong>(<a href="file:///usr/share/doc/default-jdk-doc/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> in)</code>
<div class="block">Loads completions from an XML input stream.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/fife/ui/autocomplete/DefaultCompletionProvider.html#loadFromXML(java.io.InputStream, java.lang.ClassLoader)">loadFromXML</a></strong>(<a href="file:///usr/share/doc/default-jdk-doc/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> in,
<a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a> cl)</code>
<div class="block">Loads completions from an XML input stream.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/fife/ui/autocomplete/DefaultCompletionProvider.html#loadFromXML(java.lang.String)">loadFromXML</a></strong>(<a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> resource)</code>
<div class="block">Loads completions from an XML file.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.fife.ui.autocomplete.AbstractCompletionProvider">
<!-- -->
</a>
<h3>Methods inherited from class org.fife.ui.autocomplete.<a href="../../../../org/fife/ui/autocomplete/AbstractCompletionProvider.html" title="class in org.fife.ui.autocomplete">AbstractCompletionProvider</a></h3>
<code><a href="../../../../org/fife/ui/autocomplete/AbstractCompletionProvider.html#addCompletion(org.fife.ui.autocomplete.Completion)">addCompletion</a>, <a href="../../../../org/fife/ui/autocomplete/AbstractCompletionProvider.html#addCompletions(java.util.List)">addCompletions</a>, <a href="../../../../org/fife/ui/autocomplete/AbstractCompletionProvider.html#addWordCompletions(java.lang.String[])">addWordCompletions</a>, <a href="../../../../org/fife/ui/autocomplete/AbstractCompletionProvider.html#checkProviderAndAdd(org.fife.ui.autocomplete.Completion)">checkProviderAndAdd</a>, <a href="../../../../org/fife/ui/autocomplete/AbstractCompletionProvider.html#clear()">clear</a>, <a href="../../../../org/fife/ui/autocomplete/AbstractCompletionProvider.html#getCompletionByInputText(java.lang.String)">getCompletionByInputText</a>, <a href="../../../../org/fife/ui/autocomplete/AbstractCompletionProvider.html#getCompletionsImpl(javax.swing.text.JTextComponent)">getCompletionsImpl</a>, <a href="../../../../org/fife/ui/autocomplete/AbstractCompletionProvider.html#removeCompletion(org.fife.ui.autocomplete.Completion)">removeCompletion</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.fife.ui.autocomplete.CompletionProviderBase">
<!-- -->
</a>
<h3>Methods inherited from class org.fife.ui.autocomplete.<a href="../../../../org/fife/ui/autocomplete/CompletionProviderBase.html" title="class in org.fife.ui.autocomplete">CompletionProviderBase</a></h3>
<code><a href="../../../../org/fife/ui/autocomplete/CompletionProviderBase.html#clearParameterizedCompletionParams()">clearParameterizedCompletionParams</a>, <a href="../../../../org/fife/ui/autocomplete/CompletionProviderBase.html#getCompletions(javax.swing.text.JTextComponent)">getCompletions</a>, <a href="../../../../org/fife/ui/autocomplete/CompletionProviderBase.html#getListCellRenderer()">getListCellRenderer</a>, <a href="../../../../org/fife/ui/autocomplete/CompletionProviderBase.html#getParameterChoicesProvider()">getParameterChoicesProvider</a>, <a href="../../../../org/fife/ui/autocomplete/CompletionProviderBase.html#getParameterListEnd()">getParameterListEnd</a>, <a href="../../../../org/fife/ui/autocomplete/CompletionProviderBase.html#getParameterListSeparator()">getParameterListSeparator</a>, <a href="../../../../org/fife/ui/autocomplete/CompletionProviderBase.html#getParameterListStart()">getParameterListStart</a>, <a href="../../../../org/fife/ui/autocomplete/CompletionProviderBase.html#getParent()">getParent</a>, <a href="../../../../org/fife/ui/autocomplete/CompletionProviderBase.html#isAutoActivateOkay(javax.swing.text.JTextComponent)">isAutoActivateOkay</a>, <a href="../../../../org/fife/ui/autocomplete/CompletionProviderBase.html#setAutoActivationRules(boolean, java.lang.String)">setAutoActivationRules</a>, <a href="../../../../org/fife/ui/autocomplete/CompletionProviderBase.html#setListCellRenderer(javax.swing.ListCellRenderer)">setListCellRenderer</a>, <a href="../../../../org/fife/ui/autocomplete/CompletionProviderBase.html#setParameterChoicesProvider(org.fife.ui.autocomplete.ParameterChoicesProvider)">setParameterChoicesProvider</a>, <a href="../../../../org/fife/ui/autocomplete/CompletionProviderBase.html#setParameterizedCompletionParams(char, java.lang.String, char)">setParameterizedCompletionParams</a>, <a href="../../../../org/fife/ui/autocomplete/CompletionProviderBase.html#setParent(org.fife.ui.autocomplete.CompletionProvider)">setParent</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.<a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="seg">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>seg</h4>
<pre>protected <a href="file:///usr/share/doc/default-jdk-doc/api/javax/swing/text/Segment.html?is-external=true" title="class or interface in javax.swing.text">Segment</a> seg</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="DefaultCompletionProvider()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DefaultCompletionProvider</h4>
<pre>public DefaultCompletionProvider()</pre>
<div class="block">Constructor. The returned provider will not be aware of any completions.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/fife/ui/autocomplete/AbstractCompletionProvider.html#addCompletion(org.fife.ui.autocomplete.Completion)"><code>AbstractCompletionProvider.addCompletion(Completion)</code></a></dd></dl>
</li>
</ul>
<a name="DefaultCompletionProvider(java.lang.String[])">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DefaultCompletionProvider</h4>
<pre>public DefaultCompletionProvider(<a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] words)</pre>
<div class="block">Creates a completion provider that provides completion for a simple
list of words.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>words</code> - The words to offer as completion suggestions. If this is
<code>null</code>, no completions will be known.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/fife/ui/autocomplete/BasicCompletion.html" title="class in org.fife.ui.autocomplete"><code>BasicCompletion</code></a></dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getAlreadyEnteredText(javax.swing.text.JTextComponent)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAlreadyEnteredText</h4>
<pre>public <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getAlreadyEnteredText(<a href="file:///usr/share/doc/default-jdk-doc/api/javax/swing/text/JTextComponent.html?is-external=true" title="class or interface in javax.swing.text">JTextComponent</a> comp)</pre>
<div class="block">Returns the text just before the current caret position that could be
the start of something auto-completable.<p>
This method returns all characters before the caret that are matched
by <a href="../../../../org/fife/ui/autocomplete/DefaultCompletionProvider.html#isValidChar(char)"><code>isValidChar(char)</code></a>.
Returns the text just before the current caret position that could be
the start of something auto-completable.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>comp</code> - The text component.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The text. A return value of <code>null</code> means nothing
should be auto-completed; a value of an empty string
(<code>""</code>) means auto-completion should still be
considered (i.e., all possible choices are valid).</dd></dl>
</li>
</ul>
<a name="getCompletionsAt(javax.swing.text.JTextComponent, java.awt.Point)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCompletionsAt</h4>
<pre>public <a href="file:///usr/share/doc/default-jdk-doc/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/fife/ui/autocomplete/Completion.html" title="interface in org.fife.ui.autocomplete">Completion</a>> getCompletionsAt(<a href="file:///usr/share/doc/default-jdk-doc/api/javax/swing/text/JTextComponent.html?is-external=true" title="class or interface in javax.swing.text">JTextComponent</a> tc,
<a href="file:///usr/share/doc/default-jdk-doc/api/java/awt/Point.html?is-external=true" title="class or interface in java.awt">Point</a> p)</pre>
<div class="block">Returns the completions that have been entered at the specified visual
location. This can be used for tool tips when the user hovers the
mouse over completed text.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>tc</code> - The text component.</dd><dd><code>p</code> - The position, usually from a <tt>MouseEvent</tt>.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The completions, or an empty list if there are none.</dd></dl>
</li>
</ul>
<a name="getParameterizedCompletions(javax.swing.text.JTextComponent)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getParameterizedCompletions</h4>
<pre>public <a href="file:///usr/share/doc/default-jdk-doc/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/fife/ui/autocomplete/ParameterizedCompletion.html" title="interface in org.fife.ui.autocomplete">ParameterizedCompletion</a>> getParameterizedCompletions(<a href="file:///usr/share/doc/default-jdk-doc/api/javax/swing/text/JTextComponent.html?is-external=true" title="class or interface in javax.swing.text">JTextComponent</a> tc)</pre>
<div class="block">Returns a list of parameterized completions that have been entered
at the current caret position of a text component (and thus can have
their completion choices displayed).</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>tc</code> - The text component.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The list of <a href="../../../../org/fife/ui/autocomplete/ParameterizedCompletion.html" title="interface in org.fife.ui.autocomplete"><code>ParameterizedCompletion</code></a>s. If no completions
are available, this may be <code>null</code>.</dd></dl>
</li>
</ul>
<a name="init()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>init</h4>
<pre>protected void init()</pre>
<div class="block">Initializes this completion provider.</div>
</li>
</ul>
<a name="isValidChar(char)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isValidChar</h4>
<pre>protected boolean isValidChar(char ch)</pre>
<div class="block">Returns whether the specified character is valid in an auto-completion.
The default implementation is equivalent to
"<code>Character.isLetterOrDigit(ch) || ch=='_'</code>". Subclasses
can override this method to change what characters are matched.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>ch</code> - The character.</dd>
<dt><span class="strong">Returns:</span></dt><dd>Whether the character is valid.</dd></dl>
</li>
</ul>
<a name="loadFromXML(java.io.File)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>loadFromXML</h4>
<pre>public void loadFromXML(<a href="file:///usr/share/doc/default-jdk-doc/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> file)
throws <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Loads completions from an XML file. The XML should validate against
<code>CompletionXml.dtd</code>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>file</code> - An XML file to load from.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If an IO error occurs.</dd></dl>
</li>
</ul>
<a name="loadFromXML(java.io.InputStream)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>loadFromXML</h4>
<pre>public void loadFromXML(<a href="file:///usr/share/doc/default-jdk-doc/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> in)
throws <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Loads completions from an XML input stream. The XML should validate
against <code>CompletionXml.dtd</code>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>in</code> - The input stream to read from.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If an IO error occurs.</dd></dl>
</li>
</ul>
<a name="loadFromXML(java.io.InputStream, java.lang.ClassLoader)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>loadFromXML</h4>
<pre>public void loadFromXML(<a href="file:///usr/share/doc/default-jdk-doc/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> in,
<a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a> cl)
throws <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Loads completions from an XML input stream. The XML should validate
against <code>CompletionXml.dtd</code>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>in</code> - The input stream to read from.</dd><dd><code>cl</code> - The class loader to use when loading any extra classes defined
in the XML, such as custom <a href="../../../../org/fife/ui/autocomplete/FunctionCompletion.html" title="class in org.fife.ui.autocomplete"><code>FunctionCompletion</code></a>s. This
may be <code>null</code> if the default is to be used, or if no
custom completions are defined in the XML.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If an IO error occurs.</dd></dl>
</li>
</ul>
<a name="loadFromXML(java.lang.String)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>loadFromXML</h4>
<pre>public void loadFromXML(<a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> resource)
throws <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Loads completions from an XML file. The XML should validate against
<code>CompletionXml.dtd</code>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>resource</code> - A resource the current ClassLoader can get to.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If an IO error occurs.</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../org/fife/ui/autocomplete/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/fife/ui/autocomplete/CompletionXMLParser.html" title="class in org.fife.ui.autocomplete"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/fife/ui/autocomplete/DescWindowCallback.html" title="interface in org.fife.ui.autocomplete"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/fife/ui/autocomplete/DefaultCompletionProvider.html" target="_top">Frames</a></li>
<li><a href="DefaultCompletionProvider.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li><a href="#nested_classes_inherited_from_class_org.fife.ui.autocomplete.AbstractCompletionProvider">Nested</a> | </li>
<li><a href="#field_summary">Field</a> | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field_detail">Field</a> | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
|