org.apache.flex.compiler.internal.definitions

Class EffectDefinition

java.lang.Object

org.apache.flex.compiler.internal.definitions.DefinitionBase

org.apache.flex.compiler.internal.definitions.MetadataDefinitionBase

org.apache.flex.compiler.internal.definitions.EffectDefinition

All Implemented Interfaces:

IDefinition, IDocumentableDefinition, IEffectDefinition, IMetadataDefinition, IDefinitionSet

public class EffectDefinition
extends MetadataDefinitionBase
implements IEffectDefinition

Each instance of this class represent the definition of an MXML effect in the symbol table.

MXML effects are defined by [Effect] metadata on ActionScript class declarations.

After an effect definition is in the symbol table, it should always be accessed through the read-only IEffectDefinition interface.

Field Summary

Fields inherited from class org.apache.flex.compiler.internal.definitions.DefinitionBase

FLAG_CAST_FUNCTION, FLAG_CONSTRUCTOR, FLAG_CONTINGENT, FLAG_DECLARED_IN_CONTROL_FLOW, FLAG_DEFAULT, FLAG_DEPRECATED, FLAG_DYNAMIC, FLAG_FINAL, FLAG_GENERATED_EMBED_CLASS, FLAG_HAS_INIT, FLAG_IMPLICIT, FLAG_NATIVE, FLAG_OVERRIDE, FLAG_REST, FLAG_STATIC, flags, nodeRef, singletonEmptyMetaTags

Constructor Summary

Constructors

Constructor and Description
EffectDefinition(String name, IClassDefinition decoratedDefinition)

Method Summary

Methods

Modifier and Type	Method and Description
String	getEvent() Gets the value of this effect's event attribute.
IEffectTagNode	getNode() Returns the IDefinitionNode from which this definition was created, if the definition came from the AST for a source file.
IEventDefinition	resolveEvent(ICompilerProject project) Resolves the value of this effect's event attribute to an event definition.
void	setEvent(String event) Sets the value of this effect's event attribute.

Methods inherited from class org.apache.flex.compiler.internal.definitions.MetadataDefinitionBase

getAttributes, getAttributeValue, getDecoratedDefinition, getDecoratedDefinitionNode, getDeprecatedMessage, getDeprecatedReplacement, getDeprecatedSince, getEnd, getStart, getTagName, getTagNode, matches

Methods inherited from class org.apache.flex.compiler.internal.definitions.DefinitionBase

addMetaTag, buildInnerString, buildString, getAbsoluteEnd, getAbsoluteStart, getAllMetaTags, getAncestorOfType, getArrayElementType, getBaseName, getBindableEventNames, getColumn, getContainingASScope, getContainingFilePath, getContainingScope, getContainingSourceFilePath, getDefinition, getDeprecationInfo, getExplicitSourceComment, getFileScope, getFileSpecification, getInstanceType, getLine, getLocationString, getMaxSize, getMetaTagByName, getMetaTagsByName, getMName, getModifiers, getNameColumn, getNameEnd, getNameLine, getNamespaceReference, getNamespaceReferenceAsString, getNameStart, getPackageName, getParent, getPercentProxy, getQualifiedName, getSize, getSkinPart, getSourcePath, getStorageName, getTypeAsDisplayString, getTypeDependencyType, getTypeReference, hasCollapseWhiteSpace, hasExplicitComment, hasMetaTagByName, hasModifier, hasNamespace, hasRichTextContent, inPackageNamespace, isBindable, isBindableStyle, isColor, isContingent, isContingentNeeded, isDeprecated, isDynamic, isEmpty, isFinal, isGeneratedEmbedClass, isImplicit, isInProject, isInternal, isNative, isOverride, isPrivate, isProtected, isPublic, isRequiredSkinPart, isStatic, isTopLevelDefinition, resolveNamespace, resolveType, resolveType, resolveType, resolveType, resolveType, setBindable, setContainingScope, setContingent, setDynamic, setFinal, setGeneratedEmbedClass, setImplicit, setLocation, setMetaTags, setModifier, setNameLocation, setNamespaceReference, setNative, setNode, setOverride, setPublic, setStatic, setTypeReference, toStorageName, toString, unsetOverride, verify

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

getDecoratedDefinition, getDeprecatedMessage, getDeprecatedReplacement, getDeprecatedSince

Methods inherited from interface org.apache.flex.compiler.definitions.IDocumentableDefinition

getExplicitSourceComment, hasExplicitComment

Methods inherited from interface org.apache.flex.compiler.definitions.IDefinition

getAbsoluteEnd, getAbsoluteStart, getAllMetaTags, getAncestorOfType, getBaseName, getBindableEventNames, getColumn, getContainingFilePath, getContainingScope, getContainingSourceFilePath, getDeprecationInfo, getEnd, getLine, getMetaTagByName, getMetaTagsByName, getModifiers, getNameColumn, getNameEnd, getNameLine, getNamespaceReference, getNameStart, getPackageName, getParent, getQualifiedName, getSourcePath, getStart, getTypeAsDisplayString, getTypeReference, hasMetaTagByName, hasModifier, hasNamespace, isBindable, isBindableStyle, isContingent, isContingentNeeded, isDeprecated, isDynamic, isFinal, isGeneratedEmbedClass, isImplicit, isInProject, isInternal, isNative, isOverride, isPrivate, isProtected, isPublic, isStatic, resolveNamespace, resolveType

Constructor Detail

EffectDefinition

public EffectDefinition(String name,
                IClassDefinition decoratedDefinition)

Method Detail

getNode

public IEffectTagNode getNode()

Description copied from interface: IDefinition

Returns the IDefinitionNode from which this definition was created, if the definition came from the AST for a source file.

This method may require the AST to be reloaded or regenerated and therefore may be slow.

More specific definition interfaces such as IClassDefinition redeclare this method to return a more specific node interface such as IClassNode.

Specified by:

getNode in interface IDefinition

Specified by:

getNode in interface IEffectDefinition

Overrides:

getNode in class DefinitionBase

getEvent

public String getEvent()

Description copied from interface: IEffectDefinition

Gets the value of this effect's event attribute.

This is the name of the event that will trigger this effect.

Specified by:

getEvent in interface IEffectDefinition

Returns:

The name of the triggering event as a String.

setEvent

public void setEvent(String event)

Sets the value of this effect's event attribute.

This is the name of the event that will trigger the effect.

Parameters:

event - The event name as a String.

resolveEvent

public IEventDefinition resolveEvent(ICompilerProject project)

Description copied from interface: IEffectDefinition

Resolves the value of this effect's event attribute to an event definition.

This is the definition of the event that will trigger this effect.

Specified by:

resolveEvent in interface IEffectDefinition

Parameters:

project - The ICompilerProject within which references should be resolved.

Returns:

An IEventDefinition for the triggering event, or null.