org.apache.flex.compiler.internal.definitions

Class StyleDefinition

java.lang.Object

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

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

org.apache.flex.compiler.internal.definitions.StyleDefinition

All Implemented Interfaces:

IDefinition, IDocumentableDefinition, IMetadataDefinition, IStyleDefinition, IDefinitionSet

public class StyleDefinition
extends MetadataDefinitionBase
implements IStyleDefinition

Instances of this class represent definitions of MXML styles in the symbol table.

MXML styles are defined by [Style] metadata on ActionScript class declarations.

After a style definition is in the symbol table, it should always be accessed through the read-only IStyleDefinition 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
StyleDefinition(String name, IClassDefinition decoratedDefinition)

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 IDefinitionNode 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.
void	setArrayType(String arrayType)
void	setEnumeration(String[] enumeration) Sets the value of the enumeration attribute.
void	setFormat(String format) Sets the value of the format attribute.
void	setInherit(String inherit) Sets the value of the inherit attribute.
void	setMaxValue(String maxValue) Sets the value of the maxValue attribute.
void	setMaxValueExclusive(String maxValueExclusive) Sets the value of the maxValueExclusive attribute.
void	setMinValue(String minValue) Sets the value of the minValue attribute.
void	setMinValueExclusive(String minValueExclusive) Sets the value of the minValueExclusive attribute.
void	setStates(String[] states) Sets the value of the states attribute.
void	setThemes(String themes) Sets a list of theme names separated by comma or spaces.

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

StyleDefinition

public StyleDefinition(String name,
               IClassDefinition decoratedDefinition)

Method Detail

getNode

public IStyleTagNode 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 IStyleDefinition

Overrides:

getNode in class DefinitionBase

getArrayType

public String getArrayType()

Description copied from interface: IStyleDefinition

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.

Specified by:

getArrayType in interface IStyleDefinition

Returns:

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

setArrayType

public void setArrayType(String arrayType)

resolveArrayType

public ITypeDefinition resolveArrayType(ICompilerProject project)

Description copied from interface: IStyleDefinition

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.

Specified by:

resolveArrayType in interface IStyleDefinition

Parameters:

project - The ICompilerProject within which references should be resolved.

Returns:

An ITypeDefinition for the resolved array type, or null.

getEnumeration

public String[] getEnumeration()

Description copied from interface: IStyleDefinition

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.

Specified by:

getEnumeration in interface IStyleDefinition

Returns:

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

setEnumeration

public void setEnumeration(String[] enumeration)

Sets the value of the enumeration attribute.

Parameters:

enumeration - The enumerated values as an array of Strings.

getFormat

public String getFormat()

Description copied from interface: IStyleDefinition

Gets the value of this style's format attribute.

Specified by:

getFormat in interface IStyleDefinition

Returns:

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

setFormat

public void setFormat(String format)

Sets the value of the format attribute.

Parameters:

format - The value as a String.

isColor

public boolean isColor()

Description copied from interface: IStyleDefinition

Determines whether this style represents a color.

Specified by:

isColor in interface IStyleDefinition

Returns:

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

getInherit

public String getInherit()

Description copied from interface: IStyleDefinition

Gets the value of this style's inherit attribute.

Specified by:

getInherit in interface IStyleDefinition

Returns:

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

setInherit

public void setInherit(String inherit)

Sets the value of the inherit attribute.

Parameters:

inherit - The value as a String.

isInheriting

public boolean isInheriting()

Description copied from interface: IStyleDefinition

Determines whether this style is inheriting.

Specified by:

isInheriting in interface IStyleDefinition

Returns:

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

getStates

public String[] getStates()

Description copied from interface: IStyleDefinition

Gets the value of this style's states attribute.

Specified by:

getStates in interface IStyleDefinition

Returns:

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

setStates

public void setStates(String[] states)

Sets the value of the states attribute.

Parameters:

states - The state names as an array of Strings.

getThemes

public String[] getThemes()

Description copied from interface: IStyleDefinition

Gets the value of this style's themes attribute.

Specified by:

getThemes in interface IStyleDefinition

Returns:

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

setThemes

public void setThemes(String themes)

Sets a list of theme names separated by comma or spaces.

Parameters:

themes - Comma-separated or space-separated theme names.

getMinValue

public String getMinValue()

Description copied from interface: IStyleDefinition

Gets the value of this style's minValue attribute.

Specified by:

getMinValue in interface IStyleDefinition

Returns:

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

setMinValue

public void setMinValue(String minValue)

Sets the value of the minValue attribute.

Parameters:

minValue - The value as a String.

getMinValueExclusive

public String getMinValueExclusive()

Description copied from interface: IStyleDefinition

Gets the value of this style's minValueExclusive attribute.

Specified by:

getMinValueExclusive in interface IStyleDefinition

Returns:

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

setMinValueExclusive

public void setMinValueExclusive(String minValueExclusive)

Sets the value of the minValueExclusive attribute.

Parameters:

minValueExclusive - The value as a String.

getMaxValue

public String getMaxValue()

Description copied from interface: IStyleDefinition

Gets the value of this style's maxValue attribute.

Specified by:

getMaxValue in interface IStyleDefinition

Returns:

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

setMaxValue

public void setMaxValue(String maxValue)

Sets the value of the maxValue attribute.

Parameters:

maxValue - The value as a String.

getMaxValueExclusive

public String getMaxValueExclusive()

Description copied from interface: IStyleDefinition

Gets the value of this style's maxValueExclusive attribute.

Specified by:

getMaxValueExclusive in interface IStyleDefinition

Returns:

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

setMaxValueExclusive

public void setMaxValueExclusive(String maxValueExclusive)

Sets the value of the maxValueExclusive attribute.

Parameters:

maxValueExclusive - The value as a String.