org.apache.flex.compiler.tree.mxml

Interface IMXMLClassReferenceNode

All Superinterfaces:

IASNode, IMXMLNode, ISourceLocation

All Known Subinterfaces:

IMXMLApplicationNode, IMXMLArrayNode, IMXMLBooleanNode, IMXMLClassDefinitionNode, IMXMLClassNode, IMXMLClearNode, IMXMLCompilerDirectiveNodeBase, IMXMLComponentNode, IMXMLConcatenatedDataBindingNode, IMXMLDataBindingNode, IMXMLDataBindingNodeContainer, IMXMLDeferredInstanceNode, IMXMLDesignLayerNode, IMXMLDocumentNode, IMXMLEmbedNode, IMXMLExpressionNode, IMXMLFactoryNode, IMXMLFunctionNode, IMXMLHTTPServiceNode, IMXMLInstanceNode, IMXMLIntNode, IMXMLModelNode, IMXMLNumberNode, IMXMLObjectNode, IMXMLRegExpNode, IMXMLRemoteObjectMethodNode, IMXMLRemoteObjectNode, IMXMLRepeaterNode, IMXMLResourceNode, IMXMLSingleDataBindingNode, IMXMLStateNode, IMXMLStringNode, IMXMLUintNode, IMXMLVectorNode, IMXMLWebServiceNode, IMXMLWebServiceOperationNode, IMXMLXMLListNode

All Known Implementing Classes:

MXMLClassDefinitionNode, MXMLDocumentNode, MXMLRepeaterNode

public interface IMXMLClassReferenceNode
extends IMXMLNode

This AST node represents an MXML tag which maps to an ActionScript class, either as an instance of that class or a definition of a subclass of this class.

An IMXMLClassReferenceNode has N child nodes; each is an IMXMLSpecifierNode specifying the value of a property, the value of a style, or ActionScript code to handle an event.

Field Summary

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

UNKNOWN

Method Summary

Methods

Modifier and Type	Method and Description
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.
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?
boolean	needsDescriptor() Determines whether this node needs to generate a UIComponentDescriptor.
boolean	needsDocumentDescriptor() Determines whether this node needs to set its documentDescriptor property.

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

getClassReference

IClassDefinition getClassReference(ICompilerProject project)

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

Returns:

An IClassDefinition for the ActionScript class.

isMXMLObject

boolean isMXMLObject()

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

Returns:

true if it does.

isVisualElementContainer

boolean isVisualElementContainer()

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

Returns:

true if it does.

isDeferredInstantiationUIComponent

boolean isDeferredInstantiationUIComponent()

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

Returns:

true if it does.

isContainer

boolean isContainer()

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

Returns:

true if it does.

getPropertySpecifierNode

IMXMLPropertySpecifierNode getPropertySpecifierNode(String name)

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

Parameters:

name - The name of the property.

Returns:

An IMXMLPropertySpecifierNode specifying that property.

getPropertySpecifierNodes

IMXMLPropertySpecifierNode[] getPropertySpecifierNodes()

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

Returns:

An array of IMXMLPropertySpecifierNode objects.

getEventSpecifierNode

IMXMLEventSpecifierNode getEventSpecifierNode(String name)

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

Parameters:

name - The name of the event.

Returns:

An IMXMLEventSpecifierNode specifying that event.

getEventSpecifierNodes

IMXMLEventSpecifierNode[] getEventSpecifierNodes()

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

Returns:

An array of IMXMLEventSpecifierNode objects.

getSpecifierNodesWithSuffix

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.

Parameters:

suffix - The name of a state or state group.

Returns:

An array of IMXMLSpecifierNode objects.

needsDescriptor

boolean needsDescriptor()

Determines whether this node needs to generate a UIComponentDescriptor.

Returns:

true if it needs a descriptor.

needsDocumentDescriptor

boolean needsDocumentDescriptor()

Determines whether this node needs to set its documentDescriptor property.

Returns:

true if it needs a document descriptor.