ITargetSettings (Apache Flex - FlexJS: Compiler: Parent 0.8.0-SNAPSHOT API)

All Known Implementing Classes:

TargetSettings, TargetSettingsProxy
```
public interface ITargetSettings
```
The settings used to compile a target.

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`areDefaultScriptLimitsSet()` Returns if the default script limits have been set.
`boolean`	`areVerboseStacktracesEnabled()` Returns true if the target is capable of verbose stack traces.
`boolean`	`getAllowSubclassOverrides()`
`Collection<String>`	`getASMetadataNames()` The names of ActionScript metadata that will be preserved in the target.
`int`	`getDefaultBackgroundColor()` Returns the default background color.
`File`	`getDefaultCSS()` Returns the location of the default CSS file.
`int`	`getDefaultFrameRate()` Returns the default frame rate.
`int`	`getDefaultHeight()` Returns the default height.
`int`	`getDefaultScriptRecursionLimit()` Returns the default script recursion limit.
`int`	`getDefaultScriptTimeLimit()` Returns the default script time limit.
`List<String>`	`getDefaultsCSSFiles()`
`int`	`getDefaultWidth()` Returns the default width.
`Collection<File>`	`getExternalLibraryPath()` Returns a collection of libraries whose classes are not be linked into the target.
`Collection<String>`	`getExterns()` Returns a list of fully qualified class names that should not be linked into the target.
`String`	`getFlexMinimumSupportedVersion()` Used when creating a library.
`List<FrameInfo>`	`getFrameLabels()` A `List` of `FrameInfo` objects that describe extra frames of a SWF.
`Collection<String>`	`getIncludeClasses()` Returns a collection of fully-qualified class names that are included in the target library.
`Map<String,File>`	`getIncludeFiles()` Returns a collection of files that are included in the target library.
`Collection<File>`	`getIncludeLibraries()` Returns a collection of libraries whose classes are linked into the target.
`Collection<String>`	`getIncludeNamespaces()` Returns a collection of namespaces that are included in the target library.
`Collection<String>`	`getIncludeResourceBundles()` Returns a collection of resource bundle names that are included in the target library.
`Collection<String>`	`getIncludes()` Returns a list of fully qualified class names that should be linked into the target regardless of whether they are required by the target or not.
`Collection<File>`	`getIncludeSources()` Returns a collection of sources that are included in the target library.
`Map<String,File>`	`getIncludeStyleSheets()` Returns a map of style sheet names and files that are included in the target library.
`File`	`getLinkReport()` Returns the file that specifies where the link report should be written.
`boolean`	`getMxmlChildrenAsData()`
`String[]`	`getMxmlImplicitImports()` Gets the implicit imports for MXML.
`File`	`getOutput()` Returns the file that specifies where the target should be created.
`String`	`getPreloaderClassName()` Returns the preloader class name
`boolean`	`getRemoveDeadCode()`
`String`	`getRootClassName()` Returns the root class name for the application SWF.
`String`	`getRootSourceFileName()` Returns the absolute file name of the source file that defines the root class.
`List<String>`	`getRuntimeSharedLibraries()` A list of URLs pointing to RSLs to load.
`List<RSLSettings>`	`getRuntimeSharedLibraryPath()` A list of RSLs to load, complete with all the settings on how to load the RSLs.
`File`	`getSizeReport()` Returns the file that specifies where the size report should be written.
`String`	`getSWFMetadata()` Get the Metadata text.
`int`	`getSWFVersion()` Return the SWF version
`List<File>`	`getThemes()` Returns a list of CSS and SWC files to apply as a theme.
`boolean`	`isAccessible()` Returns true if the target file is accessible.
`boolean`	`isDebugEnabled()` Returns true if the target file has debugging instructions included.
`boolean`	`isIncludeLookupOnlyEnabled()` Returns true if only manifest entries with lookupOnly=true are included in the SWC catalog, false otherwise.
`boolean`	`isLinkageExternal(String path)` Determine is a library has external linkage.
`boolean`	`isOptimized()` Returns true if the target should be optimized.
`boolean`	`isTelemetryEnabled()` Returns true if the target file has advanced telemetry enabled.
`boolean`	`keepAllTypeSelectors()` Returns true if the compiler has disabled the pruning of unused type selectors.
`boolean`	`removeUnusedRuntimeSharedLibraryPaths()` Returns true if RSLs that have no classes used by the application are not loaded at runtime.
`boolean`	`useCompression()` Returns true if the target should be output using compression.
`boolean`	`useDirectBlit()` Returns whether the application SWF is flagged for direct blit use.
`boolean`	`useGPU()` Returns whether the application SWF is flagged for GPU use.
`boolean`	`useNetwork()` Returns whether the application SWF is flagged for access to network resources.
`boolean`	`useResourceBundleMetadata()` Returns true if resource bundle metadata should be processed.
`boolean`	`verifyDigests()` Returns the default setting for all RSLs as to whether an RSL's digest should be verified after the RSL is loaded.

