Package com.intellij.codeInsight.lookup

Class LookupElementBuilder

java.lang.Object

com.intellij.openapi.util.UserDataHolderBase

com.intellij.codeInsight.lookup.LookupElement

com.intellij.codeInsight.lookup.LookupElementBuilder

All Implemented Interfaces:

UserDataHolder, UserDataHolderEx

public final class LookupElementBuilder
extends LookupElement

See Also:

LookupElementDecorator, PrioritizedLookupElement

Field Summary

Fields inherited from class com.intellij.codeInsight.lookup.LookupElement

EMPTY_ARRAY

Method Summary

Modifier and Type	Method and Description
LookupElementBuilder	addLookupString(java.lang.String another) Deprecated. use withLookupString(String)
LookupElementBuilder	appendTailText(java.lang.String tailText, boolean grayed)
LookupElementBuilder	bold()
static LookupElementBuilder	create(java.lang.Object object)
static LookupElementBuilder	create(java.lang.Object lookupObject, java.lang.String lookupString)
static LookupElementBuilder	create(PsiNamedElement element)
static LookupElementBuilder	create(java.lang.String lookupString)
static LookupElementBuilder	createWithIcon(PsiNamedElement element)
static LookupElementBuilder	createWithSmartPointer(java.lang.String lookupString, PsiElement element)
boolean	equals(java.lang.Object o)
java.util.Set<java.lang.String>	getAllLookupStrings()
InsertHandler<LookupElement>	getInsertHandler()
java.lang.String	getLookupString()
java.lang.Object	getObject()
PsiElement	getPsiElement()
LookupElementRenderer<LookupElement>	getRenderer()
void	handleInsert(InsertionContext context)
int	hashCode()
boolean	isCaseSensitive()
void	renderElement(LookupElementPresentation presentation)
LookupElementBuilder	setBold() Deprecated. use bold()
LookupElementBuilder	setBold(boolean bold) Deprecated. use withBoldness(boolean)
LookupElementBuilder	setCaseSensitive(boolean caseSensitive) Deprecated. use withCaseSensitivity(boolean)
LookupElementBuilder	setIcon(javax.swing.Icon icon) Deprecated. use withIcon(Icon)
LookupElementBuilder	setInsertHandler(InsertHandler<LookupElement> insertHandler) Deprecated. use withInsertHandler(InsertHandler)
LookupElementBuilder	setItemTextForeground(java.awt.Color itemTextForeground) Deprecated. use withItemTextForeground(Color)
LookupElementBuilder	setItemTextUnderlined(boolean underlined) Deprecated. use withItemTextUnderlined(boolean)
LookupElementBuilder	setPresentableText(java.lang.String presentableText) Deprecated. use withPresentableText(String)
LookupElementBuilder	setRenderer(LookupElementRenderer<LookupElement> renderer) Deprecated. use withRenderer(LookupElementRenderer)
LookupElementBuilder	setStrikeout() Deprecated. use strikeout()
LookupElementBuilder	setStrikeout(boolean strikeout) Deprecated. use withStrikeoutness(boolean)
LookupElementBuilder	setTailText(java.lang.String tailText) Deprecated. use withTailText(String)
LookupElementBuilder	setTailText(java.lang.String tailText, boolean grayed) Deprecated. use withTailText(String, boolean)
LookupElementBuilder	setTypeText(java.lang.String typeText) Deprecated. use withTypeText(String)
LookupElementBuilder	setTypeText(java.lang.String typeText, boolean grayed) Deprecated. use withTypeText(String, boolean)
LookupElementBuilder	strikeout()
java.lang.String	toString()
LookupElement	withAutoCompletionPolicy(AutoCompletionPolicy policy)
LookupElementBuilder	withBoldness(boolean bold)
LookupElementBuilder	withCaseSensitivity(boolean caseSensitive)
LookupElementBuilder	withIcon(javax.swing.Icon icon)
LookupElementBuilder	withInsertHandler(InsertHandler<LookupElement> insertHandler)
LookupElementBuilder	withItemTextForeground(java.awt.Color itemTextForeground)
LookupElementBuilder	withItemTextItalic(boolean italic)
LookupElementBuilder	withItemTextUnderlined(boolean underlined)
LookupElementBuilder	withLookupString(java.lang.String another)
LookupElementBuilder	withLookupStrings(java.util.Collection<java.lang.String> another)
LookupElementBuilder	withPresentableText(java.lang.String presentableText)
LookupElementBuilder	withPsiElement(PsiElement psi) Allows to pass custom PSI that will be returned from getPsiElement().
LookupElementBuilder	withRenderer(LookupElementRenderer<LookupElement> renderer)
LookupElementBuilder	withStrikeoutness(boolean strikeout)
LookupElementBuilder	withTailText(java.lang.String tailText)
LookupElementBuilder	withTailText(java.lang.String tailText, boolean grayed)
LookupElementBuilder	withTypeIconRightAligned(boolean typeIconRightAligned)
LookupElementBuilder	withTypeText(java.lang.String typeText)
LookupElementBuilder	withTypeText(java.lang.String typeText, boolean grayed)
LookupElementBuilder	withTypeText(java.lang.String typeText, javax.swing.Icon typeIcon, boolean grayed)

