org.apache.flex.compiler.mxml

Interface IMXMLUnitData

All Superinterfaces:

ISourceLocation

All Known Subinterfaces:

IMXMLInstructionData, IMXMLTagData, IMXMLTextData

All Known Implementing Classes:

MXMLInstructionData, MXMLTagData, MXMLTextData, MXMLUnitData

public interface IMXMLUnitData
extends ISourceLocation

Represents one unit of MXML.

Field Summary

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

UNKNOWN

Method Summary

Methods

Modifier and Type	Method and Description
boolean	containsOffset(int offset) Does this unit contain the given offset (excluding start and including end)?
IMXMLTagData	getContainingTag(int offset) Get the nearest containing tag.
int	getContentEnd() Returns the offset after the last character of actual content.
int	getContentStart() Returns the first character of the actual content of the unit For most units this is the same as getStart(), but for things like tags which have "junk punctuation" around them, SourceLocation.getAbsoluteStart() will return the junk punctuation, whereas getContentStart will get the content inside the punctuation.
int	getIndex() Get this unit's position in the IMXMLData.
MXMLDialect	getMXMLDialect() Returns the MXML dialect used in the MXML document that contains this unit.
IMXMLUnitData	getNext() Gets the next MXML unit.
IMXMLUnitData	getNextSiblingUnit() Gets the next sibling unit after this unit.
IMXMLTagData	getNextTag() Gets the next tag.
IMXMLData	getParent() Gets the IMXMLData representing the MXML document that contains this unit.
IMXMLUnitData	getParentUnitData() Gets the IMXMLUnitData which is the hierarchical parent of this unit in its parents array of IMXMLUnitData objects
IMXMLUnitData	getPrevious() Gets the previous MXML unit.
IFileSpecification	getSource() Gets the source file that contains this unit.
boolean	isCloseTag() Is this MXML unit an close tag?
boolean	isOpenAndNotEmptyTag() Is this MXML unit an open tag and not an empty tag (i.e. only <foo>, not <foo;/>)?
boolean	isOpenTag() Is this MXML unit an open tag?
boolean	isTag() Is this MXML unit a tag?
boolean	isText() Is this MXML unit a block of text?

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

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

Method Detail

getSource

IFileSpecification getSource()

Gets the source file that contains this unit.

Returns:

An IFileSpecification representing the source file.

getParent

IMXMLData getParent()

Gets the IMXMLData representing the MXML document that contains this unit.

Returns:

The IMXMLData that contains this unit.

getMXMLDialect

MXMLDialect getMXMLDialect()

Returns the MXML dialect used in the MXML document that contains this unit.

Returns:

An MXMLDialect object.

getIndex

int getIndex()

Get this unit's position in the IMXMLData.

Returns:

The index of this unit.

containsOffset

boolean containsOffset(int offset)

Does this unit contain the given offset (excluding start and including end)?

Returns:

true if the offset falls within this unit's bounds.

getParentUnitData

IMXMLUnitData getParentUnitData()

Gets the IMXMLUnitData which is the hierarchical parent of this unit in its parents array of IMXMLUnitData objects

Returns:

the parent IMXMLUnitData or null.

getContainingTag

IMXMLTagData getContainingTag(int offset)

Get the nearest containing tag. Moving backwards through the list of tokens for this MXML file, this is the first open tag that you find for which you haven't found a corresponding close.

Returns:

nearest containing open tag (or null, if no such open tag exists)

isText

boolean isText()

Is this MXML unit a block of text?

Returns:

true if the unit is a block of text

isTag

boolean isTag()

Is this MXML unit a tag?

Returns:

true if the unit is a tag

isOpenTag

boolean isOpenTag()

Is this MXML unit an open tag?

Returns:

true if the unit is an open tag

isOpenAndNotEmptyTag

boolean isOpenAndNotEmptyTag()

Is this MXML unit an open tag and not an empty tag (i.e. only <foo>, not <foo;/>)?

Returns:

true if the unit is an open tag, and not an empty tag

isCloseTag

boolean isCloseTag()

Is this MXML unit an close tag?

Returns:

true if the unit is a close tag

getContentStart

int getContentStart()

Returns the first character of the actual content of the unit For most units this is the same as getStart(), but for things like tags which have "junk punctuation" around them, SourceLocation.getAbsoluteStart() will return the junk punctuation, whereas getContentStart will get the content inside the punctuation.

getContentEnd

int getContentEnd()

Returns the offset after the last character of actual content. See getContentStart() for more.

getNext

IMXMLUnitData getNext()

Gets the next MXML unit.

Returns:

The next MXML unit.

getNextSiblingUnit

IMXMLUnitData getNextSiblingUnit()

Gets the next sibling unit after this unit. The next sibling unit may be a tag or text. If there is no sibling unit after this one, this method returns null.

Returns:

The next sibling unit.

getNextTag

IMXMLTagData getNextTag()

Gets the next tag.

Returns:

The next tag, or null if none.

getPrevious

IMXMLUnitData getPrevious()

Gets the previous MXML unit.

Returns:

the previous MXML unit.