- Method Detail
  - isAccessible
```
boolean isAccessible()
```
    Returns true if the target file is accessible.
    
    Returns:
    true if the target file is accessible, false otherwise.
  - isDebugEnabled
```
boolean isDebugEnabled()
```
    Returns true if the target file has debugging instructions included.
    
    Returns:
    true if the target file has debugging instructions included, false otherwise.
  - isTelemetryEnabled
```
boolean isTelemetryEnabled()
```
    Returns true if the target file has advanced telemetry enabled.
    
    Returns:
    true if the target file has advanced telemetry enabled, false otherwise.
  - isOptimized
```
boolean isOptimized()
```
    Returns true if the target should be optimized.
    
    Returns:
    true if the target should be optimized, false otherwise.
  - useCompression
```
boolean useCompression()
```
    Returns true if the target should be output using compression.
    
    Returns:
    true if the target should be output using compression, false otherwise.
  - areVerboseStacktracesEnabled
```
boolean areVerboseStacktracesEnabled()
```
    Returns true if the target is capable of verbose stack traces.
    
    Returns:
    true if the target is capable of verbose stack traces, false otherwise.
  - getASMetadataNames
```
Collection<String> getASMetadataNames()
```
    The names of ActionScript metadata that will be preserved in the target. If the target is a SWC, the metadata names to preserve will be recorded in the SWC's catalog. When the SWC is later linked into a target the metadata names will be appended to the list of metadata names preserved in the target.
    
    Returns:
    the list of names of ActionScript metadata that will be preserved in the target. If null, all metadata is preserved.
  - getDefaultCSS
```
File getDefaultCSS()
```
    Returns the location of the default CSS file.
    
    Returns:
    an instance of java.io.File.
  - getDefaultsCSSFiles
```
List<String> getDefaultsCSSFiles()
```
    Returns:
    Normalized paths in defaults-css-files configuration option.
  - getDefaultBackgroundColor
```
int getDefaultBackgroundColor()
```
    Returns the default background color.
    
    Returns:
    the default background color.
  - getDefaultFrameRate
```
int getDefaultFrameRate()
```
    Returns the default frame rate.
    
    Returns:
    the default frame rate in frames per second.
  - areDefaultScriptLimitsSet
```
boolean areDefaultScriptLimitsSet()
```
    Returns if the default script limits have been set.
    
    Returns:
    true if limits set, false otherwise.
  - getDefaultScriptTimeLimit
```
int getDefaultScriptTimeLimit()
```
    Returns the default script time limit.
    
    Returns:
    the default script time limit in seconds.
  - getDefaultScriptRecursionLimit
```
int getDefaultScriptRecursionLimit()
```
    Returns the default script recursion limit.
    
    Returns:
    the default script recursion limit.
  - getDefaultWidth
```
int getDefaultWidth()
```
    Returns the default width.
    
    Returns:
    the default width in pixels.
  - getDefaultHeight
```
int getDefaultHeight()
```
    Returns the default height.
    
    Returns:
    the default height in pixels.
  - getExterns
```
Collection<String> getExterns()
```
    Returns a list of fully qualified class names that should not be linked into the target.
    
    Returns:
    a list of fully qualified class names that should not be linked into the target.
  - getIncludes
```
Collection<String> getIncludes()
```
    Returns a list of fully qualified class names that should be linked into the target regardless of whether they are required by the target or not.
    
    Returns:
    a list of fully qualified class names that should be linked into the target.
  - getFrameLabels
```
List<FrameInfo> getFrameLabels()
```
    A List of FrameInfo objects that describe extra frames of a SWF. Each frame label has a list of class names that will be linked onto the frame.
    
    Returns:
    A collection of FrameInfo objects in SWF order.
  - getSWFMetadata
```
String getSWFMetadata()
```
    Get the Metadata text. This is a Metadata property.
    The Metadata tag is an optional tag to describe the SWF file to an external process. The tag embeds XML metadata in the SWF file so that, for example, a search engine can locate this tag, access a title for the SWF file, and display that title in search results.
    
    Returns:
    metadata XML text; null if Metadata tag doesn't exit.
  - getSWFVersion
```
int getSWFVersion()
```
    Return the SWF version
    
    Returns:
    SWF version
  - getPreloaderClassName
