Package com.intellij.xml.util

Class IncludedXmlTag

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

com.intellij.xml.util.IncludedXmlTag

All Implemented Interfaces:

PsiExternalReferenceHost, NavigationItem, Iconable, UserDataHolder, UserDataHolderEx, Navigatable, PsiMetaOwner, NavigatablePsiElement, PsiElement, PsiNamedElement, XmlElement, XmlNamedReferenceHost, XmlTag, XmlTagChild, java.lang.Cloneable

public class IncludedXmlTag
extends IncludedXmlElement<XmlTag>
implements XmlTag

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.XmlTag

EMPTY

Fields inherited from interface com.intellij.psi.PsiNamedElement

EMPTY_ARRAY

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

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
IncludedXmlTag(XmlTag original, PsiElement parent)

Method Summary

Modifier and Type	Method and Description
XmlTag	addSubTag(XmlTag subTag, boolean first)
void	collapseIfEmpty()
XmlTag	createChildTag(java.lang.String localName, java.lang.String namespace, java.lang.String bodyText, boolean enforceNamespacesDeep) Creates a new child tag
XmlTag	findFirstSubTag(java.lang.String qname)
XmlTag []	findSubTags(java.lang.String qname)
XmlTag []	findSubTags(java.lang.String localName, java.lang.String namespace)
XmlAttribute	getAttribute(java.lang.String qname) Returns a tag attribute by qualified name.
XmlAttribute	getAttribute(java.lang.String name, java.lang.String namespace)
XmlAttribute []	getAttributes()
java.lang.String	getAttributeValue(java.lang.String qname) Returns a tag attribute value by qualified name.
java.lang.String	getAttributeValue(java.lang.String name, java.lang.String namespace)
XmlElementDescriptor	getDescriptor()
java.lang.String	getLocalName()
java.util.Map<java.lang.String,java.lang.String>	getLocalNamespaceDeclarations()
PsiMetaData	getMetaData()
java.lang.String	getName() Returns the name of the element.
java.lang.String	getNamespace()
java.lang.String	getNamespaceByPrefix(java.lang.String prefix)
java.lang.String	getNamespacePrefix()
XmlTagChild	getNextSiblingInTag()
XmlNSDescriptor	getNSDescriptor(java.lang.String namespace, boolean strict)
XmlTag	getParentTag()
java.lang.String	getPrefixByNamespace(java.lang.String namespace)
XmlTagChild	getPrevSiblingInTag()
XmlTag []	getSubTags()
java.lang.String	getSubTagText(java.lang.String qname)
XmlTagValue	getValue()
boolean	hasNamespaceDeclarations()
boolean	isEmpty()
java.lang.String[]	knownNamespaces()
XmlAttribute	setAttribute(java.lang.String qname, java.lang.String value)
XmlAttribute	setAttribute(java.lang.String name, java.lang.String namespace, java.lang.String value)
PsiElement	setName(java.lang.String name) Renames the element.

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

equals, getContainingFile, getNavigationElement, getOriginal, getParent, 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.XmlTag

getHostName, getRealNs, isCaseSensitive

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

IncludedXmlTag

public IncludedXmlTag(XmlTag original,
                      PsiElement parent)

Method Detail

getParentTag

public XmlTag getParentTag()

Specified by:

getParentTag in interface XmlTagChild

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 XmlTag

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.

getNamespace

public java.lang.String getNamespace()

Specified by:

getNamespace in interface XmlTag

getLocalName

public java.lang.String getLocalName()

Specified by:

getLocalName in interface XmlTag

getDescriptor

public XmlElementDescriptor getDescriptor()

Specified by:

getDescriptor in interface XmlTag

getAttributes

public XmlAttribute [] getAttributes()

Specified by:

getAttributes in interface XmlTag

getAttribute

public XmlAttribute getAttribute(java.lang.String name,
                                 java.lang.String namespace)

Specified by:

getAttribute in interface XmlTag

getAttribute

public XmlAttribute getAttribute(java.lang.String qname)

Description copied from interface: XmlTag

Returns a tag attribute by qualified name.

Specified by:

getAttribute in interface XmlTag

Parameters:

qname - qualified attribute name, like "ns:name" or "name".

Returns:

null if the attribute not exist.

See Also:

XmlTag.getAttribute(String, String)

getAttributeValue

