org.apache.flex.compiler.definitions

Interface IStyleDefinition

All Superinterfaces:

IDefinition, IDocumentableDefinition, IMetadataDefinition

All Known Implementing Classes:

StyleDefinition

public interface IStyleDefinition
extends IMetadataDefinition

Represents style metadata decorating a class definition, such as Style(name="color", type="uint", format="color", inherit="yes")].

Use IDefinition.getBaseName()() to get the style's name (e.g., "color".

Method Summary

Methods

Modifier and Type	Method and Description
String	getArrayType() Gets the value of this style's arrayType attribute.
String[]	getEnumeration() Gets the possible values of this style, as specified by its enumeration attribute.
String	getFormat() Gets the value of this style's format attribute.
String	getInherit() Gets the value of this style's inherit attribute.
String	getMaxValue() Gets the value of this style's maxValue attribute.
String	getMaxValueExclusive() Gets the value of this style's maxValueExclusive attribute.
String	getMinValue() Gets the value of this style's minValue attribute.
String	getMinValueExclusive() Gets the value of this style's minValueExclusive attribute.
IStyleTagNode	getNode() Returns the IStyleTagNode from which this definition was created, if the definition came from the AST for a source file.
String[]	getStates() Gets the value of this style's states attribute.
String[]	getThemes() Gets the value of this style's themes attribute.
boolean	isColor() Determines whether this style represents a color.
boolean	isInheriting() Determines whether this style is inheriting.
ITypeDefinition	resolveArrayType(ICompilerProject project) Resolves the type specified by the arrayType attribute to a class or interface definitions.

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

IStyleTagNode getNode()

Returns the IStyleTagNode 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

getArrayType

String getArrayType()

Gets the value of this style's arrayType attribute.

When the type attribute is "Array, the arrayType attribute specifies the type of the array elements.

Returns:

The value of the arrayType attribute as a String, or null.

resolveArrayType

ITypeDefinition resolveArrayType(ICompilerProject project)

Resolves the type specified by the arrayType attribute to a class or interface definitions.

When the value of the type attribute is "Array", the arrayType attribute specifies the type of the array elements.

Parameters:

project - The ICompilerProject within which references should be resolved.

Returns:

An ITypeDefinition for the resolved array type, or null.

getEnumeration

String[] getEnumeration()

Gets the possible values of this style, as specified by its enumeration attribute.

When the value of the type attribute is "String", the enumeration attribute specifies the allowed String values.

Returns:

The comma-separated values in the enumeration attribute as an array of Strings, or an empty array.

getFormat

String getFormat()

Gets the value of this style's format attribute.

Returns:

The value of the format attribute as a String, or null.

isColor

boolean isColor()

Determines whether this style represents a color.

Returns:

true if the value of the format attribute is "Color".

getInherit

String getInherit()

Gets the value of this style's inherit attribute.

Returns:

The value of the inherit attribute as a String, or null.

isInheriting

boolean isInheriting()

Determines whether this style is inheriting.

Returns:

true if the value of the inherit attribute is "yes".

getStates

String[] getStates()

Gets the value of this style's states attribute.

Returns:

The comma-separated values in the states attribute as an array of Strings, or an empty array.

getThemes

String[] getThemes()

Gets the value of this style's themes attribute.

Returns:

The comma-separated values in the themes attribute as an array of Strings, or an empty array.

getMinValue

String getMinValue()

Gets the value of this style's minValue attribute.

Returns:

The value of the minValue attribute as a String, or null.

getMinValueExclusive

String getMinValueExclusive()

Gets the value of this style's minValueExclusive attribute.

Returns:

The value of the minValueExclusive attribute as a String, or null.

getMaxValue

String getMaxValue()

Gets the value of this style's maxValue attribute.

Returns:

The value of the maxValue attribute as a String, or null.

getMaxValueExclusive

String getMaxValueExclusive()

Gets the value of this style's maxValueExclusive attribute.

Returns:

The value of the maxValueExclusive attribute as a String, or null.