```
String getPreloaderClassName()
```
    Returns the preloader class name
    
    Returns:
    preloader class name
  - getRootSourceFileName
```
String getRootSourceFileName()
```
    Returns the absolute file name of the source file that defines the root class. If ITargets using this ITargetSettings do not build SWFs ( they could build SWCs instead ), then this method will return null.
    
    Returns:
    absolute file name of the source file that defines the root class, or null if this ITargetSettings is not for building SWFs.
  - getRootClassName
```
String getRootClassName()
```
    Returns the root class name for the application SWF. If ITargets using this ITargetSettings do not build SWFs ( they could build SWCs instead ), then this method will return null.
    
    Returns:
    rootClassName of the application SWF, or null if this ITargetSettings is not for building SWFs.
  - keepAllTypeSelectors
```
boolean keepAllTypeSelectors()
```
    Returns true if the compiler has disabled the pruning of unused type selectors.
    
    Returns:
    true if the compiler has disabled the pruning of unused type selectors, false otherwise.
  - useNetwork
```
boolean useNetwork()
```
    Returns whether the application SWF is flagged for access to network resources.
    
    Returns:
    true if the application SWF is flagged for access to network resources, false otherwise.
  - getThemes
```
List<File> getThemes()
```
    Returns a list of CSS and SWC files to apply as a theme.
    
    Returns:
    a list of CSS and SWC files to apply as a theme.
  - removeUnusedRuntimeSharedLibraryPaths
```
boolean removeUnusedRuntimeSharedLibraryPaths()
```
    Returns true if RSLs that have no classes used by the application are not loaded at runtime.
    
    Returns:
    true if RSLs that have no classes used by the application are not loaded at runtime, false otherwise.
  - verifyDigests
```
boolean verifyDigests()
```
    Returns the default setting for all RSLs as to whether an RSL's digest should be verified after the RSL is loaded. This setting may be overridden by setting the verify digest flag on an individual RSL. This is equivalent to using the verify-digests option in the mxmlc compiler.
    
    See Also:
    RSLSettings
  - getExternalLibraryPath
```
Collection<File> getExternalLibraryPath()
```
    Returns a collection of libraries whose classes are not be linked into the target.
    
    Returns:
    a collection of libraries whose classes are not be linked into the target.
  - getIncludeLibraries
```
Collection<File> getIncludeLibraries()
```
    Returns a collection of libraries whose classes are linked into the target. All the of classes in each library are linked into the application regardless of whether the classes is referenced by the target.
    
    Returns:
    a collection of libraries whose classes will be linked into the target.
  - getRuntimeSharedLibraries
```
List<String> getRuntimeSharedLibraries()
```
    A list of URLs pointing to RSLs to load. The RSLs will be loaded in the order that they appear in the list. This is equivalent to using the runtime-shared-libraries option in the mxmlc compiler. These RSLs are available to support legacy applications. For the latest RSL support see getRuntimeSharedLibraryPath.
    
    Returns:
    A list of URLs pointing to RSLs to load.
  - getRuntimeSharedLibraryPath
```
List<RSLSettings> getRuntimeSharedLibraryPath()
```
    A list of RSLs to load, complete with all the settings on how to load the RSLs. The RSLs will be loaded in the order that they appear in the list. This is the complete list of RSLs that could possibly be loaded. This list could be reduced if unused RSLs are being removed. This is equivalent to using the runtime-shared-library-path option in the mxmlc compiler.
    
    Returns:
    A list of RSLs to load.
  - useResourceBundleMetadata
```
boolean useResourceBundleMetadata()
```
    Returns true if resource bundle metadata should be processed.
    
    Returns:
    true if resource bundle metadata should be processed, false otherwise.
  - getOutput
```
File getOutput()
```
    Returns the file that specifies where the target should be created.
    
    Returns:
    the file that specifies where the target should be created.
  - getLinkReport
```
File getLinkReport()
```
    Returns the file that specifies where the link report should be written.
    
    Returns:
    the file that specifies where the link report should be written or null if the link report was not requested.
  - getSizeReport
```
File getSizeReport()
```
    Returns the file that specifies where the size report should be written.
    
    Returns:
    the file that specifies where the size report should be written or null if the size report was not requested.
  - getIncludeClasses
```
Collection<String> getIncludeClasses()
```
    Returns a collection of fully-qualified class names that are included in the target library.
    
    Returns:
    a collection of fully-qualified class names that are included in the target library.
  - getIncludeSources
```
Collection<File> getIncludeSources()
```
    Returns a collection of sources that are included in the target library.
    
    Returns:
    a collection of sources that are included in the target library.
  - getIncludeFiles
