Package com.intellij.psi.impl

Class FakePsiElement

java.lang.Object

com.intellij.openapi.util.UserDataHolderBase

com.intellij.psi.impl.ElementBase

com.intellij.psi.impl.PsiElementBase

com.intellij.psi.impl.FakePsiElement

All Implemented Interfaces:

ItemPresentation, NavigationItem, Iconable, UserDataHolder, UserDataHolderEx, Navigatable, NavigatablePsiElement, PsiElement, PsiNamedElement, java.lang.Cloneable

Direct Known Subclasses:

BeanPropertyElement, CustomMembersGenerator.GdslNamedParameter, GoToSymbolProvider.BaseNavigationItem, InspectionElement, RenameableFakePsiElement, TaskPsiElement

public abstract class FakePsiElement
extends PsiElementBase
implements PsiNamedElement, ItemPresentation

Nested Class Summary

Nested classes/interfaces inherited from interface com.intellij.openapi.util.Iconable

Iconable.IconFlags, Iconable.LastComputedIcon

Field Summary

Fields inherited from class com.intellij.psi.impl.ElementBase

FLAGS_LOCKED, ICON_PLACEHOLDER

Fields inherited from interface com.intellij.psi.PsiNamedElement

EMPTY_ARRAY

Fields inherited from interface com.intellij.psi.PsiElement

ARRAY_FACTORY

Fields inherited from interface com.intellij.openapi.util.Iconable

ICON_FLAG_IGNORE_MASK, ICON_FLAG_OPEN, ICON_FLAG_READ_STATUS, ICON_FLAG_VISIBILITY

Fields inherited from interface com.intellij.psi.NavigatablePsiElement

EMPTY_NAVIGATABLE_ELEMENT_ARRAY

Fields inherited from interface com.intellij.navigation.NavigationItem

EMPTY_NAVIGATION_ITEM_ARRAY

Constructor Summary

Constructors

Constructor and Description
FakePsiElement()

Method Summary

Modifier and Type	Method and Description
PsiElement	findElementAt(int offset) Finds a leaf PSI element at the specified offset from the start of the text range of this node.
PsiElement []	getChildren() Returns the array of children for the PSI element.
protected javax.swing.Icon	getElementIcon(int flags)
PsiElement	getFirstChild() Returns the first child of the PSI element.
javax.swing.Icon	getIcon(boolean open) Returns the icon representing the object.
javax.swing.Icon	getIcon(int flags)
Language	getLanguage() Returns the language of the PSI element.
PsiElement	getLastChild() Returns the last child of the PSI element.
java.lang.String	getLocationString() Returns the location of the object (for example, the package of a class).
PsiManager	getManager() Returns the PSI manager for the project to which the PSI element belongs.
PsiElement	getNextSibling() Returns the next sibling of the PSI element.
ASTNode	getNode() Returns the AST node corresponding to the element.
java.lang.String	getPresentableText() Returns the name of the object to be presented in most renderers across the program.
ItemPresentation	getPresentation()
PsiElement	getPrevSibling() Returns the previous sibling of the PSI element.
int	getStartOffsetInParent() Returns the text offset of the PSI element relative to its parent.
java.lang.String	getText() Returns the text of the PSI element.
int	getTextLength() Returns the length of text of the PSI element.
int	getTextOffset() Returns the offset in the file to which the caret should be placed when performing the navigation to the element.
TextRange	getTextRange() Returns the text range in the document occupied by the PSI element.
boolean	isPhysical() Checks if an actual source or class file corresponds to the element.
PsiElement	setName(java.lang.String name) Renames the element.
boolean	textContains(char c) Checks if the text of this element contains the specified character.
char []	textToCharArray() Returns the text of the PSI element as a character array.

Methods inherited from class com.intellij.psi.impl.PsiElementBase

