/plugins/TextAutocomplete/tags/RELEASE-0_9_5/TextAutocomplete.html

# · HTML · 454 lines · 391 code · 63 blank · 0 comment · 0 complexity · 264dc4cfaec03407cfa579d5574d96c3 MD5 · raw file 

    

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
    2. 

  2.       "http://www.w3.org/TR/html4/loose.dtd">
    3. 

  3. <html>
    4. 

  4. <head>
    5. 

  5.   <meta http-equiv="content-type" content="text/html; charset=UTF-8">
    6. 

  6.   <title>Plugin: TextAutocomplete - Docs</title>
    7. 

  7.   <meta name="generator" content="amaya 9.51, see http://www.w3.org/Amaya/">
    8. 

  8. </head>
    9. 

  9. 

  10. <body lang="en">
    11. 

  11. <h1>TextAutocomplete Plugin</h1>
    12. 

  12. 

  13. <p><strong>by Jakub Holý</strong></p>
    14. 

  14. <hr>
    15. 

  15. 

  16. <h2>Table of Contents</h2>
    17. 

  17. 

  18. <div class="toc">
    19. 

  19. <ul>
    20. 

  20.   <li><a href="#About">About</a></li>
    21. 

  21.   <li><a href="#Words">Words, completions</a> and how does it work</li>
    22. 

  22.   <li><a href="#Control">Control keys</a> of the completions pop-up
    23. 

  23.   window</li>
    24. 

  24.   <li><a href="#Menu">Menu</a></li>
    25. 

  25.   <li><a href="#Options">Options</a></li>
    26. 

  26.   <li><a href="#Accessing">Accessing the plugin from BeanShell</a></li>
    27. 

  27.   <li><a href="#Development">Development</a>
    28. 

  28.     <ul>
    29. 

  29.       <li><a href="#Feedback">Feedback</a></li>
    30. 

  30.       <li><a href="#Wish">Wish list</a></li>
    31. 

  31.       <li><a href="#Change">Change Log</a></li>
    32. 

  32.       <li><a href="#Overview">Overview of the Classes</a></li>
    33. 

  33.       <li><a href="#Working">How does it work?</a></li>
    34. 

  34.     </ul>
    35. 

  35.   </li>
    36. 

  36.   <li><a href="#License">License</a></li>
    37. 

  37. </ul>
    38. 

  38. </div>
    39. 

  39. 

  40. <h2><a name="About">About</a></h2>
    41. 

  41. 

  42. <p>TextAutocomplete collects "words" in the current buffer and those that you
    43. 

  43. type and offers you automatically a list of possible completions. It's pretty
    44. 

  44. similar to the jEdit's function "Complete Word" but it's automatic, you don't
    45. 

  45. need to press any key to invoke the list of completions. Contrary to
    46. 

  46. "Complete Word" it doesn't search the buffer every time for possible
    47. 

  47. completions. Instead of that it keeps a list of remembered words (i.e.
    48. 

  48. possible completions) that is created by parsing the buffer at startup and is
    49. 

  49. updated with new words that you type. You can export (save), import and
    50. 

  50. modify the list of remembered words. The plugin was inspired by a similar
    51. 

  51. functionality in OpenOffice.org.</p>
    52. 

  52. 

  53. <p>The plugin is configurable, you can define what is a "word", what words
    54. 

  54. (not) to remember etc. - see below. It's also possible to modify manually the
    55. 

  55. list of remembered words.</p>
    56. 

  56. 

  57. <p>You must enable the autocompletion manually for every buffer where you
    58. 

  58. want it (Plugins - TextAutocomplete - Start for buffer). Alternatively, you
    59. 

  59. can enable the autocompletion for all buffers (Plugins - TextAutocomplete -
    60. 

  60. Start for all buffers) or set the plugin to start automatically for every new
    61. 

  61. buffer that you open (Plugins - Plugin Options... - TextAutocomplete - check
    62. 

  62. "Start autom. for new buffers").</p>
    63. 

  63. 

  64. <h2><a name="Words" id="Words">Words, completions and how does it
    65. 

  65. work</a></h2>
    66. 

  66. 

  67. <p>As described above, the plugin parses the buffer and what you type to find
    68. 

  68. and remember the words to offer as completions later on. But what is a word
    69. 

  69. and when/how is the list of completions offered?</p>
    70. 

  70. 

  71. <p>To consider a string as a word it must pass some tests - see the options
    72. 

  72. "Belongs to word?" and "Is word to remember?". The first one determines
    73. 

  73. whether the character typed may start/extend a word or whether it ends one,
    74. 

  74. i.e. whether it is a word separator or a word constituent. By default only
    75. 

  75. letters are regarded as constituting a word. The second option may be used to
    76. 

  76. limit what words are remembered as possible completions - by default we
    77. 

  77. ignore words shorter than determined by the option "Remember words long at
    78. 

  78. least".</p>
    79. 

    80. 

  80. <p>The pop-up window with completions appears when you type the beginning of
    81. 

  81. a word long enough (assuming there are some completions for that prefix). The
    82. 

  82. length is given by the option "Minimal prefix length". So, with the default
    83. 

  83. setting, you must type at least two letters before the completions may be
    84. 

  84. offered.</p>
    85. 

  85. 

  86. <p><a name="L590" id="L590"></a>The important thing to note is that even
    87. 

  87. though you can add arbitrary string to the list of remembered words (by
    88. 

  88. importing them from a file or by adding the string by means of the
    89. 

  89. "Remembered words" dialog), it will <em>never be offered as a completion</em>
    90. 

  90. unless it satisfies the condition for the pop-up completions window to turn
    91. 

  91. up, in other words it must start with a word that is at least as long as the
    92. 

  92. "Minimal prefix length" - under the default setting it must start with two
    93. 

  93. letters.</p>
    94. 

  94. 

  95. <p>Please be aware that the words are <em>case sensitive</em>, so
    96. 

  96. "Something", "something" and "someTHING" are three different words.</p>
    97. 

  97. 

  98. <h2><a name="Control">Control keys of the completions pop-up window</a></h2>
    99. 

  99. 

  100. <p>By default, the following keys may be used to control the completion
    101. 

  101. pop-up window:</p>
    102. 

  102. <ul>
    103. 

  103.   <li><kbd>Escape</kbd> - Cancel (dispose) the window.</li>
    104. 

  104.   <li><kbd>Enter</kbd>, <kbd>Tab</kbd> - Accept and insert the selected
    105. 

  105.     completion.</li>
    106. 

  106.   <li><kbd>Up arrow</kbd> - Select the completion above the currently
    107. 

  107.     selected one. It cycles through the list, so pressing Up on the first
    108. 

  108.     entry gets you to the last one.</li>
    109. 

  109.   <li><kbd>Down arrow</kbd> - Select the completion below the currently
    110. 

  110.     selected one. It cycles through the list.</li>
    111. 

  111.   <li>Numbers <kbd>0-9</kbd> - Accept and insert the completion with the
    112. 

  112.     given number. You may disable it if you want numbers to be treated as
    113. 

  113.     regular characters or you may set it so that &lt;a modifier key&gt; +
    114. 

  114.     number inserts a completion while number without the modifier is just
    115. 

  115.     appended to the current word.</li>
    116. 

  116. </ul>
    117. 

  117. 

  118. <h2><a name="Menu">Menu</a></h2>
    119. 

  119. <dl>
    120. 

  120.   <dt><strong>Start for buffer</strong></dt>
    121. 

  121.     <dd>Enable autocompletion for the current buffer. The buffer is parsed to
    122. 

  122.       collect the words that already exist in it.</dd>
    123. 

  123.   <dt><strong>Stop for buffer</strong></dt>
    124. 

  124.     <dd>Disable autocompletion for the current buffer and forget all
    125. 

  125.       remembered words.</dd>
    126. 

  126.   <dt><strong>Parse buffer</strong></dt>
    127. 

  127.     <dd>Scan the current buffer for words to remember and add them to the
    128. 

  128.       list of remembered words.</dd>
    129. 

  129.   <dt><strong>Show remembered words</strong></dt>
    130. 

  130.     <dd>Display the list of remember words that you can edit: <br>
    131. 

  131. 

  132.       <ol>
    133. 

  133.         <li><em>Add a word</em> typed in the text field; the string is
    134. 

  134.           remembered as is, even if normally it wouldn't be considered to be
    135. 

  135.           a word - but it should start as a word, see the <a
    136. 

  136.           href="#L590">explanation</a> above.</li>
    137. 

  137.         <li><em>Delete selected</em> - forgets the words you've selected in
    138. 

  138.           the list. To select multiple entries use Control+click.</li>
    139. 

  139.         <li><em>Delete all</em> - forget all remembered words. You can Parse
    140. 

  140.           buffer to get them back.<br>
    141. 

  141.         </li>
    142. 

  142.       </ol>
    143. 

  143.     </dd>
    144. 

  144.     <dd>Additionally, you can:
    145. 

  145.       <ol>
    146. 

  146.         <li><em>Import words</em> - read a file with previously saved words
    147. 

  147.           and add them to the list. One line is considered as one word and is
    148. 

  148.           added to the list "as is" even if it wouldn't normally be
    149. 

  149.           considered as a word - but it should start as a word, see the <a
    150. 

  150.           href="#L590">explanation</a> above.</li>
    151. 

  151.         <li><em>Export words</em> - save the remembered words into a file,
    152. 

  152.           one per line.</li>
    153. 

  153.       </ol>
    154. 

  154.     </dd>
    155. 

  155.   <dt><strong>Start for all buffers</strong></dt>
    156. 

  156.     <dd>Enable autocompletion for all currently opened buffers. (To detach
    157. 

  157.       from all buffers, open the Plugin Manager and under Manage uncheck and
    158. 

  158.       re-check the TextAutocomplete plugin.)</dd>
    159. 

  159.   <dt><strong>Stop for all buffers</strong></dt>
    160. 

  160.     <dd>Disable autocompletion for all buffers that have it enabled and
    161. 

  161.       forget all remembered words.</dd>
    162. 

  162. </dl>
    163. 

  163. 

  164. <h2 id="Options"><a name="Options">Options</a></h2>
    165. 

  165. 

  166. <p>It's possible to set some options that will apply to autocompletion in all
    167. 

  167. buffers.</p>
    168. 

  168. 

  169. <p>When you put the mouse pointer above some of the text field on the option
    170. 

  170. page and wait for a while, a tool tip with more detailed description will
    171. 

  171. show up.</p>
    172. 

  172. <dl>
    173. 

  173.   <dt>Start autom. for new buffers</dt>
    174. 

  174.     <dd>Enable autocompletion for every new buffer that you will open from
    175. 

  175.       that moment on.<br>
    176. 

  176.       Default: Off</dd>
    177. 

  177.   <dt>Filename filters</dt>
    178. 

  178.     <dd>Specify filename glob patterns to be included or excluded from
    179. 

  179.       autocompletion.<br>
    180. 

  180.       Default: Include all files</dd>
    181. 

  181. </dl>
    182. 

  182. 

  183. <p>The following options influence words and completions.</p>
    184. 

  184. <dl>
    185. 

  185.   <dt>Remember at max. words</dt>
    186. 

  186.     <dd>The maximal number of words that should be remembered as potential
    187. 

  187.       completions. Notice, that completions are only offered based on the
    188. 

  188.       list of remembered words.<br>
    189. 

  189.       Default: 1000</dd>
    190. 

  190.   <dt>Minimal prefix length</dt>
    191. 

  191.     <dd>Don't offer possible completions until at least the given number of
    192. 

  192.       characters have been typed.</dd>
    193. 

  193.     <dd>Default: 2.</dd>
    194. 

  194.   <dt>Remember words long at least</dt>
    195. 

  195.     <dd>Don't remember words shorter than the given value.</dd>
    196. 

  196.     <dd>Default: 5.</dd>
    197. 

  197. </dl>
    198. 

  198. 

  199. <p>Value of the following properties is a beanshell expression that evaluates
    200. 

  200. to either true or false. It can make use of special variables - see below. If
    201. 

  201. the code isn't correct, BeanShell will throw an exception when it is first
    202. 

  202. executed so you should make sure that it is all right; than it reverts to the
    203. 

  203. default setting to prevent repetitions of the same error. The description of
    204. 

  204. such an exception will mention either PreferencesManager.precompileCode or
    205. 

  205. PreferencesManager.executeCachedCode and either the method accept (for
    206. 

  206. "Belongs to word?") or isWordToRemember. The expression must be valid Java
    207. 

  207. expression, so it should end with a semicolon.</p>
    208. 

  208. <dl>
    209. 

  209.   <dt>Is word to remember? [code]</dt>
    210. 

  210.     <dd>Return true if the word that has just been typed should be
    211. 

  211.       remembered. In addition to that, the word must also be at least as long
    212. 

  212.       as required by "Remember words long at least". The variable
    213. 

  213.       <code>word</code> (String) holds the word in question.</dd>
    214. 

  214.     <dd>Example: <code>! word.startsWith("X");</code></dd>
    215. 

  215.     <dd>Default: always true</dd>
    216. 

  216.   <dt>Belongs to word? [code]</dt>
    217. 

  217.     <dd>Return true when the insertion (the typed character) doesn't end the
    218. 

  218.       word being typed, in other words, it must return false for word
    219. 

  219.       separators. The available variables are <var>prefix</var> (String; the
    220. 

  220.       word that has been typed so far) and <var>insertion</var> (char; the
    221. 

  221.       newly typed character). This determines what is considered as a word
    222. 

  222.       while the previous option determines whether something, that is already
    223. 

  223.       considered to be a word, should be remembered or not.</dd>
    224. 

  224.     <dd>Example: <code>Character.isLetterOrDigit(insertion) || insertion ==
    225. 

  225.       '_' || (prefix.startsWith("&lt;") &amp;&amp; prefix.indexOf("&gt;") ==
    226. 

  226.       -1);</code> // alphanumeric string or anything between &lt; and
    227. 

  227.     &gt;</dd>
    228. 

  228.     <dd>Default: <code>Character.isLetter(insertion);</code></dd>
    229. 

  229. </dl>
    230. 

  230. 

  231. <p>Use the following properties to change the <a href="#Control">default
    232. 

  232. control keys</a> (see above). All of them take a list of keys separated by a
    233. 

  233. single space or by a comma. A key is represented by the name of one of the
    234. 

  234. constants of the class <a
    235. 

  235. href="http://java.sun.com/j2se/1.4.2/docs/api/index.html">java.awt.event.KeyEvent</a>
    236. 

  236. that start with the prefix "VK_". You can only use special keys, that means
    237. 

  237. keys that don't produce a character. It includes VK_ENTER, VK_ESCAPE,
    238. 

  238. VK_BACK_SPACE, VK_DELETE, VK_F1 etc., VK_TAB, VK_UP, VK_DOWN and others.</p>
    239. 

  239. <dl>
    240. 

  240.   <dt>Accept with key</dt>
    241. 

  241.     <dd>Accept and insert the currently selected completion.</dd>
    242. 

  242.     <dd>Default: VK_ENTER,VK_TAB</dd>
    243. 

  243.   <dt>Dispose with key</dt>
    244. 

  244.     <dd>Hide the window with completions.</dd>
    245. 

  245.     <dd>Default: VK_ESCAPE</dd>
    246. 

  246.   <dt>Up in completions key</dt>
    247. 

  247.     <dd>Select the completion above.</dd>
    248. 

  248.     <dd>Default: VK_UP</dd>
    249. 

  249.   <dt>Down in completions key</dt>
    250. 

  250.     <dd>Select the completion below.</dd>
    251. 

  251.     <dd>Default: VK_DOWN</dd>
    252. 

  252.   <dt>Select compl. by number</dt>
    253. 

  253.     <dd>If checked, pressing a number inserts the completion with that index.
    254. 

  254.       If unchecked, the number is just inserted as an ordinary character.<br>
    255. 

  255.       Default: Checked (i.e. enabled)</dd>
    256. 

  256.   <dt>Select by number modifier</dt>
    257. 

  257.     <dd>If you press the selected modifier key + a number, the completion
    258. 

  258.       with that index is inserted. If you press only the number, it's
    259. 

  259.       inserted into the buffer. Note: Some of the modifiers may not work for
    260. 

  260.       you. There are reports of problems with AltGr.<br>
    261. 

  261.       Default: None (no modifier key, pressing the number inserts the
    262. 

  262.       completion)</dd>
    263. 

  263. </dl>
    264. 

  264. 

  265. <p>The button <var>Reset options</var> resets them to the default values.</p>
    266. 

  266. 

  267. <h2><a name="Accessing" id="Accessing">Accessing the plugin from
    268. 

  268. BeanShell</a></h2>
    269. 

  269. 

  270. <p>If you know Java programming, you can access and control the plugin via
    271. 

  271. BeanShell - either by means of the Console plugin or from a macro.</p>
    272. 

  272. 

  273. <p>You can see the current options by calling the methods of
    274. 

  274. PreferencesManager, for example<br>
    275. 

  275. <code>net.jakubholy.jedit.autocomplete.PreferencesManager.getPreferencesManager().getMaxCountOfWords()</code><br>
    276. 

  276. To modify the options you'd need to set some properties (jEdit.setProperty) -
    277. 

  277. see the file TextAutocomplete.props within the plugin's .jar archive.</p>
    278. 

    279. 

  279. <p>You could also invoke the actions that are usually run from the menu - for
    280. 

  280. example
    281. 

  281. <code>net.jakubholy.jedit.autocomplete.AutoComplete.attachAction(buffer)</code>.</p>
    282. 

  282. 

  283. <p>To get the AutoComplete associated with the buffer, call
    284. 

  284. <code>net.jakubholy.jedit.autocomplete.getAutoCompleteOfBuffer(buffer)</code>.
    285. 

  285. If it returns null, you must attach one first.</p>
    286. 

  286. 

  287. <p>See the JavaDoc for <a
    288. 

  288. href="docs/javadocs/net/jakubholy/jedit/autocomplete/AutoComplete.html">AutoComplete</a>,
    289. 

  289. <a
    290. 

  290. href="docs/javadocs/net/jakubholy/jedit/autocomplete/PreferencesManager.html">PreferencesManager</a>,
    291. 

  291. <a
    292. 

  292. href="docs/javadocs/net/jakubholy/jedit/autocomplete/WordList.html">WordList</a>,
    293. 

  293. <a
    294. 

  294. href="docs/javadocs/net/jakubholy/jedit/autocomplete/Completion.html">Completion</a>
    295. 

  295. and <a
    296. 

  296. href="docs/javadocs/net/jakubholy/jedit/autocomplete/TextAutocompletePlugin.html">TextAutocompletePlugin</a>
    297. 

  297. included with this plugin or download the plugins's source with the full API
    298. 

  298. JavaDoc. You can also browse the plugin's source files via Source Forge's web
    299. 

  299. interface to the <a
    300. 

  300. href="http://cvs.sourceforge.net/viewcvs.py/jedit/plugins/TextAutocomplete/net/jakubholy/jedit/autocomplete/">CVS</a>
    301. 

  301. repository.</p>
    302. 

  302. 

  303. <h2><a name="Development">Development</a></h2>
    304. 

  304. 

  305. <h3><a name="Feedback">Feedback</a></h3>
    306. 

  306. 

  307. <p>The preferred way to send bug reports is to use the Sourceforge Bug
    308. 

  308. Tracker at <a
    309. 

  309. href="http://sourceforge.net/bugs/?group_id=588">http://sourceforge.net/bugs/?group_id=588</a>
    310. 

  310. and also notify me by e-mail.</p>
    311. 

  311. 

  312. <p>You can also write to:</p>
    313. 

  313. 

  314. <p>Jakub Holý alias MalyVelky &lt;malyvelky@users.sourceforge.net&gt;;</p>
    315. 

  315. 

  316. <p>If you find a bug, help to discover it by switching on verbose logging for
    317. 

  317. the plugin - execute the following BeanShell code (paste it into a new
    318. 

  318. buffer, select it and execute it via Utilities &gt; BeanShell &gt; Evaluate
    319. 

  319. Selection):</p>
    320. 

  320. <code>jEdit.setIntegerProperty("plugin.net.jakubholy.jedit.autocomplete.TextAutocompletePlugin.logLevel",2)</code>
    321. 

  321. 

  322. <p>You will need to either reload the plugin or restart jEdit to activate the
    323. 

  323. change. (WordTypedListener reads the log level only upon its creation.) Look
    324. 

  324. for the logs starting with "TextAutocompletePlugin:" in Utilities &gt;
    325. 

  325. Troubleshooting &gt; Activity Log. To disable the logging again, execute:</p>
    326. 

  326. <code>jEdit.setIntegerProperty("plugin.net.jakubholy.jedit.autocomplete.TextAutocompletePlugin.logLevel",0)</code>
    327. 

  327. 

  328. <p>And reload/restart.</p>
    329. 

  329. 

  330. <h3><a name="Wish">Wish list</a></h3>
    331. 

  331. <ul>
    332. 

  332.   <li>Make it possible to start with a default word list (read from a file, same for all buffers)</li>
    333. 

  333.   <li>Options - check that the beanshell expressions are ok before the
    334. 

  334.     preferences are saved</li>
    335. 

  335.   <li>Allow for the insertion of longer texts after a prefix (so far only 1
    336. 

  336.     character can be inserted/typed)</li>
    337. 

  337.   <li>Support the insertion of the "longest common suffix" of two or more
    338. 

  338.     completions (typed: "co", possible completions: community, communist
    339. 

  339.     =&gt; insert (co)mmuni)</li>
    340. 

  340.   <li>Option to show the completion popup only after a period of inactivity
    341. 

  341.     (e.g. when the user stops typing for 2 seconds).</li>
    342. 

  342. </ul>
    343. 

  343. 

  344. <h3><a name="Change">Change Log</a></h3>
    345. 

  345. 

  346. <h4>Version 0.9.4, October 2006</h4>
    347. 

  347. 

  348. <p>Added the possibility to disable selection of a completion by number or to
    349. 

  349. require a modifier key together with the number.</p>
    350. 

  350. 

  351. <h4>Version 0.9.3, May 2006</h4>
    352. 

  352. 

  353. <p>Added handling of backspace.</p>
    354. 

  354. 

  355. <p>Development: added unit tests, corrections of the code (thanks to
    356. 

  356. JUnit!).</p>
    357. 

  357. 

  358. <h4>Version 0.9.2, April 2006</h4>
    359. 

  359. 

  360. <p>This is a bug fixes and enhancement release. Additionally, the plugin has
    361. 

  361. been updated for jEdit 4.3pre3.</p>
    362. 

  362. 

  363. <p>Bug fixes:</p>
    364. 

  364. <ul>
    365. 

  365.   <li>Prevent the cursor from switching buffer/view: When you edited one or
    366. 

  366.     two file(s) in a split view, it sometimes happened that you started
    367. 

  367.     writing in one and suddenly the cursor jumped into the another. This
    368. 

  368.     should be now fixed (We prefer jEdit.getActiveView over the remembered
    369. 

  369.     view). I'd like to thank Jeremias, who discovered the bug.</li>
    370. 

  370. </ul>
    371. 

  371. 

  372. <p>New features:</p>
    373. 

  373. <ul>
    374. 

  374.   <li>Start for all opened buffers and Stop for all opened buffers</li>
    375. 

  375.   <li>Start automatically for new buffers</li>
    376. 

  376.   <li>The number of remembered words is now limited to 1000, the limit may be
    377. 

  377.     changed.</li>
    378. 

  378.   <li>It's now possible to export/import (append) the list of remembered
    379. 

  379.     words.</li>
    380. 

  380. </ul>
    381. 

  381. 

  382. <h4 id="Version">Version 0.9, May 2006</h4>
    383. 

  383. 

  384. <p>Initial release.</p>
    385. 

  385. 

  386. <h3><a name="Overview">Overview of the Classes</a></h3>
    387. 

  387. 

  388. <p>Core classes:</p>
    389. 

  389. <ul>
    390. 

  390.   <li>AutoComplete - ties together all the core classes: registers a
    391. 

  391.     WordTypedListener for the buffer, stores the words into a WordList and
    392. 

  392.     displays a CompletionPopup window with the possible completions. It keeps
    393. 

  393.     the map (buffer to its autocompletion instance).</li>
    394. 

  394.   <li>PreferencesManager - handles options; other classes use its methods and
    395. 

  395.     do not access the preferences directly. Only one instance exists.</li>
    396. 

  396.   <li>CompletionPopup - Pop-up window with completions of the word being
    397. 

  397.     typed. It intercepts keys and handles the control keys.</li>
    398. 

  398.   <li>WordList [interface] - structure for storage of the words (more exactly
    399. 

  399.     completions) to remember.</li>
    400. 

  400.   <li>WordListTreeSet - a concrete implementation of the WordList.</li>
    401. 

  401.   <li>WordTypedListener - it listens to what keys are typed in the buffer and
    402. 

  402.     notifies others (the AutoComplete) about such events as a character being
    403. 

  403.     appended to a word and the end of a word.</li>
    404. 

  404. </ul>
    405. 

  405. 

  406. <p>GUI classes:</p>
    407. 

  407. <ul>
    408. 

  408.   <li>TextAutocompletePlugin - implements jEdit plugin.</li>
    409. 

  409.   <li>TextAutocompletePane - the Option pane.</li>
    410. 

  410.   <li>WordListEditorUI - the editor of remembered words.</li>
    411. 

  411. </ul>
    412. 

  412. 

  413. <p>Helper classes</p>
    414. 

  414. <ul>
    415. 

  415.   <li>Completion - the structure used to keep a word to remember. Using it
    416. 

  416.     instead of a string enables us to add later on additional information to
    417. 

  417.     each word and, for instance, offer completions order with respect to the
    418. 

  418.     frequency of their occurrence.</li>
    419. 

  419.   <li>WordTypedEvent - produced by WordTypedListener to carry information
    420. 

  420.     about what's going on in the buffer.</li>
    421. 

  421.   <li>ActionException - thrown when some of the actions invoked via menu
    422. 

  422.     fails.</li>
    423. 

  423. </ul>
    424. 

  424. 

  425. <p>For more info see <a
    426. 

  426. href="http://jakubholy.net/comp/jedit.html">http://jakubholy.net/comp/jedit.html</a>.</p>
    427. 

  427. 

  428. <h3><a name="Working">How does it work?</a></h3>
    429. 

  429. 

  430. <p>A BufferListener (implemented by my WordTypedListener) is attached to the
    431. 

  431. buffer. When it detects an important event (a letter appended to a word, a
    432. 

  432. word ended...), it notifies the main class AutoComplete via the
    433. 

  433. Observer/Observable mechanism. It may then display (or dispose) a list of
    434. 

  434. completions. When the list of completions is displayed, it intercepts special
    435. 

  435. keys being pressed (such as Enter, Escape...) and reacts according to its
    436. 

  436. setting (hide itself, insert the selected completion...).</p>
    437. 

  437. 

  438. <h2><a name="License">License</a></h2>
    439. 

  439. 

  440. <p>This plugin is released under the GNU General Public License version 2
    441. 

  441. (GPL). Please see <a
    442. 

  442. href="http://www.fsf.org/copyleft/gpl.html">http://www.fsf.org/copyleft/gpl.html</a>.</p>
    443. 

  443. 

  444. <p>Moreover, permission is granted to copy, distribute and/or modify this
    445. 

  445. document under the terms of the GNU Free Documentation License, Version 1.1
    446. 

  446. or any later version published by the Free Software Foundation; with no
    447. 

  447. "Invariant Sections", "Front-Cover Texts" or "Back-Cover Texts", each as
    448. 

  448. defined in the license. A copy of the license can be found in the file
    449. 

  449. COPYING.DOC.txt included with jEdit.</p>
    450. 

  450. <hr>
    451. 

  451. 

  452. <p style="text-align:center">Jakub Holý 2006</p>
    453. 

  453. </body>
    454. 

  454. </html>
    455.