public java.lang.String getAttributeValue(java.lang.String name,
                                          java.lang.String namespace)

Specified by:

getAttributeValue in interface XmlTag

getAttributeValue

public java.lang.String getAttributeValue(java.lang.String qname)

Description copied from interface: XmlTag

Returns a tag attribute value by qualified name.

Specified by:

getAttributeValue in interface XmlTag

Parameters:

qname - qualified attribute name, like "ns:name" or "name".

Returns:

null if the attribute not exist.

See Also:

XmlTag.getAttributeValue(String, String)

setAttribute

public XmlAttribute setAttribute(java.lang.String name,
                                 java.lang.String namespace,
                                 java.lang.String value)
                          throws IncorrectOperationException

Specified by:

setAttribute in interface XmlTag

Throws:

IncorrectOperationException

setAttribute

public XmlAttribute setAttribute(java.lang.String qname,
                                 java.lang.String value)
                          throws IncorrectOperationException

Specified by:

setAttribute in interface XmlTag

Throws:

IncorrectOperationException

createChildTag

public XmlTag createChildTag(java.lang.String localName,
                             java.lang.String namespace,
                             java.lang.String bodyText,
                             boolean enforceNamespacesDeep)

Description copied from interface: XmlTag

Creates a new child tag

Specified by:

createChildTag in interface XmlTag

Parameters:

localName - new tag's name

namespace - new tag's namespace

bodyText - pass null to create collapsed tag, empty string means creating expanded one

enforceNamespacesDeep - if you pass some xml tags to bodyText parameter, this flag sets namespace prefixes for them

Returns:

created tag. Use XmlTag.addSubTag(XmlTag, boolean)} to add it to parent

addSubTag

public XmlTag addSubTag(XmlTag subTag,
                        boolean first)

Specified by:

addSubTag in interface XmlTag

getSubTags

public XmlTag [] getSubTags()

Specified by:

getSubTags in interface XmlTag

findSubTags

public XmlTag [] findSubTags(java.lang.String qname)

Specified by:

findSubTags in interface XmlTag

findSubTags

public XmlTag [] findSubTags(java.lang.String localName,
                             java.lang.String namespace)

Specified by:

findSubTags in interface XmlTag

Parameters:

localName - non-qualified tag name.

namespace - if null, name treated as qualified name to find.

findFirstSubTag

public XmlTag findFirstSubTag(java.lang.String qname)

Specified by:

findFirstSubTag in interface XmlTag

getNamespacePrefix

public java.lang.String getNamespacePrefix()

Specified by:

getNamespacePrefix in interface XmlTag

getNamespaceByPrefix

public java.lang.String getNamespaceByPrefix(java.lang.String prefix)

Specified by:

getNamespaceByPrefix in interface XmlTag

getPrefixByNamespace

public java.lang.String getPrefixByNamespace(java.lang.String namespace)

Specified by:

getPrefixByNamespace in interface XmlTag

knownNamespaces

public java.lang.String[] knownNamespaces()

Specified by:

knownNamespaces in interface XmlTag

hasNamespaceDeclarations

public boolean hasNamespaceDeclarations()

Specified by:

hasNamespaceDeclarations in interface XmlTag

getLocalNamespaceDeclarations

public java.util.Map<java.lang.String,java.lang.String> getLocalNamespaceDeclarations()

Specified by:

getLocalNamespaceDeclarations in interface XmlTag

Returns:

map keys: prefixes values: namespaces

getValue

public XmlTagValue getValue()

Specified by:

getValue in interface XmlTag

getNSDescriptor

public XmlNSDescriptor getNSDescriptor(java.lang.String namespace,
                                       boolean strict)

Specified by:

getNSDescriptor in interface XmlTag

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface XmlTag

collapseIfEmpty

public void collapseIfEmpty()

Specified by:

collapseIfEmpty in interface XmlTag

getSubTagText

public java.lang.String getSubTagText(java.lang.String qname)

Specified by:

getSubTagText in interface XmlTag

getMetaData

public PsiMetaData getMetaData()

Specified by:

getMetaData in interface PsiMetaOwner

getNextSiblingInTag

public XmlTagChild getNextSiblingInTag()

Specified by:

getNextSiblingInTag in interface XmlTagChild

getPrevSiblingInTag

public XmlTagChild getPrevSiblingInTag()

Specified by:

getPrevSiblingInTag in interface XmlTagChild