CompletionResultSet (Editor Code Completion)

java.lang.Object
- org.netbeans.spi.editor.completion.CompletionResultSet

```
public final class CompletionResultSet
extends Object
```
Listener interface for passing the query results.

See Also:

CompletionProvider.createTask(int, javax.swing.text.JTextComponent)

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`PRIORITY_SORT_TYPE` Sort type returned from `CompletionResultSet.getSortType()` that prefers priority of the item (`CompletionItem.getSortPriority()`) over the text of the item (`CompletionItem.getSortText()`).
`static int`	`TEXT_SORT_TYPE` Sort type returned from `CompletionResultSet.getSortType()` that prefers text of the item (`CompletionItem.getSortText()`).

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`addAllItems(Collection<? extends CompletionItem> items)` Add the collection of the completion items to this result set.
`boolean`	`addItem(CompletionItem item)` Add the completion item to this result set.
`void`	`estimateItems(int estimatedItemCount, int estimatedItemWidth)` 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.
`void`	`finish()` Mark that this result set is finished and there will be no more modifications done to it.
`int`	`getSortType()` Get the sort type currently used by the code completion.
`boolean`	`isFinished()` Check whether this result set is finished.
`void`	`setAnchorOffset(int anchorOffset)` Set the document offset to which the returned completion items or documentation or tooltip should be anchored.
`void`	`setDocumentation(CompletionDocumentation documentation)` Set the documentation to this result set.
`void`	`setHasAdditionalItems(boolean value)` Indicate that additional items could be added to this result set.
`void`	`setHasAdditionalItemsText(String text)` Set the text to be displayed in a completion popup whenever a `CompletionProvider` indicates that additional items could be added to this result set by passing `true` to `CompletionResultSet.setHasAdditionalItems(boolean)`.
`void`	`setTitle(String title)` Deprecated.
`void`	`setToolTip(JToolTip toolTip)` Set the tooltip to this result set.
`void`	`setWaitText(String waitText)` Set the explicit value displayed in a label when the completion results do not get computed during a certain timeout (e.g.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - PRIORITY_SORT_TYPE
```
public static final int PRIORITY_SORT_TYPE
```
    Sort type returned from CompletionResultSet.getSortType() that prefers priority of the item (CompletionItem.getSortPriority()) over the text of the item (CompletionItem.getSortText()).
    
    See Also:
    
    Constant Field Values
  - TEXT_SORT_TYPE
```
public static final int TEXT_SORT_TYPE
```
    Sort type returned from CompletionResultSet.getSortType() that prefers text of the item (CompletionItem.getSortText()). over the priority of the item (CompletionItem.getSortPriority())
    
    See Also:
    
    Constant Field Values
- Method Detail
  - setTitle
```
@Deprecated
public void setTitle(String title)
```
    Deprecated.
    
    Set title that will be assigned to the completion popup window.
    It's only relevant to set the title when providing completion items for 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.
  - setAnchorOffset
```
public void setAnchorOffset(int anchorOffset)
```
    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.
  - addItem
```
public boolean addItem(CompletionItem item)
```
    Add the completion item to this result set.
    This method can be called multiple times until all the items have been added to this result set.
    After the adding is completed @link #finish()} must be called to confirm that the result set will no longer be modified.
    
    Parameters:
    
    item - non-null completion item.
    
    Returns:
    
    true if adding of the items can continue or false if there is already too many items to be practical to display in the listbox so subsequent adding should preferably be discontinued.
  - addAllItems
```
public boolean addAllItems(Collection<? extends CompletionItem> items)
```
    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 this result set.
    After the adding is completed @link #finish()} must be called to confirm that the result set will no longer be modified.
    
    Parameters:
    
    items - collection of items to be added.
    
    Returns:
    
    true if adding of the items can continue or false if there is already too many items to be practical to display in the listbox so subsequent adding should preferably be discontinued.
  - estimateItems
```
public void estimateItems(int estimatedItemCount,
                          int estimatedItemWidth)
```
    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 CompletionResultSet.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 CompletionResultSet.addItem(CompletionItem) subsequently are already in the order corresponding to the CompletionResultSet.getSortType().
    
    Parameters:
    
    estimatedItemCount - estimated number of the items that will be added to this result set by CompletionResultSet.addItem(CompletionItem). If the estimate is significantly lower than the reality then the vertical scrollbar granularity may be decreased or the vertical scrollbar can be removed completely once the result set is finished. If the estimate is significantly higher than the reality then the vertical scrollbar granularity may be increased once the result set is finished.
    
    estimatedItemWidth - estimated maximum visual width of a completion item.
  - setHasAdditionalItems
```
public void setHasAdditionalItems(boolean value)
```
    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 CompletionProvider.COMPLETION_ALL_QUERY_TYPE.
    Calling this method is relevant only for tasks created by CompletionProvider.createTask(int, javax.swing.text.JTextComponent) with CompletionProvider.COMPLETION_QUERY_TYPE.
  - setHasAdditionalItemsText
```
public void setHasAdditionalItemsText(String text)
```
    Set the text to be displayed in a completion popup whenever a CompletionProvider indicates that additional items could be added to this result set by passing true to CompletionResultSet.setHasAdditionalItems(boolean).
    
    Parameters:
    
    text - the text that will be directly prepend to the "Press 'Ctrl-Space' Again for All Items" message in the completion popup. The text should end with a separator (e.g. space, semicolon and space, etc.) that will separate it from the rest of the displayed message. null can be passed to revert any previous setting of the text.
    
    Since:
    
    1.11
  - setDocumentation
```
public void setDocumentation(CompletionDocumentation documentation)
```
    Set the documentation to this result set.
    Calling this method is only relevant for tasks created by CompletionProvider.createTask(int, javax.swing.text.JTextComponent) with CompletionProvider.DOCUMENTATION_QUERY_TYPE or for CompletionItem.createDocumentationTask().
  - setToolTip
```
public void setToolTip(JToolTip toolTip)
```
    Set the tooltip to this result set.
    Calling this method is only relevant for tasks created by CompletionProvider.createTask(int, javax.swing.text.JTextComponent) with CompletionProvider.TOOLTIP_QUERY_TYPE or for CompletionItem.createToolTipTask().
  - finish
```
public void finish()
```
    Mark that this result set is finished and there will be no more modifications done to it.
  - isFinished
```
public boolean isFinished()
```
    Check whether this result set is finished.
    
    Returns:
    
    true if the result set is already finished by previous call to CompletionResultSet.finish().
  - getSortType
```
public int getSortType()
```
    Get the sort type currently used by the code completion.
    It's one of the CompletionResultSet.PRIORITY_SORT_TYPE or CompletionResultSet.TEXT_SORT_TYPE.
  - setWaitText
```
public void setWaitText(String waitText)
```
    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.
    
    Parameters:
    
    waitText - description of what the query computation is currently (doing or waiting for).
    After previous explicit setting null can be passed to restore using of the default text.
    
    Since:
    
    1.5

Class CompletionResultSet

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PRIORITY_SORT_TYPE

TEXT_SORT_TYPE

Method Detail

setTitle

setAnchorOffset

addItem

addAllItems

estimateItems

setHasAdditionalItems

setHasAdditionalItemsText

setDocumentation

setToolTip

finish

isFinished

getSortType

setWaitText