Skip navigation links

Introduction

This document lists changes made to the Editor Code Completion API.


Index of APIs

Incompatible changes by date

Fuller descriptions of all changes can be found below (follow links).

Not all deprecations are listed here, assuming that the deprecated APIs continue to essentially work. For a full deprecation list, please consult the Javadoc.

All changes by date

Changes by version

These API specification versions may be used to indicate that a module requires a certain API feature in order to function. For example, if you see here a feature you need which is labelled 1.20, your manifest should contain in its main attributes the line:

OpenIDE-Module-Module-Dependencies: org.netbeans.modules.editor.completion/1 > 1.20

Changes by affected class


Details of all changes by API and date


Editor Code Completion API

Addition of optional CompletionItem.shouldSingleClickInvokeDefaultAction() method

Jan 20 '23; API spec. version: 1.65; made by: ebakke

CompletionItem.shouldSingleClickInvokeDefaultAction method was added to to indicate that a single mouse click on the CompletionItem in the completion list, rather than only a double-click, will invoke its default action. A default method is provided in the method which returns false, preserving the old behavior by default.

Addition of CompletionUtilities.newCompletionItemBuilder() method

Nov 26 '21; API spec. version: 1.60; made by: dbalek

CompletionUtilities.newCompletionItemBuilder() method was added to allow for creation of simple CompletionItems.

Addition of CompositeCompletionItem

Sep 24 '13; API spec. version: 1.38; made by: dbalek; issues: #236313

CompositeCompletionItem interface was added to allow for completion items containing possible sub-items.

Addition of CompletionResultSet.setHasAdditionalItemsText()

Feb 7 '08; API spec. version: 1.11; made by: dbalek; issues: #124351

void CompletionResultSet.setHasAdditionalItemsText(String text) was added to allow for customization of the text displayed in a completion popup whenever a CompletionProvider indicates that additional items could be added to the result set.

Addition of CompletionResultSet.setHasAdditionalItems()

Jun 27 '07; API spec. version: 1.9; made by: dbalek; issues: #104409

void CompletionResultSet.setHasAdditionalItems(boolean value) was added to indicate that some items could exist that will likely need a long time to be computed and added to the result set. It is preferred to add them on the special 'all' code completion invocation only.

Support for UI Gestures Collector

Apr 17 '07; API spec. version: 1.8; made by: dbalek

Adds few structured logging triggers to cooperate with the UI Gestures Collector.

Addition of CompletionResultSet.setWaitText()

Nov 8 '05; API spec. version: 1.5; made by: mmetelka; issues: #68235

void CompletionResultSet.setWaitText(String waitText) was added to allow customization of the text in the label displayed if the completion query results are not computed in certain timeout.

Adddition of CompletionItem.getInsertPrefix()

Nov 8 '05; API spec. version: 1.4; made by: mmetelka; issues: #68235

CharSequence CompletionItem.getInsertPrefix() was added.

Semantic change of CompletionTask.refresh()

Nov 8 '05; API spec. version: 1.3; made by: mmetelka; issues: #68235

CompletionTask.refresh(CompletionResultSet resultSet) now allows null parameter.
void AsyncCompletionQuery.preQueryUpdate(JTextComponent component) was added to reflect that in AsyncCompletionTask.

Editor Code Completion API created

Jul 27 '05; API spec. version: 1.1; made by: mmetelka; issues: #59388

Editor Code Completion API was created.