Methods inherited from class com.intellij.codeInsight.lookup.LookupElement

as, as, getAutoCompletionPolicy, isValid, isWorthShowingInAutoPopup, requiresCommittedDocuments

Methods inherited from class com.intellij.openapi.util.UserDataHolderBase

changeUserMap, clearUserData, clone, copyCopyableDataTo, copyUserDataTo, getCopyableUserData, getUserData, getUserDataString, getUserMap, isUserDataEmpty, putCopyableUserData, putUserData, putUserDataIfAbsent, replace, setUserMap

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

create

public static LookupElementBuilder create(java.lang.String lookupString)

create

public static LookupElementBuilder create(java.lang.Object object)

createWithSmartPointer

public static LookupElementBuilder createWithSmartPointer(java.lang.String lookupString,
                                                          PsiElement element)

create

public static LookupElementBuilder create(PsiNamedElement element)

createWithIcon

public static LookupElementBuilder createWithIcon(PsiNamedElement element)

create

public static LookupElementBuilder create(java.lang.Object lookupObject,
                                          java.lang.String lookupString)

setInsertHandler

@Deprecated
public LookupElementBuilder setInsertHandler(InsertHandler<LookupElement> insertHandler)

Deprecated. use withInsertHandler(InsertHandler)

withInsertHandler

public LookupElementBuilder withInsertHandler(InsertHandler<LookupElement> insertHandler)

setRenderer

@Deprecated
public LookupElementBuilder setRenderer(LookupElementRenderer<LookupElement> renderer)

Deprecated. use withRenderer(LookupElementRenderer)

withRenderer

public LookupElementBuilder withRenderer(LookupElementRenderer<LookupElement> renderer)

getAllLookupStrings

public java.util.Set<java.lang.String> getAllLookupStrings()

Overrides:

getAllLookupStrings in class LookupElement

setIcon

@Deprecated
public LookupElementBuilder setIcon(javax.swing.Icon icon)

Deprecated. use withIcon(Icon)

withIcon

public LookupElementBuilder withIcon(javax.swing.Icon icon)

addLookupString

@Deprecated
public LookupElementBuilder addLookupString(java.lang.String another)

Deprecated. use withLookupString(String)

withLookupString

public LookupElementBuilder withLookupString(java.lang.String another)

withLookupStrings

public LookupElementBuilder withLookupStrings(java.util.Collection<java.lang.String> another)

isCaseSensitive

public boolean isCaseSensitive()

Overrides:

isCaseSensitive in class LookupElement

setCaseSensitive

@Deprecated
public LookupElementBuilder setCaseSensitive(boolean caseSensitive)

Deprecated. use withCaseSensitivity(boolean)

withCaseSensitivity

public LookupElementBuilder withCaseSensitivity(boolean caseSensitive)

Parameters:

caseSensitive - if this lookup item should be completed in the same letter case as prefix

Returns:

modified builder

See Also:

CompletionResultSet.caseInsensitive()

withPsiElement

public LookupElementBuilder withPsiElement(PsiElement psi)