accept, acceptChildren, add, addAfter, addBefore, addRange, addRangeAfter, addRangeBefore, canNavigate, canNavigateToSource, checkAdd, checkDelete, copy, delete, deleteChildRange, findChildByClass, findChildrenByClass, findNotNullChildByClass, findReferenceAt, getContainingFile, getContext, getName, getNavigationElement, getOriginalElement, getProject, getReference, getReferences, getResolveScope, getUseScope, isEquivalentTo, isValid, isWritable, navigate, notNullChild, processDeclarations, replace, textMatches, textMatches

Methods inherited from class com.intellij.psi.impl.ElementBase

buildRowIcon, computeBaseIcon, createLayeredIcon, getAdjustedBaseIcon, getBaseIcon, iconWithVisibilityIfNeeded, isNativeFileType, isVisibilitySupported, overlayIcons, registerIconLayer, transformFlags

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

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

Methods inherited from interface com.intellij.psi.PsiNamedElement

getName

Methods inherited from interface com.intellij.psi.PsiElement

accept, acceptChildren, add, addAfter, addBefore, addRange, addRangeAfter, addRangeBefore, checkAdd, checkDelete, copy, delete, deleteChildRange, findReferenceAt, getContainingFile, getContext, getCopyableUserData, getNavigationElement, getOriginalElement, getOwnReferences, getParent, getProject, getReference, getReferences, getResolveScope, getTextRangeInParent, getUseScope, isEquivalentTo, isValid, isWritable, processDeclarations, putCopyableUserData, replace, textMatches, textMatches, toString

Methods inherited from interface com.intellij.openapi.util.UserDataHolder

getUserData, putUserData

Constructor Detail

FakePsiElement

public FakePsiElement()

Method Detail

getPresentation

public ItemPresentation getPresentation()

Specified by:

getPresentation in interface NavigationItem

Overrides:

getPresentation in class PsiElementBase

getLanguage

public Language getLanguage()

Description copied from interface: PsiElement

Returns the language of the PSI element.

Specified by:

getLanguage in interface PsiElement

Returns:

the language instance.

getChildren

public PsiElement [] getChildren()

Description copied from interface: PsiElement

Returns the array of children for the PSI element. Important: In some implementations children are only composite elements, i.e. not a leaf elements

Specified by:

getChildren in interface PsiElement

Returns:

the array of child elements.

getFirstChild

public PsiElement getFirstChild()

Description copied from interface: PsiElement

Returns the first child of the PSI element.

Specified by:

getFirstChild in interface PsiElement

Overrides:

getFirstChild in class PsiElementBase

Returns:

the first child, or null if the element has no children.

getLastChild

public PsiElement getLastChild()

Description copied from interface: PsiElement

Returns the last child of the PSI element.

Specified by:

getLastChild in interface PsiElement

Overrides:

getLastChild in class PsiElementBase

Returns:

the last child, or null if the element has no children.

getNextSibling

public PsiElement getNextSibling()

Description copied from interface: PsiElement

Returns the next sibling of the PSI element.

Specified by:

getNextSibling in interface PsiElement

Overrides:

getNextSibling in class PsiElementBase

Returns:

the next sibling, or null if the node is the last in the list of siblings.

getPrevSibling

public PsiElement getPrevSibling()

Description copied from interface: PsiElement

Returns the previous sibling of the PSI element.

Specified by:

getPrevSibling in interface PsiElement

Overrides:

getPrevSibling in class PsiElementBase

Returns:

the previous sibling, or null if the node is the first in the list of siblings.

getTextRange

public TextRange getTextRange()

Description copied from interface: PsiElement

Returns the text range in the document occupied by the PSI element.

Note: it works in O(tree_depth) time, which can be slow in deep trees, so invoking this method should be avoided if possible.

Specified by:

getTextRange in interface PsiElement

Returns:

the text range.

getStartOffsetInParent

public int getStartOffsetInParent()

Description copied from interface: PsiElement

Returns the text offset of the PSI element relative to its parent.

Specified by:

getStartOffsetInParent in interface PsiElement

Returns:

the relative offset.

getTextLength

public int getTextLength()

Description copied from interface: PsiElement

Returns the length of text of the PSI element.

Specified by:

getTextLength in interface PsiElement

Returns:

the text length.

findElementAt

public PsiElement findElementAt(int offset)

