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

Class MXMLDocumentNode

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.MXMLClassDefinitionNode

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

All Implemented Interfaces:

ISourceLocation, IASNode, ICommonClassNode, IDefinitionNode, IDocumentableDefinitionNode, IScopedDefinitionNode, IScopedNode, ITypeNode, IMXMLClassDefinitionNode, IMXMLClassReferenceNode, IMXMLDocumentNode, IMXMLNode

public class MXMLDocumentNode
extends MXMLClassDefinitionNode
implements IMXMLDocumentNode

MXMLDocumentNode represents the root MXML tag in an MXML document.

Nested Class Summary

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

MXMLNodeBase.MXMLNodeInfo

Field Summary

Fields

Modifier and Type	Field and Description
MXMLClassDirectiveProcessor	cdp
protected Map<String,String>	rootAttributes A map of special attribute values.

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
MXMLDocumentNode(NodeBase parent) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	buildInnerString(StringBuilder sb) For debugging only.
protected MXMLNodeBase.MXMLNodeInfo	createNodeInfo(MXMLTreeBuilder builder)
protected org.apache.flex.compiler.internal.tree.mxml.MXMLSpecifierNodeBase	createSpecifierNode(MXMLTreeBuilder builder, String specifierName) Resolve the specifier name in the class definition to a member definition, and create a specifier node based on the member type.
IASNode	getChild(int i) Get a particular child of this node
int	getChildCount() Get the number of children
IClassDefinition	getClassReference(ICompilerProject project) Gets the definition of the ActionScript class corresponding to this MXML tag.
IMXMLEventSpecifierNode	getEventSpecifierNode(String name) Gets the child node specifying a particular event.
IMXMLEventSpecifierNode[]	getEventSpecifierNodes() Gets all the child nodes that specify events.
String	getName() Gets the name of this node.
ASTNodeID	getNodeID() Get the opcode of this node
IMXMLPropertySpecifierNode	getPropertySpecifierNode(String name) Gets the child node specifying a particular property.
IMXMLPropertySpecifierNode[]	getPropertySpecifierNodes() Gets all the child nodes that specify properties.
IMXMLSpecifierNode[]	getSpecifierNodesWithSuffix(String suffix) Gets all the child nodes that represent properties, styles, and events and which have a particular suffix specifying a state or state group.
boolean	isContainer() Does the class referenced by this node implement mx.core.IContainer?
boolean	isDeferredInstantiationUIComponent() Does the class referenced by this node implement mx.core.IDeferredInstantiatonUIComponent?
boolean	isMXMLObject() Does the class referenced by this node implement mx.core.IMXMLObject?
boolean	isVisualElementContainer() Does the class referenced by this node implement mx.core.IVisualElementContainer?
protected void	processChildNonWhitespaceUnit(MXMLTreeBuilder builder, IMXMLTagData tag, IMXMLTextData text, MXMLNodeBase.MXMLNodeInfo info) Processes a single child text unit which is not all whitespace.
protected void	processChildTag(MXMLTreeBuilder builder, IMXMLTagData tag, IMXMLTagData childTag, MXMLNodeBase.MXMLNodeInfo info) Processes a single child tag.
protected void	processTagSpecificAttribute(MXMLTreeBuilder builder, IMXMLTagData tag, IMXMLTagAttributeData attribute, MXMLNodeBase.MXMLNodeInfo info) Add all attributes to rootAttributes.

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

generateID, getAllImportNodes, getAllImports, getAllStateDependentNodes, getASDocComment, getBaseClassName, getClassClassification, getClassDefinition, getDeclarationsNodes, getDefinition, getGeneratedID, getHasDataBindings, getImplementedInterfaces, getInitialState, getMetadataNodes, getMetaInfos, getMetaTags, getMetaTagsByName, getNameAbsoluteEnd, getNameAbsoluteStart, getNameEnd, getNameExpressionNode, getNamespace, getNameStart, getNodesDependentOnState, getNodeWithID, getPackageName, getQualifiedName, getScope, getScopedNode, getScriptNodes, getShortName, getStateByName, getStateGroupByName, getStateGroupNames, getStateGroups, getStateNames, getStateNode, getStates, hasExplicitComment, hasModifier, hasNamespace, initializationComplete, isImplicit, isState, needsDescriptor, needsDocumentDescriptor, setASDocComment, setHasDataBindings, setScope

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

