org.apache.flex.compiler.internal.tree.mxml

Class MXMLFileNode

java.lang.Object

org.apache.flex.compiler.common.SourceLocation

org.apache.flex.compiler.internal.tree.as.NodeBase

org.apache.flex.compiler.internal.tree.mxml.MXMLNodeBase

org.apache.flex.compiler.internal.tree.mxml.MXMLFileNode

All Implemented Interfaces:

ISourceLocation, IASNode, IFileNode, IFileNodeAccumulator, IScopedNode, IMXMLFileNode, IMXMLNode

public class MXMLFileNode
extends MXMLNodeBase
implements IMXMLFileNode, IScopedNode, IFileNode, IFileNodeAccumulator

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.flex.compiler.internal.tree.mxml.MXMLNodeBase

MXMLNodeBase.MXMLNodeInfo

Field Summary

Fields inherited from class org.apache.flex.compiler.internal.tree.as.NodeBase

emptyNodeArray, parent

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

UNKNOWN

Constructor Summary

Constructors

Constructor and Description
MXMLFileNode()

Method Summary

Methods

Modifier and Type	Method and Description
void	addDeferredFunctionNode(FunctionNode functionNode) Add a function node whose body contents are deferred.
void	addEmbedNode(IEmbedResolver node) Adds an embed node to the list of embed nodes within this file.
void	addImportNode(IImportNode node) Adds an import node to the list of import nodes within this file.
void	addRequiredResourceBundle(String bundleName) Adds a Resource Bundle to the set of Resource Bundles that are referenced within this file.
protected boolean	buildInnerString(StringBuilder sb) For debugging only.
void	getAllImportNodes(Collection<IImportNode> imports) Returns all the imports that are relevant in the current scope.
void	getAllImports(Collection<String> imports) Returns all the imports that are relevant in the current scope.
IASNode	getChild(int i) Get a particular child of this node
int	getChildCount() Get the number of children
ICompilerProject	getCompilerProject() Returns the project that created this file node.
CSSCompilationSession	getCSSCompilationSession() Get the CSS semantic information.
IMXMLDocumentNode	getDocumentNode() Gets the closest ancestor node that is the root node of the MXML file.
List<IEmbedResolver>	getEmbedNodes() Returns a list of nodes representing embedded assets.
IFileSpecification	getFileSpecification() Get the IFileSpecification that produced this node
List<IImportNode>	getImportNodes() Returns the list of the ImportNodes
long	getIncludeTreeLastModified() Returns a last modification timestamp of the current include file tree
IClassDefinition[]	getLibraryDefinitions()
String	getName() Gets the name of this node.
ASTNodeID	getNodeID() Get the opcode of this node
OffsetLookup	getOffsetLookup()
Collection<ICompilerProblem>	getProblems() Returns the problems that are contained in this file.
Set<String>	getRequiredResourceBundles()
IASScope	getScope() Get the scope associated with this node as an IASScope
List<IMXMLStyleNode>	getStyleNodes() Assuming MXMLStyleNode is always a direct child of MXMLDocumentNode.
ITargetAttributes	getTargetAttributes(ICompilerProject project) If this IFileNode can be used as the MXML main application or ActionScript main class, it returns attributes related to SWF target.
IDefinitionNode[]	getTopLevelDefinitionNodes(boolean includeDefinitionsOutsideOfPackage, boolean includeNonPublicDefinitions) Gets definition nodes within this file node that are children of the file node or children of a package block node.
IDefinition[]	getTopLevelDefinitions(boolean includeDefinitionsOutsideOfPackage, boolean includeNonPublicDefinitions) Gets the definitions corresponding to the definitions nodes within this file node that are children of the file node or children of a package block node.
boolean	hasIncludes()
void	populateFunctionNodes() Rebuild function body nodes.
protected void	updateIncludeTreeLastModified(long lastModified)

Methods inherited from class org.apache.flex.compiler.internal.tree.mxml.MXMLNodeBase

accumulateTextFragments, adjustOffsets, createNodeInfo, getClassDefinitionNode, getFileNode, initializationComplete, initializeFromTag, isValidASIdentifier, isValidForCodeGen, isValidXMLTagName, processChildNonWhitespaceUnit, processChildTag, processChildWhitespaceUnit, processIncludeInOrExcludeFromAttribute, processTagSpecificAttribute, processUnitAsAS, resolveSourceAttributePath, setLocation, setLocation, setLocation, setLocation, setLocation

Methods inherited from class org.apache.flex.compiler.internal.tree.as.NodeBase

analyze, buildStringRecursive, canContinueContainmentSearch, collectImportNodes, combineAttributes, connectedToProjectScope, contains, endAfter, endAfter, endBefore, endBefore, fillInOffsets, getAbsoluteEnd, getAbsoluteStart, getAncestorOfType, getASScope, getContainingFilePath, getContainingNode, getContainingScope, getEnd, getFileScope, getInnerString, getNodeKind, getPackageName, getParent, getScopeNode, getSpanningStart, getStart, getSucceedingNode, getWorkspace, isTerminal, isTransparent, looselyContains, normalize, replaceChild, runPostProcess, setChildren, setParent, span, span, span, startAfter, startAfter, startBefore, startBefore, swapChildren, toString, tryGetOffsetLookup, verify

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

