/usr/share/doc/libautocomplete-java/api/org/fife/ui/autocomplete/CompletionProviderBase.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 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 | <!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>CompletionProviderBase</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="CompletionProviderBase";
}
//-->
</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/CompletionProvider.html" title="interface in org.fife.ui.autocomplete"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/fife/ui/autocomplete/CompletionXMLParser.html" title="class 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/CompletionProviderBase.html" target="_top">Frames</a></li>
<li><a href="CompletionProviderBase.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>Nested | </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 CompletionProviderBase" class="title">Class CompletionProviderBase</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>org.fife.ui.autocomplete.CompletionProviderBase</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>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../org/fife/ui/autocomplete/AbstractCompletionProvider.html" title="class in org.fife.ui.autocomplete">AbstractCompletionProvider</a>, <a href="../../../../org/fife/ui/autocomplete/LanguageAwareCompletionProvider.html" title="class in org.fife.ui.autocomplete">LanguageAwareCompletionProvider</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="strong">CompletionProviderBase</span>
extends <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>
implements <a href="../../../../org/fife/ui/autocomplete/CompletionProvider.html" title="interface in org.fife.ui.autocomplete">CompletionProvider</a></pre>
<div class="block">A base class for all standard completion providers. This class implements
functionality that should be sharable across all <tt>CompletionProvider</tt>
implementations.</div>
<dl><dt><span class="strong">Version:</span></dt>
<dd>1.0</dd>
<dt><span class="strong">Author:</span></dt>
<dd>Robert Futrell</dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/fife/ui/autocomplete/AbstractCompletionProvider.html" title="class in org.fife.ui.autocomplete"><code>AbstractCompletionProvider</code></a></dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== 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 static <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/CompletionProviderBase.html#EMPTY_STRING">EMPTY_STRING</a></strong></code> </td>
</tr>
</table>
</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/CompletionProviderBase.html#CompletionProviderBase()">CompletionProviderBase</a></strong>()</code> </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>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/fife/ui/autocomplete/CompletionProviderBase.html#clearParameterizedCompletionParams()">clearParameterizedCompletionParams</a></strong>()</code>
<div class="block">Clears the values used to identify and insert "parameterized completions"
(e.g. functions or methods).</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/CompletionProviderBase.html#getCompletions(javax.swing.text.JTextComponent)">getCompletions</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">Gets the possible completions for the text component at the current
caret position.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected abstract <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/CompletionProviderBase.html#getCompletionsImpl(javax.swing.text.JTextComponent)">getCompletionsImpl</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">Does the dirty work of creating a list of completions.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="file:///usr/share/doc/default-jdk-doc/api/javax/swing/ListCellRenderer.html?is-external=true" title="class or interface in javax.swing">ListCellRenderer</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/fife/ui/autocomplete/CompletionProviderBase.html#getListCellRenderer()">getListCellRenderer</a></strong>()</code>
<div class="block">Returns the cell renderer for completions returned from this provider.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/fife/ui/autocomplete/ParameterChoicesProvider.html" title="interface in org.fife.ui.autocomplete">ParameterChoicesProvider</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/fife/ui/autocomplete/CompletionProviderBase.html#getParameterChoicesProvider()">getParameterChoicesProvider</a></strong>()</code>
<div class="block">Returns an object that can return a list of completion choices for
parameters.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>char</code></td>
<td class="colLast"><code><strong><a href="../../../../org/fife/ui/autocomplete/CompletionProviderBase.html#getParameterListEnd()">getParameterListEnd</a></strong>()</code>
<div class="block">Returns the text that marks the end of a list of parameters to a
function or method.</div>
</td>
</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/CompletionProviderBase.html#getParameterListSeparator()">getParameterListSeparator</a></strong>()</code>
<div class="block">Returns the text that separates parameters to a function or method.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>char</code></td>
<td class="colLast"><code><strong><a href="../../../../org/fife/ui/autocomplete/CompletionProviderBase.html#getParameterListStart()">getParameterListStart</a></strong>()</code>
<div class="block">Returns the text that marks the start of a list of parameters to a
function or method.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/fife/ui/autocomplete/CompletionProvider.html" title="interface in org.fife.ui.autocomplete">CompletionProvider</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/fife/ui/autocomplete/CompletionProviderBase.html#getParent()">getParent</a></strong>()</code>
<div class="block">Returns the parent completion provider.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/fife/ui/autocomplete/CompletionProviderBase.html#isAutoActivateOkay(javax.swing.text.JTextComponent)">isAutoActivateOkay</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">This method is called if auto-activation is enabled in the parent
<a href="../../../../org/fife/ui/autocomplete/AutoCompletion.html" title="class in org.fife.ui.autocomplete"><code>AutoCompletion</code></a> after the user types a single character.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/fife/ui/autocomplete/CompletionProviderBase.html#setAutoActivationRules(boolean, java.lang.String)">setAutoActivationRules</a></strong>(boolean letters,
<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> others)</code>
<div class="block">Sets the characters that auto-activation should occur after.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/fife/ui/autocomplete/CompletionProviderBase.html#setListCellRenderer(javax.swing.ListCellRenderer)">setListCellRenderer</a></strong>(<a href="file:///usr/share/doc/default-jdk-doc/api/javax/swing/ListCellRenderer.html?is-external=true" title="class or interface in javax.swing">ListCellRenderer</a> r)</code>
<div class="block">Sets the renderer to use when displaying completion choices.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/fife/ui/autocomplete/CompletionProviderBase.html#setParameterChoicesProvider(org.fife.ui.autocomplete.ParameterChoicesProvider)">setParameterChoicesProvider</a></strong>(<a href="../../../../org/fife/ui/autocomplete/ParameterChoicesProvider.html" title="interface in org.fife.ui.autocomplete">ParameterChoicesProvider</a> pcp)</code>
<div class="block">Sets the param choices provider.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/fife/ui/autocomplete/CompletionProviderBase.html#setParameterizedCompletionParams(char, java.lang.String, char)">setParameterizedCompletionParams</a></strong>(char listStart,
<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> separator,
char listEnd)</code>
<div class="block">Sets the values used to identify and insert "parameterized completions"
(e.g. functions or methods).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/fife/ui/autocomplete/CompletionProviderBase.html#setParent(org.fife.ui.autocomplete.CompletionProvider)">setParent</a></strong>(<a href="../../../../org/fife/ui/autocomplete/CompletionProvider.html" title="interface in org.fife.ui.autocomplete">CompletionProvider</a> parent)</code>
<div class="block">Sets the parent completion provider.</div>
</td>
</tr>
</table>
<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>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.fife.ui.autocomplete.CompletionProvider">
<!-- -->
</a>
<h3>Methods inherited from interface org.fife.ui.autocomplete.<a href="../../../../org/fife/ui/autocomplete/CompletionProvider.html" title="interface in org.fife.ui.autocomplete">CompletionProvider</a></h3>
<code><a href="../../../../org/fife/ui/autocomplete/CompletionProvider.html#getAlreadyEnteredText(javax.swing.text.JTextComponent)">getAlreadyEnteredText</a>, <a href="../../../../org/fife/ui/autocomplete/CompletionProvider.html#getCompletionsAt(javax.swing.text.JTextComponent, java.awt.Point)">getCompletionsAt</a>, <a href="../../../../org/fife/ui/autocomplete/CompletionProvider.html#getParameterizedCompletions(javax.swing.text.JTextComponent)">getParameterizedCompletions</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="EMPTY_STRING">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>EMPTY_STRING</h4>
<pre>protected static final <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> EMPTY_STRING</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.fife.ui.autocomplete.CompletionProviderBase.EMPTY_STRING">Constant Field Values</a></dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="CompletionProviderBase()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>CompletionProviderBase</h4>
<pre>public CompletionProviderBase()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="clearParameterizedCompletionParams()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clearParameterizedCompletionParams</h4>
<pre>public void clearParameterizedCompletionParams()</pre>
<div class="block">Clears the values used to identify and insert "parameterized completions"
(e.g. functions or methods). After this method is called, functions and
methods will not have their parameters auto-completed.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/fife/ui/autocomplete/CompletionProvider.html#clearParameterizedCompletionParams()">clearParameterizedCompletionParams</a></code> in interface <code><a href="../../../../org/fife/ui/autocomplete/CompletionProvider.html" title="interface in org.fife.ui.autocomplete">CompletionProvider</a></code></dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/fife/ui/autocomplete/CompletionProvider.html#setParameterizedCompletionParams(char, java.lang.String, char)"><code>CompletionProvider.setParameterizedCompletionParams(char, String, char)</code></a></dd></dl>
</li>
</ul>
<a name="getCompletions(javax.swing.text.JTextComponent)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCompletions</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>> getCompletions(<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">Gets the possible completions for the text component at the current
caret position.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/fife/ui/autocomplete/CompletionProvider.html#getCompletions(javax.swing.text.JTextComponent)">getCompletions</a></code> in interface <code><a href="../../../../org/fife/ui/autocomplete/CompletionProvider.html" title="interface in org.fife.ui.autocomplete">CompletionProvider</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>comp</code> - The text component.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The list of <a href="../../../../org/fife/ui/autocomplete/Completion.html" title="interface in org.fife.ui.autocomplete"><code>Completion</code></a>s. If no completions are
available, this may be <code>null</code>.</dd></dl>
</li>
</ul>
<a name="getCompletionsImpl(javax.swing.text.JTextComponent)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCompletionsImpl</h4>
<pre>protected abstract <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>> getCompletionsImpl(<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">Does the dirty work of creating a list of completions.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>comp</code> - The text component to look in.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The list of possible completions, or an empty list if there
are none.</dd></dl>
</li>
</ul>
<a name="getListCellRenderer()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getListCellRenderer</h4>
<pre>public <a href="file:///usr/share/doc/default-jdk-doc/api/javax/swing/ListCellRenderer.html?is-external=true" title="class or interface in javax.swing">ListCellRenderer</a> getListCellRenderer()</pre>
<div class="block">Returns the cell renderer for completions returned from this provider.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/fife/ui/autocomplete/CompletionProvider.html#getListCellRenderer()">getListCellRenderer</a></code> in interface <code><a href="../../../../org/fife/ui/autocomplete/CompletionProvider.html" title="interface in org.fife.ui.autocomplete">CompletionProvider</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>The cell renderer, or <code>null</code> if the default should
be used.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/fife/ui/autocomplete/CompletionProvider.html#setListCellRenderer(javax.swing.ListCellRenderer)"><code>CompletionProvider.setListCellRenderer(ListCellRenderer)</code></a></dd></dl>
</li>
</ul>
<a name="getParameterChoicesProvider()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getParameterChoicesProvider</h4>
<pre>public <a href="../../../../org/fife/ui/autocomplete/ParameterChoicesProvider.html" title="interface in org.fife.ui.autocomplete">ParameterChoicesProvider</a> getParameterChoicesProvider()</pre>
<div class="block">Returns an object that can return a list of completion choices for
parameters. This is used when a user code-completes a parameterized
completion, such as a function or method. For any parameter to the
function/method, this object can return possible completions.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/fife/ui/autocomplete/CompletionProvider.html#getParameterChoicesProvider()">getParameterChoicesProvider</a></code> in interface <code><a href="../../../../org/fife/ui/autocomplete/CompletionProvider.html" title="interface in org.fife.ui.autocomplete">CompletionProvider</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>The parameter choices provider, or <code>null</code> if
none is installed.</dd></dl>
</li>
</ul>
<a name="getParameterListEnd()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getParameterListEnd</h4>
<pre>public char getParameterListEnd()</pre>
<div class="block">Returns the text that marks the end of a list of parameters to a
function or method.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/fife/ui/autocomplete/CompletionProvider.html#getParameterListEnd()">getParameterListEnd</a></code> in interface <code><a href="../../../../org/fife/ui/autocomplete/CompletionProvider.html" title="interface in org.fife.ui.autocomplete">CompletionProvider</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>The text for a parameter list end, for example,
'<code>)</code>'.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/fife/ui/autocomplete/CompletionProvider.html#getParameterListStart()"><code>CompletionProvider.getParameterListStart()</code></a>,
<a href="../../../../org/fife/ui/autocomplete/CompletionProvider.html#getParameterListSeparator()"><code>CompletionProvider.getParameterListSeparator()</code></a>,
<a href="../../../../org/fife/ui/autocomplete/CompletionProvider.html#setParameterizedCompletionParams(char, java.lang.String, char)"><code>CompletionProvider.setParameterizedCompletionParams(char, String, char)</code></a></dd></dl>
</li>
</ul>
<a name="getParameterListSeparator()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getParameterListSeparator</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> getParameterListSeparator()</pre>
<div class="block">Returns the text that separates parameters to a function or method.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/fife/ui/autocomplete/CompletionProvider.html#getParameterListSeparator()">getParameterListSeparator</a></code> in interface <code><a href="../../../../org/fife/ui/autocomplete/CompletionProvider.html" title="interface in org.fife.ui.autocomplete">CompletionProvider</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>The text that separates parameters, for example,
"<code>, </code>".</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/fife/ui/autocomplete/CompletionProvider.html#getParameterListStart()"><code>CompletionProvider.getParameterListStart()</code></a>,
<a href="../../../../org/fife/ui/autocomplete/CompletionProvider.html#getParameterListEnd()"><code>CompletionProvider.getParameterListEnd()</code></a>,
<a href="../../../../org/fife/ui/autocomplete/CompletionProvider.html#setParameterizedCompletionParams(char, java.lang.String, char)"><code>CompletionProvider.setParameterizedCompletionParams(char, String, char)</code></a></dd></dl>
</li>
</ul>
<a name="getParameterListStart()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getParameterListStart</h4>
<pre>public char getParameterListStart()</pre>
<div class="block">Returns the text that marks the start of a list of parameters to a
function or method.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/fife/ui/autocomplete/CompletionProvider.html#getParameterListStart()">getParameterListStart</a></code> in interface <code><a href="../../../../org/fife/ui/autocomplete/CompletionProvider.html" title="interface in org.fife.ui.autocomplete">CompletionProvider</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>The text for a parameter list start, for example,
"<code>(</code>".</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/fife/ui/autocomplete/CompletionProvider.html#getParameterListEnd()"><code>CompletionProvider.getParameterListEnd()</code></a>,
<a href="../../../../org/fife/ui/autocomplete/CompletionProvider.html#getParameterListSeparator()"><code>CompletionProvider.getParameterListSeparator()</code></a>,
<a href="../../../../org/fife/ui/autocomplete/CompletionProvider.html#setParameterizedCompletionParams(char, java.lang.String, char)"><code>CompletionProvider.setParameterizedCompletionParams(char, String, char)</code></a></dd></dl>
</li>
</ul>
<a name="getParent()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getParent</h4>
<pre>public <a href="../../../../org/fife/ui/autocomplete/CompletionProvider.html" title="interface in org.fife.ui.autocomplete">CompletionProvider</a> getParent()</pre>
<div class="block">Returns the parent completion provider.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/fife/ui/autocomplete/CompletionProvider.html#getParent()">getParent</a></code> in interface <code><a href="../../../../org/fife/ui/autocomplete/CompletionProvider.html" title="interface in org.fife.ui.autocomplete">CompletionProvider</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>The parent completion provider.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/fife/ui/autocomplete/CompletionProvider.html#setParent(org.fife.ui.autocomplete.CompletionProvider)"><code>CompletionProvider.setParent(CompletionProvider)</code></a></dd></dl>
</li>
</ul>
<a name="isAutoActivateOkay(javax.swing.text.JTextComponent)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isAutoActivateOkay</h4>
<pre>public boolean isAutoActivateOkay(<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">This method is called if auto-activation is enabled in the parent
<a href="../../../../org/fife/ui/autocomplete/AutoCompletion.html" title="class in org.fife.ui.autocomplete"><code>AutoCompletion</code></a> after the user types a single character. This
provider should check the text at the current caret position of the
text component, and decide whether auto-activation would be appropriate
here. For example, a <code>CompletionProvider</code> for Java might
want to return <code>true</code> for this method only if the last
character typed was a '<code>.</code>'.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/fife/ui/autocomplete/CompletionProvider.html#isAutoActivateOkay(javax.swing.text.JTextComponent)">isAutoActivateOkay</a></code> in interface <code><a href="../../../../org/fife/ui/autocomplete/CompletionProvider.html" title="interface in org.fife.ui.autocomplete">CompletionProvider</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>tc</code> - The text component.</dd>
<dt><span class="strong">Returns:</span></dt><dd>Whether auto-activation would be appropriate.</dd></dl>
</li>
</ul>
<a name="setAutoActivationRules(boolean, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAutoActivationRules</h4>
<pre>public void setAutoActivationRules(boolean letters,
<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> others)</pre>
<div class="block">Sets the characters that auto-activation should occur after. A Java
completion provider, for example, might want to set <code>others</code>
to "<code>.</code>", to allow auto-activation for members of an object.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>letters</code> - Whether auto-activation should occur after any letter.</dd><dd><code>others</code> - A string of (non-letter) chars that auto-activation should
occur after. This may be <code>null</code>.</dd></dl>
</li>
</ul>
<a name="setParameterChoicesProvider(org.fife.ui.autocomplete.ParameterChoicesProvider)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setParameterChoicesProvider</h4>
<pre>public void setParameterChoicesProvider(<a href="../../../../org/fife/ui/autocomplete/ParameterChoicesProvider.html" title="interface in org.fife.ui.autocomplete">ParameterChoicesProvider</a> pcp)</pre>
<div class="block">Sets the param choices provider. This is used when a user
code-completes a parameterized completion, such as a function or method.
For any parameter to the function/method, this object can return
possible completions.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pcp</code> - The parameter choices provider, or <code>null</code> for
none.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/fife/ui/autocomplete/CompletionProviderBase.html#getParameterChoicesProvider()"><code>getParameterChoicesProvider()</code></a></dd></dl>
</li>
</ul>
<a name="setListCellRenderer(javax.swing.ListCellRenderer)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setListCellRenderer</h4>
<pre>public void setListCellRenderer(<a href="file:///usr/share/doc/default-jdk-doc/api/javax/swing/ListCellRenderer.html?is-external=true" title="class or interface in javax.swing">ListCellRenderer</a> r)</pre>
<div class="block">Sets the renderer to use when displaying completion choices.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/fife/ui/autocomplete/CompletionProvider.html#setListCellRenderer(javax.swing.ListCellRenderer)">setListCellRenderer</a></code> in interface <code><a href="../../../../org/fife/ui/autocomplete/CompletionProvider.html" title="interface in org.fife.ui.autocomplete">CompletionProvider</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>r</code> - The renderer to use.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/fife/ui/autocomplete/CompletionProvider.html#getListCellRenderer()"><code>CompletionProvider.getListCellRenderer()</code></a></dd></dl>
</li>
</ul>
<a name="setParameterizedCompletionParams(char, java.lang.String, char)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setParameterizedCompletionParams</h4>
<pre>public void setParameterizedCompletionParams(char listStart,
<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> separator,
char listEnd)</pre>
<div class="block">Sets the values used to identify and insert "parameterized completions"
(e.g. functions or methods). If this method isn't called, functions
and methods will not have their parameters auto-completed.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/fife/ui/autocomplete/CompletionProvider.html#setParameterizedCompletionParams(char, java.lang.String, char)">setParameterizedCompletionParams</a></code> in interface <code><a href="../../../../org/fife/ui/autocomplete/CompletionProvider.html" title="interface in org.fife.ui.autocomplete">CompletionProvider</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>listStart</code> - The character that marks the beginning of a list of
parameters, such as '<tt>(</tt>' in C or Java.</dd><dd><code>separator</code> - Text that should separate parameters in a parameter
list when one is inserted. For example, "<tt>, </tt>".</dd><dd><code>listEnd</code> - The character that marks the end of a list of parameters,
such as '<tt>)</tt>' in C or Java.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/fife/ui/autocomplete/CompletionProvider.html#clearParameterizedCompletionParams()"><code>CompletionProvider.clearParameterizedCompletionParams()</code></a></dd></dl>
</li>
</ul>
<a name="setParent(org.fife.ui.autocomplete.CompletionProvider)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setParent</h4>
<pre>public void setParent(<a href="../../../../org/fife/ui/autocomplete/CompletionProvider.html" title="interface in org.fife.ui.autocomplete">CompletionProvider</a> parent)</pre>
<div class="block">Sets the parent completion provider.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/fife/ui/autocomplete/CompletionProvider.html#setParent(org.fife.ui.autocomplete.CompletionProvider)">setParent</a></code> in interface <code><a href="../../../../org/fife/ui/autocomplete/CompletionProvider.html" title="interface in org.fife.ui.autocomplete">CompletionProvider</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>parent</code> - The parent provider. <code>null</code> means there will
be no parent provider.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/fife/ui/autocomplete/CompletionProvider.html#getParent()"><code>CompletionProvider.getParent()</code></a></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/CompletionProvider.html" title="interface in org.fife.ui.autocomplete"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/fife/ui/autocomplete/CompletionXMLParser.html" title="class 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/CompletionProviderBase.html" target="_top">Frames</a></li>
<li><a href="CompletionProviderBase.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>Nested | </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>
|