DefaultCompletionItem

java.lang.Object
- org.das2.jythoncompletion.DefaultCompletionItem

All Implemented Interfaces:

CompletionItem

Direct Known Subclasses:

ClassImportCompletionItem
```
public class DefaultCompletionItem
extends java.lang.Object
implements CompletionItem
```
Completion item which will insert text when accepted.

Constructor Summary

Constructors
Constructor and Description
`DefaultCompletionItem(java.lang.String text, int offset, java.lang.String complete, java.lang.String label, java.lang.String link)`
`DefaultCompletionItem(java.lang.String text, int offset, java.lang.String complete, java.lang.String label, java.lang.String link, int sortPriority, javax.swing.ImageIcon icon)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CompletionTask`	`createDocumentationTask()` Returns a task used to obtain a documentation associated with the item if there is any.
`CompletionTask`	`createToolTipTask()` Returns a task used to obtain a tooltip hint associated with the item if there is any.
`void`	`defaultAction(javax.swing.text.JTextComponent jTextComponent)` Gets invoked when user presses `VK_ENTER` key or when she double-clicks on this item with the mouse cursor.
`static DefaultCompletionItem`	`error(java.lang.String message)`
`java.lang.String`	`getComplete()`
`java.lang.CharSequence`	`getInsertPrefix()` Returns a text used for finding of a longest common prefix after the TAB gets pressed or when the completion is opened explicitly.
`int`	`getPreferredWidth(java.awt.Graphics graphics, java.awt.Font font)` Get the preferred visual width of this item.
`int`	`getSortPriority()` Returns the item's priority.
`java.lang.CharSequence`	`getSortText()` Returns a text used to sort items alphabetically.
`boolean`	`instantSubstitution(javax.swing.text.JTextComponent jTextComponent)` When enabled for the item the instant substitution should process the item in the same way like when the item is displayed and Enter key gets pressed by the user.
`void`	`processKeyEvent(java.awt.event.KeyEvent keyEvent)` Process the key pressed when this completion item was selected in the completion popup window.
`void`	`render(java.awt.Graphics graphics, java.awt.Font font, java.awt.Color color, java.awt.Color color0, int i, int i0, boolean b)` Render this item into the given graphics.
`void`	`setReferenceOnly(boolean ref)`
`protected void`	`substituteText(javax.swing.text.JTextComponent c, int offset, int len, java.lang.String toAdd)`

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

- Constructor Detail
  - DefaultCompletionItem
```
public DefaultCompletionItem(java.lang.String text,
                             int offset,
                             java.lang.String complete,
                             java.lang.String label,
                             java.lang.String link,
                             int sortPriority,
                             javax.swing.ImageIcon icon)
```
    Parameters:
    
    text - used for sort and insert prefix. Typically same as complete.
    
    offset - number of chars already typed.
    
    complete - complete.substring(offset) is inserted.
    
    label - the human readable presentation of this, maybe with html. Note an arrow "->" will split the label to the left and right.
    
    link - handed over to DefaultDocumentationItem, if non null. May be "inline:<html>..."
    
    sortPriority - 1 is default.
    
    icon - the icon to show next to this completion.
  - DefaultCompletionItem
```
public DefaultCompletionItem(java.lang.String text,
                             int offset,
                             java.lang.String complete,
                             java.lang.String label,
                             java.lang.String link)
```
    Parameters:
    
    text - used for sort and insert prefix. Typically same as complete.
    
    offset - number of chars already typed.
    
    complete - complete.substring(offset) is inserted.
    
    label - the human readable presentation of this, maybe with html.
    
    link - handed over to DefaultDocumentationItem, if non null. May be "inline:<html>..."
- Method Detail
  - setReferenceOnly
```
public void setReferenceOnly(boolean ref)
```
  - error
```
public static DefaultCompletionItem error(java.lang.String message)
```
  - defaultAction
```
public void defaultAction(javax.swing.text.JTextComponent jTextComponent)
```
    Description copied from interface: CompletionItem
    
    Gets invoked when user presses VK_ENTER key or when she double-clicks on this item with the mouse cursor.
    This method gets invoked from AWT thread.
    
    Specified by:
    
    defaultAction in interface CompletionItem
    
    Parameters:
    
    jTextComponent - non-null text component for which the completion was invoked.
  - getComplete
```
public java.lang.String getComplete()
```
  - substituteText
```
protected void substituteText(javax.swing.text.JTextComponent c,
                              int offset,
                              int len,
                              java.lang.String toAdd)
```
  - processKeyEvent
