Package com.intellij.psi.impl.source.tree

Class ForeignLeafPsiElement

java.lang.Object

com.intellij.openapi.util.UserDataHolderBase

com.intellij.psi.impl.ElementBase

com.intellij.psi.impl.source.tree.TreeElement

com.intellij.psi.impl.source.tree.LeafElement

com.intellij.psi.impl.source.tree.LeafPsiElement

com.intellij.psi.impl.source.tree.ForeignLeafPsiElement

All Implemented Interfaces:

ASTNode, NavigationItem, Iconable, UserDataHolder, UserDataHolderEx, Navigatable, PsiElement, java.lang.Cloneable

public class ForeignLeafPsiElement
extends LeafPsiElement

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.source.tree.TreeElement

EMPTY_ARRAY

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

FLAGS_LOCKED, ICON_PLACEHOLDER

Fields inherited from interface com.intellij.psi.PsiElement

ARRAY_FACTORY, EMPTY_ARRAY

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.navigation.NavigationItem

EMPTY_NAVIGATION_ITEM_ARRAY

Constructor Summary

Constructors

Constructor and Description
ForeignLeafPsiElement(ForeignLeafType type, java.lang.CharSequence text)

Method Summary

Modifier and Type	Method and Description
LeafElement	findLeafElementAt(int offset) Finds a leaf child node at the specified offset from the start of the text range of this node.
ForeignLeafType	getForeignType()
int	getStartOffset() Returns the starting offset of the node text in the document.
int	getTextLength() Returns the length of the node text.
boolean	textMatches(java.lang.CharSequence seq) Checks if the text of this PSI element is equal to the specified character sequence.
protected int	textMatches(java.lang.CharSequence buffer, int start)
boolean	textMatches(PsiElement element) Checks if the text of this PSI element is equal to the text of the specified PSI element.
java.lang.String	toString() toString() should never be presented to the user.

Methods inherited from class com.intellij.psi.impl.source.tree.LeafPsiElement

accept, acceptChildren, add, addAfter, addBefore, addRange, addRangeAfter, addRangeBefore, canNavigate, canNavigateToSource, checkAdd, checkDelete, copy, delete, deleteChildRange, findElementAt, findReferenceAt, getChildren, getContainingFile, getContext, getFirstChild, getLanguage, getLastChild, getName, getNavigationElement, getNextSibling, getNode, getOriginalElement, getParent, getPresentation, getPrevSibling, getProject, getPsi, getReference, getReferences, getResolveScope, getUseScope, isEquivalentTo, isPhysical, isValid, isWritable, navigate, processDeclarations, replace

Methods inherited from class com.intellij.psi.impl.source.tree.LeafElement

acceptTree, addChild, addChild, addChildren, addLeaf, charAt, clone, copyTo, findChildByType, findChildByType, findChildByType, findChildByType, getCachedLength, getChars, getChildren, getFirstChildNode, getLastChildNode, getPsi, getText, hc, rawReplaceWithText, removeChild, removeRange, replaceAllChildrenToChildrenOf, replaceChild, replaceWithText, textContains, textMatches, textToCharArray

Methods inherited from class com.intellij.psi.impl.source.tree.TreeElement

clearCaches, copyElement, equals, getElementType, getManager, getStartOffsetInParent, getTextOffset, getTextRange, getTreeNext, getTreeParent, getTreePrev, invalidate, onInvalidated, rawInsertAfterMe, rawInsertBeforeMe, rawRemove, rawRemoveUpTo, rawRemoveUpToLast, rawReplaceWithList

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

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

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

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.psi.PsiElement

getCopyableUserData, getManager, getOwnReferences, getStartOffsetInParent, getText, getTextOffset, getTextRange, getTextRangeInParent, putCopyableUserData, textContains, textToCharArray

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

getUserData, putUserData

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

getIcon

Methods inherited from interface com.intellij.lang.ASTNode

getCopyableUserData, putCopyableUserData

Constructor Detail

ForeignLeafPsiElement

public ForeignLeafPsiElement(ForeignLeafType type,
                             java.lang.CharSequence text)

Method Detail

findLeafElementAt

public LeafElement findLeafElementAt(int offset)

Description copied from interface: ASTNode

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

Specified by:

findLeafElementAt in interface ASTNode

Overrides:

findLeafElementAt in class LeafElement

Parameters:

offset - the relative offset for which the child node is requested.

Returns:

the child node, or null if none is found.

textMatches

public boolean textMatches(java.lang.CharSequence seq)

Description copied from interface: PsiElement

Checks if the text of this PSI element is equal to the specified character sequence.

Specified by:

textMatches in interface PsiElement

Overrides:

textMatches in class TreeElement

Parameters:

seq - the character sequence to compare with.

Returns:

true if the text is equal, false otherwise.

textMatches

protected int textMatches(java.lang.CharSequence buffer,
                          int start)

Overrides:

textMatches in class LeafElement

textMatches

public boolean textMatches(PsiElement element)

Description copied from interface: PsiElement

Checks if the text of this PSI element is equal to the text of the specified PSI element.

Specified by:

textMatches in interface PsiElement

Overrides:

textMatches in class TreeElement

Parameters:

element - the element to compare the text with.

Returns:

true if the text is equal, false otherwise.

getTextLength

public int getTextLength()

Description copied from interface: ASTNode

Returns the length of the node text.

Specified by:

getTextLength in interface ASTNode

Specified by:

getTextLength in interface PsiElement

Overrides:

getTextLength in class LeafElement

Returns:

the text length.

getStartOffset

public int getStartOffset()

Description copied from interface: ASTNode

Returns the starting offset of the node text in the document.

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:

getStartOffset in interface ASTNode

Overrides:

getStartOffset in class TreeElement

Returns:

the start offset.

getForeignType

public ForeignLeafType getForeignType()

toString

public java.lang.String toString()

Description copied from interface: PsiElement

toString() should never be presented to the user.

Specified by:

toString in interface PsiElement

Overrides:

toString in class LeafPsiElement