org.apache.flex.compiler.mxml

Interface IMXMLData

All Known Implementing Classes:

MXMLData

public interface IMXMLData

Represents the syntax, but not the semantics, of an MXML file.

The file is represented as a sequence of "units", one for each open tag, close tag, and block of text.

No meaning is assigned to any tag, attribute, or text.

Method Summary

Methods

Modifier and Type	Method and Description
IMXMLTagData	findTagOrSurroundingTagContainingOffset(int offset) Similar to findTagContainingOffset, but if the unit inside offset is a text node, will return the surrounding tag instead.
int	getEnd() Gets the ending offset of the last unit.
IFileSpecification	getFileSpecification() Gets the file on disk that created this MXMLData.
MXMLDialect	getMXMLDialect() Gets the MXML dialect being used.
int	getNumUnits() Gets the number of MXML "units".
String	getPath() Gets the path to the file on disk that created this MXMLData.
PrefixMap	getPrefixMapForData(IMXMLTagData data) Returns the PrefixMap for the given IMXMLTagData.
Collection<ICompilerProblem>	getProblems() Gets the compiler problems found during the creation of this MXMLData.
IMXMLTagData	getRootTag() Gets the root tag.
IMXMLUnitData	getUnit(int i) Gets an MXML unit by index.
IMXMLUnitData[]	getUnits() Get the MXML units found in this IMXMLData.

Method Detail

getFileSpecification

IFileSpecification getFileSpecification()

Gets the file on disk that created this MXMLData.

Returns:

The file as an IFileSpecification.

getPath

String getPath()

Gets the path to the file on disk that created this MXMLData.

Returns:

The path as a String.

getMXMLDialect

MXMLDialect getMXMLDialect()

Gets the MXML dialect being used.

Returns:

An MXMLDialect.

getUnits

IMXMLUnitData[] getUnits()

Get the MXML units found in this IMXMLData.

Returns:

An array of the IMXMLUnitData.

getNumUnits

int getNumUnits()

Gets the number of MXML "units".

Each unit represents an open tag, a close tag, a block of text, etc.

Returns:

The number of MXMLUnitData objects you can retrieve with getUnit().

getUnit

IMXMLUnitData getUnit(int i)

Gets an MXML unit by index.

Parameters:

i - The index into the list of MXML units.

Returns:

The specified MXML unit, or null if the index is out of range.

getProblems

Collection<ICompilerProblem> getProblems()

Gets the compiler problems found during the creation of this MXMLData.

Returns:

A collection of ICompilerProblem objects.

getEnd

int getEnd()

Gets the ending offset of the last unit.

getRootTag

IMXMLTagData getRootTag()

Gets the root tag.

Returns:

An MXMLTagData for the root tag.

findTagOrSurroundingTagContainingOffset

IMXMLTagData findTagOrSurroundingTagContainingOffset(int offset)

Similar to findTagContainingOffset, but if the unit inside offset is a text node, will return the surrounding tag instead.

Parameters:

offset - offset

Returns:

the containing/surrounding tag, or null if one can not be found

getPrefixMapForData

PrefixMap getPrefixMapForData(IMXMLTagData data)

Returns the PrefixMap for the given IMXMLTagData. This will not walk up the chain of prefix maps if this tag does not physically have uri->namespace mappings.

Parameters:

data - the IMXMLTagData to find the PrefixMap for

Returns:

a PrefixMap or null