org.apache.royale.compiler.mxml

Interface IMXMLTagData

All Superinterfaces:

IMXMLUnitData, ISourceLocation

public interface IMXMLTagData
extends IMXMLUnitData

Represents an open tag, a close tag, or an empty tag in MXML.

Field Summary

Fields inherited from interface org.apache.royale.compiler.common.ISourceLocation

UNKNOWN

Method Summary

Modifier and Type	Method and Description
IMXMLTagData	findMatchingEndTag() Finds the close tag that matches this tag.
IMXMLTagAttributeData[]	getAttributeDatas() Gets all of the attributes in this tag.
String	getCompilableText() Gets this compilable text inside this tag.
PrefixMap	getCompositePrefixMap() Gets the namespace mapping that apply to this tag, taking ancestor tags into account.
IMXMLTagData	getFirstChild(boolean includeEmptyTags) Gets the first child open tag of this tag.
IMXMLUnitData	getFirstChildUnit() Gets the first child unit inside this tag.
ISourceLocation	getLocationOfChildUnits() Gets the source location of this tag's child units.
String	getName() Gets the name of this tag as written, such as "s:width.over" .
IMXMLTagData	getNextSibling(boolean includeEmptyTags) Gets the next sibling open tag of this tag.
IMXMLTagData	getParentTag() Gets the tag that contains this tag.
String	getPrefix() Gets the prefix of this tag.
PrefixMap	getPrefixMap() Gets the namespace mappings specified on this tag.
String	getRawAttributeValue(String attributeName) Gets the attribute value in this tag for the specified attribute name.
String	getShortName() Gets the short name of this tag, not including the prefix or state.
String	getStateName() Gets the state name for this tag.
IMXMLTagAttributeData	getTagAttributeData(String attributeName) Gets the attribute in this tag that has the specified name.
String	getURI() Gets the URI of this tag.
XMLName	getXMLName() Gets the name of this tag as an XMLName.
boolean	hasExplicitCloseTag() Determines whether this tag has an actual close tag, and was not closed as a post-process step of MXML repair.
boolean	isCloseTag() Determines whether this tag is a close tag.
boolean	isEmptyTag() Determines whether this tag is empty.
boolean	isImplicit() Determines whether this tag does not actually exist within the MXML document that is its source.
boolean	isOffsetInAttributeList(int offset) Determines whether the specified offset falls inside the attribute list of this tag.

Methods inherited from interface org.apache.royale.compiler.mxml.IMXMLUnitData

containsOffset, getContainingTag, getContentEnd, getContentStart, getIndex, getMXMLDialect, getNext, getNextSiblingUnit, getNextTag, getParent, getParentUnitData, getPrevious, getSource, isOpenAndNotEmptyTag, isOpenTag, isTag, isText

Methods inherited from interface org.apache.royale.compiler.common.ISourceLocation

getAbsoluteEnd, getAbsoluteStart, getColumn, getEnd, getEndColumn, getEndLine, getLine, getSourcePath, getStart

Method Detail

getParentTag

IMXMLTagData getParentTag()

Gets the tag that contains this tag.

If the document is not balanced before this tag, this method returns null.

Returns:

An IMXMLTagData object.

isEmptyTag

boolean isEmptyTag()

Determines whether this tag is empty.

Returns:

true if it is.

isCloseTag

boolean isCloseTag()

Determines whether this tag is a close tag.

Specified by:

isCloseTag in interface IMXMLUnitData

Returns:

true if it is.

hasExplicitCloseTag

boolean hasExplicitCloseTag()

Determines whether this tag has an actual close tag, and was not closed as a post-process step of MXML repair.

Returns:

If we have an explicit close tag.

getName

String getName()

Gets the name of this tag as written, such as "s:width.over" .

Returns:

The complete tag name, including a possible prefix and state.

getPrefix

String getPrefix()

Gets the prefix of this tag.

If the tag does not have a prefix, this method returns null.

Returns:

The prefix as a String, or null.

getPrefixMap

PrefixMap getPrefixMap()

Gets the namespace mappings specified on this tag.

Returns:

A prefix map.

getCompositePrefixMap

PrefixMap getCompositePrefixMap()

Gets the namespace mapping that apply to this tag, taking ancestor tags into account.

Returns:

A prefix map.

getURI

String getURI()

Gets the URI of this tag.

If the tag does not have a prefix, this method returns null.

Returns:

The URI as a String, or null.

getShortName

String getShortName()

Gets the short name of this tag, not including the prefix or state.

Returns:

The short tag name as a String

getXMLName

XMLName getXMLName()

Gets the name of this tag as an XMLName.

This takes into account the prefix but not the state.

Returns:

The tag name as an XMLName.

getStateName

String getStateName()

Gets the state name for this tag.

Returns:

The state name as a String

isOffsetInAttributeList

boolean isOffsetInAttributeList(int offset)

Determines whether the specified offset falls inside the attribute list of this tag.

Parameters:

offset - The offset to test.

Returns:

true if the offset falls inside this tag's attribute list.

getAttributeDatas

IMXMLTagAttributeData[] getAttributeDatas()

Gets all of the attributes in this tag.

Returns:

All of the attributes as a array of IMXMLTagAttributeData objects.

getTagAttributeData

IMXMLTagAttributeData getTagAttributeData(String attributeName)

Gets the attribute in this tag that has the specified name.

Parameters:

attributeName - The name of the attribute.

Returns:

The attribute, or null if no such attribute exists.

getRawAttributeValue

String getRawAttributeValue(String attributeName)

Gets the attribute value in this tag for the specified attribute name.

This value does not include the quotes.

Parameters:

attributeName - The name of the attribute.

Returns:

The value of the attribute, or null if no such attribute exists.

getLocationOfChildUnits

ISourceLocation getLocationOfChildUnits()

Gets the source location of this tag's child units.

Returns:

A source location.

getFirstChildUnit

IMXMLUnitData getFirstChildUnit()

Gets the first child unit inside this tag.

The child unit may be a tag or text. If there is no child unit, this method returns null.

Returns:

The first child unit inside this tag.

getFirstChild

IMXMLTagData getFirstChild(boolean includeEmptyTags)

Gets the first child open tag of this tag.

"First child" means the first open (or maybe empty) tag found before a close tag. If this is a close tag, this method starts looking after the corresponding start tag.

Returns:

Child tag, or null if none.

getNextSibling

IMXMLTagData getNextSibling(boolean includeEmptyTags)

Gets the next sibling open tag of this tag.

"Sibling" is defined as the first open (or maybe empty) tag after this tag's close tag. If this is a close tag, this method starts looking after the corresponding start tag.

Returns:

Sibling, or null if none.

findMatchingEndTag

IMXMLTagData findMatchingEndTag()

Finds the close tag that matches this tag.

Returns null if this tag is a close or empty tag.

Returns null if a surrounding tag is unbalanced; this is determined by backing up to the innermost parent tag with a different tag.

<a> <b> <b> <-- find matching for this one will return null </b> </a> *

getCompilableText

String getCompilableText()

Gets this compilable text inside this tag. The compilable text may appear as multiple child text units, and there may also be comments (which are ignored). If any child units are tags rather than text, they are simply ignored.

Returns:

The compilable text inside this tag.

isImplicit

boolean isImplicit()

Determines whether this tag does not actually exist within the MXML document that is its source.

Returns:

true if this tag is implicit.