Description copied from interface: PsiElement

Finds a leaf PSI element at the specified offset from the start of the text range of this node.

Specified by:

findElementAt in interface PsiElement

Parameters:

offset - the relative offset for which the PSI element is requested.

Returns:

the element at the offset, or null if none is found.

getTextOffset

public int getTextOffset()

Description copied from interface: PsiElement

Returns the offset in the file to which the caret should be placed when performing the navigation to the element. (For classes implementing PsiNamedElement, this should return the offset in the file of the name identifier.)

Specified by:

getTextOffset in interface PsiElement

Returns:

the offset of the PSI element.

getText

public java.lang.String getText()

Description copied from interface: PsiElement

Returns the text of the PSI element.

Note: This call requires traversing whole subtree, so it can be expensive for composite elements, and should be avoided if possible.

Specified by:

getText in interface PsiElement

Returns:

the element text.

See Also:

PsiElement.textMatches(java.lang.CharSequence), PsiElement.textContains(char)

textToCharArray

public char [] textToCharArray()

Description copied from interface: PsiElement

Returns the text of the PSI element as a character array.

Specified by:

textToCharArray in interface PsiElement

Returns:

the element text as a character array.

textContains

public boolean textContains(char c)

Description copied from interface: PsiElement

Checks if the text of this element contains the specified character.

Specified by:

textContains in interface PsiElement

Overrides:

textContains in class PsiElementBase

Parameters:

c - the character to search for.

Returns:

true if the character is found, false otherwise.

getNode

public ASTNode getNode()

Description copied from interface: PsiElement

Returns the AST node corresponding to the element.

Specified by:

getNode in interface PsiElement

Returns:

the AST node instance.

getPresentableText

public java.lang.String getPresentableText()

Description copied from interface: ItemPresentation

Returns the name of the object to be presented in most renderers across the program.

Specified by:

getPresentableText in interface ItemPresentation

Returns:

the object name.

getLocationString

public java.lang.String getLocationString()

Description copied from interface: ItemPresentation

Returns the location of the object (for example, the package of a class). The location string is used by some renderers and usually displayed as grayed text next to the item name.

Specified by:

getLocationString in interface ItemPresentation

Returns:

the location description, or null if none is applicable.

getIcon

public final javax.swing.Icon getIcon(int flags)

Specified by:

getIcon in interface Iconable

Overrides:

getIcon in class ElementBase

getElementIcon

protected final javax.swing.Icon getElementIcon(int flags)

Overrides:

getElementIcon in class ElementBase

getIcon

public javax.swing.Icon getIcon(boolean open)

Description copied from interface: ItemPresentation

Returns the icon representing the object.

Specified by:

getIcon in interface ItemPresentation

Parameters:

open - Used to mean if open/close icons for tree renderer. No longer in use. The parameter is only there for API compatibility reason.

setName

public PsiElement setName(java.lang.String name)
                   throws IncorrectOperationException

Description copied from interface: PsiNamedElement

Renames the element.

Specified by:

setName in interface PsiNamedElement

Parameters:

name - the new element name.

Returns:

the element corresponding to this element after the rename (either this or a different element if the rename caused the element to be replaced).

Throws:

IncorrectOperationException - if the modification is not supported or not possible for some reason.

getManager

public PsiManager getManager()

Description copied from interface: PsiElement

Returns the PSI manager for the project to which the PSI element belongs.

Specified by:

getManager in interface PsiElement

Overrides:

getManager in class PsiElementBase

Returns:

the PSI manager instance.

isPhysical

public boolean isPhysical()

Description copied from interface: PsiElement

Checks if an actual source or class file corresponds to the element. Non-physical elements include, for example, PSI elements created for the watch expressions in the debugger. Non-physical elements do not generate tree change events. Also, PsiDocumentManager.getDocument(PsiFile) returns null for non-physical elements. Not to be confused with FileViewProvider.isPhysical().

Specified by:

isPhysical in interface PsiElement

Overrides:

isPhysical in class PsiElementBase

Returns:

true if the element is physical, false otherwise.