Package com.intellij.codeInsight

Class TargetElementUtilBase

java.lang.Object

com.intellij.codeInsight.TargetElementUtilBase

public final class TargetElementUtilBase
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static int	ELEMENT_NAME_ACCEPTED A flag used in findTargetElement(Editor, int, int) indicating that if a element declaration name (e.g.
static int	REFERENCED_ELEMENT_ACCEPTED A flag used in findTargetElement(Editor, int, int) indicating that if a reference is found at the specified offset, it should be resolved and the result returned.

Constructor Summary

Constructors

Constructor and Description
TargetElementUtilBase()

Method Summary

Modifier and Type	Method and Description
static int	adjustOffset(PsiFile file, Document document, int offset) Attempts to adjust the offset in the file to point to an identifier, single quote, double quote, closing bracket or parentheses by moving it back by a single character.
static PsiReference	findReference(Editor editor, int offset)
static PsiElement	findTargetElement(Editor editor, int flags) Note: this method can perform slow PSI activity (e.g.
static PsiElement	findTargetElement(Editor editor, int flags, int offset) Note: this method can perform slow PSI activity (e.g.
static PsiElement	getNamedElement(PsiElement element, int offsetInElement)

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

A flag used in findTargetElement(Editor, int, int) indicating that if a reference is found at the specified offset, it should be resolved and the result returned.

See Also:

Constant Field Values

ELEMENT_NAME_ACCEPTED

public static final int ELEMENT_NAME_ACCEPTED

A flag used in findTargetElement(Editor, int, int) indicating that if a element declaration name (e.g. class name identifier) is found at the specified offset, the declared element should be returned.

See Also:

Constant Field Values

Constructor Detail

TargetElementUtilBase

public TargetElementUtilBase()

Method Detail

adjustOffset

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

Attempts to adjust the offset in the file to point to an identifier, single quote, double quote, closing bracket or parentheses by moving it back by a single character. Does nothing if there are no identifiers around, or the offset is already in one.

Parameters:

file - language source for the isIdentifierPart(PsiFile, CharSequence, int)

See Also:

PsiTreeUtilKt#elementsAroundOffsetUp(PsiFile, int)

getNamedElement

public static PsiElement getNamedElement(PsiElement element,
                                         int offsetInElement)

findReference

public static PsiReference findReference(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

Returns:

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

See Also:

findTargetElement(Editor, int, int)

findTargetElement

public static 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

offset - offset in the editor's document

Returns:

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

See Also:

findTargetElement(Editor, int)