getColumn, getEndColumn, getEndLine, getLine, getLineColumnString, getOffsetsString, getSourcePath, getSourcePathString, 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.tree.mxml.IMXMLNode

getClassDefinitionNode, getFileNode, isValidForCodeGen

Methods inherited from interface org.apache.flex.compiler.tree.as.IASNode

contains, getAncestorOfType, getContainingNode, getContainingScope, getPackageName, getParent, getSpanningStart, getSucceedingNode, isTerminal

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

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

Constructor Detail

MXMLFileNode

public MXMLFileNode()

Method Detail

getChild

public IASNode getChild(int i)

Description copied from interface: IASNode

Get a particular child of this node

Specified by:

getChild in interface IASNode

Overrides:

getChild in class MXMLNodeBase

Parameters:

i - the child's index

Returns:

the specified child

getChildCount

public int getChildCount()

Description copied from interface: IASNode

Get the number of children

Specified by:

getChildCount in interface IASNode

Overrides:

getChildCount in class MXMLNodeBase

Returns:

the number of children

getNodeID

public ASTNodeID getNodeID()

Description copied from interface: IASNode

Get the opcode of this node

Specified by:

getNodeID in interface IASNode

Returns:

the opcode - this is one of the constants defined in ASTConstants

getName

public String getName()

Description copied from interface: IMXMLNode

Gets the name of this node.

For a node that refers to a class, this is the fully-qualified ActionScript class name. (For example, for <s:Button> it would be "spark.components.Button".)

For a node that specifies a property, style, or event, this is the name of the property, style, or event. (For example, for <s:text> it would be "text".)

For a language node, this is the short name of the tag. (For example, for <fx:Script> it would be "Script".)

Specified by:

getName in interface IMXMLNode

Returns:

The name of this node as a String.

getDocumentNode

public IMXMLDocumentNode getDocumentNode()

Description copied from interface: IMXMLNode

Gets the closest ancestor node that is the root node of the MXML file.

Specified by:

getDocumentNode in interface IMXMLFileNode

Specified by:

getDocumentNode in interface IMXMLNode

Overrides:

getDocumentNode in class MXMLNodeBase

Returns:

An IMXMLDocumentNode object.

getScope

public IASScope getScope()

Description copied from interface: IScopedNode

Get the scope associated with this node as an IASScope

Specified by:

getScope in interface IScopedNode

Returns:

scope associated with this node

getAllImports

public void getAllImports(Collection<String> imports)

Description copied from interface: IScopedNode

Returns all the imports that are relevant in the current scope. This will walk up the scope chain. If we are in a package context, this will avoid adding imports from the a File scope.

Specified by:

getAllImports in interface IScopedNode

Parameters:

imports - an array of Strings representing all the imports

getAllImportNodes

public void getAllImportNodes(Collection<IImportNode> imports)

Description copied from interface: IScopedNode

Returns all the imports that are relevant in the current scope. This will walk up the scope chain. If we are in a package context, this will avoid adding imports from the a File scope.

Specified by:

getAllImportNodes in interface IScopedNode

Parameters:

imports - an array of IImportNode representing all the imports

getTopLevelDefinitions

public IDefinition[] getTopLevelDefinitions(boolean includeDefinitionsOutsideOfPackage,
                                   boolean includeNonPublicDefinitions)

Description copied from interface: IFileNode

Gets the definitions corresponding to the definitions nodes within this file node that are children of the file node or children of a package block node.

Specified by:

getTopLevelDefinitions in interface IFileNode

Parameters:

includeDefinitionsOutsideOfPackage - A flag indicating whether definitions that aren't in a package should be included.

includeNonPublicDefinitions - A flag indicating whether definitions that don't have a public keyword should be included.

Returns:

An array of IDefinition objects.

getTopLevelDefinitionNodes

public IDefinitionNode[] getTopLevelDefinitionNodes(boolean includeDefinitionsOutsideOfPackage,
                                           boolean includeNonPublicDefinitions)

Description copied from interface: IFileNode

Gets definition nodes within this file node that are children of the file node or children of a package block node.

Specified by:

getTopLevelDefinitionNodes in interface IFileNode

Parameters:

includeDefinitionsOutsideOfPackage - A flag indicating whether definition nodes that aren't in a package should be included.

includeNonPublicDefinitions - A flag indicating whether definition nodes that don't have a public keyword should be included.

Returns:

An array of IDefinitionNode objects.

hasIncludes

public boolean hasIncludes()

Specified by:

hasIncludes in interface IFileNode

Returns:

True is this file contains any include statements

getLibraryDefinitions

public IClassDefinition[] getLibraryDefinitions()

