org.apache.flex.compiler.definitions

Interface IEffectDefinition

All Superinterfaces:

IDefinition, IDocumentableDefinition, IMetadataDefinition

All Known Implementing Classes:

EffectDefinition

public interface IEffectDefinition
extends IMetadataDefinition

Represents effect metadata decorating a class definition, such as [Effect(name="rollOverEffect", event="rollOver")].

Use the inherited IDefinition.getBaseName()() method to get the effect's name (e.g., "rollOverEffect").

Use getEvent()() to get the name of the effect's trigger event (e.g., "rollOver") as a String, and resolveEvent(org.apache.flex.compiler.projects.ICompilerProject)() to resolve it to an event definition.

Method Summary

Methods

Modifier and Type	Method and Description
String	getEvent() Gets the value of this effect's event attribute.
IEffectTagNode	getNode() Returns the IEffectTagNode 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.

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

Method Detail

getNode

IEffectTagNode getNode()

Returns the IEffectTagNode 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.

Specified by:

getNode in interface IDefinition

getEvent

String getEvent()

Gets the value of this effect's event attribute.

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

Returns:

The name of the triggering event as a String.

resolveEvent

IEventDefinition resolveEvent(ICompilerProject project)

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.

Parameters:

project - The ICompilerProject within which references should be resolved.

Returns:

An IEventDefinition for the triggering event, or null.