flexmojos:flexbuilder

Full name:

org.sonatype.flexmojos:flexmojos-maven-plugin:3.5.0:flexbuilder

Description:

Generates Flex Builder configuration files for SWC and SWF projects.

Attributes:

  • Requires a Maven 2.0 project to be executed.
  • Requires dependency resolution of artifacts in scope: test.
  • Since version: 3.0.

Optional Parameters

Name Type Since Description
accessible boolean 3.0 Turn on generation of accessible SWFs.
Default value is: false.
additionalApplications List 3.0 Additional application files. The paths must be relative to the source folder.
buildCssFiles String[] 3.0 List of css files that will be compiled into swfs within Eclipse. The path must be relative to the base directory of the project. Usage: 
<buildCssFiles&gt
    <path>src/style/main.css<path>
</buildCssFiles>

compiledLocales String[] 3.0 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>

contextRoot String 3.0 Context root to pass to the compiler.
defaultLocale String 3.0 Default locale for libraries. This is useful to non localized applications, just to define swc.rb locale
Default value is: en_US.
definesDeclaration Properties 3.0 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>

enableFlexBuilderBuildCommand boolean 3.0 (no description)
Default value is: true.
enableM2e boolean 3.0 (no description)
Default value is: true.
flexBuilderOutputFolderPath String 3.0 Customize the outputFolderPath of the Eclipse FlexBuilder Compiler.
Default value is: bin-debug.
generateHtmlWrapper boolean 3.0 (no description)
Default value is: false.
includeClasses String[] 3.0 This is the equilvalent of the include-classes option of the compc compiler.
Usage: 
<includeClassses>
  <class>foo.Bar</class>
</includeClasses>

includeSources File[] 3.0 This is the equilvalent of the include-sources option of the compc compiler.
Usage: 
<includeSources>
  <sources>${baseDir}/src/main/flex</sources>
</includeSources>

incremental boolean 3.0 The greeting to display.
locales String[] 3.0 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.0 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
pureActionscriptProject Boolean 3.0 Specifies whether this project should be treated as a Flex or a pure ActionScript project by Flexbuilder. If set to true:
  • Removes Flex (app/lib) natures from .project file.
  • Changes exclusions from library path entries in .actionScriptProperties file.
  • Completly omits creation of the .flexProperties file.
If not defined Flexmojos will lockup for com.adobe.flex.framework:framework:swc and set as true if found or false if not found
remoteRepositories List 3.0 (no description)
resourceBundlePath String 3.0 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}.
services File 3.0 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.0 Run the AS3 compiler in a mode that detects legal but potentially incorrect code
Default value is: true.
sourceFile String 3.0 The file to be compiled. The path must be relative to the source folder.
sourcePaths File[] 3.0 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.
strict boolean 3.0 Run the AS3 compiler in strict error checking mode.
Default value is: true.
targetPlayer String 3.0 (no description)
Default value is: 9.0.0.
useM2Repo boolean 3.0 Implies enableM2e=true
Default value is: false.
verifyDigests boolean 3.0 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.

Parameter Details

accessible:

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

additionalApplications:

Additional application files. The paths must be relative to the source folder.
  • Type: java.util.List
  • Since: 3.0
  • Required: No

buildCssFiles:

List of css files that will be compiled into swfs within Eclipse. The path must be relative to the base directory of the project. Usage: 
<buildCssFiles&gt
    <path>src/style/main.css<path>
</buildCssFiles>
  • Type: java.lang.String[]
  • Since: 3.0
  • 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.0
  • Required: No

contextRoot:

Context root to pass to the compiler.
  • Type: java.lang.String
  • Since: 3.0
  • Required: No

defaultLocale:

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

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.0
  • Required: No

enableFlexBuilderBuildCommand:

(no description)
  • Type: boolean
  • Since: 3.0
  • Required: No
  • Expression: ${enableFlexBuilderBuildCommand}
  • Default: true

enableM2e:

(no description)
  • Type: boolean
  • Since: 3.0
  • Required: No
  • Expression: ${enableM2e}
  • Default: true

flexBuilderOutputFolderPath:

Customize the outputFolderPath of the Eclipse FlexBuilder Compiler.
  • Type: java.lang.String
  • Since: 3.0
  • Required: No
  • Default: bin-debug

generateHtmlWrapper:

(no description)
  • Type: boolean
  • Since: 3.0
  • Required: No
  • Expression: ${generateHtmlWrapper}
  • Default: false

includeClasses:

This is the equilvalent of the include-classes option of the compc compiler.
Usage: 
<includeClassses>
  <class>foo.Bar</class>
</includeClasses>
  • Type: java.lang.String[]
  • Since: 3.0
  • Required: No

includeSources:

This is the equilvalent of the include-sources option of the compc compiler.
Usage: 
<includeSources>
  <sources>${baseDir}/src/main/flex</sources>
</includeSources>
  • Type: java.io.File[]
  • Since: 3.0
  • Required: No

incremental:

The greeting to display.
  • Type: boolean
  • Since: 3.0
  • Required: No

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.0
  • 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.0
  • Required: No

pureActionscriptProject:

Specifies whether this project should be treated as a Flex or a pure ActionScript project by Flexbuilder. If set to true:
  • Removes Flex (app/lib) natures from .project file.
  • Changes exclusions from library path entries in .actionScriptProperties file.
  • Completly omits creation of the .flexProperties file.
If not defined Flexmojos will lockup for com.adobe.flex.framework:framework:swc and set as true if found or false if not found
  • Type: java.lang.Boolean
  • Since: 3.0
  • Required: No

remoteRepositories:

(no description)
  • Type: java.util.List
  • Since: 3.0
  • 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.0
  • Required: No
  • Default: ${basedir}/src/main/locales/{locale}

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.0
  • Required: No

showWarnings:

Run the AS3 compiler in a mode that detects legal but potentially incorrect code
  • Type: boolean
  • Since: 3.0
  • Required: No
  • Default: true

sourceFile:

The file to be compiled. The path must be relative to the source folder.
  • Type: java.lang.String
  • Since: 3.0
  • 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.0
  • Required: No

strict:

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

targetPlayer:

(no description)
  • Type: java.lang.String
  • Since: 3.0
  • Required: No
  • Default: 9.0.0

useM2Repo:

Implies enableM2e=true
  • Type: boolean
  • Since: 3.0
  • Required: No
  • Expression: ${useM2Home}
  • 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.0
  • Required: No
  • Default: true