```
public void processKeyEvent(java.awt.event.KeyEvent keyEvent)
```
    Description copied from interface: CompletionItem
    
    Process the key pressed when this completion item was selected in the completion popup window.
    This method gets invoked from AWT thread.
    
    Specified by:
    
    processKeyEvent in interface CompletionItem
    
    Parameters:
    
    keyEvent - non-null key event of the pressed key. It should be consumed in case the item is sensitive to the given key. The source of this event is the text component to which the corresponding action should be performed.
  - getPreferredWidth
```
public int getPreferredWidth(java.awt.Graphics graphics,
                             java.awt.Font font)
```
    Description copied from interface: CompletionItem
    
    Get the preferred visual width of this item.
    The visual height of the item is fixed to 16 points.
    
    Specified by:
    
    getPreferredWidth in interface CompletionItem
    
    Parameters:
    
    graphics - graphics that can be used for determining the preferred width e.g. getting of the font metrics.
    
    font - default font used for rendering.
  - render
```
public void render(java.awt.Graphics graphics,
                   java.awt.Font font,
                   java.awt.Color color,
                   java.awt.Color color0,
                   int i,
                   int i0,
                   boolean b)
```
    Description copied from interface: CompletionItem
    
    Render this item into the given graphics.
    
    Specified by:
    
    render in interface CompletionItem
    
    Parameters:
    
    graphics - graphics to render the item into.
    
    font - default font used for rendering.
    
    color - default color used for rendering.
    
    color0 - color used for background.
    
    i - width of the area to render into.
    
    i0 - height of the are to render into.
    
    b - whether this item is visually selected in the list into which the items are being rendered.
  - createDocumentationTask
```
public CompletionTask createDocumentationTask()
```
    Description copied from interface: CompletionItem
    
    Returns a task used to obtain a documentation associated with the item if there is any.
    
    Specified by:
    
    createDocumentationTask in interface CompletionItem
  - createToolTipTask
```
public CompletionTask createToolTipTask()
```
    Description copied from interface: CompletionItem
    
    Returns a task used to obtain a tooltip hint associated with the item if there is any.
    
    Specified by:
    
    createToolTipTask in interface CompletionItem
  - instantSubstitution
```
public boolean instantSubstitution(javax.swing.text.JTextComponent jTextComponent)
```
    Description copied from interface: CompletionItem
    
    When enabled for the item the instant substitution should process the item in the same way like when the item is displayed and Enter key gets pressed by the user.
    Instant substitution is invoked when there would be just a single item displayed in the completion popup window.
    The implementation can invoke the CompletionItem.defaultAction(JTextComponent) if necessary.
    This method gets invoked from AWT thread.
    
    Specified by:
    
    instantSubstitution in interface CompletionItem
    
    Parameters:
    
    jTextComponent - non-null text component for which the completion was invoked.
    
    Returns:
    
    true if the instant substitution was successfully done. false means that the instant substitution should not be done for this item and the completion item should normally be displayed.
  - getSortPriority
```
public int getSortPriority()
```
    Description copied from interface: CompletionItem
    
    Returns the item's priority. A lower value means a lower index of the item in the completion result list.
    
    Specified by:
    
    getSortPriority in interface CompletionItem
  - getSortText
```
public java.lang.CharSequence getSortText()
```
    Description copied from interface: CompletionItem
    
    Returns a text used to sort items alphabetically.
    
    Specified by:
    
    getSortText in interface CompletionItem
  - getInsertPrefix
```
public java.lang.CharSequence getInsertPrefix()
```
    Description copied from interface: CompletionItem
    
    Returns a text used for finding of a longest common prefix after the TAB gets pressed or when the completion is opened explicitly.
    The completion infrastructure will evaluate the insert prefixes of all the items present in the visible result and finds the longest common prefix.
    Generally the returned text does not need to contain all the information that gets inserted when the item is selected.
    For example in java completion the field name should be returned for fields or a method name for methods (but not parameters) or a non-FQN name for classes.
    
    Specified by:
    
    getInsertPrefix in interface CompletionItem
    
    Returns:
    
    non-null character sequence containing the insert prefix.
    Returning an empty string will effectively disable the TAB completion as the longest common prefix will be empty.

Class DefaultCompletionItem

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DefaultCompletionItem

DefaultCompletionItem

Method Detail

setReferenceOnly

error

defaultAction

getComplete

substituteText

processKeyEvent

getPreferredWidth

render

createDocumentationTask

createToolTipTask

instantSubstitution

getSortPriority

getSortText

getInsertPrefix