accumulateTextFragments, adjustOffsets, getClassDefinitionNode, getDocumentNode, getFileNode, initializeFromTag, isValidASIdentifier, isValidForCodeGen, isValidXMLTagName, processChildWhitespaceUnit, processIncludeInOrExcludeFromAttribute, 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, getFileSpecification, getInnerString, getNodeKind, 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.IMXMLClassDefinitionNode

getAllStateDependentNodes, getClassDefinition, getDeclarationsNodes, getGeneratedID, getHasDataBindings, getInitialState, getMetadataNodes, getNodesDependentOnState, getNodeWithID, getScriptNodes, getStateByName, getStateGroupByName, getStateGroupNames, getStateGroups, getStateNames, getStates

Methods inherited from interface org.apache.flex.compiler.tree.mxml.IMXMLClassReferenceNode

getClassReference, getEventSpecifierNode, getEventSpecifierNodes, getPropertySpecifierNode, getPropertySpecifierNodes, getSpecifierNodesWithSuffix, isContainer, isDeferredInstantiationUIComponent, isMXMLObject, isVisualElementContainer, needsDescriptor, needsDocumentDescriptor

Methods inherited from interface org.apache.flex.compiler.tree.mxml.IMXMLNode

getClassDefinitionNode, getDocumentNode, getFileNode, getName, isValidForCodeGen

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

getBaseClassName, getClassClassification, getDefinition, getImplementedInterfaces, getMetaTagsByName

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

getScopedNode

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

getContainingFilePath, getMetaInfos, getMetaTags, getName, getNameAbsoluteEnd, getNameAbsoluteStart, getNameEnd, getNameExpressionNode, getNamespace, getNameStart, getQualifiedName, getShortName, hasModifier, hasNamespace, isImplicit

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

contains, getAncestorOfType, getChild, getChildCount, getContainingNode, getContainingScope, getFileSpecification, getParent, getSpanningStart, getSucceedingNode, isTerminal

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

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

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

getASDocComment, hasExplicitComment

Field Detail

cdp

public MXMLClassDirectiveProcessor cdp

rootAttributes

protected final Map<String,String> rootAttributes

A map of special attribute values.

Constructor Detail

MXMLDocumentNode

public MXMLDocumentNode(NodeBase parent)

Constructor

Parameters:

parent - The parent node of this node, or null if there is no parent.

Method Detail

getNodeID

public ASTNodeID getNodeID()

Description copied from interface: IASNode

Get the opcode of this node

Specified by:

getNodeID in interface IASNode

Overrides:

getNodeID in class MXMLClassDefinitionNode

Returns:

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

processChildTag

protected void processChildTag(MXMLTreeBuilder builder,
                   IMXMLTagData tag,
                   IMXMLTagData childTag,
                   MXMLNodeBase.MXMLNodeInfo info)

Description copied from class: MXMLNodeBase

Processes a single child tag.

Overrides:

processChildTag in class MXMLClassDefinitionNode

tag - An MXMLTagData object representing the child tag.

The default behavior implemented in this base class is to report each child tag as a problem.

Subclasses must override this method in order to allow the child tags that they recognize.

processTagSpecificAttribute

protected void processTagSpecificAttribute(MXMLTreeBuilder builder,
                               IMXMLTagData tag,
                               IMXMLTagAttributeData attribute,
                               MXMLNodeBase.MXMLNodeInfo info)

Add all attributes to rootAttributes. If the attribute is not a known special attribute, delegate the process to the base class.

Note that this method might not be triggered if there's only namespace attributes on the root tag.

Overrides:

processTagSpecificAttribute in class MXMLClassDefinitionNode

attribute - An MXMLTagAttributeData object representing the attribute.

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

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.

getClassReference

public IClassDefinition getClassReference(ICompilerProject project)

Description copied from interface: IMXMLClassReferenceNode

Gets the definition of the ActionScript class corresponding to this MXML tag.

Specified by:

getClassReference in interface IMXMLClassReferenceNode

Returns:

An IClassDefinition for the ActionScript class.

isMXMLObject

public boolean isMXMLObject()

Description copied from interface: IMXMLClassReferenceNode

Does the class referenced by this node implement mx.core.IMXMLObject?

Specified by:

isMXMLObject in interface IMXMLClassReferenceNode

Returns:

true if it does.

isContainer

public boolean isContainer()

Description copied from interface: IMXMLClassReferenceNode

Does the class referenced by this node implement mx.core.IContainer?

