flexmojos:test-swf

Full name:

org.sonatype.flexmojos:flexmojos-maven-plugin:3.5.0:test-swf

Description:

Build the SWF including all TEST libraries.

Attributes:

  • Requires a Maven 2.0 project to be executed.
  • Requires dependency resolution of artifacts in scope: runtime.
  • Since version: 3.5.
  • Binds by default to the lifecycle phase: compile.

Optional Parameters

Name Type Since Description
accessible boolean 3.5 Turn on generation of accessible SWFs.
Default value is: false.
allowSourcePathOverlap boolean 3.5 Allow the source-path to have path-elements which contain other path-elements
Default value is: false.
as3 boolean 3.5 Use the ActionScript 3 class based object model for greater performance and better error reporting. In the class based object model most built-in functions are implemented as fixed methods of classes (-strict is recommended, but not required, for earlier errors)
Default value is: true.
classifier String 3.5 Classifier to add to the artifact generated. If given, the artifact will be an attachment instead.
compatibilityVersion String 3.5
compiledLocales String[] 3.5 Sets the locales that the compiler uses to replace {locale} tokens that appear in some configuration values. This is equivalent to using the compiler.locale option of the mxmlc or compc compilers.
Usage:
<compiledLocales>
   <locale>en_US</locale>
   <locale>pt_BR</locale>
   <locale>es_ES</locale>
</compiledLocales>

configFile File 3.5 Load a file containing configuration options If not defined, by default will search for one on resources folder.
configurationReport boolean 3.5 Writes the configuration report to a file after the build.
Default value is: false.
contextRoot String 3.5 Sets the context root path so that the compiler can replace {context.root} tokens for service channel endpoints.
debug boolean 3.5 Turn on generation of debuggable SWFs. False by default for mxmlc, but true by default for compc.
Default value is: false.
debugPassword String 3.5 A password that is embedded in the application
defaultBackgroundColor String 3.5 Sets the default background color. You can override this by using the application code. This is the equivalent of the default-background-color option of the mxmlc or compc compilers.
Default value is: 869CA7.
defaultFrameRate int 3.5 Sets the default frame rate to be used in the application. This is the equivalent of the default-frame-rate option of the mxmlc or compc compilers.
Default value is: 24.
defaultLocale String 3.5 Default locale for libraries. This is useful to non localized applications, just to define swc.rb locale
Default value is: en_US.
defaultSizeHeight int 3.5 Sets the default application height in pixels. This is equivalent to using the default-size option of the mxmlc or compc compilers.
Default value is: 375.
defaultSizeWidth int 3.5 Sets the default application width in pixels. This is equivalent to using the default-size option of the mxmlc or compc compilers.
Default value is: 500.
defaultsCss File 3.5 Sets the location of the default CSS file. This is equivalent to using the compiler.defaults-css-url option of the mxmlc or compc compilers.
defines Map 3.5 Deprecated. See definesDeclaration
definesDeclaration Properties 3.5 defines: specifies a list of define directive key and value pairs. For example, CONFIG::debugging
Usage:
<definesDeclaration>
  <property>
    <name>SOMETHING::aNumber</name>
    <value>2.2</value>
  </property>
  <property>
    <name>SOMETHING::aString</name>
    <value>"text"</value>
  </property>
</definesDeclaration>

enableMavenResourcesResolver boolean 3.5 When enabled flexmojos will add a custom path resolver to flex compiler. This allow flexmojos to resolve Embed assets located at src/main/resources. This is a workaround and it is described at http://bugs.adobe.com/jira/browse/SDK-15466
Default value is: true.
encoding String 3.5 Sets the ActionScript file encoding. The compiler uses this encoding to read the ActionScript source files. This is equivalent to using the actionscript-file-encoding option of the mxmlc or compc compilers.

The character encoding; for example UTF-8 or Big5.


Default value is: UTF-8.
es boolean 3.5 Use the ECMAScript edition 3 prototype based object model to allow dynamic overriding of prototype properties. In the prototype based object model built-in functions are implemented as dynamic properties of prototype objects (-strict is allowed, but may result in compiler errors for references to dynamic properties)
Default value is: false.
externs String[] 3.5 Sets a list of definitions to omit from linking when building an application. This is equivalent to using the externs option of the mxmlc and compc compilers. An array of definitions (for example, classes, functions, variables, or namespaces).
Usage:
<externs>
  <extern>com.acme.AClass</extern>
</externs>

fonts Font 3.5 Local Fonts Snapshot File containing cached system font licensing information produced via java -cp mxmlc.jar flex2.tools.FontSnapshot (fontpath). Will default to winFonts.ser on Windows XP and macFonts.ser on Mac OS X.
Usage:
<fonts>
  <advancedAntiAliasing>true</advancedAntiAliasing>
  <flashType>true</flashType>
  <languages>
    <englishRange>U+0020-U+007E</englishRange>
  </languages>
  <localFontsSnapshot>${baseDir}/src/main/resources/fonts.ser</localFontsSnapshot>
  <managers>
    <manager>flash.fonts.BatikFontManager</manager>
  </managers>
  <maxCachedFonts>20</maxCachedFonts>
  <maxGlyphsPerFace>1000</maxGlyphsPerFace>
