org.apache.flex.compiler.tree.mxml

Interface IMXMLNode

All Superinterfaces:

IASNode, ISourceLocation

All Known Subinterfaces:

IMXMLApplicationNode, IMXMLArrayNode, IMXMLBindingAttributeNode, IMXMLBindingNode, IMXMLBooleanNode, IMXMLClassDefinitionNode, IMXMLClassNode, IMXMLClassReferenceNode, IMXMLClearNode, IMXMLCompilerDirectiveNodeBase, IMXMLComponentNode, IMXMLConcatenatedDataBindingNode, IMXMLDataBindingNode, IMXMLDataBindingNodeContainer, IMXMLDeclarationsNode, IMXMLDeferredInstanceNode, IMXMLDefinitionNode, IMXMLDesignLayerNode, IMXMLDocumentNode, IMXMLEffectSpecifierNode, IMXMLEmbedNode, IMXMLEventSpecifierNode, IMXMLExpressionNode, IMXMLFactoryNode, IMXMLFileNode, IMXMLFunctionNode, IMXMLHTTPServiceNode, IMXMLHTTPServiceRequestPropertyNode, IMXMLImplementsNode, IMXMLInstanceNode, IMXMLIntNode, IMXMLLibraryNode, IMXMLMetadataNode, IMXMLModelNode, IMXMLModelPropertyContainerNode, IMXMLModelPropertyNode, IMXMLModelRootNode, IMXMLNumberNode, IMXMLObjectNode, IMXMLPrivateNode, IMXMLPropertySpecifierNode, IMXMLRegExpNode, IMXMLRemoteObjectMethodNode, IMXMLRemoteObjectNode, IMXMLReparentNode, IMXMLRepeaterNode, IMXMLResourceNode, IMXMLScriptNode, IMXMLSingleDataBindingNode, IMXMLSpecifierNode, IMXMLStateNode, IMXMLStringNode, IMXMLStyleNode, IMXMLStyleSpecifierNode, IMXMLUintNode, IMXMLVectorNode, IMXMLWebServiceNode, IMXMLWebServiceOperationNode, IMXMLXMLListNode, IMXMLXMLNode

All Known Implementing Classes:

MXMLClassDefinitionNode, MXMLDocumentNode, MXMLFileNode, MXMLNodeBase, MXMLRepeaterNode

public interface IMXMLNode
extends IASNode

This is the base interface for all MXML-specific AST nodes.

Field Summary

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

UNKNOWN

Method Summary

Methods

Modifier and Type	Method and Description
IMXMLClassDefinitionNode	getClassDefinitionNode() Gets the closest ancestor node that defines a class.
IMXMLClassDefinitionNode	getDocumentNode() Gets the closest ancestor node that is the root node of the MXML file.
IMXMLFileNode	getFileNode() Gets the root file node.
String	getName() Gets the name of this node.
boolean	isValidForCodeGen() Indicates whether code should be generated for this node.

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

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

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

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

Method Detail

getName

String getName()

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".)

Returns:

The name of this node as a String.

isValidForCodeGen

boolean isValidForCodeGen()

Indicates whether code should be generated for this node.

If this method returns false, there is something invalid about this node, or one of its descendants, that prevents code generation.

getClassDefinitionNode

IMXMLClassDefinitionNode getClassDefinitionNode()

Gets the closest ancestor node that defines a class.

Returns:

An IMXMLClassDefinitionNode object.

getDocumentNode

IMXMLClassDefinitionNode getDocumentNode()

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

Returns:

An IMXMLDocumentNode object.

getFileNode

IMXMLFileNode getFileNode()

Gets the root file node.

Returns:

An IOldMXMLFileNode object.