Listener interface for passing the query results.
Sort type returned from {@link #getSortType()} that prefers priority of the item ({@link CompletionItem#getSortPriority()}) over the text of the item ({@link CompletionItem#getSortText()}).
Sort type returned from {@link #getSortType()} that prefers text of the item ({@link CompletionItem#getSortText()}). over the priority of the item ({@link CompletionItem#getSortPriority()})
Add the collection of the completion items to this result set.
This method can be called multiple times until
all the items have been added to ths result set.
After the adding is completed @link #finish()} must be called to confirm
that the result set will no longer be modified.
Add the completion item to this result set.
This method can be called multiple times until
all the items have been added to ths result set.
After the adding is completed @link #finish()} must be called to confirm
that the result set will no longer be modified.
Indicate that adding of the items to this result set
will likely need a long time so the resulting number of items
and their visual size should be estimated so that
the completion infrastructure can estimate the size
of the popup window and display the items added subsequently
without changing its bound extensively.
Without calling of this method the completion infrastructure
will wait until {@link #finish()} gets called on this result set
before displaying any of the items added to this result set.
By calling of this method the task also confirms that the items added by {@link #addItem(CompletionItem)} subsequently are already in the order corresponding to the {@link #getSortType()}.
Mark that this result set is finished and there will be no more modifications done to it.
Get the sort type currently used by the code completion.
It's one of the {@link #PRIORITY_SORT_TYPE} or {@link #TEXT_SORT_TYPE}.
Check whether this result set is finished.
Set the document offset to which the returned completion items
or documentation or tooltip should be anchored.
If there will be multiple completion providers setting this property
for the given mime-type then only the first one
(according to the xml-layer registration order)
will be taken into account.
Set the documentation to this result set.
Calling this method is only relevant for tasks
created by {@link CompletionProvider#createTask(int, javax.swing.text.JTextComponent)}
with {@link CompletionProvider#DOCUMENTATION_QUERY_TYPE}
or for {@link CompletionItem#createDocumentationTask()}.
Indicate that additional items could be added to this result set. However,
adding of these items will likely need a long time to complete so it is
preferred to add them only on the special code completion invocation
denoted by {@link CompletionProvider#COMPLETION_ALL_QUERY_TYPE}.
Calling this method is relevant only for tasks
created by {@link CompletionProvider#createTask(int, javax.swing.text.JTextComponent)}
with {@link CompletionProvider#COMPLETION_QUERY_TYPE}.
Set title that will be assigned to the completion popup window.
It's only relevant to set the title when providing completion items
for {@link CompletionProvider#COMPLETION_QUERY_TYPE}.
If there will be multiple completion providers setting this property
for the given mime-type then only the first one
(according to the xml-layer registration order)
will be taken into account.
Set the tooltip to this result set.
Calling this method is only relevant for tasks
created by {@link CompletionProvider#createTask(int, javax.swing.text.JTextComponent)}
with {@link CompletionProvider#TOOLTIP_QUERY_TYPE}
or for {@link CompletionItem#createToolTipTask()}.
Set the explicit value displayed in a label when the completion results
do not get computed during a certain timeout (e.g. 250ms).
If not set explicitly the completion infrastructure will use
the default text.
null can be passed
to restore using of the default text.