</fonts>

frames FrameLabel[] 3.5 Sets a SWF frame label with a sequence of class names that are linked onto the frame. This is equivalent to using the frames.frame option of the mxmlc or compc compilers.
Usage:
<frames>
  <frame>
    <label>frame1</label>
    <classNames>
      <className>com.acme.AClass</className>
    </classNames>
  </frame>
</frames>

headlessServer boolean 3.5 Sets the compiler when it runs on a server without a display. This is equivalent to using the compiler.headless-server option of the mxmlc or compc compilers. that value determines if the compiler is running on a server without a display.
Default value is: false.
ignoreVersionIssues boolean 3.5 When true, flexmojos will check if the compiler and the framework versions match. Usually, you must use the same compiler and framework versions. Set this to true to avoid this check. EXTREMELLY UN-ADVISIBLE.
Default value is: false.
includeLookupOnly boolean 3.5 if true, manifest entries with lookupOnly=true are included in SWC catalog. default is false. This exists only so that manifests can mention classes that come in from filespec rather than classpath, e.g. in playerglobal.swc.
Default value is: false.
includeResourceBundles String[] 3.5 This is equilvalent to the include-resource-bundles option of the compc compiler.
Usage:
<includeResourceBundles>
  <bundle>SharedResources</bundle>
  <bundle>collections</bundle>
  <bundle>containers</bundle>
</includeResourceBundles>

includes String[] 3.5 Sets a list of definitions to always link in when building an application. This is equivalent to using the includes option of the mxmlc or compc compilers. An array of definitions (for example, classes, functions, variables, or namespaces).
Usage:
<includes>
  <include>com.acme.AClass</include>
</includes>

incremental boolean 3.5 If the incremental input argument is false, this method recompiles all parts of the object. If the incremental input argument is true, this method compiles only the parts of the object that have changed since the last compilation.
Default value is: false.
keepAllTypeSelectors boolean 3.5 Instructs the compiler to keep a style sheet's type selector in a SWF file, even if that type (the class) is not used in the application. This is equivalent to using the compiler.keep-all-type-selectors option of the mxmlc or compc compilers.
Default value is: false.
keepAs3Metadatas String[] 3.5 Keep the following AS3 metadata in the bytecodes.
Usage:
<keepAs3Metadatas>
  <keepAs3Metadata>Bindable</keepAs3Metadata>
  <keepAs3Metadata>Events</keepAs3Metadata>
</keepAs3Metadatas>

