Package com.intellij.xml.util

Class IncludedXmlAttribute

java.lang.Object

com.intellij.openapi.util.UserDataHolderBase

com.intellij.psi.impl.ElementBase

com.intellij.psi.impl.PsiElementBase

com.intellij.psi.impl.light.LightElement

com.intellij.xml.util.IncludedXmlElement<XmlAttribute>

com.intellij.xml.util.IncludedXmlAttribute

All Implemented Interfaces:

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

public class IncludedXmlAttribute
extends IncludedXmlElement<XmlAttribute>
implements XmlAttribute

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.light.LightElement

myManager

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

FLAGS_LOCKED, ICON_PLACEHOLDER

Fields inherited from interface com.intellij.psi.xml.XmlAttribute

EMPTY_ARRAY

Fields inherited from interface com.intellij.psi.xml.XmlElement

DEPENDING_ELEMENT, DO_NOT_VALIDATE, INCLUDING_ELEMENT

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
IncludedXmlAttribute(XmlAttribute original, XmlTag parent)

Method Summary

Modifier and Type	Method and Description
int	displayToPhysical(int offset)
XmlAttributeDescriptor	getDescriptor()
java.lang.String	getDisplayValue()
java.lang.String	getLocalName()
java.lang.String	getName() Returns the name of the element.
XmlElement	getNameElement()
java.lang.String	getNamespace()
java.lang.String	getNamespacePrefix()
XmlTag	getParent() Returns the parent of the PSI element.
java.lang.String	getValue()
XmlAttributeValue	getValueElement()
TextRange	getValueTextRange()
boolean	isNamespaceDeclaration()
int	physicalToDisplay(int offset)
PsiElement	setName(java.lang.String name) Renames the element.
void	setValue(java.lang.String value)

Methods inherited from class com.intellij.xml.util.IncludedXmlElement

equals, getContainingFile, getNavigationElement, getOriginal, hashCode, isValid, processElements, toString

Methods inherited from class com.intellij.psi.impl.light.LightElement

accept, add, addAfter, addBefore, checkAdd, checkDelete, copy, delete, findElementAt, getChildren, getLanguage, getManager, getNextSibling, getNode, getPrevSibling, getStartOffsetInParent, getText, getTextLength, getTextOffset, getTextRange, isPhysical, isWritable, replace, setNavigationElement, textMatches, textMatches, textToCharArray

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

acceptChildren, addRange, addRangeAfter, addRangeBefore, canNavigate, canNavigateToSource, deleteChildRange, findChildByClass, findChildrenByClass, findNotNullChildByClass, findReferenceAt, getContext, getFirstChild, getLastChild, getOriginalElement, getPresentation, getProject, getReference, getReferences, getResolveScope, getUseScope, isEquivalentTo, navigate, notNullChild, processDeclarations, textContains

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, 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

Methods inherited from interface com.intellij.psi.xml.XmlElement

processElements, skipValidation

Methods inherited from interface com.intellij.psi.PsiElement

accept, acceptChildren, add, addAfter, addBefore, addRange, addRangeAfter, addRangeBefore, checkAdd, checkDelete, copy, delete, deleteChildRange, findElementAt, findReferenceAt, getChildren, getContainingFile, getContext, getCopyableUserData, getFirstChild, getLanguage, getLastChild, getManager, getNavigationElement, getNextSibling, getNode, getOriginalElement, getOwnReferences, getPrevSibling, getProject, getReference, getReferences, getResolveScope, getStartOffsetInParent, getText, getTextLength, getTextOffset, getTextRange, getTextRangeInParent, getUseScope, isEquivalentTo, isPhysical, isValid, isWritable, processDeclarations, putCopyableUserData, replace, textContains, textMatches, textMatches, textToCharArray, toString

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

getUserData, putUserData

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

getIcon

Constructor Detail

IncludedXmlAttribute

public IncludedXmlAttribute(XmlAttribute original,
                            XmlTag parent)

Method Detail

getName

public java.lang.String getName()

Description copied from interface: PsiNamedElement

Returns the name of the element.

Specified by:

getName in interface NavigationItem

Specified by:

getName in interface PsiNamedElement

Specified by:

getName in interface XmlAttribute

Overrides:

getName in class PsiElementBase

Returns:

the element name.

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.

getLocalName

public java.lang.String getLocalName()

Specified by:

getLocalName in interface XmlAttribute

getNameElement

public XmlElement getNameElement()

Specified by:

getNameElement in interface XmlAttribute

getNamespace

public java.lang.String getNamespace()

Specified by:

getNamespace in interface XmlAttribute

getNamespacePrefix

public java.lang.String getNamespacePrefix()

Specified by:

getNamespacePrefix in interface XmlAttribute

getParent

public XmlTag getParent()

Description copied from interface: PsiElement

Returns the parent of the PSI element.

Specified by:

getParent in interface PsiElement

Specified by:

getParent in interface XmlAttribute

Overrides:

getParent in class IncludedXmlElement<XmlAttribute>

Returns:

the parent of the element, or null if the element has no parent.

getValue

public java.lang.String getValue()

Specified by:

getValue in interface XmlAttribute

Returns:

text inside XML attribute with quotes stripped off

getDisplayValue

public java.lang.String getDisplayValue()

Specified by:

getDisplayValue in interface XmlAttribute

Returns:

text inside XML attribute with quotes stripped off and XML char entities replaced with corresponding characters

physicalToDisplay

public int physicalToDisplay(int offset)

Specified by:

physicalToDisplay in interface XmlAttribute

Parameters:

offset - in string returned by XmlAttribute.getValue() (with quotes stripped)

Returns:

offset in the string returned from XmlAttribute.getDisplayValue() or -1 if the offset is out of valid range

displayToPhysical

public int displayToPhysical(int offset)

Specified by:

displayToPhysical in interface XmlAttribute

Parameters:

offset - in the string returned from XmlAttribute.getDisplayValue()

Returns:

offset in string returned by XmlAttribute.getValue() (with quotes stripped) or -1 if the offset is out of valid range

getValueTextRange

public TextRange getValueTextRange()

Specified by:

getValueTextRange in interface XmlAttribute

Returns:

TextRange of the XML attribute value. If quotes are present, it returns new TextRange(1, getValue().getTextLength()-1), otherwise it is new TextRange(0, getValue().getTextLength())

isNamespaceDeclaration

public boolean isNamespaceDeclaration()

Specified by:

isNamespaceDeclaration in interface XmlAttribute

Returns:

true if the attribute is a namespace declaration (its name equals to xmlns or starts with xmlns:)

getDescriptor

public XmlAttributeDescriptor getDescriptor()

Specified by:

getDescriptor in interface XmlAttribute

getValueElement

public XmlAttributeValue getValueElement()

Specified by:

getValueElement in interface XmlAttribute

setValue

public void setValue(java.lang.String value)
              throws IncorrectOperationException

Specified by:

setValue in interface XmlAttribute

Throws:

IncorrectOperationException