org.apache.flex.compiler.projects

Interface IFlexProject

All Superinterfaces:

IASProject, ICompilerProject, IWriteOnlyProjectSettings, IXMLNameResolver

All Known Implementing Classes:

FlexJSProject, FlexProject

public interface IFlexProject
extends IASProject, IXMLNameResolver, IWriteOnlyProjectSettings

Base interface for all project types that support all flex source file types ( mxml, fxg, css, etc ).

Method Summary

Methods

Modifier and Type	Method and Description
Set<String>	computeLibraryDependencies(File targetLibrary, DependencyTypeSet dependencyTypeSet) Get the set of libraries a given library depends on.
List<String>	computeLibraryDependencyOrder(DependencyTypeSet dependencySet) Get the dependency order of libraries on the internal library path and external library path of this project.
ISWCTarget	createSWCTarget(ITargetSettings targetSettings, ITargetProgressMonitor progressMonitor) Create a SWC target
String	getActionScriptFileEncoding() Returns the file encoding use to compile ActionScript files.
ICSSManager	getCSSManager() Get the project-level CSS manager.
Map<File,List<String>>	getExtensionLibraries() Returns a map of extension element files to extension paths.
Collection<String>	getLocales() Returns the requested locales for this project.
IMXMLNamespaceMapping[]	getNamespaceMappings() Get all the namespace mappings.
String	getResourceLocale(String path) Returns the locale of the resource with a given path if the resource is locale dependent.
List<RSLSettings>	getRuntimeSharedLibraryPath() The list of RSLs configured for this application.
String	getServicesXMLPath() The absolute path of the services-config.xml file.
Collection<XMLName>	getTagNamesForClass(String className) Uses the manifest information to find all the MXML tags that map to a specified fully-qualified ActionScript classname, such as as "spark.controls.Button"
List<String>	getThemeNames() Get the names of all the themes used in this project.
boolean	isFlex() Option of enable or prevent various Flex compiler behaviors.
void	setLocaleDependentResources(Map<String,String> localeDependentResources) Sets the locale dependent path map for the project.
void	setNamespaceMappings(List<? extends IMXMLNamespaceMapping> namespaceMappings) Sets the mappings from MXML namespace URI to manifest files, as specified by -namespace options.
void	setRuntimeSharedLibraryPath(List<RSLSettings> rsls) Set the RSL library path with an ordered list of RSLs.

Methods inherited from interface org.apache.flex.compiler.projects.IASProject

addIncludeSourceFile, addIncludeSourceFile, addProjectDependeny, attachExternalLibrarySourcePath, attachInternalLibrarySourcePath, createInvisibleCompilationUnit, createInvisibleCompilationUnit, getAttachedSourceDirectory, getCompatibilityVersion, getCompatibilityVersionString, getDependingProjects, getLibraries, getSourceFileFromSourcePath, getSourcePath, invalidateLibraries, invalidateLibrary, isSupportedSourceFileType, removeIncludeSourceFile, removeProjectDependeny, setDependencies, setIncludeSources, setLibraries, setSourcePath

Methods inherited from interface org.apache.flex.compiler.projects.ICompilerProject

clean, createSWFTarget, delete, doubleCheckAmbiguousDefinition, getActualPackageName, getBuiltinType, getCompilationUnits, getCompilationUnits, getDirectDependencies, getDirectReverseDependencies, getIncludingCompilationUnits, getProblems, getReachableCompilationUnitsInSWFOrder, getScope, getUndefinedValue, getWorkspace, isAssetEmbeddingSupported, isCompatibleOverrideReturnType, isInliningEnabled, isValidTypeConversion, resolveQNameToCompilationUnit, resolveQNameToDefinition, setProblems, setUseParallelCodeGeneration

Methods inherited from interface org.apache.flex.compiler.mxml.IXMLNameResolver

resolveXMLNameToDefinition, resolveXMLNameToQualifiedName

Methods inherited from interface org.apache.flex.compiler.internal.config.IWriteOnlyProjectSettings

setActionScriptFileEncoding, setCompatibilityVersion, setDefineDirectives, setExcludeNativeJSLibraries, setExtensionLibraries, setFlex, setIncludeSources, setLocales, setServicesXMLPath, setSourcePath

Method Detail

createSWCTarget

ISWCTarget createSWCTarget(ITargetSettings targetSettings,
                         ITargetProgressMonitor progressMonitor)
                           throws InterruptedException

Create a SWC target

Parameters:

targetSettings - The settings to use for this target

progressMonitor - to collect progress information, can be null

Returns:

The newly created ISWCTarget

