/usr/share/doc/libautocomplete-java/api/org/fife/ui/autocomplete/Completion.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 | <!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>Completion</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="Completion";
}
//-->
</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/BasicCompletion.html" title="class in org.fife.ui.autocomplete"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/fife/ui/autocomplete/CompletionCellRenderer.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/Completion.html" target="_top">Frames</a></li>
<li><a href="Completion.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>Constr | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </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="Interface Completion" class="title">Interface Completion</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a><<a href="../../../../org/fife/ui/autocomplete/Completion.html" title="interface in org.fife.ui.autocomplete">Completion</a>></dd>
</dl>
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><a href="../../../../org/fife/ui/autocomplete/ParameterizedCompletion.html" title="interface in org.fife.ui.autocomplete">ParameterizedCompletion</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../org/fife/ui/autocomplete/AbstractCompletion.html" title="class in org.fife.ui.autocomplete">AbstractCompletion</a>, <a href="../../../../org/fife/ui/autocomplete/BasicCompletion.html" title="class in org.fife.ui.autocomplete">BasicCompletion</a>, <a href="../../../../org/fife/ui/autocomplete/FunctionCompletion.html" title="class in org.fife.ui.autocomplete">FunctionCompletion</a>, <a href="../../../../org/fife/ui/autocomplete/MarkupTagCompletion.html" title="class in org.fife.ui.autocomplete">MarkupTagCompletion</a>, <a href="../../../../org/fife/ui/autocomplete/ShorthandCompletion.html" title="class in org.fife.ui.autocomplete">ShorthandCompletion</a>, <a href="../../../../org/fife/ui/autocomplete/TemplateCompletion.html" title="class in org.fife.ui.autocomplete">TemplateCompletion</a>, <a href="../../../../org/fife/ui/autocomplete/VariableCompletion.html" title="class in org.fife.ui.autocomplete">VariableCompletion</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">Completion</span>
extends <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a><<a href="../../../../org/fife/ui/autocomplete/Completion.html" title="interface in org.fife.ui.autocomplete">Completion</a>></pre>
<div class="block">Represents a completion choice. A <a href="../../../../org/fife/ui/autocomplete/CompletionProvider.html" title="interface in org.fife.ui.autocomplete"><code>CompletionProvider</code></a> returns lists
of objects implementing this interface. A <tt>Completion</tt> contains the
following information:
<ul>
<li>The text the user must (begin to) input for this to be a completion
choice.
<li>The text that will be filled in if the user chooses this completion.
Note that often, this is the same as the text the user must (begin to)
enter, but this doesn't have to be the case.
<li>Summary HTML that describes this completion. This is information that
can be displayed in a helper "tooltip"-style window beside the
completion list. This may be <code>null</code>. It may also be
lazily generated to cut down on memory usage.
<li>The <tt>CompletionProvider</tt> that returned this completion.
<li>Tool tip text that can be displayed when a mouse hovers over this
completion in a text component.
</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>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/fife/ui/autocomplete/AbstractCompletion.html" title="class in org.fife.ui.autocomplete"><code>AbstractCompletion</code></a></dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== 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>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/fife/ui/autocomplete/Completion.html#compareTo(org.fife.ui.autocomplete.Completion)">compareTo</a></strong>(<a href="../../../../org/fife/ui/autocomplete/Completion.html" title="interface in org.fife.ui.autocomplete">Completion</a> other)</code>
<div class="block">Compares this completion to another one lexicographically, ignoring
case.</div>
</td>
</tr>
<tr class="rowColor">
<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/Completion.html#getAlreadyEntered(javax.swing.text.JTextComponent)">getAlreadyEntered</a></strong>(<a href="file:///usr/share/doc/default-jdk-doc/api/javax/swing/text/JTextComponent.html?is-external=true" title="class or interface in javax.swing.text">JTextComponent</a> comp)</code>
<div class="block">Returns the portion of this completion that has already been entered
into the text component.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="file:///usr/share/doc/default-jdk-doc/api/javax/swing/Icon.html?is-external=true" title="class or interface in javax.swing">Icon</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/fife/ui/autocomplete/Completion.html#getIcon()">getIcon</a></strong>()</code>
<div class="block">Returns the icon to use for this completion.</div>
</td>
</tr>
<tr class="rowColor">
<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/Completion.html#getInputText()">getInputText</a></strong>()</code>
<div class="block">Returns the text that the user has to (start) typing for this completion
to be offered.</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/Completion.html#getProvider()">getProvider</a></strong>()</code>
<div class="block">Returns the provider that returned this completion.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/fife/ui/autocomplete/Completion.html#getRelevance()">getRelevance</a></strong>()</code>
<div class="block">Returns the "relevance" of this completion.</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/Completion.html#getReplacementText()">getReplacementText</a></strong>()</code>
<div class="block">Returns the text to insert as the result of this auto-completion.</div>
</td>
</tr>
<tr class="rowColor">
<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/Completion.html#getSummary()">getSummary</a></strong>()</code>
<div class="block">Returns the description of this auto-complete choice.</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/Completion.html#getToolTipText()">getToolTipText</a></strong>()</code>
<div class="block">Returns the tool tip text to display for mouse hovers over this
completion.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="compareTo(org.fife.ui.autocomplete.Completion)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>compareTo</h4>
<pre>int compareTo(<a href="../../../../org/fife/ui/autocomplete/Completion.html" title="interface in org.fife.ui.autocomplete">Completion</a> other)</pre>
<div class="block">Compares this completion to another one lexicographically, ignoring
case.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Comparable.html?is-external=true#compareTo(T)" title="class or interface in java.lang">compareTo</a></code> in interface <code><a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a><<a href="../../../../org/fife/ui/autocomplete/Completion.html" title="interface in org.fife.ui.autocomplete">Completion</a>></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>other</code> - Another completion instance.</dd>
<dt><span class="strong">Returns:</span></dt><dd>How this completion compares to the other one.</dd></dl>
</li>
</ul>
<a name="getAlreadyEntered(javax.swing.text.JTextComponent)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAlreadyEntered</h4>
<pre><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> getAlreadyEntered(<a href="file:///usr/share/doc/default-jdk-doc/api/javax/swing/text/JTextComponent.html?is-external=true" title="class or interface in javax.swing.text">JTextComponent</a> comp)</pre>
<div class="block">Returns the portion of this completion that has already been entered
into the text component. The match is case-insensitive.<p>
This is a convenience method for:
<code>getProvider().getAlreadyEnteredText(comp)</code>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>comp</code> - The text component.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The already-entered portion of this completion.</dd></dl>
</li>
</ul>
<a name="getIcon()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIcon</h4>
<pre><a href="file:///usr/share/doc/default-jdk-doc/api/javax/swing/Icon.html?is-external=true" title="class or interface in javax.swing">Icon</a> getIcon()</pre>
<div class="block">Returns the icon to use for this completion.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The icon, or <code>null</code> for none.</dd></dl>
</li>
</ul>
<a name="getInputText()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInputText</h4>
<pre><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> getInputText()</pre>
<div class="block">Returns the text that the user has to (start) typing for this completion
to be offered. Note that this will usually be the same value as
<a href="../../../../org/fife/ui/autocomplete/Completion.html#getReplacementText()"><code>getReplacementText()</code></a>, but not always (a completion could be
a way to implement shorthand, for example, "<code>sysout</code>" mapping
to "<code>System.out.println(</code>").</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The text the user has to (start) typing for this completion to
be offered.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/fife/ui/autocomplete/Completion.html#getReplacementText()"><code>getReplacementText()</code></a></dd></dl>
</li>
</ul>
<a name="getProvider()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProvider</h4>
<pre><a href="../../../../org/fife/ui/autocomplete/CompletionProvider.html" title="interface in org.fife.ui.autocomplete">CompletionProvider</a> getProvider()</pre>
<div class="block">Returns the provider that returned this completion.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The provider.</dd></dl>
</li>
</ul>
<a name="getRelevance()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRelevance</h4>
<pre>int getRelevance()</pre>
<div class="block">Returns the "relevance" of this completion. This is used when sorting
completions by their relevance. It is an abstract concept that may
mean different things to different languages, and may depend on the
context of the completion.<p>
By default, all completions have a relevance of <code>0</code>. The
higher the value returned by this method, the higher up in the list
this completion will be; the lower the value returned, the lower it will
be. <code>Completion</code>s with equal relevance values will be
sorted alphabetically.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The relevance of this completion.</dd></dl>
</li>
</ul>
<a name="getReplacementText()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReplacementText</h4>
<pre><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()</pre>
<div class="block">Returns the text to insert as the result of this auto-completion. This
is the "complete" text, including any text that replaces what the user
has already typed.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The replacement text.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/fife/ui/autocomplete/Completion.html#getInputText()"><code>getInputText()</code></a></dd></dl>
</li>
</ul>
<a name="getSummary()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSummary</h4>
<pre><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> getSummary()</pre>
<div class="block">Returns the description of this auto-complete choice. This can be
used in a popup "description window."</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>This item's description. This should be HTML. It may be
<code>null</code> if there is no description for this
completion.</dd></dl>
</li>
</ul>
<a name="getToolTipText()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getToolTipText</h4>
<pre><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> getToolTipText()</pre>
<div class="block">Returns the tool tip text to display for mouse hovers over this
completion.<p>
Note that for this functionality to be enabled, a
<tt>JTextComponent</tt> must be registered with the
<tt>ToolTipManager</tt>, and the text component must know to search
for this value. In the case of an
<a href="http://fifesoft.com/rsyntaxtextarea">RSyntaxTextArea</a>, this
can be done with a <tt>org.fife.ui.rtextarea.ToolTipSupplier</tt> that
calls into
<a href="../../../../org/fife/ui/autocomplete/CompletionProvider.html#getCompletionsAt(javax.swing.text.JTextComponent, java.awt.Point)"><code>CompletionProvider.getCompletionsAt(JTextComponent, java.awt.Point)</code></a>.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The tool tip text for this completion, or <code>null</code> if
none.</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/BasicCompletion.html" title="class in org.fife.ui.autocomplete"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/fife/ui/autocomplete/CompletionCellRenderer.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/Completion.html" target="_top">Frames</a></li>
<li><a href="Completion.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>Constr | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
|