Specified by:

isContainer in interface IMXMLClassReferenceNode

Returns:

true if it does.

isVisualElementContainer

public boolean isVisualElementContainer()

Description copied from interface: IMXMLClassReferenceNode

Does the class referenced by this node implement mx.core.IVisualElementContainer?

Specified by:

isVisualElementContainer in interface IMXMLClassReferenceNode

Returns:

true if it does.

isDeferredInstantiationUIComponent

public boolean isDeferredInstantiationUIComponent()

Description copied from interface: IMXMLClassReferenceNode

Does the class referenced by this node implement mx.core.IDeferredInstantiatonUIComponent?

Specified by:

isDeferredInstantiationUIComponent in interface IMXMLClassReferenceNode

Returns:

true if it does.

getPropertySpecifierNode

public IMXMLPropertySpecifierNode getPropertySpecifierNode(String name)

Description copied from interface: IMXMLClassReferenceNode

Gets the child node specifying a particular property. It may have been specified in MXML either by an attribute or by a child tag.

Specified by:

getPropertySpecifierNode in interface IMXMLClassReferenceNode

Parameters:

name - The name of the property.

Returns:

An IMXMLPropertySpecifierNode specifying that property.

getPropertySpecifierNodes

public IMXMLPropertySpecifierNode[] getPropertySpecifierNodes()

Description copied from interface: IMXMLClassReferenceNode

Gets all the child nodes that specify properties. These may have been specified in MXML either by attributes or by child tags.

Specified by:

getPropertySpecifierNodes in interface IMXMLClassReferenceNode

Returns:

An array of IMXMLPropertySpecifierNode objects.

getEventSpecifierNode

public IMXMLEventSpecifierNode getEventSpecifierNode(String name)

Description copied from interface: IMXMLClassReferenceNode

Gets the child node specifying a particular event. It may have been specified in MXML either by an attribute or by a child tag.

Specified by:

getEventSpecifierNode in interface IMXMLClassReferenceNode

Parameters:

name - The name of the event.

Returns:

An IMXMLEventSpecifierNode specifying that event.

getEventSpecifierNodes

public IMXMLEventSpecifierNode[] getEventSpecifierNodes()

Description copied from interface: IMXMLClassReferenceNode

Gets all the child nodes that specify events. These may have been specified in MXML either by attributes or by child tags.

Specified by:

getEventSpecifierNodes in interface IMXMLClassReferenceNode

Returns:

An array of IMXMLEventSpecifierNode objects.

getSpecifierNodesWithSuffix

public IMXMLSpecifierNode[] getSpecifierNodesWithSuffix(String suffix)

Description copied from interface: IMXMLClassReferenceNode

Gets all the child nodes that represent properties, styles, and events and which have a particular suffix specifying a state or state group.

Specified by:

getSpecifierNodesWithSuffix in interface IMXMLClassReferenceNode

Parameters:

suffix - The name of a state or state group.

Returns:

An array of IMXMLSpecifierNode objects.

createNodeInfo

protected MXMLNodeBase.MXMLNodeInfo createNodeInfo(MXMLTreeBuilder builder)

Overrides:

createNodeInfo in class MXMLNodeBase

processChildNonWhitespaceUnit

protected void processChildNonWhitespaceUnit(MXMLTreeBuilder builder,
                                 IMXMLTagData tag,
                                 IMXMLTextData text,
                                 MXMLNodeBase.MXMLNodeInfo info)

Description copied from class: MXMLNodeBase

Processes a single child text unit which is not all whitespace.

The default behavior implemented in this base class is to report each unit of non-whitespace as a problem.

Subclasses must override this method in order to allow the non-whitespace text unit.

Overrides:

processChildNonWhitespaceUnit in class MXMLNodeBase

text - An MXMLTextData object representing the child text unit.

createSpecifierNode

protected org.apache.flex.compiler.internal.tree.mxml.MXMLSpecifierNodeBase createSpecifierNode(MXMLTreeBuilder builder,
                                                                                    String specifierName)

Resolve the specifier name in the class definition to a member definition, and create a specifier node based on the member type.

Parameters:

builder - MXML tree builder.

specifierName - Specifier name.

Returns:

A MXML specifier node.

buildInnerString

protected boolean buildInnerString(StringBuilder sb)

For debugging only. Builds a string such as "spark.components.Application" from the qualified name of the class reference by the node.

Overrides:

buildInnerString in class NodeBase