keepGeneratedActionscript boolean 3.5 Turn on writing of generated/*.as files to disk. These files are generated by the compiler during mxml translation and are helpful with understanding and debugging Flex applications.
Default value is: false.
licenses Map 3.5 licenses: specifies a list of product and serial number pairs.
Usage:
<licenses>
  <flexbuilder3>xxxx-xxxx-xxxx-xxxx</flexbuilder3>
</licenses>

linkReport boolean 3.5 Uses the default compiler options as base
Default value is: false.
loadExterns MavenArtifact[] 3.5 Deprecated. Use dependency with type "xml" and classifier "link-report"
loadExternsOnModules boolean 3.5 When true, tells flexmojos to use link reports/load externs on modules compilation
Default value is: true.
localRepository ArtifactRepository 3.5 Local repository to be used by the plugin to resolve dependencies.
locales String[] 3.5 Sets the locales that the compiler uses to replace {locale} tokens that appear in some configuration values. This is equivalent to using the compiler.locale option of the mxmlc or compc compilers.
Usage:
<locales>
   <locale>en_US</locale>
   <locale>pt_BR</locale>
   <locale>es_ES</locale>
</locales>

mergeResourceBundle Boolean 3.5 When true resources are compiled into Application or Library. When false resources are compiled into separated Application or Library files. If not defined no resourceBundle generation is done
metadata Metadata 3.5 SWF metadata useless there is no API to read it.
Usage:
<metadata>
  <contributor>buddy</contributor>
  <creator>me</creator>
  <date>01/01/01</date>
  <descriptions>
    <en_US>Simple description</en_US>
  </descriptions>
  <language>en_US</language>
  <publishers>
    <publisher>publisher1</publisher>
    <publisher>publisher2</publisher>
  </publishers>
  <titles>
    <en_US>Project title</en_US>
  </titles>
</metadata>

moduleFiles String[] 3.5 The list of modules files to be compiled. The path must be relative with source folder.
Usage:
<moduleFiles>
  <module>com/acme/AModule.mxml</module>
</moduleFiles>

namespaces Namespace[] 3.5 Specify a URI to associate with a manifest of components for use as MXML elements.
Usage:
<namespaces>
  <namespace>
    <uri>http://www.adobe.com/2006/mxml</uri>
    <manifest>${basedir}/manifest.xml</manifest>
  </namespace>
</namespaces>

optimize boolean 3.5 Enable post-link SWF optimization.
Default value is: true.
output File 3.5 The filename of the compiled artifact
pluginArtifacts List 3.5 (no description)
policyFileUrls String[] 3.5 policyFileUrls array of policy file URLs. Each entry in the rslUrls array must have a corresponding entry in this array. A policy file may be needed in order to allow the player to read an RSL from another domain. If a policy file is not required, then set it to an empty string. Accept some special tokens:
{contextRoot}        - replace by defined context root
{groupId}            - replace by library groupId
{artifactId}         - replace by library artifactId
{version}            - replace by library version
{extension}          - replace by library extension swf or swz

Usage:
<policyFileUrls>
  <url>/{contextRoot}/rsl/policy-{artifactId}-{version}.xml</url>
</policyFileUrls>

quick boolean 3.5 Quick compile mode. When true, flexmojos will check if the last artifact available at maven repository is newer then sources. If so, will not recompile.
Default value is: false.
rawMetadata String 3.5 Sets the metadata section of the application SWF. This is equivalent to the raw-metadata option of the mxmlc or compc compilers. Need a well-formed XML fragment
remoteRepositories List 3.5 List of remote repositories to be used by the plugin to resolve dependencies.
resourceBundlePath String 3.5 Define the base path to locate resouce bundle files Accept some special tokens:
{locale}     - replace by locale name

Default value is: ${basedir}/src/main/locales/{locale}.
rslUrls String[] 3.5 rslUrls array of URLs. The first RSL URL in the list is the primary RSL. The remaining RSL URLs will only be loaded if the primary RSL fails to load. Accept some special tokens:
{contextRoot}        - replace by defined context root
{groupId}            - replace by library groupId
{artifactId}         - replace by library artifactId
{version}            - replace by library version
{extension}          - replace by library extension swf or swz
default-value="/{contextRoot}/rsl/{artifactId}-{version}.{extension}"
Usage:
<rslUrls>
  <url>/{contextRoot}/rsl/{artifactId}-{version}.{extension}</url>
</rslUrls>

runtimeLocaleOutputPath String 3.5 Resource module or resource library output path
Default value is: ${project.build.directory}/locales/${project.artifactId}-${project.version}-{locale}.{extension}.
runtimeLocales String[] 3.5 Sets the locales that should be used to generate resource bundles.
Usage:
<runtimeLocales>
   <locale>en_US</locale>
   <locale>pt_BR</locale>
   <locale>es_ES</locale>
</runtimeLocales>

scriptMaxExecutionTime int 3.5 Sets the default script execution limits (which can be overridden by root attributes). This is equivalent to using the default-script-limits option of the mxmlc or compc compilers. Execution time, in seconds
Default value is: 60.
scriptMaxRecursionDepth int 3.5 Sets the default script execution limits (which can be overridden by root attributes). This is equivalent to using the default-script-limits option of the mxmlc or compc compilers. Recursion depth
Default value is: 1000.
services File 3.5 Sets the location of the Flex Data Services service configuration file. This is equivalent to using the compiler.services option of the mxmlc and compc compilers. If not define will look inside resources directory for services-config.xml
showWarnings boolean 3.5 Run the AS3 compiler in a mode that detects legal but potentially incorrect code. Equivalent compiler option: warnings
Default value is: true.
skip boolean 3.5 (no description)
Default value is: false.
sourceFile String 3.5 The file to be compiled. The path must be relative with source folder
sourcePaths File[] 3.5 List of path elements that form the roots of ActionScript class hierarchies.
Usage:
<sourcePaths>
   <path>${baseDir}/src/main/flex</path>
</sourcePaths>
By default use Maven source and resources folders.
staticLinkRuntimeSharedLibraries boolean 3.5 Determines whether to compile against libraries statically or use RSLs. Set this option to true to ignore the RSLs specified by the rslUrls. Set this option to false to use the RSLs.

Add the static-link-runtime-shared-libraries=true option; this ensures that you are not using the framework RSL when compiling the application, regardless of the settings in your configuration files. Instead, you are compiling the framework classes into your SWF file.

http://livedocs.adobe.com/flex/3/html/help.html?content=rsl_09.html
Default value is: false.
strict boolean 3.5 Run the AS3 compiler in strict error checking mode.
Default value is: true.
targetPlayer String 3.5 specifies the version of the player the application is targeting. Features requiring a later version will not be compiled into the application. The minimum value supported is "9.0.0". If not defined will take the default value from current playerglobal dependency.
themes String[] 3.5 List of CSS or SWC files to apply as a theme. <>BR Usage:
<themes>
   <theme>css/main.css</theme>
</themes>
If you are using SWC theme should be better keep it's version controlled, so is advised to use a dependency with theme scope.
Like this:
<dependency>
  <groupId>com.acme</groupId>
  <artifactId>acme-theme</artifactId>
  <type>swc</type>
  <scope>theme</scope>
  <version>1.0</version>
</dependency>

updateSecuritySandbox boolean 3.5 When true, flexmojos will register register every compiled SWF files as trusted. These SWF files are assigned to the local-trusted sandbox. They can interact with any other SWF files, and they can load data from anywhere, remote or local. On false nothing is done, so if the file is already trusted it will still as it is.
Default value is: true.
useDefaultLocale boolean 3.5 (no description)
Default value is: true.
useNetwork boolean 3.5 Enables SWFs to access the network.
Default value is: true.
useResourceBundleMetadata boolean 3.5 Determines whether resources bundles are included in the application. This is equivalent to using the compiler.use-resource-bundle-metadata option of the mxmlc or compc compilers.
Default value is: true.
verboseStacktraces boolean 3.5 Turns on the display of stack traces for uncaught runtime errors.
Default value is: false.
verifyDigests boolean 3.5 Verifies the RSL loaded has the same digest as the RSL specified when the application was compiled. This is equivalent to using the verify-digests option in the mxmlc compiler.
Default value is: true.
warnings Warning 3.5 Enables checking of the following ActionScript warnings:
--compiler.warn-array-tostring-changes
--compiler.warn-assignment-within-conditional
--compiler.warn-bad-array-cast
--compiler.warn-bad-bool-assignment
--compiler.warn-bad-date-cast
--compiler.warn-bad-es3-type-method
--compiler.warn-bad-es3-type-prop
--compiler.warn-bad-nan-comparison
--compiler.warn-bad-null-assignment
--compiler.warn-bad-null-comparison
--compiler.warn-bad-undefined-comparison
--compiler.warn-boolean-constructor-with-no-args
--compiler.warn-changes-in-resolve
--compiler.warn-class-is-sealed
--compiler.warn-const-not-initialized
--compiler.warn-constructor-returns-value
--compiler.warn-deprecated-event-handler-error
--compiler.warn-deprecated-function-error
--compiler.warn-deprecated-property-error
--compiler.warn-duplicate-argument-names
--compiler.warn-duplicate-variable-def
--compiler.warn-for-var-in-changes
--compiler.warn-import-hides-class
--compiler.warn-instance-of-changes
--compiler.warn-internal-error
--compiler.warn-level-not-supported
--compiler.warn-missing-namespace-decl
--compiler.warn-negative-uint-literal
--compiler.warn-no-constructor
--compiler.warn-no-explicit-super-call-in-constructor
--compiler.warn-no-type-decl
--compiler.warn-number-from-string-changes
--compiler.warn-scoping-change-in-this
--compiler.warn-slow-text-field-addition
--compiler.warn-unlikely-function-value
--compiler.warn-xml-class-has-changed

Usage:
<warnigs>
  <arrayTostringChanges>true</arrayTostringChanges>
  <assignmentWithinConditional>false</assignmentWithinConditional>
</warnigs>

Parameter Details

accessible:

Turn on generation of accessible SWFs.
  • Type: boolean
  • Since: 3.5
  • Required: No
  • Default: false

allowSourcePathOverlap:

Allow the source-path to have path-elements which contain other path-elements
  • Type: boolean
  • Since: 3.5
  • Required: No
  • Default: false

as3:

Use the ActionScript 3 class based object model for greater performance and better error reporting. In the class based object model most built-in functions are implemented as fixed methods of classes (-strict is recommended, but not required, for earlier errors)
  • Type: boolean
  • Since: 3.5
  • Required: No
  • Default: true

classifier:

Classifier to add to the artifact generated. If given, the artifact will be an attachment instead.
  • Type: java.lang.String
  • Since: 3.5
  • Required: No
  • Expression: ${flexmojos.classifier}

compatibilityVersion:

  • Type: java.lang.String
  • Since: 3.5
  • Required: No

compiledLocales:

Sets the locales that the compiler uses to replace {locale} tokens that appear in some configuration values. This is equivalent to using the compiler.locale option of the mxmlc or compc compilers.
Usage:
<compiledLocales>
   <locale>en_US</locale>
   <locale>pt_BR</locale>
   <locale>es_ES</locale>
</compiledLocales>
  • Type: java.lang.String[]
  • Since: 3.5
  • Required: No

configFile:

Load a file containing configuration options If not defined, by default will search for one on resources folder.
  • Type: java.io.File
  • Since: 3.5
  • Required: No

configurationReport:

Writes the configuration report to a file after the build.
  • Type: boolean
  • Since: 3.5
  • Required: No
  • Expression: ${configurationReport}
  • Default: false

contextRoot:

Sets the context root path so that the compiler can replace {context.root} tokens for service channel endpoints.
  • Type: java.lang.String
  • Since: 3.5
  • Required: No

debug:

Turn on generation of debuggable SWFs. False by default for mxmlc, but true by default for compc.
  • Type: boolean
  • Since: 3.5
  • Required: No
  • Default: false

debugPassword:

A password that is embedded in the application
  • Type: java.lang.String
  • Since: 3.5
  • Required: No

defaultBackgroundColor:

Sets the default background color. You can override this by using the application code. This is the equivalent of the default-background-color option of the mxmlc or compc compilers.
  • Type: java.lang.String
  • Since: 3.5
  • Required: No
  • Default: 869CA7

defaultFrameRate:

Sets the default frame rate to be used in the application. This is the equivalent of the default-frame-rate option of the mxmlc or compc compilers.
  • Type: int
  • Since: 3.5
  • Required: No
  • Default: 24

defaultLocale:

Default locale for libraries. This is useful to non localized applications, just to define swc.rb locale
  • Type: java.lang.String
  • Since: 3.5
  • Required: No
  • Default: en_US

defaultSizeHeight:

Sets the default application height in pixels. This is equivalent to using the default-size option of the mxmlc or compc compilers.
  • Type: int
  • Since: 3.5
  • Required: No
  • Default: 375

defaultSizeWidth:

Sets the default application width in pixels. This is equivalent to using the default-size option of the mxmlc or compc compilers.
  • Type: int
  • Since: 3.5
  • Required: No
  • Default: 500

defaultsCss:

Sets the location of the default CSS file. This is equivalent to using the compiler.defaults-css-url option of the mxmlc or compc compilers.
  • Type: java.io.File
  • Since: 3.5
  • Required: No

defines:

Deprecated. See definesDeclaration
defines: specifies a list of define directive key and value pairs. For example, CONFIG::debugging
Usage:
<defines>
  <SOMETHING::aNumber>2.2</SOMETHING::aNumber>
  <SOMETHING::aString>"text"</SOMETHING::aString>
</defines>
  • Type: java.util.Map
  • Since: 3.5
  • Required: No

definesDeclaration:

defines: specifies a list of define directive key and value pairs. For example, CONFIG::debugging
Usage:
<definesDeclaration>
  <property>
    <name>SOMETHING::aNumber</name>
    <value>2.2</value>
  </property>
  <property>
    <name>SOMETHING::aString</name>
    <value>"text"</value>
  </property>
</definesDeclaration>
  • Type: java.util.Properties
  • Since: 3.5
  • Required: No

enableMavenResourcesResolver:

When enabled flexmojos will add a custom path resolver to flex compiler. This allow flexmojos to resolve Embed assets located at src/main/resources. This is a workaround and it is described at http://bugs.adobe.com/jira/browse/SDK-15466
  • Type: boolean
  • Since: 3.5
  • Required: No
  • Expression: ${enableMavenResourcesResolver}
  • Default: true

encoding:

Sets the ActionScript file encoding. The compiler uses this encoding to read the ActionScript source files. This is equivalent to using the actionscript-file-encoding option of the mxmlc or compc compilers.

The character encoding; for example UTF-8 or Big5.

  • Type: java.lang.String
  • Since: 3.5
  • Required: No
  • Default: UTF-8

es:

Use the ECMAScript edition 3 prototype based object model to allow dynamic overriding of prototype properties. In the prototype based object model built-in functions are implemented as dynamic properties of prototype objects (-strict is allowed, but may result in compiler errors for references to dynamic properties)
  • Type: boolean
  • Since: 3.5
  • Required: No
  • Default: false

externs:

Sets a list of definitions to omit from linking when building an application. This is equivalent to using the externs option of the mxmlc and compc compilers. An array of definitions (for example, classes, functions, variables, or namespaces).
Usage:
<externs>
  <extern>com.acme.AClass</extern>
</externs>
  • Type: java.lang.String[]
  • Since: 3.5
  • Required: No

fonts:

Local Fonts Snapshot File containing cached system font licensing information produced via java -cp mxmlc.jar flex2.tools.FontSnapshot (fontpath). Will default to winFonts.ser on Windows XP and macFonts.ser on Mac OS X.
Usage:
<fonts>
  <advancedAntiAliasing>true</advancedAntiAliasing>
  <flashType>true</flashType>
  <languages>
    <englishRange>U+0020-U+007E</englishRange>
  </languages>
  <localFontsSnapshot>${baseDir}/src/main/resources/fonts.ser</localFontsSnapshot>
  <managers>
    <manager>flash.fonts.BatikFontManager</manager>
  </managers>
  <maxCachedFonts>20</maxCachedFonts>
  <maxGlyphsPerFace>1000</maxGlyphsPerFace>
</fonts>
  • Type: org.sonatype.flexmojos.compiler.Font
  • Since: 3.5
  • Required: No

frames:

Sets a SWF frame label with a sequence of class names that are linked onto the frame. This is equivalent to using the frames.frame option of the mxmlc or compc compilers.
Usage:
<frames>
  <frame>
    <label>frame1</label>
    <classNames>
      <className>com.acme.AClass</className>
    </classNames>
  </frame>
</frames>
  • Type: org.sonatype.flexmojos.compiler.FrameLabel[]
  • Since: 3.5
  • Required: No

headlessServer:

Sets the compiler when it runs on a server without a display. This is equivalent to using the compiler.headless-server option of the mxmlc or compc compilers. that value determines if the compiler is running on a server without a display.
  • Type: boolean
  • Since: 3.5
  • Required: No
  • Default: false

ignoreVersionIssues:

When true, flexmojos will check if the compiler and the framework versions match. Usually, you must use the same compiler and framework versions. Set this to true to avoid this check. EXTREMELLY UN-ADVISIBLE.
  • Type: boolean
  • Since: 3.5
  • Required: No
  • Expression: ${ignore.version.issues}
  • Default: false

includeLookupOnly:

if true, manifest entries with lookupOnly=true are included in SWC catalog. default is false. This exists only so that manifests can mention classes that come in from filespec rather than classpath, e.g. in playerglobal.swc.
  • Type: boolean
  • Since: 3.5
  • Required: No
  • Default: false

includeResourceBundles:

This is equilvalent to the include-resource-bundles option of the compc compiler.
Usage:
<includeResourceBundles>
  <bundle>SharedResources</bundle>
  <bundle>collections</bundle>
  <bundle>containers</bundle>
</includeResourceBundles>
  • Type: java.lang.String[]
  • Since: 3.5
  • Required: No

includes:

Sets a list of definitions to always link in when building an application. This is equivalent to using the includes option of the mxmlc or compc compilers. An array of definitions (for example, classes, functions, variables, or namespaces).
Usage:
<includes>
  <include>com.acme.AClass</include>
</includes>
  • Type: java.lang.String[]
  • Since: 3.5
  • Required: No

incremental:

If the incremental input argument is false, this method recompiles all parts of the object. If the incremental input argument is true, this method compiles only the parts of the object that have changed since the last compilation.
  • Type: boolean
  • Since: 3.5
  • Required: No
  • Expression: ${incremental}
  • Default: false

keepAllTypeSelectors:

Instructs the compiler to keep a style sheet's type selector in a SWF file, even if that type (the class) is not used in the application. This is equivalent to using the compiler.keep-all-type-selectors option of the mxmlc or compc compilers.
  • Type: boolean
  • Since: 3.5
  • Required: No
  • Default: false

keepAs3Metadatas:

Keep the following AS3 metadata in the bytecodes.
Usage:
<keepAs3Metadatas>
  <keepAs3Metadata>Bindable</keepAs3Metadata>
  <keepAs3Metadata>Events</keepAs3Metadata>
</keepAs3Metadatas>
  • Type: java.lang.String[]
  • Since: 3.5
  • Required: No

keepGeneratedActionscript:

Turn on writing of generated/*.as files to disk. These files are generated by the compiler during mxml translation and are helpful with understanding and debugging Flex applications.
  • Type: boolean
  • Since: 3.5
  • Required: No
  • Default: false

licenses:

licenses: specifies a list of product and serial number pairs.
Usage:
<licenses>
  <flexbuilder3>xxxx-xxxx-xxxx-xxxx</flexbuilder3>
</licenses>
  • Type: java.util.Map
  • Since: 3.5
  • Required: No

linkReport:

Uses the default compiler options as base
  • Type: boolean
  • Since: 3.5
  • Required: No
  • Default: false

loadExterns:

Deprecated. Use dependency with type "xml" and classifier "link-report"
Sets a list of artifacts to omit from linking when building an application. This is equivalent to using the load-externs option of the mxmlc or compc compilers.
Usage:
<loadExterns>
  <loadExtern>
    <groupId>com.acme</groupId>
    <artifactId>flexmodule</artifactId>
    <version>1.0.0</version>
  </loadExtern>
  <loadExtern>
    <groupId>org.tabajara</groupId>
    <artifactId>flexmodule</artifactId>
    <version>1.0.0</version>
  </loadExtern>
</loadExterns>
  • Type: org.sonatype.flexmojos.compiler.MavenArtifact[]
  • Since: 3.5
  • Required: No

loadExternsOnModules:

When true, tells flexmojos to use link reports/load externs on modules compilation
  • Type: boolean
  • Since: 3.5
  • Required: No
  • Expression: ${loadExternsOnModules}
  • Default: true

localRepository:

Local repository to be used by the plugin to resolve dependencies.
  • Type: org.apache.maven.artifact.repository.ArtifactRepository
  • Since: 3.5
  • Required: No
  • Expression: ${localRepository}

locales:

Sets the locales that the compiler uses to replace {locale} tokens that appear in some configuration values. This is equivalent to using the compiler.locale option of the mxmlc or compc compilers.
Usage:
<locales>
   <locale>en_US</locale>
   <locale>pt_BR</locale>
   <locale>es_ES</locale>
</locales>
  • Type: java.lang.String[]
  • Since: 3.5
  • Required: No

mergeResourceBundle:

When true resources are compiled into Application or Library. When false resources are compiled into separated Application or Library files. If not defined no resourceBundle generation is done
  • Type: java.lang.Boolean
  • Since: 3.5
  • Required: No

metadata:

SWF metadata useless there is no API to read it.
Usage:
<metadata>
  <contributor>buddy</contributor>
  <creator>me</creator>
  <date>01/01/01</date>
  <descriptions>
    <en_US>Simple description</en_US>
  </descriptions>
  <language>en_US</language>
  <publishers>
    <publisher>publisher1</publisher>
    <publisher>publisher2</publisher>
  </publishers>
  <titles>
    <en_US>Project title</en_US>
  </titles>
</metadata>
  • Type: org.sonatype.flexmojos.compiler.Metadata
  • Since: 3.5
  • Required: No

moduleFiles:

The list of modules files to be compiled. The path must be relative with source folder.
Usage:
<moduleFiles>
  <module>com/acme/AModule.mxml</module>
</moduleFiles>
  • Type: java.lang.String[]
  • Since: 3.5
  • Required: No

namespaces:

Specify a URI to associate with a manifest of components for use as MXML elements.
Usage:
<namespaces>
  <namespace>
    <uri>http://www.adobe.com/2006/mxml</uri>
    <manifest>${basedir}/manifest.xml</manifest>
  </namespace>
</namespaces>
  • Type: org.sonatype.flexmojos.utilities.Namespace[]
  • Since: 3.5
  • Required: No

optimize:

Enable post-link SWF optimization.
  • Type: boolean
  • Since: 3.5
  • Required: No
  • Default: true

output:

The filename of the compiled artifact
  • Type: java.io.File
  • Since: 3.5
  • Required: No

pluginArtifacts:

(no description)
  • Type: java.util.List
  • Since: 3.5
  • Required: No
  • Expression: ${plugin.artifacts}

policyFileUrls:

policyFileUrls array of policy file URLs. Each entry in the rslUrls array must have a corresponding entry in this array. A policy file may be needed in order to allow the player to read an RSL from another domain. If a policy file is not required, then set it to an empty string. Accept some special tokens:
{contextRoot}        - replace by defined context root
{groupId}            - replace by library groupId
{artifactId}         - replace by library artifactId
{version}            - replace by library version
{extension}          - replace by library extension swf or swz

Usage:
<policyFileUrls>
  <url>/{contextRoot}/rsl/policy-{artifactId}-{version}.xml</url>
</policyFileUrls>
  • Type: java.lang.String[]
  • Since: 3.5
  • Required: No

quick:

Quick compile mode. When true, flexmojos will check if the last artifact available at maven repository is newer then sources. If so, will not recompile.
  • Type: boolean
  • Since: 3.5
  • Required: No
  • Expression: ${quick.compile}
  • Default: false

rawMetadata:

Sets the metadata section of the application SWF. This is equivalent to the raw-metadata option of the mxmlc or compc compilers. Need a well-formed XML fragment
  • Type: java.lang.String
  • Since: 3.5
  • Required: No

remoteRepositories:

List of remote repositories to be used by the plugin to resolve dependencies.
  • Type: java.util.List
  • Since: 3.5
  • Required: No
  • Expression: ${project.remoteArtifactRepositories}

resourceBundlePath:

Define the base path to locate resouce bundle files Accept some special tokens:
{locale}     - replace by locale name
  • Type: java.lang.String
  • Since: 3.5
  • Required: No
  • Default: ${basedir}/src/main/locales/{locale}

rslUrls:

rslUrls array of URLs. The first RSL URL in the list is the primary RSL. The remaining RSL URLs will only be loaded if the primary RSL fails to load. Accept some special tokens:
{contextRoot}        - replace by defined context root
{groupId}            - replace by library groupId
{artifactId}         - replace by library artifactId
{version}            - replace by library version
{extension}          - replace by library extension swf or swz
default-value="/{contextRoot}/rsl/{artifactId}-{version}.{extension}"
Usage:
<rslUrls>
  <url>/{contextRoot}/rsl/{artifactId}-{version}.{extension}</url>
</rslUrls>
  • Type: java.lang.String[]
  • Since: 3.5
  • Required: No

runtimeLocaleOutputPath:

Resource module or resource library output path
  • Type: java.lang.String
  • Since: 3.5
  • Required: No
  • Default: ${project.build.directory}/locales/${project.artifactId}-${project.version}-{locale}.{extension}

runtimeLocales:

Sets the locales that should be used to generate resource bundles.
Usage:
<runtimeLocales>
   <locale>en_US</locale>
   <locale>pt_BR</locale>
   <locale>es_ES</locale>
</runtimeLocales>
  • Type: java.lang.String[]
  • Since: 3.5
  • Required: No

scriptMaxExecutionTime:

Sets the default script execution limits (which can be overridden by root attributes). This is equivalent to using the default-script-limits option of the mxmlc or compc compilers. Execution time, in seconds
  • Type: int
  • Since: 3.5
  • Required: No
  • Default: 60

scriptMaxRecursionDepth:

Sets the default script execution limits (which can be overridden by root attributes). This is equivalent to using the default-script-limits option of the mxmlc or compc compilers. Recursion depth
  • Type: int
  • Since: 3.5
  • Required: No
  • Default: 1000

services:

Sets the location of the Flex Data Services service configuration file. This is equivalent to using the compiler.services option of the mxmlc and compc compilers. If not define will look inside resources directory for services-config.xml
  • Type: java.io.File
  • Since: 3.5
  • Required: No

showWarnings:

Run the AS3 compiler in a mode that detects legal but potentially incorrect code. Equivalent compiler option: warnings
  • Type: boolean
  • Since: 3.5
  • Required: No
  • Default: true

skip:

(no description)
  • Type: boolean
  • Since: 3.5
  • Required: No
  • Expression: ${flexmojos.skip}
  • Default: false

sourceFile:

The file to be compiled. The path must be relative with source folder
  • Type: java.lang.String
  • Since: 3.5
  • Required: No

sourcePaths:

List of path elements that form the roots of ActionScript class hierarchies.
Usage:
<sourcePaths>
   <path>${baseDir}/src/main/flex</path>
</sourcePaths>
By default use Maven source and resources folders.
  • Type: java.io.File[]
  • Since: 3.5
  • Required: No

staticLinkRuntimeSharedLibraries:

Determines whether to compile against libraries statically or use RSLs. Set this option to true to ignore the RSLs specified by the rslUrls. Set this option to false to use the RSLs.

Add the static-link-runtime-shared-libraries=true option; this ensures that you are not using the framework RSL when compiling the application, regardless of the settings in your configuration files. Instead, you are compiling the framework classes into your SWF file.

http://livedocs.adobe.com/flex/3/html/help.html?content=rsl_09.html
  • Type: boolean
  • Since: 3.5
  • Required: No
  • Default: false

strict:

Run the AS3 compiler in strict error checking mode.
  • Type: boolean
  • Since: 3.5
  • Required: No
  • Default: true

targetPlayer:

specifies the version of the player the application is targeting. Features requiring a later version will not be compiled into the application. The minimum value supported is "9.0.0". If not defined will take the default value from current playerglobal dependency.
  • Type: java.lang.String
  • Since: 3.5
  • Required: No

themes:

List of CSS or SWC files to apply as a theme. <>BR Usage:
<themes>
   <theme>css/main.css</theme>
</themes>
If you are using SWC theme should be better keep it's version controlled, so is advised to use a dependency with theme scope.
Like this:
<dependency>
  <groupId>com.acme</groupId>
  <artifactId>acme-theme</artifactId>
  <type>swc</type>
  <scope>theme</scope>
  <version>1.0</version>
</dependency>
  • Type: java.lang.String[]
  • Since: 3.5
  • Required: No

updateSecuritySandbox:

When true, flexmojos will register register every compiled SWF files as trusted. These SWF files are assigned to the local-trusted sandbox. They can interact with any other SWF files, and they can load data from anywhere, remote or local. On false nothing is done, so if the file is already trusted it will still as it is.
  • Type: boolean
  • Since: 3.5
  • Required: No
  • Expression: ${updateSecuritySandbox}
  • Default: true

useDefaultLocale:

(no description)
  • Type: boolean
  • Since: 3.5
  • Required: No
  • Default: true

useNetwork:

Enables SWFs to access the network.
  • Type: boolean
  • Since: 3.5
  • Required: No
  • Default: true

useResourceBundleMetadata:

Determines whether resources bundles are included in the application. This is equivalent to using the compiler.use-resource-bundle-metadata option of the mxmlc or compc compilers.
  • Type: boolean
  • Since: 3.5
  • Required: No
  • Default: true

verboseStacktraces:

Turns on the display of stack traces for uncaught runtime errors.
  • Type: boolean
  • Since: 3.5
  • Required: No
  • Default: false

verifyDigests:

Verifies the RSL loaded has the same digest as the RSL specified when the application was compiled. This is equivalent to using the verify-digests option in the mxmlc compiler.
  • Type: boolean
  • Since: 3.5
  • Required: No
  • Default: true

warnings:

Enables checking of the following ActionScript warnings:
--compiler.warn-array-tostring-changes
--compiler.warn-assignment-within-conditional
--compiler.warn-bad-array-cast
--compiler.warn-bad-bool-assignment
--compiler.warn-bad-date-cast
--compiler.warn-bad-es3-type-method
--compiler.warn-bad-es3-type-prop
--compiler.warn-bad-nan-comparison
--compiler.warn-bad-null-assignment
--compiler.warn-bad-null-comparison
--compiler.warn-bad-undefined-comparison
--compiler.warn-boolean-constructor-with-no-args
--compiler.warn-changes-in-resolve
--compiler.warn-class-is-sealed
--compiler.warn-const-not-initialized
--compiler.warn-constructor-returns-value
--compiler.warn-deprecated-event-handler-error
--compiler.warn-deprecated-function-error
--compiler.warn-deprecated-property-error
--compiler.warn-duplicate-argument-names
--compiler.warn-duplicate-variable-def
--compiler.warn-for-var-in-changes
--compiler.warn-import-hides-class
--compiler.warn-instance-of-changes
--compiler.warn-internal-error
--compiler.warn-level-not-supported
--compiler.warn-missing-namespace-decl
--compiler.warn-negative-uint-literal
--compiler.warn-no-constructor
--compiler.warn-no-explicit-super-call-in-constructor
--compiler.warn-no-type-decl
--compiler.warn-number-from-string-changes
--compiler.warn-scoping-change-in-this
--compiler.warn-slow-text-field-addition
--compiler.warn-unlikely-function-value
--compiler.warn-xml-class-has-changed

Usage:
<warnigs>
  <arrayTostringChanges>true</arrayTostringChanges>
  <assignmentWithinConditional>false</assignmentWithinConditional>
</warnigs>
  • Type: org.sonatype.flexmojos.compiler.Warning
  • Since: 3.5
  • Required: No