Package com.intellij.codeInsight

Class TargetElementUtil

java.lang.Object

com.intellij.codeInsight.TargetElementUtil

public class TargetElementUtil
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static int	ELEMENT_NAME_ACCEPTED
static int	LOOKUP_ITEM_ACCEPTED A flag used in findTargetElement(Editor, int, int) indicating that if a lookup (e.g.
static int	REFERENCED_ELEMENT_ACCEPTED

Constructor Summary

Constructors

Constructor and Description
TargetElementUtil()

Method Summary

Modifier and Type	Method and Description
boolean	acceptImplementationForReference(PsiReference reference, PsiElement element)
PsiElement	adjustElement(Editor editor, int flags, PsiElement element, PsiElement contextElement)
static int	adjustOffset(PsiFile file, Document document, int offset)
PsiElement	adjustReference(PsiReference ref)
static PsiReference	findReference(Editor editor)
static PsiReference	findReference(Editor editor, int offset)
static PsiElement	findTargetElement(Editor editor, int flags) Note: this method can perform slow PSI activity (e.g.
PsiElement	findTargetElement(Editor editor, int flags, int offset) Note: this method can perform slow PSI activity (e.g.
int	getAllAccepted()
int	getDefinitionSearchFlags()
PsiElement	getGotoDeclarationTarget(PsiElement element, PsiElement navElement)
static TargetElementUtil	getInstance()
static PsiElement	getNamedElement(PsiElement element)
PsiElement	getNamedElement(PsiElement element, int offsetInElement)
int	getReferenceSearchFlags()
SearchScope	getSearchScope(Editor editor, PsiElement element)
java.util.Collection<PsiElement>	getTargetCandidates(PsiReference reference)
boolean	includeSelfInGotoImplementation(PsiElement element)
static boolean	inVirtualSpace(Editor editor, int offset)
boolean	isNavigatableSource(PsiElement element)

Methods inherited from class java.lang.Object

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

Field Detail

REFERENCED_ELEMENT_ACCEPTED

public static final int REFERENCED_ELEMENT_ACCEPTED

See Also:

TargetElementUtilBase.REFERENCED_ELEMENT_ACCEPTED, Constant Field Values

ELEMENT_NAME_ACCEPTED

public static final int ELEMENT_NAME_ACCEPTED

See Also:

TargetElementUtilBase.ELEMENT_NAME_ACCEPTED, Constant Field Values

LOOKUP_ITEM_ACCEPTED

public static final int LOOKUP_ITEM_ACCEPTED

A flag used in findTargetElement(Editor, int, int) indicating that if a lookup (e.g. completion) is shown in the editor, the PSI element corresponding to the selected lookup item should be returned.

See Also:

Constant Field Values

Constructor Detail

TargetElementUtil

public TargetElementUtil()

Method Detail

getInstance

public static TargetElementUtil getInstance()

getAllAccepted

public int getAllAccepted()

getDefinitionSearchFlags

public int getDefinitionSearchFlags()

getReferenceSearchFlags

public int getReferenceSearchFlags()

findReference

public static PsiReference findReference(Editor editor)

findReference

public static PsiReference findReference(Editor editor,
                                         int offset)

adjustOffset

public static int adjustOffset(PsiFile file,
                               Document document,
                               int offset)

inVirtualSpace

public static boolean inVirtualSpace(Editor editor,
                                     int offset)

findTargetElement

public static PsiElement findTargetElement(Editor editor,
                                           int flags)

Note: this method can perform slow PSI activity (e.g. PsiReference.resolve(), so please avoid calling it from Swing thread.

Parameters:

editor - editor

flags - a combination of REFERENCED_ELEMENT_ACCEPTED, ELEMENT_NAME_ACCEPTED, LOOKUP_ITEM_ACCEPTED

Returns:

a PSI element declared or referenced at the editor caret position, or selected in the Lookup if shown in the editor, depending on the flags passed.

See Also:

findTargetElement(Editor, int, int)

findTargetElement

public PsiElement findTargetElement(Editor editor,
                                    int flags,
                                    int offset)

Note: this method can perform slow PSI activity (e.g. PsiReference.resolve(), so please avoid calling it from Swing thread.

Parameters:

editor - editor

flags - a combination of REFERENCED_ELEMENT_ACCEPTED, ELEMENT_NAME_ACCEPTED, LOOKUP_ITEM_ACCEPTED

offset - offset in the editor's document

Returns:

a PSI element declared or referenced at the specified offset in the editor, or selected in the Lookup if shown in the editor, depending on the flags passed.

See Also:

findTargetElement(Editor, int)

adjustElement

public PsiElement adjustElement(Editor editor,
                                int flags,
                                PsiElement element,
                                PsiElement contextElement)

adjustReference

public PsiElement adjustReference(PsiReference ref)

getNamedElement

public PsiElement getNamedElement(PsiElement element,
                                  int offsetInElement)

getNamedElement

public static PsiElement getNamedElement(PsiElement element)

getTargetCandidates

public java.util.Collection<PsiElement> getTargetCandidates(PsiReference reference)

isNavigatableSource

public boolean isNavigatableSource(PsiElement element)

getGotoDeclarationTarget

public PsiElement getGotoDeclarationTarget(PsiElement element,
                                           PsiElement navElement)

includeSelfInGotoImplementation

public boolean includeSelfInGotoImplementation(PsiElement element)

acceptImplementationForReference

public boolean acceptImplementationForReference(PsiReference reference,
                                                PsiElement element)

getSearchScope

public SearchScope getSearchScope(Editor editor,
                                  PsiElement element)