/usr/share/doc/libautocomplete-java/api/org/fife/ui/autocomplete/AutoCompletion.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 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 | <!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:32 UTC 2013 -->
<title>AutoCompletion</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="AutoCompletion";
}
//-->
</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/AbstractCompletionProvider.CaseInsensitiveComparator.html" title="class in org.fife.ui.autocomplete"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/fife/ui/autocomplete/AutoCompletionStyleContext.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/AutoCompletion.html" target="_top">Frames</a></li>
<li><a href="AutoCompletion.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>Field | </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>Field | </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 AutoCompletion" class="title">Class AutoCompletion</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.AutoCompletion</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">AutoCompletion</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></pre>
<div class="block">Adds auto-completion to a text component. Provides a popup window with a
list of auto-complete choices on a given keystroke, such as Crtrl+Space.<p>
Depending on the <a href="../../../../org/fife/ui/autocomplete/CompletionProvider.html" title="interface in org.fife.ui.autocomplete"><code>CompletionProvider</code></a> installed, the following
auto-completion features may be enabled:
<ul>
<li>An auto-complete choices list made visible via e.g. Ctrl+Space</li>
<li>A "description" window displayed alongside the choices list that
provides documentation on the currently selected completion choice
(as seen in Eclipse and NetBeans).</li>
<li>Parameter assistance. If this is enabled, if the user enters a
"parameterized" completion, such as a method or a function, then
they will receive a tool tip describing the arguments they have to
enter to the completion. Also, the arguments can be navigated via
tab and shift+tab (a la Eclipse and NetBeans).</li>
</ul></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">
<!-- ======== 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/AutoCompletion.html#AutoCompletion(org.fife.ui.autocomplete.CompletionProvider)">AutoCompletion</a></strong>(<a href="../../../../org/fife/ui/autocomplete/CompletionProvider.html" title="interface in org.fife.ui.autocomplete">CompletionProvider</a> provider)</code>
<div class="block">Constructor.</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>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/fife/ui/autocomplete/AutoCompletion.html#doCompletion()">doCompletion</a></strong>()</code>
<div class="block">Displays the popup window.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/fife/ui/autocomplete/AutoCompletion.html#getAutoActivationDelay()">getAutoActivationDelay</a></strong>()</code>
<div class="block">Returns the delay between when the user types a character and when the
code completion popup should automatically appear (if applicable).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/fife/ui/autocomplete/AutoCompletion.html#getAutoCompleteSingleChoices()">getAutoCompleteSingleChoices</a></strong>()</code>
<div class="block">Returns whether, if a single auto-complete choice is available, it
should be automatically inserted, without displaying the popup menu.</div>
</td>
</tr>
<tr class="rowColor">
<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/AutoCompletion.html#getCompletionProvider()">getCompletionProvider</a></strong>()</code>
<div class="block">Returns the completion provider.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="file:///usr/share/doc/default-jdk-doc/api/javax/swing/KeyStroke.html?is-external=true" title="class or interface in javax.swing">KeyStroke</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/fife/ui/autocomplete/AutoCompletion.html#getDefaultTriggerKey()">getDefaultTriggerKey</a></strong>()</code>
<div class="block">Returns the default auto-complete "trigger key" for this OS.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/fife/ui/autocomplete/ExternalURLHandler.html" title="interface in org.fife.ui.autocomplete">ExternalURLHandler</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/fife/ui/autocomplete/AutoCompletion.html#getExternalURLHandler()">getExternalURLHandler</a></strong>()</code>
<div class="block">Returns the handler to use when an external URL is clicked in the
description window.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../org/fife/ui/autocomplete/LinkRedirector.html" title="interface in org.fife.ui.autocomplete">LinkRedirector</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/fife/ui/autocomplete/AutoCompletion.html#getLinkRedirector()">getLinkRedirector</a></strong>()</code>
<div class="block">Returns the link redirector, if any.</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/AutoCompletion.html#getListCellRenderer()">getListCellRenderer</a></strong>()</code>
<div class="block">Returns the default list cell renderer used when a completion provider
does not supply its own.</div>
</td>
</tr>
<tr class="altColor">
<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/AutoCompletion.html#getParamChoicesRenderer()">getParamChoicesRenderer</a></strong>()</code>
<div class="block">Returns the renderer to use for <a href="../../../../org/fife/ui/autocomplete/Completion.html" title="interface in org.fife.ui.autocomplete"><code>Completion</code></a>s in the optional
parameter choices popup window (displayed when a
<a href="../../../../org/fife/ui/autocomplete/ParameterizedCompletion.html" title="interface in org.fife.ui.autocomplete"><code>ParameterizedCompletion</code></a> is code-completed).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <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/AutoCompletion.html#getReplacementText(org.fife.ui.autocomplete.Completion, javax.swing.text.Document, int, int)">getReplacementText</a></strong>(<a href="../../../../org/fife/ui/autocomplete/Completion.html" title="interface in org.fife.ui.autocomplete">Completion</a> c,
<a href="file:///usr/share/doc/default-jdk-doc/api/javax/swing/text/Document.html?is-external=true" title="class or interface in javax.swing.text">Document</a> doc,
int start,
int len)</code>
<div class="block">Returns the text to replace with in the document.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/fife/ui/autocomplete/AutoCompletion.html#getShowDescWindow()">getShowDescWindow</a></strong>()</code>
<div class="block">Returns whether the "description window" should be shown alongside
the completion window.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../org/fife/ui/autocomplete/AutoCompletionStyleContext.html" title="class in org.fife.ui.autocomplete">AutoCompletionStyleContext</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/fife/ui/autocomplete/AutoCompletion.html#getStyleContext()">getStyleContext</a></strong>()</code>
<div class="block">Returns the style context describing how auto-completion related
highlights in the editor are rendered.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><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></code></td>
<td class="colLast"><code><strong><a href="../../../../org/fife/ui/autocomplete/AutoCompletion.html#getTextComponent()">getTextComponent</a></strong>()</code>
<div class="block">Returns the text component for which auto-completion is enabled.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="file:///usr/share/doc/default-jdk-doc/api/javax/swing/KeyStroke.html?is-external=true" title="class or interface in javax.swing">KeyStroke</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/fife/ui/autocomplete/AutoCompletion.html#getTriggerKey()">getTriggerKey</a></strong>()</code>
<div class="block">Returns the "trigger key" used for auto-complete.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/fife/ui/autocomplete/AutoCompletion.html#hideChildWindows()">hideChildWindows</a></strong>()</code>
<div class="block">Hides any child windows being displayed by the auto-completion system.</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/AutoCompletion.html#insertCompletion(org.fife.ui.autocomplete.Completion)">insertCompletion</a></strong>(<a href="../../../../org/fife/ui/autocomplete/Completion.html" title="interface in org.fife.ui.autocomplete">Completion</a> c)</code>
<div class="block">Inserts a completion.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/fife/ui/autocomplete/AutoCompletion.html#insertCompletion(org.fife.ui.autocomplete.Completion, boolean)">insertCompletion</a></strong>(<a href="../../../../org/fife/ui/autocomplete/Completion.html" title="interface in org.fife.ui.autocomplete">Completion</a> c,
boolean typedParamListStartChar)</code>
<div class="block">Inserts a 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/AutoCompletion.html#install(javax.swing.text.JTextComponent)">install</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> c)</code>
<div class="block">Installs this auto-completion on a text component.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/fife/ui/autocomplete/AutoCompletion.html#isAutoActivationEnabled()">isAutoActivationEnabled</a></strong>()</code>
<div class="block">Returns whether auto-activation is enabled (that is, whether the
completion popup will automatically appear after a delay when the user
types an appropriate character).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/fife/ui/autocomplete/AutoCompletion.html#isAutoCompleteEnabled()">isAutoCompleteEnabled</a></strong>()</code>
<div class="block">Returns whether auto-completion is enabled.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/fife/ui/autocomplete/AutoCompletion.html#isParameterAssistanceEnabled()">isParameterAssistanceEnabled</a></strong>()</code>
<div class="block">Returns whether parameter assistance is enabled.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/fife/ui/autocomplete/AutoCompletion.html#refreshPopupWindow()">refreshPopupWindow</a></strong>()</code>
<div class="block">Refreshes the popup window.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/fife/ui/autocomplete/AutoCompletion.html#setAutoActivationDelay(int)">setAutoActivationDelay</a></strong>(int ms)</code>
<div class="block">Sets the delay between when the user types a character and when the
code completion popup should automatically appear (if applicable).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/fife/ui/autocomplete/AutoCompletion.html#setAutoActivationEnabled(boolean)">setAutoActivationEnabled</a></strong>(boolean enabled)</code>
<div class="block">Toggles whether auto-activation is enabled.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/fife/ui/autocomplete/AutoCompletion.html#setAutoCompleteEnabled(boolean)">setAutoCompleteEnabled</a></strong>(boolean enabled)</code>
<div class="block">Sets whether auto-completion is enabled.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/fife/ui/autocomplete/AutoCompletion.html#setAutoCompleteSingleChoices(boolean)">setAutoCompleteSingleChoices</a></strong>(boolean autoComplete)</code>
<div class="block">Sets whether, if a single auto-complete choice is available, it should
be automatically inserted, without displaying the popup menu.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/fife/ui/autocomplete/AutoCompletion.html#setChoicesWindowSize(int, int)">setChoicesWindowSize</a></strong>(int w,
int h)</code>
<div class="block">Sets the size of the completion choices window.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/fife/ui/autocomplete/AutoCompletion.html#setCompletionProvider(org.fife.ui.autocomplete.CompletionProvider)">setCompletionProvider</a></strong>(<a href="../../../../org/fife/ui/autocomplete/CompletionProvider.html" title="interface in org.fife.ui.autocomplete">CompletionProvider</a> provider)</code>
<div class="block">Sets the completion provider being used.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/fife/ui/autocomplete/AutoCompletion.html#setDescriptionWindowSize(int, int)">setDescriptionWindowSize</a></strong>(int w,
int h)</code>
<div class="block">Sets the size of the description window.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/fife/ui/autocomplete/AutoCompletion.html#setExternalURLHandler(org.fife.ui.autocomplete.ExternalURLHandler)">setExternalURLHandler</a></strong>(<a href="../../../../org/fife/ui/autocomplete/ExternalURLHandler.html" title="interface in org.fife.ui.autocomplete">ExternalURLHandler</a> handler)</code>
<div class="block">Sets the handler to use when an external URL is clicked in the
description window.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/fife/ui/autocomplete/AutoCompletion.html#setLinkRedirector(org.fife.ui.autocomplete.LinkRedirector)">setLinkRedirector</a></strong>(<a href="../../../../org/fife/ui/autocomplete/LinkRedirector.html" title="interface in org.fife.ui.autocomplete">LinkRedirector</a> linkRedirector)</code>
<div class="block">Sets the redirector for external URL's found in code completion
documentation.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/fife/ui/autocomplete/AutoCompletion.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> renderer)</code>
<div class="block">Sets the default list cell renderer to use when a completion provider
does not supply its own.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/fife/ui/autocomplete/AutoCompletion.html#setParamChoicesRenderer(javax.swing.ListCellRenderer)">setParamChoicesRenderer</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 for <a href="../../../../org/fife/ui/autocomplete/Completion.html" title="interface in org.fife.ui.autocomplete"><code>Completion</code></a>s in the optional
parameter choices popup window (displayed when a
<a href="../../../../org/fife/ui/autocomplete/ParameterizedCompletion.html" title="interface in org.fife.ui.autocomplete"><code>ParameterizedCompletion</code></a> is code-completed).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/fife/ui/autocomplete/AutoCompletion.html#setParameterAssistanceEnabled(boolean)">setParameterAssistanceEnabled</a></strong>(boolean enabled)</code>
<div class="block">Sets whether parameter assistance is enabled.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/fife/ui/autocomplete/AutoCompletion.html#setShowDescWindow(boolean)">setShowDescWindow</a></strong>(boolean show)</code>
<div class="block">Sets whether the "description window" should be shown beside the
completion window.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/fife/ui/autocomplete/AutoCompletion.html#setTriggerKey(javax.swing.KeyStroke)">setTriggerKey</a></strong>(<a href="file:///usr/share/doc/default-jdk-doc/api/javax/swing/KeyStroke.html?is-external=true" title="class or interface in javax.swing">KeyStroke</a> ks)</code>
<div class="block">Sets the keystroke that should be used to trigger the auto-complete
popup window.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/fife/ui/autocomplete/AutoCompletion.html#uninstall()">uninstall</a></strong>()</code>
<div class="block">Uninstalls this auto-completion from its text component.</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>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="AutoCompletion(org.fife.ui.autocomplete.CompletionProvider)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>AutoCompletion</h4>
<pre>public AutoCompletion(<a href="../../../../org/fife/ui/autocomplete/CompletionProvider.html" title="interface in org.fife.ui.autocomplete">CompletionProvider</a> provider)</pre>
<div class="block">Constructor.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>provider</code> - The completion provider. This cannot be
<code>null</code>.</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="doCompletion()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>doCompletion</h4>
<pre>public void doCompletion()</pre>
<div class="block">Displays the popup window. Hosting applications can call this method
to programmatically begin an auto-completion operation.</div>
</li>
</ul>
<a name="getAutoActivationDelay()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAutoActivationDelay</h4>
<pre>public int getAutoActivationDelay()</pre>
<div class="block">Returns the delay between when the user types a character and when the
code completion popup should automatically appear (if applicable).</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The delay, in milliseconds.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/fife/ui/autocomplete/AutoCompletion.html#setAutoActivationDelay(int)"><code>setAutoActivationDelay(int)</code></a></dd></dl>
</li>
</ul>
<a name="getAutoCompleteSingleChoices()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAutoCompleteSingleChoices</h4>
<pre>public boolean getAutoCompleteSingleChoices()</pre>
<div class="block">Returns whether, if a single auto-complete choice is available, it
should be automatically inserted, without displaying the popup menu.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>Whether to auto-complete single choices.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/fife/ui/autocomplete/AutoCompletion.html#setAutoCompleteSingleChoices(boolean)"><code>setAutoCompleteSingleChoices(boolean)</code></a></dd></dl>
</li>
</ul>
<a name="getCompletionProvider()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCompletionProvider</h4>
<pre>public <a href="../../../../org/fife/ui/autocomplete/CompletionProvider.html" title="interface in org.fife.ui.autocomplete">CompletionProvider</a> getCompletionProvider()</pre>
<div class="block">Returns the completion provider.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The completion provider.</dd></dl>
</li>
</ul>
<a name="getDefaultTriggerKey()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDefaultTriggerKey</h4>
<pre>public static <a href="file:///usr/share/doc/default-jdk-doc/api/javax/swing/KeyStroke.html?is-external=true" title="class or interface in javax.swing">KeyStroke</a> getDefaultTriggerKey()</pre>
<div class="block">Returns the default auto-complete "trigger key" for this OS. For
Windows, for example, it is Ctrl+Space.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The default auto-complete trigger key.</dd></dl>
</li>
</ul>
<a name="getExternalURLHandler()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExternalURLHandler</h4>
<pre>public <a href="../../../../org/fife/ui/autocomplete/ExternalURLHandler.html" title="interface in org.fife.ui.autocomplete">ExternalURLHandler</a> getExternalURLHandler()</pre>
<div class="block">Returns the handler to use when an external URL is clicked in the
description window.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The handler.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/fife/ui/autocomplete/AutoCompletion.html#setExternalURLHandler(org.fife.ui.autocomplete.ExternalURLHandler)"><code>setExternalURLHandler(ExternalURLHandler)</code></a>,
<a href="../../../../org/fife/ui/autocomplete/AutoCompletion.html#getLinkRedirector()"><code>getLinkRedirector()</code></a></dd></dl>
</li>
</ul>
<a name="getLinkRedirector()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLinkRedirector</h4>
<pre>public static <a href="../../../../org/fife/ui/autocomplete/LinkRedirector.html" title="interface in org.fife.ui.autocomplete">LinkRedirector</a> getLinkRedirector()</pre>
<div class="block">Returns the link redirector, if any.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The link redirector, or <code>null</code> if none.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/fife/ui/autocomplete/AutoCompletion.html#setLinkRedirector(org.fife.ui.autocomplete.LinkRedirector)"><code>setLinkRedirector(LinkRedirector)</code></a></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 default list cell renderer used when a completion provider
does not supply its own.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The default list cell renderer.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/fife/ui/autocomplete/AutoCompletion.html#setListCellRenderer(javax.swing.ListCellRenderer)"><code>setListCellRenderer(ListCellRenderer)</code></a></dd></dl>
</li>
</ul>
<a name="getParamChoicesRenderer()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getParamChoicesRenderer</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> getParamChoicesRenderer()</pre>
<div class="block">Returns the renderer to use for <a href="../../../../org/fife/ui/autocomplete/Completion.html" title="interface in org.fife.ui.autocomplete"><code>Completion</code></a>s in the optional
parameter choices popup window (displayed when a
<a href="../../../../org/fife/ui/autocomplete/ParameterizedCompletion.html" title="interface in org.fife.ui.autocomplete"><code>ParameterizedCompletion</code></a> is code-completed). If this returns
<code>null</code>, a default renderer is used.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The renderer to use.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/fife/ui/autocomplete/AutoCompletion.html#setParamChoicesRenderer(javax.swing.ListCellRenderer)"><code>setParamChoicesRenderer(ListCellRenderer)</code></a>,
<a href="../../../../org/fife/ui/autocomplete/AutoCompletion.html#isParameterAssistanceEnabled()"><code>isParameterAssistanceEnabled()</code></a></dd></dl>
</li>
</ul>
<a name="getReplacementText(org.fife.ui.autocomplete.Completion, javax.swing.text.Document, int, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReplacementText</h4>
<pre>protected <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> getReplacementText(<a href="../../../../org/fife/ui/autocomplete/Completion.html" title="interface in org.fife.ui.autocomplete">Completion</a> c,
<a href="file:///usr/share/doc/default-jdk-doc/api/javax/swing/text/Document.html?is-external=true" title="class or interface in javax.swing.text">Document</a> doc,
int start,
int len)</pre>
<div class="block">Returns the text to replace with in the document. This is a
"last-chance" hook for subclasses to make special modifications to the
completion text inserted. The default implementation simply returns
<tt>c.getReplacementText()</tt>. You usually will not need to modify
this method.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>c</code> - The completion being inserted.</dd><dd><code>doc</code> - The document being modified.</dd><dd><code>start</code> - The start of the text being replaced.</dd><dd><code>len</code> - The length of the text being replaced.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The text to replace with.</dd></dl>
</li>
</ul>
<a name="getShowDescWindow()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getShowDescWindow</h4>
<pre>public boolean getShowDescWindow()</pre>
<div class="block">Returns whether the "description window" should be shown alongside
the completion window.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>Whether the description window should be shown.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/fife/ui/autocomplete/AutoCompletion.html#setShowDescWindow(boolean)"><code>setShowDescWindow(boolean)</code></a></dd></dl>
</li>
</ul>
<a name="getStyleContext()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStyleContext</h4>
<pre>public static <a href="../../../../org/fife/ui/autocomplete/AutoCompletionStyleContext.html" title="class in org.fife.ui.autocomplete">AutoCompletionStyleContext</a> getStyleContext()</pre>
<div class="block">Returns the style context describing how auto-completion related
highlights in the editor are rendered.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The style context.</dd></dl>
</li>
</ul>
<a name="getTextComponent()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTextComponent</h4>
<pre>public <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> getTextComponent()</pre>
<div class="block">Returns the text component for which auto-completion is enabled.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The text component, or <code>null</code> if this
<a href="../../../../org/fife/ui/autocomplete/AutoCompletion.html" title="class in org.fife.ui.autocomplete"><code>AutoCompletion</code></a> is not installed on any text component.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/fife/ui/autocomplete/AutoCompletion.html#install(javax.swing.text.JTextComponent)"><code>install(JTextComponent)</code></a></dd></dl>
</li>
</ul>
<a name="getTriggerKey()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTriggerKey</h4>
<pre>public <a href="file:///usr/share/doc/default-jdk-doc/api/javax/swing/KeyStroke.html?is-external=true" title="class or interface in javax.swing">KeyStroke</a> getTriggerKey()</pre>
<div class="block">Returns the "trigger key" used for auto-complete.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The trigger key.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/fife/ui/autocomplete/AutoCompletion.html#setTriggerKey(javax.swing.KeyStroke)"><code>setTriggerKey(KeyStroke)</code></a></dd></dl>
</li>
</ul>
<a name="hideChildWindows()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hideChildWindows</h4>
<pre>public boolean hideChildWindows()</pre>
<div class="block">Hides any child windows being displayed by the auto-completion system.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>Whether any windows were visible.</dd></dl>
</li>
</ul>
<a name="insertCompletion(org.fife.ui.autocomplete.Completion)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>insertCompletion</h4>
<pre>protected final void insertCompletion(<a href="../../../../org/fife/ui/autocomplete/Completion.html" title="interface in org.fife.ui.autocomplete">Completion</a> c)</pre>
<div class="block">Inserts a completion. Any time a code completion event occurs, the
actual text insertion happens through this method.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>c</code> - A completion to insert. This cannot be <code>null</code>.</dd></dl>
</li>
</ul>
<a name="insertCompletion(org.fife.ui.autocomplete.Completion, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>insertCompletion</h4>
<pre>protected void insertCompletion(<a href="../../../../org/fife/ui/autocomplete/Completion.html" title="interface in org.fife.ui.autocomplete">Completion</a> c,
boolean typedParamListStartChar)</pre>
<div class="block">Inserts a completion. Any time a code completion event occurs, the
actual text insertion happens through this method.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>c</code> - A completion to insert. This cannot be <code>null</code>.</dd><dd><code>typedParamListStartChar</code> - Whether the parameterized completion
start character was typed (typically <code>'('</code>).</dd></dl>
</li>
</ul>
<a name="install(javax.swing.text.JTextComponent)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>install</h4>
<pre>public void install(<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> c)</pre>
<div class="block">Installs this auto-completion on a text component. If this
<a href="../../../../org/fife/ui/autocomplete/AutoCompletion.html" title="class in org.fife.ui.autocomplete"><code>AutoCompletion</code></a> is already installed on another text component,
it is uninstalled first.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>c</code> - The text component.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/fife/ui/autocomplete/AutoCompletion.html#uninstall()"><code>uninstall()</code></a></dd></dl>
</li>
</ul>
<a name="isAutoActivationEnabled()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isAutoActivationEnabled</h4>
<pre>public boolean isAutoActivationEnabled()</pre>
<div class="block">Returns whether auto-activation is enabled (that is, whether the
completion popup will automatically appear after a delay when the user
types an appropriate character). Note that this parameter will be
ignored if auto-completion is disabled.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>Whether auto-activation is enabled.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/fife/ui/autocomplete/AutoCompletion.html#setAutoActivationEnabled(boolean)"><code>setAutoActivationEnabled(boolean)</code></a>,
<a href="../../../../org/fife/ui/autocomplete/AutoCompletion.html#getAutoActivationDelay()"><code>getAutoActivationDelay()</code></a>,
<a href="../../../../org/fife/ui/autocomplete/AutoCompletion.html#isAutoCompleteEnabled()"><code>isAutoCompleteEnabled()</code></a></dd></dl>
</li>
</ul>
<a name="isAutoCompleteEnabled()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isAutoCompleteEnabled</h4>
<pre>public boolean isAutoCompleteEnabled()</pre>
<div class="block">Returns whether auto-completion is enabled.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>Whether auto-completion is enabled.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/fife/ui/autocomplete/AutoCompletion.html#setAutoCompleteEnabled(boolean)"><code>setAutoCompleteEnabled(boolean)</code></a></dd></dl>
</li>
</ul>
<a name="isParameterAssistanceEnabled()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isParameterAssistanceEnabled</h4>
<pre>public boolean isParameterAssistanceEnabled()</pre>
<div class="block">Returns whether parameter assistance is enabled.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>Whether parameter assistance is enabled.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/fife/ui/autocomplete/AutoCompletion.html#setParameterAssistanceEnabled(boolean)"><code>setParameterAssistanceEnabled(boolean)</code></a></dd></dl>
</li>
</ul>
<a name="refreshPopupWindow()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>refreshPopupWindow</h4>
<pre>protected int refreshPopupWindow()</pre>
<div class="block">Refreshes the popup window. First, this method gets the possible
completions for the current caret position. If there are none, and the
popup is visible, it is hidden. If there are some completions and the
popup is hidden, it is made visible and made to display the completions.
If there are some completions and the popup is visible, its list is
updated to the current set of completions.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The current line number of the caret.</dd></dl>
</li>
</ul>
<a name="setAutoActivationDelay(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAutoActivationDelay</h4>
<pre>public void setAutoActivationDelay(int ms)</pre>
<div class="block">Sets the delay between when the user types a character and when the
code completion popup should automatically appear (if applicable).</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>ms</code> - The delay, in milliseconds. This should be greater than zero.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/fife/ui/autocomplete/AutoCompletion.html#getAutoActivationDelay()"><code>getAutoActivationDelay()</code></a></dd></dl>
</li>
</ul>
<a name="setAutoActivationEnabled(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAutoActivationEnabled</h4>
<pre>public void setAutoActivationEnabled(boolean enabled)</pre>
<div class="block">Toggles whether auto-activation is enabled. Note that auto-activation
also depends on auto-completion itself being enabled.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>enabled</code> - Whether auto-activation is enabled.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/fife/ui/autocomplete/AutoCompletion.html#isAutoActivationEnabled()"><code>isAutoActivationEnabled()</code></a>,
<a href="../../../../org/fife/ui/autocomplete/AutoCompletion.html#setAutoActivationDelay(int)"><code>setAutoActivationDelay(int)</code></a></dd></dl>
</li>
</ul>
<a name="setAutoCompleteEnabled(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAutoCompleteEnabled</h4>
<pre>public void setAutoCompleteEnabled(boolean enabled)</pre>
<div class="block">Sets whether auto-completion is enabled.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>enabled</code> - Whether auto-completion is enabled.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/fife/ui/autocomplete/AutoCompletion.html#isAutoCompleteEnabled()"><code>isAutoCompleteEnabled()</code></a></dd></dl>
</li>
</ul>
<a name="setAutoCompleteSingleChoices(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAutoCompleteSingleChoices</h4>
<pre>public void setAutoCompleteSingleChoices(boolean autoComplete)</pre>
<div class="block">Sets whether, if a single auto-complete choice is available, it should
be automatically inserted, without displaying the popup menu.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>autoComplete</code> - Whether to auto-complete single choices.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/fife/ui/autocomplete/AutoCompletion.html#getAutoCompleteSingleChoices()"><code>getAutoCompleteSingleChoices()</code></a></dd></dl>
</li>
</ul>
<a name="setCompletionProvider(org.fife.ui.autocomplete.CompletionProvider)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCompletionProvider</h4>
<pre>public void setCompletionProvider(<a href="../../../../org/fife/ui/autocomplete/CompletionProvider.html" title="interface in org.fife.ui.autocomplete">CompletionProvider</a> provider)</pre>
<div class="block">Sets the completion provider being used.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>provider</code> - The new completion provider. This cannot be
<code>null</code>.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - If <code>provider</code> is
<code>null</code>.</dd></dl>
</li>
</ul>
<a name="setChoicesWindowSize(int, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setChoicesWindowSize</h4>
<pre>public void setChoicesWindowSize(int w,
int h)</pre>
<div class="block">Sets the size of the completion choices window.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>w</code> - The new width.</dd><dd><code>h</code> - The new height.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/fife/ui/autocomplete/AutoCompletion.html#setDescriptionWindowSize(int, int)"><code>setDescriptionWindowSize(int, int)</code></a></dd></dl>
</li>
</ul>
<a name="setDescriptionWindowSize(int, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDescriptionWindowSize</h4>
<pre>public void setDescriptionWindowSize(int w,
int h)</pre>
<div class="block">Sets the size of the description window.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>w</code> - The new width.</dd><dd><code>h</code> - The new height.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/fife/ui/autocomplete/AutoCompletion.html#setChoicesWindowSize(int, int)"><code>setChoicesWindowSize(int, int)</code></a></dd></dl>
</li>
</ul>
<a name="setExternalURLHandler(org.fife.ui.autocomplete.ExternalURLHandler)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setExternalURLHandler</h4>
<pre>public void setExternalURLHandler(<a href="../../../../org/fife/ui/autocomplete/ExternalURLHandler.html" title="interface in org.fife.ui.autocomplete">ExternalURLHandler</a> handler)</pre>
<div class="block">Sets the handler to use when an external URL is clicked in the
description window. This handler can perform some action, such as
open the URL in a web browser. The default implementation will open
the URL in a browser, but only if running in Java 6. If you want
browser support for Java 5 and below, or otherwise want to respond to
hyperlink clicks, you will have to install your own handler to do so.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>handler</code> - The new handler.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/fife/ui/autocomplete/AutoCompletion.html#getExternalURLHandler()"><code>getExternalURLHandler()</code></a></dd></dl>
</li>
</ul>
<a name="setLinkRedirector(org.fife.ui.autocomplete.LinkRedirector)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setLinkRedirector</h4>
<pre>public static void setLinkRedirector(<a href="../../../../org/fife/ui/autocomplete/LinkRedirector.html" title="interface in org.fife.ui.autocomplete">LinkRedirector</a> linkRedirector)</pre>
<div class="block">Sets the redirector for external URL's found in code completion
documentation. When a non-local link in completion popups is clicked,
this redirector is given the chance to modify the URL fetched and
displayed.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>linkRedirector</code> - The link redirector, or <code>null</code> for
none.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/fife/ui/autocomplete/AutoCompletion.html#getLinkRedirector()"><code>getLinkRedirector()</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> renderer)</pre>
<div class="block">Sets the default list cell renderer to use when a completion provider
does not supply its own.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>renderer</code> - The renderer to use. If this is <code>null</code>,
a default renderer is used.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/fife/ui/autocomplete/AutoCompletion.html#getListCellRenderer()"><code>getListCellRenderer()</code></a></dd></dl>
</li>
</ul>
<a name="setParamChoicesRenderer(javax.swing.ListCellRenderer)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setParamChoicesRenderer</h4>
<pre>public void setParamChoicesRenderer(<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 for <a href="../../../../org/fife/ui/autocomplete/Completion.html" title="interface in org.fife.ui.autocomplete"><code>Completion</code></a>s in the optional
parameter choices popup window (displayed when a
<a href="../../../../org/fife/ui/autocomplete/ParameterizedCompletion.html" title="interface in org.fife.ui.autocomplete"><code>ParameterizedCompletion</code></a> is code-completed). If this isn't set,
a default renderer is used.</div>
<dl><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/AutoCompletion.html#getParamChoicesRenderer()"><code>getParamChoicesRenderer()</code></a>,
<a href="../../../../org/fife/ui/autocomplete/AutoCompletion.html#setParameterAssistanceEnabled(boolean)"><code>setParameterAssistanceEnabled(boolean)</code></a></dd></dl>
</li>
</ul>
<a name="setParameterAssistanceEnabled(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setParameterAssistanceEnabled</h4>
<pre>public void setParameterAssistanceEnabled(boolean enabled)</pre>
<div class="block">Sets whether parameter assistance is enabled. If parameter assistance
is enabled, and a "parameterized" completion (such as a function or
method) is inserted, the user will get "assistance" in inserting the
parameters in the form of a popup window with documentation and easy
tabbing through the arguments (as seen in Eclipse and NetBeans).</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>enabled</code> - Whether parameter assistance should be enabled.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/fife/ui/autocomplete/AutoCompletion.html#isParameterAssistanceEnabled()"><code>isParameterAssistanceEnabled()</code></a></dd></dl>
</li>
</ul>
<a name="setShowDescWindow(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setShowDescWindow</h4>
<pre>public void setShowDescWindow(boolean show)</pre>
<div class="block">Sets whether the "description window" should be shown beside the
completion window.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>show</code> - Whether to show the description window.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/fife/ui/autocomplete/AutoCompletion.html#getShowDescWindow()"><code>getShowDescWindow()</code></a></dd></dl>
</li>
</ul>
<a name="setTriggerKey(javax.swing.KeyStroke)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTriggerKey</h4>
<pre>public void setTriggerKey(<a href="file:///usr/share/doc/default-jdk-doc/api/javax/swing/KeyStroke.html?is-external=true" title="class or interface in javax.swing">KeyStroke</a> ks)</pre>
<div class="block">Sets the keystroke that should be used to trigger the auto-complete
popup window.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>ks</code> - The keystroke.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - If <code>ks</code> is <code>null</code>.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/fife/ui/autocomplete/AutoCompletion.html#getTriggerKey()"><code>getTriggerKey()</code></a></dd></dl>
</li>
</ul>
<a name="uninstall()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>uninstall</h4>
<pre>public void uninstall()</pre>
<div class="block">Uninstalls this auto-completion from its text component. If it is not
installed on any text component, nothing happens.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/fife/ui/autocomplete/AutoCompletion.html#install(javax.swing.text.JTextComponent)"><code>install(JTextComponent)</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/AbstractCompletionProvider.CaseInsensitiveComparator.html" title="class in org.fife.ui.autocomplete"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/fife/ui/autocomplete/AutoCompletionStyleContext.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/AutoCompletion.html" target="_top">Frames</a></li>
<li><a href="AutoCompletion.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>Field | </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>Field | </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>
|