public class BuilderConfiguration extends Object implements Configuration
CONTRIBUTOR, CREATOR, DATE, DEFAULT_OUTPUT_DIRECTORY_TOKEN, DESCRIPTION, LANGUAGE, PUBLISHER, TITLE, WARN_ARRAY_TOSTRING_CHANGES, WARN_ASSIGNMENT_WITHIN_CONDITIONAL, WARN_BAD_ARRAY_CAST, WARN_BAD_BOOLEAN_ASSIGNMENT, WARN_BAD_DATE_CAST, WARN_BAD_ES3_TYPE_METHOD, WARN_BAD_ES3_TYPE_PROP, WARN_BAD_NAN_COMPARISON, WARN_BAD_NULL_ASSIGNMENT, WARN_BAD_NULL_COMPARISON, WARN_BAD_UNDEFINED_COMPARISON, WARN_BOOLEAN_CONSTRUCTOR_WITH_NO_ARGS, WARN_CHANGES_IN_RESOLVE, WARN_CLASS_IS_SEALED, WARN_CONST_NOT_INITIALIZED, WARN_CONSTRUCTOR_RETURNS_VALUE, WARN_DEPRECATED_EVENT_HANDLER_ERROR, WARN_DEPRECATED_FUNCTION_ERROR, WARN_DEPRECATED_PROPERTY_ERROR, WARN_DUPLICATE_ARGUMENT_NAMES, WARN_DUPLICATE_VARIABLE_DEF, WARN_FOR_VAR_IN_CHANGES, WARN_IMPORT_HIDES_CLASS, WARN_INSTANCEOF_CHANGES, WARN_INTERNAL_ERROR, WARN_LEVEL_NOT_SUPPORTED, WARN_MISSING_NAMESPACE_DECL, WARN_NEGATIVE_UINT_LITERAL, WARN_NO_CONSTRUCTOR, WARN_NO_EXPLICIT_SUPER_CALL_IN_CONSTRUCTOR, WARN_NO_TYPE_DECL, WARN_NUMBER_FROM_STRING_CHANGES, WARN_SCOPING_CHANGE_IN_THIS, WARN_SLOW_TEXTFIELD_ADDITION, WARN_UNLIKELY_FUNCTION_VALUE, WARN_XML_CLASS_HAS_CHANGED
Modifier and Type | Method and Description |
---|---|
void |
addActionScriptMetadata(String[] md)
Adds the list of ActionScript metadata names to the existing list of ActionScript metadata
that the compiler keeps in the SWF.
|
void |
addApplicationDomainForRuntimeSharedLibraryPath(File path,
String applicationDomainTarget)
Add application domain setting to the existing list of application domain
settings.
|
void |
addConfiguration(File file)
Adds a file to the existing list of configuration files.
|
void |
addDefineDirective(String name,
String value)
Add a global AS3 compiler configuration value and preserve existing definitions.
|
void |
addExtensionLibraries(File extension,
List<String> parameters) |
void |
addExternalLibraryPath(File[] paths)
Adds to the existing list of SWC files.
|
void |
addExterns(File[] files)
Adds a list of files to the existing list of definitions to be omitted from linking.
|
void |
addExterns(String[] definitions)
Adds a list of definitions to the existing list of definitions.
|
void |
addFontManagers(String[] classNames)
Adds font managers to the existing font manager list.
|
void |
addForceRuntimeSharedLibraryPaths(File[] paths)
Adds SWCs to the existing set of SWCs whose RSLs will be loaded at runtime.
|
void |
addIncludes(String[] definitions)
Adds a list of definitions to the existing list of definitions.
|
void |
addLibraryPath(File[] paths)
Adds a list of SWC files or directories to the default library path.
|
void |
addLocalFontPaths(String[] paths)
Adds local font paths to the existing local font path list.
|
void |
addRuntimeSharedLibraries(String[] libraries)
Adds a list of run-time shared library URLs to the existing list.
|
void |
addRuntimeSharedLibraryPath(String swc,
String[] rslUrls,
String[] policyFileUrls)
This is equivalent to using more than one
runtime-shared-library-path
option when using the mxmlc compiler. |
void |
addSourcePath(File[] paths)
Adds a list of path elements to the existing source path list.
|
void |
addTheme(File[] files)
Adds a list of CSS or SWC files to the existing list of theme files.
|
void |
allowSourcePathOverlap(boolean b)
Allows some source path directories to be subdirectories of the other.
|
void |
checkActionScriptWarning(int warningCode,
boolean b)
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
|
void |
compress(boolean b)
Enables ZLIB compression on SWF file.
|
void |
enableAccessibility(boolean b)
Enables accessibility in the application.
|
void |
enableAdvancedAntiAliasing(boolean b)
Enables advanced anti-aliasing for embedded fonts, which provides greater clarity for small fonts.
|
void |
enableDebugging(boolean b,
String debugPassword)
Enables debugging in the application.
|
void |
enableDigestComputation(boolean compute)
Enable or disable the computation of a digest for the created swf library.
|
void |
enableDigestVerification(boolean verify)
Verifies the RSL loaded
has the same digest as the RSL specified when the application was compiled.
|
void |
enableFlashType(boolean b)
Enables FlashType for embedded fonts, which provides greater clarity for small fonts.
|
void |
enableStrictChecking(boolean b)
Runs the ActionScript compiler in strict error checking mode.
|
void |
enableVerboseStacktraces(boolean b)
Generates bytecodes that include line numbers.
|
void |
includeLibraries(File[] libraries)
Includes a list of SWC files to completely include in the application.
|
void |
keepAllTypeSelectors(boolean b)
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.
|
void |
keepCompilerGeneratedActionScript(boolean b)
Saves temporary source files that are generated during MXML compilation.
|
void |
keepConfigurationReport(boolean b)
Instructs the compiler to keep a report of the compiler configuration settings.
|
void |
keepLinkReport(boolean b)
Instructs the linker to keep a report of the content that is included in the application.
|
void |
keepSizeReport(boolean b)
Instructs the linker to keep a SWF size summary.
|
void |
optimize(boolean b)
Enables post-link optimization.
|
void |
removeUnusedRuntimeSharedLibraryPaths(boolean b)
Enables the removal of RSLs associated with libraries
that are not used by an application.
|
void |
setActionScriptFileEncoding(String encoding)
Sets the ActionScript file encoding.
|
void |
setActionScriptMetadata(String[] md)
Sets the ActionScript metadata that the compiler keeps in the SWF.
|
void |
setApplicationDomainForRuntimeSharedLibraryPath(File path,
String applicationDomainTarget)
Set the application domain of a configured RSL to override the default
settings.
|
void |
setCompatibilityVersion(int major,
int minor,
int revision)
Sets the SDK compatibility version.
|
void |
setComponentManifest(String namespaceURI,
File manifest)
Specifies a URI to associate with a manifest of components for use as MXML elements.
|
void |
setComponentManifests(String namespaceURI,
List<File> manifests) |
void |
setConfiguration(File file)
Loads a file containing configuration options.
|
void |
setConfiguration(String[] args)
Sets the configuration parameters.
|
void |
setContextRoot(String path)
Sets the context root path so that the compiler can replace
{context.root} tokens for
service channel endpoints. |
void |
setDefaultBackgroundColor(int color)
Sets the default background color.
|
void |
setDefaultCSS(File url)
Sets the location of the default CSS file.
|
void |
setDefaultFrameRate(int rate)
Sets the default frame rate to be used in the application.
|
void |
setDefaultScriptLimits(int maxRecursionDepth,
int maxExecutionTime)
Sets the default script execution limits (which can be overridden by root attributes).
|
void |
setDefaultSize(int width,
int height)
Sets the default application size.
|
void |
setDefineDirective(String[] names,
String[] values)
Set global AS3 compiler configuration values and clear existing definitions.
|
void |
setExtensionLibraries(Map<File,List<String>> extensions) |
void |
setExternalLibraryPath(File[] paths)
Sets the list of SWC files or directories to compile against, but to omit from linking.
|
void |
setExterns(File[] files)
Sets a list of definitions to omit from linking when building an application.
|
void |
setExterns(String[] definitions)
Sets a list of definitions to omit from linking when building an application.
|
void |
setFontLanguageRange(String language,
String range)
Sets a range to restrict the number of font glyphs embedded into the application.
|
void |
setFontManagers(String[] classNames)
Sets the font managers used by the compiler.
|
void |
setForceRuntimeSharedLibraryPaths(File[] paths)
Sets the SWCs that will have their associated RSLs loaded at runtime.
|
void |
setFrameLabel(String label,
String[] classNames)
Sets a SWF frame label with a sequence of class names that are linked onto the frame.
|
void |
setIncludes(String[] definitions)
Sets a list of definitions to always link in when building an application.
|
void |
setLibraryPath(File[] paths)
Sets a list of SWC files or directories that contain SWC files.
|
void |
setLicense(String productName,
String serialNumber)
Specifies the licenses that the compiler validates before compiling.
|
void |
setLocale(Locale locale)
Sets the locale that the compiler uses to replace
{locale} tokens that appear in some configuration values. |
void |
setLocale(String[] locales)
Sets the locales that the compiler uses to replace
{locale} tokens that appear in some configuration values. |
void |
setLocalFontPaths(String[] paths)
Sets the local font file paths to be searched by the compiler.
|
void |
setLocalFontSnapshot(File file)
Sets the location of the local font snapshot file.
|
void |
setMaximumCachedFonts(int size)
Sets the maximum number of embedded font faces that can be cached.
|
void |
setMaximumGlyphsPerFace(int size)
Sets the maximum number of character glyph outlines to cache for each font face.
|
void |
setRuntimeSharedLibraries(String[] libraries)
Sets a list of run-time shared library URLs to be loaded before the application starts.
|
void |
setRuntimeSharedLibraryPath(String swc,
String[] rslUrls,
String[] policyFileUrls)
Set the arguments required to use an RSL with optional failover RSLs.
|
void |
setServiceConfiguration(File file)
Sets the location of the Flex Data Services service configuration file.
|
void |
setSourcePath(File[] paths)
Sets a list of path elements that form the roots of ActionScript class hierarchies.
|
void |
setSWFMetaData(int field,
Object value)
Sets the metadata section of the application SWF.
|
void |
setSWFMetaData(String xml)
Sets the metadata section of the application SWF.
|
void |
setTargetPlayer(int major,
int minor,
int revision)
Sets the version of the Flash Player that is being targeted by the application.
|
void |
setTheme(File[] files)
Sets a list of CSS or SWC files to apply as a theme.
|
void |
setToken(String name,
String value)
Defines a token that can be used for token substitutions.
|
void |
showActionScriptWarnings(boolean b)
Runs the ActionScript compiler in a mode that detects legal but potentially incorrect code.
|
void |
showBindingWarnings(boolean b)
Toggles whether warnings generated from data binding code are displayed.
|
void |
showDeprecationWarnings(boolean b)
Toggles whether the use of deprecated APIs generates a warning.
|
void |
showShadowedDeviceFontWarnings(boolean b)
Toggles whether warnings are displayed when an embedded font name shadows
a device font name.
|
void |
showUnusedTypeSelectorWarnings(boolean b)
Toggles whether warnings generated from unused type selectors are displayed.
|
String |
toString() |
void |
useActionScript3(boolean b)
Uses the ActionScript 3 class-based object model for greater performance and better error reporting.
|
void |
useECMAScript(boolean b)
Uses the ECMAScript edition 3 prototype-based object model to allow dynamic overriding
of prototype properties.
|
void |
useHeadlessServer(boolean b)
Sets the compiler when it runs on a server without a display.
|
void |
useNetwork(boolean b)
Toggles whether the application SWF is flagged for access to network resources.
|
void |
useResourceBundleMetaData(boolean b)
Determines whether resources bundles are included in the application.
|
public void addActionScriptMetadata(String[] md)
Configuration
addActionScriptMetadata
in interface Configuration
md
- An array of ActionScript metadata names.Configuration.setActionScriptMetadata(String[])
public void addConfiguration(File file)
Configuration
addConfiguration
in interface Configuration
file
- An instance of the java.io.File
class.Configuration.setConfiguration(File)
public void addExternalLibraryPath(File[] paths)
Configuration
addExternalLibraryPath
in interface Configuration
paths
- A list of paths. The File.isDirectory()
method should return
true
; File
instances should represent SWC files.Configuration.setExternalLibraryPath(File[])
public void addExterns(String[] definitions)
Configuration
addExterns
in interface Configuration
definitions
- An array of definitions (for example, classes, functions, variables, namespaces).Configuration.setExterns(File[])
,
Configuration.setExterns(String[])
public void addExterns(File[] files)
Configuration
addExterns
in interface Configuration
files
- An array of java.io.File
objects.Configuration.setExterns(File[])
,
Configuration.setExterns(String[])
public void addFontManagers(String[] classNames)
Configuration
addFontManagers
in interface Configuration
classNames
- An array of Java class names.Configuration.setFontManagers(String[])
public void addIncludes(String[] definitions)
Configuration
addIncludes
in interface Configuration
definitions
- An array of definitions (for example, classes, functions, variables, or namespaces).Configuration.setIncludes(String[])
public void addLibraryPath(File[] paths)
Configuration
addLibraryPath
in interface Configuration
paths
- An array of File
objects. The File.isDirectory()
method should return
true
; instances must represent SWC files.Configuration.setLibraryPath(File[])
public void addLocalFontPaths(String[] paths)
Configuration
addLocalFontPaths
in interface Configuration
paths
- an array of local font file paths.Configuration.setLocalFontPaths(String[])
public void addRuntimeSharedLibraries(String[] libraries)
Configuration
addRuntimeSharedLibraries
in interface Configuration
libraries
- An array of java.lang.String
objects.Configuration.setRuntimeSharedLibraries(String[])
public void addSourcePath(File[] paths)
Configuration
addSourcePath
in interface Configuration
paths
- An array of java.io.File
objects. The File.isDirectory()
method must return true
.Configuration.setSourcePath(File[])
public void addTheme(File[] files)
Configuration
addTheme
in interface Configuration
files
- An array of java.io.File
objects.Configuration.setTheme(File[])
public void allowSourcePathOverlap(boolean b)
Configuration
compiler.allow-source-path-overlap
option of the mxmlc or compc compilers.
In some J2EE settings, directory overlapping should be allowed; for example:
wwwroot/MyAppRoot wwwroot/WEB-INF/flex/source_path1
The default value is false
.
allowSourcePathOverlap
in interface Configuration
b
- Boolean value that allows directory overlapping.public void checkActionScriptWarning(int warningCode, boolean b)
Configuration
--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
checkActionScriptWarning
in interface Configuration
warningCode
- Warning code.b
- Boolean value.Configuration.WARN_ARRAY_TOSTRING_CHANGES
,
Configuration.WARN_ASSIGNMENT_WITHIN_CONDITIONAL
,
Configuration.WARN_BAD_ARRAY_CAST
,
Configuration.WARN_BAD_BOOLEAN_ASSIGNMENT
,
Configuration.WARN_BAD_DATE_CAST
,
Configuration.WARN_BAD_ES3_TYPE_METHOD
,
Configuration.WARN_BAD_ES3_TYPE_PROP
,
Configuration.WARN_BAD_NAN_COMPARISON
,
Configuration.WARN_BAD_NULL_ASSIGNMENT
,
Configuration.WARN_BAD_NULL_COMPARISON
,
Configuration.WARN_BAD_UNDEFINED_COMPARISON
,
Configuration.WARN_BOOLEAN_CONSTRUCTOR_WITH_NO_ARGS
,
Configuration.WARN_CHANGES_IN_RESOLVE
,
Configuration.WARN_CLASS_IS_SEALED
,
Configuration.WARN_CONST_NOT_INITIALIZED
,
Configuration.WARN_CONSTRUCTOR_RETURNS_VALUE
,
Configuration.WARN_DEPRECATED_EVENT_HANDLER_ERROR
,
Configuration.WARN_DEPRECATED_FUNCTION_ERROR
,
Configuration.WARN_DEPRECATED_PROPERTY_ERROR
,
Configuration.WARN_DUPLICATE_ARGUMENT_NAMES
,
Configuration.WARN_DUPLICATE_VARIABLE_DEF
,
Configuration.WARN_FOR_VAR_IN_CHANGES
,
Configuration.WARN_IMPORT_HIDES_CLASS
,
Configuration.WARN_INSTANCEOF_CHANGES
,
Configuration.WARN_INTERNAL_ERROR
,
Configuration.WARN_LEVEL_NOT_SUPPORTED
,
Configuration.WARN_MISSING_NAMESPACE_DECL
,
Configuration.WARN_NEGATIVE_UINT_LITERAL
,
Configuration.WARN_NO_CONSTRUCTOR
,
Configuration.WARN_NO_EXPLICIT_SUPER_CALL_IN_CONSTRUCTOR
,
Configuration.WARN_NO_TYPE_DECL
,
Configuration.WARN_NUMBER_FROM_STRING_CHANGES
,
Configuration.WARN_SCOPING_CHANGE_IN_THIS
,
Configuration.WARN_SLOW_TEXTFIELD_ADDITION
,
Configuration.WARN_UNLIKELY_FUNCTION_VALUE
,
Configuration.WARN_XML_CLASS_HAS_CHANGED
public void enableAccessibility(boolean b)
Configuration
accessible
option of the mxmlc or compc compilers.
The default value is false
.
enableAccessibility
in interface Configuration
b
- Boolean value that enables or disables accessibility.public void enableDebugging(boolean b, String debugPassword)
Configuration
compiler.debug
and -debug-password=true|false
options
for the mxmlc or compc compilers.
The default value debug
is false
. The default debug password is "".
enableDebugging
in interface Configuration
b
- Boolean value that enables or disables debugging.debugPassword
- A password that is embedded in the application.public void enableStrictChecking(boolean b)
Configuration
compiler.strict
option of the mxmlc or compc compilers.
The default value is true
.
enableStrictChecking
in interface Configuration
b
- Boolean value.public void enableVerboseStacktraces(boolean b)
Configuration
compiler.verbose-stacktraces
option of the mxmlc or compc compilers.
The default value is false
.
enableVerboseStacktraces
in interface Configuration
b
- Boolean value.public void enableFlashType(boolean b)
Configuration
compiler.fonts.flash-type
option for the mxmlc or compc compilers.
The default value is true
.
enableFlashType
in interface Configuration
b
- Boolean value.public void enableAdvancedAntiAliasing(boolean b)
Configuration
compiler.fonts.advanced-anti-aliasing
option for the mxmlc or compc compilers.
The default value is true
.
enableAdvancedAntiAliasing
in interface Configuration
b
- Boolean value.public void removeUnusedRuntimeSharedLibraryPaths(boolean b)
Configuration
remove-unused-rsls
option of the mxmlc compiler.
The default value is false
.
removeUnusedRuntimeSharedLibraryPaths
in interface Configuration
b
- Boolean value that enables or disables the removal.public void includeLibraries(File[] libraries)
Configuration
compiler.include-libraries
option of the mxmlc and compc compilers.includeLibraries
in interface Configuration
libraries
- An array of File
objects. The File.isDirectory()
method should return
true
; or instances must represent SWC files.Configuration.setIncludes(String[])
,
Configuration.setExterns(File[])
,
Configuration.setExterns(String[])
,
Configuration.setExternalLibraryPath(File[])
public void keepAllTypeSelectors(boolean b)
Configuration
compiler.keep-all-type-selectors
option of the mxmlc or compc compilers.
The default value is false
.
keepAllTypeSelectors
in interface Configuration
b
- Boolean value.public void keepCompilerGeneratedActionScript(boolean b)
Configuration
compiler.keep-generated-actionscript
option of the
mxmlc and compc compilers.
The default value is false
.
keepCompilerGeneratedActionScript
in interface Configuration
b
- Boolean value.public void keepLinkReport(boolean b)
Configuration
Report.writeLinkReport()
method to retrieve the linker report.keepLinkReport
in interface Configuration
b
- Boolean value.public void keepSizeReport(boolean b)
Configuration
Report.writeSizeReport()
method to retrieve the linker report.keepSizeReport
in interface Configuration
b
- Boolean value.public void keepConfigurationReport(boolean b)
Configuration
Report.writeConfigurationReport()
method to retrieve the configuration report.keepConfigurationReport
in interface Configuration
b
- Boolean value.public void optimize(boolean b)
Configuration
compiler.optimize
option of the
mxmlc or compc compilers. Application sizes are usually smaller with this option enabled.
The default value is true
.
optimize
in interface Configuration
b
- Boolean value.public void compress(boolean b)
Configuration
compiler.compress
option of the
mxmlc or compc compilers. Application sizes are usually smaller with this option enabled.compress
in interface Configuration
b
- Boolean value.public void setActionScriptMetadata(String[] md)
Configuration
compiler.keep-actionscript-metadata
option of the mxmlc or compc compilers.
The default value is {Bindable, Managed, ChangeEvent, NonCommittingChangeEvent, Transient}
.
setActionScriptMetadata
in interface Configuration
md
- An array of ActionScript metadata names.public void setActionScriptFileEncoding(String encoding)
Configuration
actionscript-file-encoding
option of the mxmlc or compc compilers.
The default encoding is UTF-8
.
setActionScriptFileEncoding
in interface Configuration
encoding
- The character encoding; for example UTF-8
or Big5
.public void setComponentManifest(String namespaceURI, File manifest)
Configuration
compiler.namespaces.namespace
option of the mxmlc or compc compilers.setComponentManifest
in interface Configuration
namespaceURI
- A namespace URI.manifest
- A component manifest file (XML).public void setConfiguration(File file)
Configuration
flex-config.xml
file.
This is equivalent to using the load-config
option of the mxmlc or compc compilers.setConfiguration
in interface Configuration
file
- An instance of the java.io.File
class.public void setConfiguration(String[] args)
Configuration
mxmlc/compc
command-line arguments.setConfiguration
in interface Configuration
args
- mxmlc/compc
command-line argumentspublic void setContextRoot(String path)
Configuration
{context.root}
tokens for
service channel endpoints. This is equivalent to using the compiler.context-root
option
for the mxmlc or compc compilers.
By default, this value is undefined.
setContextRoot
in interface Configuration
path
- An instance of String.public void setDefaultBackgroundColor(int color)
Configuration
default-background-color
option of the mxmlc or compc compilers.
The default value is 0x869CA7
.
setDefaultBackgroundColor
in interface Configuration
color
- An RGB value.public void setDefaultCSS(File url)
Configuration
compiler.defaults-css-url
option of the mxmlc or compc compilers.setDefaultCSS
in interface Configuration
url
- An instance of java.io.File
.public void setDefaultFrameRate(int rate)
Configuration
default-frame-rate
option of the mxmlc or compc compilers.
The default value is 24
.
setDefaultFrameRate
in interface Configuration
rate
- Number of frames per second.public void setDefaultScriptLimits(int maxRecursionDepth, int maxExecutionTime)
Configuration
default-script-limits
option of the mxmlc or compc compilers.
The default maximum recursion depth is 1000
.
The default maximum execution time is 60
.
setDefaultScriptLimits
in interface Configuration
maxRecursionDepth
- Recursion depth.maxExecutionTime
- Execution time, in seconds.public void setDefaultSize(int width, int height)
Configuration
default-size
option of the mxmlc or compc compilers.
The default width is 500
.
The default height is 375
.
setDefaultSize
in interface Configuration
width
- The width of the application, in pixels.height
- The height of the application, in pixels.public void setExternalLibraryPath(File[] paths)
Configuration
compiler.external-library-path
option of the
mxmlc or compc compilers.setExternalLibraryPath
in interface Configuration
paths
- A list of paths. The File.isDirectory()
method should return
true
; File
instances should represent SWC files.public void setExterns(String[] definitions)
Configuration
externs
option of the mxmlc and compc compilers.setExterns
in interface Configuration
definitions
- An array of definitions (for example, classes, functions, variables, or namespaces).public void setExterns(File[] files)
Configuration
load-externs
option of the mxmlc or compc compilers.
This option is similar to the setExterns(String[])
method. The following is an example of
the file format:
<script> <!-- use 'dep', 'pre' or 'dep' to specify a definition to be omitted from linking. --> <def id="mx.skins:ProgrammaticSkin"/> <pre id="mx.core:IFlexDisplayObject"/> <dep id="String"/> </script>
setExterns
in interface Configuration
files
- An array of java.io.File
objects.Configuration.setExterns(String[])
public void setFontLanguageRange(String language, String range)
Configuration
compiler.fonts.languages.language-range
option
for the mxmlc or compc compilers.
For example:
setFontLanguageRange("englishRange", "U+0020-U+007E");
setFontLanguageRange
in interface Configuration
language
- Represents the language name.range
- Defines range of glyphs.public void setFontManagers(String[] classNames)
Configuration
flash.fonts.JREFontManager
.
This is equivalent to using the compiler.fonts.managers
option for the mxmlc or compc compilers.
For example:
setFontManagers("flash.fonts.BatikFontManager");
setFontManagers
in interface Configuration
classNames
- An array of Java class names.public void setFrameLabel(String label, String[] classNames)
Configuration
frames.frame
option of the mxmlc or compc compilers.setFrameLabel
in interface Configuration
label
- A string.classNames
- An array of class names.public void setIncludes(String[] definitions)
Configuration
includes
option of the mxmlc or compc compilers.setIncludes
in interface Configuration
definitions
- An array of definitions (for example, classes, functions, variables, or namespaces).public void setLibraryPath(File[] paths)
Configuration
compiler.library-path
option of the mxmlc or compc compilers.setLibraryPath
in interface Configuration
paths
- An array of File
objects. The File.isDirectory()
method should return
true
; instances must represent SWC files.public void setLicense(String productName, String serialNumber)
Configuration
licenses.license
option of the mxmlc or compc compilers.setLicense
in interface Configuration
productName
- A string representing the product name; for example "flexbuilder3".serialNumber
- A serial number.public void setLocalFontPaths(String[] paths)
Configuration
mxmlc/compc --compiler.fonts.local-font-paths
.setLocalFontPaths
in interface Configuration
paths
- an array of file paths.public void setLocalFontSnapshot(File file)
Configuration
flex2.tools.FontSnapshot
tool. This is equivalent to using the compiler.fonts.local-fonts-snapshot
option for the mxmlc or compc compilers.setLocalFontSnapshot
in interface Configuration
file
- Local font snapshot file.public void setLocale(String[] locales)
Configuration
{locale}
tokens that appear in some configuration values.
This is equivalent to using the compiler.locale
option of the mxmlc or compc compilers.
For example:
addSourcePath(new File[] { "locale/{locale}" }); setLocales(new String[] { "en_US" });
The compiler adds the locale/en_US
directory to the source path.
setLocale
in interface Configuration
locales
- An array of Strings specifying locales.public void setLocale(Locale locale)
Configuration
{locale}
tokens that appear in some configuration values.
This is equivalent to using the compiler.locale
option of the mxmlc or compc compilers
to set a single locale.
For example:
addSourcePath(new File[] { "locale/{locale}" }); setLocale(Locale.US);
The compiler adds the locale/en_US
directory to the source path.
setLocale
in interface Configuration
locale
- A java.util.Locale
.public void setMaximumCachedFonts(int size)
Configuration
compiler.fonts.max-cached-fonts
option for the
mxmlc or compc compilers.
The default value is 20.
setMaximumCachedFonts
in interface Configuration
size
- An integer representing the maximum number of embedded font faces.public void setMaximumGlyphsPerFace(int size)
Configuration
compiler.fonts.max-glyphs-per-face
option
for the mxmlc or compc compilers.
The default value is 1000.
setMaximumGlyphsPerFace
in interface Configuration
size
- An integer representing the maximum number of character glyph outlines to cache for each font face.public void setRuntimeSharedLibraries(String[] libraries)
Configuration
runtime-shared-libraries
option of the mxmlc or compc compilers.setRuntimeSharedLibraries
in interface Configuration
libraries
- An array of java.lang.String
objects.public void setSWFMetaData(int field, Object value)
Configuration
metadata.contributor metadata.creator metadata.date metadata.description metadata.language metadata.localized-description metadata.localized-title metadata.publisher metadata.title
The valid fields and types of value are specified below:
CONTRIBUTOR java.lang.String CREATOR java.lang.String DATE java.util.Date DESCRIPTION java.util.MapFor example:TITLE java.util.Map LANGUAGE java.lang.String PUBLISHER java.lang.String
Map titles = new HashMap(); titles.put("EN", "Adobe Flex 2 Application"); Map descriptions = new HashMap(); descriptions.put("EN", "http://www.adobe.com/products/flex"); setSWFMetaData(Configuration.LANGUAGE, "EN"); setSWFMetaData(Configuration.TITLE, titles); setSWFMetaData(Configuration.DESCRIPTION, descriptions);
setSWFMetaData
in interface Configuration
field
- One of: CONTRIBUTOR
, CREATOR
,
DATE
, DESCRIPTION
, TITLE
,
LANGUAGE
, or PUBLISHER
.value
- A String
, Date
, or
Map
object.Configuration.CONTRIBUTOR
,
Configuration.CREATOR
,
Configuration.DATE
,
Configuration.DESCRIPTION
,
Configuration.TITLE
,
Configuration.LANGUAGE
,
Configuration.PUBLISHER
public void setSWFMetaData(String xml)
Configuration
raw-metadata
option of the mxmlc or compc compilers.
This option overrides anything set by the setSWFMetaData()
method.setSWFMetaData
in interface Configuration
xml
- A well-formed XML fragment.Configuration.setSWFMetaData(int, Object)
public void setServiceConfiguration(File file)
Configuration
compiler.services
option of the mxmlc and compc compilers.setServiceConfiguration
in interface Configuration
file
- Instance of the File
class.public void setSourcePath(File[] paths)
Configuration
compiler.source-path
option of the mxmlc or compc compilers.setSourcePath
in interface Configuration
paths
- An array of java.io.File
objects. The File.isDirectory()
method
must return true
.public void setTheme(File[] files)
Configuration
compiler.theme
option of the mxmlc or compc compilers.setTheme
in interface Configuration
files
- An array of java.io.File
objects.public void setToken(String name, String value)
Configuration
mxmlc +flexlib=path1 +foo=bar -var=${foo}Where
var=bar
occurs after the substitution of ${foo}
.setToken
in interface Configuration
name
- The name of the token.value
- The value of the token.public void showActionScriptWarnings(boolean b)
Configuration
compiler.show-actionscript-warnings
option of the
mxmlc or compc compilers.
The default value is true
.
showActionScriptWarnings
in interface Configuration
b
- Boolean value.Configuration.checkActionScriptWarning(int, boolean)
public void showBindingWarnings(boolean b)
Configuration
compiler.show-binding-warnings
option of the mxmlc or compc compilers.
The default value is true
.
showBindingWarnings
in interface Configuration
b
- Boolean value.public void showDeprecationWarnings(boolean b)
Configuration
compiler.show-deprecation-warnings
option of the mxmlc or compc compilers.
The default value is true
.
showDeprecationWarnings
in interface Configuration
b
- Boolean value.public void showShadowedDeviceFontWarnings(boolean b)
Configuration
compiler.show-shadowed-device-font-warnings
option of the mxmlc or compc compilers.
The default value is true
.
showShadowedDeviceFontWarnings
in interface Configuration
b
- Boolean value.public void showUnusedTypeSelectorWarnings(boolean b)
Configuration
compiler.show-unused-type-selector-warnings
option of the mxmlc or compc
compilers.
The default value is true
.
showUnusedTypeSelectorWarnings
in interface Configuration
b
- Boolean value.public void useActionScript3(boolean b)
Configuration
compiler.as3
option of the mxmlc or compc compilers.
The default value is false
.
useActionScript3
in interface Configuration
b
- Boolean value that determines whether to use the AS3 class-based object model.public void useECMAScript(boolean b)
Configuration
compiler.es
option for the mxmlc or compc compilers.
The default value is false
.
useECMAScript
in interface Configuration
b
- Boolean value that enables or disables the use of the ECMAScript edition 3 prototype-based object model.public void useHeadlessServer(boolean b)
Configuration
compiler.headless-server
option of the mxmlc or compc compilers.useHeadlessServer
in interface Configuration
b
- Boolean value that determines if the compiler is running on a server without a display.public void useNetwork(boolean b)
Configuration
use-network
option of the mxmlc or compc compilers.
The default value is true
.
useNetwork
in interface Configuration
b
- Boolean value.public void useResourceBundleMetaData(boolean b)
Configuration
compiler.use-resource-bundle-metadata
option of the mxmlc or compc compilers.
The default value is true
.
useResourceBundleMetaData
in interface Configuration
b
- Boolean value.public void setTargetPlayer(int major, int minor, int revision)
Configuration
setTargetPlayer
in interface Configuration
major
- The major version. Must be greater than or equal to nine.minor
- The minor version. Must be greater than or equal to zero.revision
- The revsion must be greater than or equal to zero.public void setCompatibilityVersion(int major, int minor, int revision)
Configuration
setCompatibilityVersion
in interface Configuration
major
- The major version. For this release, this value must be 2.minor
- The minor version. For this release, this value must be 0.revision
- For this release, this value must be 1.public void enableDigestComputation(boolean compute)
Configuration
compiler.computDigest
in the compc
compiler.
The default value is true
enableDigestComputation
in interface Configuration
compute
- set to true
to create a digest for the compiled library.public void enableDigestVerification(boolean verify)
Configuration
verify-digests
option in the mxmlc compiler.
The default value is true
enableDigestVerification
in interface Configuration
verify
- set to true to verify
the digest of the loaded RSL matches the digest of the
expected RSL. Set to false to disable the checks during
the development process but it is highly recommend that
production applications be compiled with verify
set to true.public void addRuntimeSharedLibraryPath(String swc, String[] rslUrls, String[] policyFileUrls)
Configuration
runtime-shared-library-path
option when using the mxmlc compiler.addRuntimeSharedLibraryPath
in interface Configuration
swc
- path to the swc. The classes in the swc will be excluded from
the compiled application.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.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.Configuration.setRuntimeSharedLibraryPath(String, String[], String[])
public void setRuntimeSharedLibraryPath(String swc, String[] rslUrls, String[] policyFileUrls)
Configuration
addRuntimeSharedLibraryPath
method.
This is equivalent to the -runtime-shared-library-path
option of the mxmlc compiler.setRuntimeSharedLibraryPath
in interface Configuration
swc
- path to the swc. The classes in the swc will be excluded from
the compiled application.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.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.Configuration.addRuntimeSharedLibraryPath(String, String[], String[])
public void addDefineDirective(String name, String value)
Configuration
-define
option.addDefineDirective
in interface Configuration
name
- The qualified name of the configuration constant, e.g. "CONFIG::debugging" or "APP::version"value
- The value of the constant, e.g. "true" or "!CONFIG::release" or "3.0"Configuration.setDefineDirective(String[], String[])
public void setDefineDirective(String[] names, String[] values)
Configuration
setDefineDirective
in interface Configuration
names
- A list of qualified names/configuration constants, e.g. "CONFIG::debugging" or "APP::version"values
- A list of values of the constants, e.g. "true" or "!CONFIG::release" or "3.0"Configuration.addDefineDirective(String, String)
public void addExtensionLibraries(File extension, List<String> parameters)
addExtensionLibraries
in interface Configuration
public void setExtensionLibraries(Map<File,List<String>> extensions)
setExtensionLibraries
in interface Configuration
public void addForceRuntimeSharedLibraryPaths(File[] paths)
Configuration
runtime-shared-library-settings.force-rsls
option of the
mxmlc compiler.addForceRuntimeSharedLibraryPaths
in interface Configuration
paths
- An array of File
objects. Each File
instance should represent a SWC file. May not be null.#setForcedRuntimeSharedLibraryPaths(File[])
public void setForceRuntimeSharedLibraryPaths(File[] paths)
Configuration
removed-used-rsls
option.
This is equivalent to using the
runtime-shared-library-settings.force-rsls
option of the
mxmlc compiler.setForceRuntimeSharedLibraryPaths
in interface Configuration
paths
- An array of File
objects. Each File
instance should represent a SWC file. May not be null.public void setApplicationDomainForRuntimeSharedLibraryPath(File path, String applicationDomainTarget)
Configuration
runtime-shared-library-settings.application-domain
option of
the mxmlc compiler.setApplicationDomainForRuntimeSharedLibraryPath
in interface Configuration
path
- The File
instance represents a SWC file with RSL
linkage. The RSL associated with the SWC will have its
application domain modified as specified in the
applicationDomainTarget
parameter. Passing null
resets the application domain settings.applicationDomainTarget
- The application domain an RSL will be loaded
into. May only be null when the path
parameter is null.public void addApplicationDomainForRuntimeSharedLibraryPath(File path, String applicationDomainTarget)
Configuration
runtime-shared-library-settings.application-domain
option of
the mxmlc compiler.addApplicationDomainForRuntimeSharedLibraryPath
in interface Configuration
path
- The File
instance represents a SWC file with RSL
linkage. The RSL associated with the SWC will have its
application domain modified as specified in the
applicationDomainTarget
parameter. May not be
null.applicationDomainTarget
- The application domain an RSL will be
loaded into. May not be null.Configuration.setApplicationDomainForRuntimeSharedLibraryPath(File, String)
Copyright © 2016 The Apache Software Foundation. All rights reserved.