org.apache.flex.compiler.internal.mxml

Class MXMLTextData

java.lang.Object

org.apache.flex.compiler.common.SourceLocation

org.apache.flex.compiler.internal.mxml.MXMLUnitData

org.apache.flex.compiler.internal.mxml.MXMLTextData

All Implemented Interfaces:

ISourceLocation, IMXMLTextData, IMXMLUnitData

public class MXMLTextData
extends MXMLUnitData
implements IMXMLTextData

Encapsulation of a block of text in MXML

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.flex.compiler.mxml.IMXMLTextData

IMXMLTextData.TextType

Field Summary

Fields inherited from class org.apache.flex.compiler.internal.mxml.MXMLUnitData

index

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

UNKNOWN

Method Summary

Methods

Modifier and Type	Method and Description
String	getCompilableText() Gets this unit's compilable text as a String.
int	getCompilableTextColumn() Gets the column of this unit's compilable text.
int	getCompilableTextEnd() Gets the end of this unit's compilable text.
int	getCompilableTextLine() Gets the line of this unit's compilable text.
int	getCompilableTextStart() Gets the start of this unit's compilable text.
String	getContent() Gets the content of the text.
String	getContents() Return the text contained within this unit, without any opening or closing delimiters
int	getContentsColumn()
int	getContentsEnd()
int	getContentsLine()
int	getContentsStart()
ISourceFragment[]	getFragments(Collection<ICompilerProblem> problems) Gets the source fragments that make up this text.
IMXMLTextData.TextType	getTextType() Gets the type of the text.
String	getTypeString()
boolean	isText() Is this MXML unit a block of text?
String	toDumpString() For debugging only.
String	toString() Displays line, column, start, end, and sourcepath in a format such as "17:5 160-188 C:\test.as"

Methods inherited from class org.apache.flex.compiler.internal.mxml.MXMLUnitData

adjustOffsets, buildDumpString, containsOffset, getContainingTag, getContentEnd, getContentStart, getIndex, getMXMLDialect, getNext, getNextSiblingUnit, getNextTag, getParent, getParentUnitData, getParentUnitDataIndex, getPrevious, getSource, isCloseTag, isOpenAndNotEmptyTag, isOpenTag, isTag, setLocation, setOffsets, setParentUnitDataIndex, verify

Methods inherited from class org.apache.flex.compiler.common.SourceLocation

getAbsoluteEnd, getAbsoluteStart, getColumn, getEnd, getEndColumn, getEndLine, getLine, getLineColumnString, getOffsetsString, getSourcePath, getSourcePathString, getStart, setColumn, setEnd, setEndColumn, setEndLine, setLine, setSourceLocation, setSourcePath, setStart, span, span

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

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

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

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

Method Detail

toString

public String toString()

Description copied from class: SourceLocation

Displays line, column, start, end, and sourcepath in a format such as

 "17:5 160-188 C:\test.as"
 

Overrides:

toString in class SourceLocation

isText

public boolean isText()

Description copied from interface: IMXMLUnitData

Is this MXML unit a block of text?

Specified by:

isText in interface IMXMLUnitData

Overrides:

isText in class MXMLUnitData

Returns:

true if the unit is a block of text

getTypeString

public String getTypeString()

Overrides:

getTypeString in class MXMLUnitData

toDumpString

public String toDumpString()

Description copied from class: MXMLUnitData

For debugging only. This format is nice in a text file.

Overrides:

toDumpString in class MXMLUnitData

getContent

public String getContent()

Description copied from interface: IMXMLTextData

Gets the content of the text.

Specified by:

getContent in interface IMXMLTextData

Returns:

The content as a String.

getTextType

public IMXMLTextData.TextType getTextType()

Description copied from interface: IMXMLTextData

Gets the type of the text.

Specified by:

getTextType in interface IMXMLTextData

Returns:

A IMXMLTextData.TextType value.

getCompilableText

public String getCompilableText()

Description copied from interface: IMXMLTextData

Gets this unit's compilable text as a String.

Comments have no compilable text. The compilable text of a CDATA unit is the text between the .

Specified by:

getCompilableText in interface IMXMLTextData

Returns:

This unit's compilable text.

getCompilableTextStart

public int getCompilableTextStart()

Description copied from interface: IMXMLTextData

Gets the start of this unit's compilable text.

Specified by:

getCompilableTextStart in interface IMXMLTextData

Returns:

The start of the compilable text

getCompilableTextEnd

public int getCompilableTextEnd()

Description copied from interface: IMXMLTextData

Gets the end of this unit's compilable text.

Specified by:

getCompilableTextEnd in interface IMXMLTextData

Returns:

The end of the compilable text

getCompilableTextLine

public int getCompilableTextLine()

Description copied from interface: IMXMLTextData

Gets the line of this unit's compilable text.

Specified by:

getCompilableTextLine in interface IMXMLTextData

Returns:

The line of the compilable text

getCompilableTextColumn

public int getCompilableTextColumn()

Description copied from interface: IMXMLTextData

Gets the column of this unit's compilable text.

Specified by:

getCompilableTextColumn in interface IMXMLTextData

Returns:

The column of the compilable text

getContents

public String getContents()

Return the text contained within this unit, without any opening or closing delimiters

Returns:

a normalized string

getContentsStart

public int getContentsStart()

Returns:

The start offset of actual content

getContentsEnd

public int getContentsEnd()

Returns:

The end offset of content

getContentsLine

public int getContentsLine()

getContentsColumn

public int getContentsColumn()

getFragments

public ISourceFragment[] getFragments(Collection<ICompilerProblem> problems)

Description copied from interface: IMXMLTextData

Gets the source fragments that make up this text.

Specified by:

getFragments in interface IMXMLTextData

Parameters:

problems - A collection of compiler problems to add problems to.

Returns:

An array of source fragments.