```
Map<String,File> getIncludeFiles()
```
    Returns a collection of files that are included in the target library. Each entry in the map is a file to be included. The key is the name of the file in the target library. The value is the file to be included in the library.
    
    Returns:
    a collection of files that are included in the target library.
  - getIncludeNamespaces
```
Collection<String> getIncludeNamespaces()
```
    Returns a collection of namespaces that are included in the target library.
    
    Returns:
    a collection of namespaces that are included in the target library.
  - getIncludeResourceBundles
```
Collection<String> getIncludeResourceBundles()
```
    Returns a collection of resource bundle names that are included in the target library.
    
    Returns:
    a collection of resource bundle names that are included in the target library.
  - getIncludeStyleSheets
```
Map<String,File> getIncludeStyleSheets()
```
    Returns a map of style sheet names and files that are included in the target library. The map's key/value pairs are as follows: key: the name of the file in the target library value: the included style sheet.
    
    Returns:
    a collection of style sheet names and files that are included in the target library.
  - isIncludeLookupOnlyEnabled
```
boolean isIncludeLookupOnlyEnabled()
```
    Returns true if only manifest entries with lookupOnly=true are included in the SWC catalog, false otherwise.
    
    Returns:
    true if only manifest entries with lookupOnly=true are included in the SWC catalog, false otherwise.
  - isLinkageExternal
```
boolean isLinkageExternal(String path)
```
    Determine is a library has external linkage. A library with external linkage will have none of its classes appear in the target. Two exceptions to this rule are classes on the -include-classes option and classes that are linked into frames preceding the last frame of SWF.
    
    Parameters:
    path - the absolute path of a library.
    
    Returns:
    true if the library has external linkage.
  - useDirectBlit
```
boolean useDirectBlit()
```
    Returns whether the application SWF is flagged for direct blit use.
    
    Returns:
    true if the application SWF should use direct blit, false otherwise.
  - useGPU
```
boolean useGPU()
```
    Returns whether the application SWF is flagged for GPU use.
    
    Returns:
    true if the application SWF should use the GPU, false otherwise.
  - getFlexMinimumSupportedVersion
```
String getFlexMinimumSupportedVersion()
```
    Used when creating a library. Specifies the minimum version of Flex that is written into the catalog of the created library. Flex uses the minimum version when compiling an application to filter out libraries that have a minimum version that is greater than the specified compatibility version.
    
    Returns:
    the minimum supported version of Flex.
  - getMxmlChildrenAsData
```
boolean getMxmlChildrenAsData()
```
    Returns:
    true if MXML child nodes are encoded into a data stream instead of a bunch of functions.
  - getAllowSubclassOverrides
```
boolean getAllowSubclassOverrides()
```
    Returns:
    true if the return type of an override can be a subclass instead of an exact match as the base class' return type
  - getRemoveDeadCode
```
boolean getRemoveDeadCode()
```
    Returns:
    true if the dead code filtering optimization step is enabled.
  - getMxmlImplicitImports
```
String[] getMxmlImplicitImports()
```
    Gets the implicit imports for MXML.
    
    Returns:
    An array of strings specifying the import targets.

Interface ITargetSettings

Method Summary

Method Detail

isAccessible

isDebugEnabled

isTelemetryEnabled

isOptimized

useCompression

areVerboseStacktracesEnabled

getASMetadataNames

getDefaultCSS

getDefaultsCSSFiles

getDefaultBackgroundColor

getDefaultFrameRate

areDefaultScriptLimitsSet

getDefaultScriptTimeLimit

getDefaultScriptRecursionLimit

getDefaultWidth

getDefaultHeight

getExterns

getIncludes

getFrameLabels

getSWFMetadata

getSWFVersion

getPreloaderClassName

getRootSourceFileName

getRootClassName

keepAllTypeSelectors

useNetwork

getThemes

removeUnusedRuntimeSharedLibraryPaths

verifyDigests

getExternalLibraryPath

getIncludeLibraries

getRuntimeSharedLibraries

getRuntimeSharedLibraryPath

useResourceBundleMetadata

getOutput

getLinkReport

getSizeReport

getIncludeClasses

getIncludeSources

getIncludeFiles

getIncludeNamespaces

getIncludeResourceBundles

getIncludeStyleSheets

isIncludeLookupOnlyEnabled

isLinkageExternal

useDirectBlit

useGPU

getFlexMinimumSupportedVersion

getMxmlChildrenAsData

getAllowSubclassOverrides

getRemoveDeadCode

getMxmlImplicitImports