Throws:

InterruptedException

setNamespaceMappings

void setNamespaceMappings(List<? extends IMXMLNamespaceMapping> namespaceMappings)

Sets the mappings from MXML namespace URI to manifest files, as specified by -namespace options.

Specified by:

setNamespaceMappings in interface IWriteOnlyProjectSettings

Parameters:

namespaceMappings - An array of MXMLNamespaceMapping objects.

getNamespaceMappings

IMXMLNamespaceMapping[] getNamespaceMappings()

Get all the namespace mappings.

Returns:

An array of namespace mappings.

getCSSManager

ICSSManager getCSSManager()

Get the project-level CSS manager.

Returns:

CSSManager of the project.

getLocales

Collection<String> getLocales()

Returns the requested locales for this project.

Returns:

a list of project's locales

setLocaleDependentResources

void setLocaleDependentResources(Map<String,String> localeDependentResources)

Sets the locale dependent path map for the project. For each entry, the key is the path of a locale dependent resource (source path or library path entry) and the value is the locale it depends on.

Parameters:

localeDependentResources - map that contains project's locale dependent resources

getResourceLocale

String getResourceLocale(String path)

Returns the locale of the resource with a given path if the resource is locale dependent. This currently returns the locale for only source path and library path entries, which are the only resources passed to compiler and can contain {locale} token.

Parameters:

path - path of a file/directory for which to determine the locale

Returns:

locale of the resource with a given path if the resource is locale dependent or null if the resource is not locale dependent.

getActionScriptFileEncoding

String getActionScriptFileEncoding()

Returns the file encoding use to compile ActionScript files.

Returns:

the file encoding use to compile ActionScript files.

getExtensionLibraries

Map<File,List<String>> getExtensionLibraries()

Returns a map of extension element files to extension paths.

Returns:

a map of extension element files to extension paths.

getServicesXMLPath

String getServicesXMLPath()

The absolute path of the services-config.xml file. This file used to configure a Flex client to talk to a BlazeDS server.

Returns:

the absolute path of the services-config.xml file. Null if the file has not been configured.

getRuntimeSharedLibraryPath

List<RSLSettings> getRuntimeSharedLibraryPath()

The list of RSLs configured for this application.

Returns:

a list of RSLSettings where each entry in the list is an RSL to load at runtime.

setRuntimeSharedLibraryPath

void setRuntimeSharedLibraryPath(List<RSLSettings> rsls)

Set the RSL library path with an ordered list of RSLs. The runtime will load the RSLs in the order specified.

Parameters:

rsls - Each RSLSettings in the list describes an RSL and its failovers. If null, the list of RSLs is reset.

computeLibraryDependencies

Set<String> computeLibraryDependencies(File targetLibrary,
                                     DependencyTypeSet dependencyTypeSet)
                                       throws LibraryCircularDependencyException

Get the set of libraries a given library depends on.

Parameters:

targetLibrary - The library to find dependencies for. May not be null.

dependencyTypeSet - The types of dependencies to consider when determining the library's dependencies. If this parameter is null or an empty set, then all dependencies will be considered.

Returns:

A set of Strings; where each String is the location of a library in the file system.

Throws:

LibraryCircularDependencyException

computeLibraryDependencyOrder

List<String> computeLibraryDependencyOrder(DependencyTypeSet dependencySet)
                                           throws LibraryCircularDependencyException

Get the dependency order of libraries on the internal library path and external library path of this project.

Parameters:

dependencySet - The types of dependencies to consider when determining the dependency order. If this parameter is null or an empty set, then all dependencies will be considered.

Returns:

An ordered list of library dependencies. Each String in the list is the location of a library in the file system. The first library in the list has no dependencies. Each library in the list has at least the same dependencies as its predecessor and may be dependent on its predecessor as well.

Throws:

LibraryCircularDependencyException

getThemeNames

List<String> getThemeNames()

Get the names of all the themes used in this project.

Returns:

A list of theme names.

isFlex

boolean isFlex()

Option of enable or prevent various Flex compiler behaviors. This is currently used to enable/disable the generation of a root class for library swfs and generation of code for application swfs.

getTagNamesForClass

Collection<XMLName> getTagNamesForClass(String className)

Uses the manifest information to find all the MXML tags that map to a specified fully-qualified ActionScript classname, such as as "spark.controls.Button"

Parameters:

className - Fully-qualified ActionScript classname, such as as "spark.controls.Button"

Returns:

A collection of XMLName's representing a MXML tags, such as a "Button" tag in the namespace "library://ns.adobe.com/flex/spark".