Allows to pass custom PSI that will be returned from getPsiElement().

setItemTextForeground

@Deprecated
public LookupElementBuilder setItemTextForeground(java.awt.Color itemTextForeground)

Deprecated. use withItemTextForeground(Color)

withItemTextForeground

public LookupElementBuilder withItemTextForeground(java.awt.Color itemTextForeground)

setItemTextUnderlined

@Deprecated
public LookupElementBuilder setItemTextUnderlined(boolean underlined)

Deprecated. use withItemTextUnderlined(boolean)

withItemTextUnderlined

public LookupElementBuilder withItemTextUnderlined(boolean underlined)

withItemTextItalic

public LookupElementBuilder withItemTextItalic(boolean italic)

setTypeText

@Deprecated
public LookupElementBuilder setTypeText(java.lang.String typeText)

Deprecated. use withTypeText(String)

withTypeText

public LookupElementBuilder withTypeText(java.lang.String typeText)

setTypeText

@Deprecated
public LookupElementBuilder setTypeText(java.lang.String typeText,
                                        boolean grayed)

Deprecated. use withTypeText(String, boolean)

withTypeText

public LookupElementBuilder withTypeText(java.lang.String typeText,
                                         boolean grayed)

withTypeText

public LookupElementBuilder withTypeText(java.lang.String typeText,
                                         javax.swing.Icon typeIcon,
                                         boolean grayed)

withTypeIconRightAligned

public LookupElementBuilder withTypeIconRightAligned(boolean typeIconRightAligned)

setPresentableText

@Deprecated
public LookupElementBuilder setPresentableText(java.lang.String presentableText)

Deprecated. use withPresentableText(String)

withPresentableText

public LookupElementBuilder withPresentableText(java.lang.String presentableText)

setBold

@Deprecated
public LookupElementBuilder setBold()

Deprecated. use bold()

bold

public LookupElementBuilder bold()

setBold

@Deprecated
public LookupElementBuilder setBold(boolean bold)

Deprecated. use withBoldness(boolean)

withBoldness

public LookupElementBuilder withBoldness(boolean bold)

setStrikeout

@Deprecated
public LookupElementBuilder setStrikeout()

Deprecated. use strikeout()

strikeout

public LookupElementBuilder strikeout()

setStrikeout

@Deprecated
public LookupElementBuilder setStrikeout(boolean strikeout)

Deprecated. use withStrikeoutness(boolean)

withStrikeoutness

public LookupElementBuilder withStrikeoutness(boolean strikeout)

setTailText

@Deprecated
public LookupElementBuilder setTailText(java.lang.String tailText)

Deprecated. use withTailText(String)

withTailText

public LookupElementBuilder withTailText(java.lang.String tailText)

setTailText

@Deprecated
public LookupElementBuilder setTailText(java.lang.String tailText,
                                        boolean grayed)

Deprecated. use withTailText(String, boolean)

withTailText

public LookupElementBuilder withTailText(java.lang.String tailText,
                                         boolean grayed)

appendTailText

public LookupElementBuilder appendTailText(java.lang.String tailText,
                                           boolean grayed)

withAutoCompletionPolicy

public LookupElement withAutoCompletionPolicy(AutoCompletionPolicy policy)

getLookupString

public java.lang.String getLookupString()

Specified by:

getLookupString in class LookupElement

getInsertHandler

public InsertHandler<LookupElement> getInsertHandler()

getRenderer

public LookupElementRenderer<LookupElement> getRenderer()

getObject

public java.lang.Object getObject()

Overrides:

getObject in class LookupElement

getPsiElement

public PsiElement getPsiElement()

Overrides:

getPsiElement in class LookupElement

Returns:

a PSI element associated with this lookup element. It's used for navigation, showing quick documentation and sorting by proximity to the current location. The default implementation tries to extract PSI element from LookupElement.getObject() result.

handleInsert

public void handleInsert(InsertionContext context)

Overrides:

handleInsert in class LookupElement

renderElement

public void renderElement(LookupElementPresentation presentation)

Overrides:

renderElement in class LookupElement

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class LookupElement

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object