org.das2.jythoncompletion

Class ClassImportCompletionItem

java.lang.Object

org.das2.jythoncompletion.DefaultCompletionItem

org.das2.jythoncompletion.ClassImportCompletionItem

All Implemented Interfaces:

CompletionItem

public class ClassImportCompletionItem
extends DefaultCompletionItem

Offer a class to use and add import for it.

Constructor Summary

Constructors

Constructor and Description
ClassImportCompletionItem(java.lang.String text, int offset, java.lang.String complete, java.lang.String label, java.lang.String link, int sortPriority, javax.swing.ImageIcon icon, java.lang.String pkg, java.lang.String name)

Method Summary

Modifier and Type	Method and Description
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.
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.

Methods inherited from class org.das2.jythoncompletion.DefaultCompletionItem

createDocumentationTask, createToolTipTask, error, getComplete, getInsertPrefix, getPreferredWidth, getSortPriority, getSortText, processKeyEvent, render, setReferenceOnly, substituteText

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ClassImportCompletionItem

public ClassImportCompletionItem(java.lang.String text,
                                 int offset,
                                 java.lang.String complete,
                                 java.lang.String label,
                                 java.lang.String link,
                                 int sortPriority,
                                 javax.swing.ImageIcon icon,
                                 java.lang.String pkg,
                                 java.lang.String name)

Method Detail

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

Overrides:

defaultAction in class DefaultCompletionItem

Parameters:

jTextComponent - non-null text component for which the completion was invoked.

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

Overrides:

instantSubstitution in class DefaultCompletionItem

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.