CompletionUtilities.CompletionItemBuilder (Editor Code Completion)

java.lang.Object
- org.netbeans.spi.editor.completion.support.CompletionUtilities.CompletionItemBuilder

Enclosing class:: CompletionUtilities

public static final class CompletionUtilities.CompletionItemBuilder
extends Object

Builder for simple CompletionItem instances.
Example usage:

 CompletionUtilities.newCompletionItemBuilder(insertText)
                    .startOffset(offset)
                    .iconResource(iconPath)
                    .leftHtmlText("" + label + "")
                    .sortPriority(10)
                    .sortText(label)
                    .build();

Since:: 1.60

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CompletionItem`	`build()` Builds completion item.
`CompletionUtilities.CompletionItemBuilder`	`documentationTask(java.util.function.Supplier<CompletionTask> task)` A task used to obtain a documentation associated with the item if there is any.
`CompletionUtilities.CompletionItemBuilder`	`endOffset(int offset)` Start offset of the region to be removed on the item's selection.
`CompletionUtilities.CompletionItemBuilder`	`iconResource(String iconResource)` Resource path of the icon.
`CompletionUtilities.CompletionItemBuilder`	`insertText(String insertText)` A text to be inserted into a document when selecting the item.
`CompletionUtilities.CompletionItemBuilder`	`leftHtmlText(String leftHtmlText)` An html text that will be displayed on the left side of the item next to the icon.
`CompletionUtilities.CompletionItemBuilder`	`onSelect(java.util.function.Consumer<CompletionUtilities.OnSelectContext> callback)` A callback to process the item insertion.
`CompletionUtilities.CompletionItemBuilder`	`rightHtmlText(String rightHtmlText)` An html text that will be aligned to the right edge of the item.
`CompletionUtilities.CompletionItemBuilder`	`sortPriority(int sortPriority)` Item's priority.
`CompletionUtilities.CompletionItemBuilder`	`sortText(CharSequence sortText)` A text used to sort items alphabetically.
`CompletionUtilities.CompletionItemBuilder`	`startOffset(int offset)` Start offset of the region to be removed on the item's selection.
`CompletionUtilities.CompletionItemBuilder`	`tooltipTask(java.util.function.Supplier<CompletionTask> task)` A task used to obtain a tooltip hint associated with the item if there is any.

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

- Method Detail
  - insertText
```
public CompletionUtilities.CompletionItemBuilder insertText(String insertText)
```
    A text to be inserted into a document when selecting the item.
    
    Since:
    
    1.60
  - startOffset
```
public CompletionUtilities.CompletionItemBuilder startOffset(int offset)
```
    Start offset of the region to be removed on the item's selection. If omitted, the caret offset would be used.
    
    Since:
    
    1.60
  - endOffset
```
public CompletionUtilities.CompletionItemBuilder endOffset(int offset)
```
    Start offset of the region to be removed on the item's selection. If omitted, the caret offset would be used.
    
    Since:
    
    1.60
  - iconResource
```
public CompletionUtilities.CompletionItemBuilder iconResource(String iconResource)
```
    Resource path of the icon. It may be null which means that no icon will be displayed.
    
    Since:
    
    1.60
  - leftHtmlText
```
public CompletionUtilities.CompletionItemBuilder leftHtmlText(String leftHtmlText)
```
    An html text that will be displayed on the left side of the item next to the icon. If omitted, insertText would be used instead.
    
    Since:
    
    1.60
  - rightHtmlText
```
public CompletionUtilities.CompletionItemBuilder rightHtmlText(String rightHtmlText)
```
    An html text that will be aligned to the right edge of the item.
    
    Since:
    
    1.60
  - sortPriority
```
public CompletionUtilities.CompletionItemBuilder sortPriority(int sortPriority)
```
    Item's priority. A lower value means a lower index of the item in the completion result list.
    
    Since:
    
    1.60
  - sortText
```
public CompletionUtilities.CompletionItemBuilder sortText(CharSequence sortText)
```
    A text used to sort items alphabetically. If omitted, insertText would be used instead.
    
    Since:
    
    1.60
  - documentationTask
```
public CompletionUtilities.CompletionItemBuilder documentationTask(java.util.function.Supplier<CompletionTask> task)
```
    A task used to obtain a documentation associated with the item if there is any.
    
    Since:
    
    1.60
  - tooltipTask
```
public CompletionUtilities.CompletionItemBuilder tooltipTask(java.util.function.Supplier<CompletionTask> task)
```
    A task used to obtain a tooltip hint associated with the item if there is any.
    
    Since:
    
    1.60
  - onSelect
```
public CompletionUtilities.CompletionItemBuilder onSelect(java.util.function.Consumer<CompletionUtilities.OnSelectContext> callback)
```
    A callback to process the item insertion. Should be used for complex cases when a simple insertText insertion is not sufficient.
    
    Since:
    
    1.60
  - build
```
public CompletionItem build()
```
    Builds completion item.
    
    Since:
    
    1.60

Class CompletionUtilities.CompletionItemBuilder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

insertText

startOffset

endOffset

iconResource

leftHtmlText

rightHtmlText

sortPriority

sortText

documentationTask

tooltipTask

onSelect

build