getFileSpecification

public IFileSpecification getFileSpecification()

Description copied from interface: IASNode

Get the IFileSpecification that produced this node

Specified by:

getFileSpecification in interface IASNode

Overrides:

getFileSpecification in class NodeBase

Returns:

the source of this node

getCompilerProject

public ICompilerProject getCompilerProject()

Description copied from interface: IMXMLFileNode

Returns the project that created this file node.

Specified by:

getCompilerProject in interface IMXMLFileNode

Returns:

An ICompilerProject object.

buildInnerString

protected boolean buildInnerString(StringBuilder sb)

For debugging only. Builds a string such as "C:\test.mxml" from the path of the file node.

Overrides:

buildInnerString in class NodeBase

updateIncludeTreeLastModified

protected void updateIncludeTreeLastModified(long lastModified)

Parameters:

lastModified -

getIncludeTreeLastModified

public long getIncludeTreeLastModified()

Description copied from interface: IFileNode

Returns a last modification timestamp of the current include file tree

Specified by:

getIncludeTreeLastModified in interface IFileNode

Returns:

A time stamp of the last modification time this filenode's include tree

addImportNode

public void addImportNode(IImportNode node)

Description copied from interface: IFileNodeAccumulator

Adds an import node to the list of import nodes within this file.

Specified by:

addImportNode in interface IFileNodeAccumulator

Parameters:

node - Node to add

getImportNodes

public List<IImportNode> getImportNodes()

Description copied from interface: IFileNodeAccumulator

Returns the list of the ImportNodes

Specified by:

getImportNodes in interface IFileNodeAccumulator

Returns:

ImportNode list or empty list

addEmbedNode

public void addEmbedNode(IEmbedResolver node)

Description copied from interface: IFileNodeAccumulator

Adds an embed node to the list of embed nodes within this file.

Specified by:

addEmbedNode in interface IFileNodeAccumulator

Parameters:

node - Node to add

getEmbedNodes

public List<IEmbedResolver> getEmbedNodes()

Description copied from interface: IMXMLFileNode

Returns a list of nodes representing embedded assets.

These can be either nodes representing the initialization value of a variable with [Embed(...)] metadata, or nodes representing the compiler directive @Embed(...)).

Specified by:

getEmbedNodes in interface IFileNodeAccumulator

Specified by:

getEmbedNodes in interface IMXMLFileNode

Returns:

A list of IEmbedResolver objects.

addRequiredResourceBundle

public void addRequiredResourceBundle(String bundleName)

Description copied from interface: IFileNodeAccumulator

Adds a Resource Bundle to the set of Resource Bundles that are referenced within this file. A ResourceBundle stated as required by either using a [ResourceBundle(...)] metadata or a @Resource compiler directive (MXML only).

Specified by:

addRequiredResourceBundle in interface IFileNodeAccumulator

Parameters:

bundleName - name of the Resource Bundle

getRequiredResourceBundles

public Set<String> getRequiredResourceBundles()

Specified by:

getRequiredResourceBundles in interface IFileNodeAccumulator

Returns:

the set of ResourceBundles required for the associated file.

getOffsetLookup

public OffsetLookup getOffsetLookup()

Specified by:

getOffsetLookup in interface IFileNode

Returns:

OffsetLookup object of this file node.

getStyleNodes

public List<IMXMLStyleNode> getStyleNodes()

Assuming MXMLStyleNode is always a direct child of MXMLDocumentNode.

Specified by:

getStyleNodes in interface IMXMLFileNode

Returns:

A list of IMXMLStyleNode's in this MXML document.

getTargetAttributes

public ITargetAttributes getTargetAttributes(ICompilerProject project)

Description copied from interface: IFileNode

If this IFileNode can be used as the MXML main application or ActionScript main class, it returns attributes related to SWF target. Otherwise, this method returns null.

Specified by:

getTargetAttributes in interface IFileNode

Parameters:

project - Context project.

Returns:

Target attributes collected from special MXML attributes or ActionScript metadata tag.

getCSSCompilationSession

public CSSCompilationSession getCSSCompilationSession()

Get the CSS semantic information.

Specified by:

getCSSCompilationSession in interface IMXMLFileNode

Returns:

CSS semantic information.

addDeferredFunctionNode

public void addDeferredFunctionNode(FunctionNode functionNode)

Description copied from interface: IFileNodeAccumulator

Add a function node whose body contents are deferred.

Specified by:

addDeferredFunctionNode in interface IFileNodeAccumulator

Parameters:

functionNode - Function node.

populateFunctionNodes

public void populateFunctionNodes()

Description copied from interface: IFileNode

Rebuild function body nodes.

Specified by:

populateFunctionNodes in interface IFileNode

getProblems

public Collection<ICompilerProblem> getProblems()

Description copied from interface: IFileNode

Returns the problems that are contained in this file.

Specified by:

getProblems in interface IFileNode

Returns:

An array of ICompilerProblem objects