Specifications

CHAPTER 9
192
The following table describes the supported attributes of the html-wrapper task:
Attribute Description
application
The name of the SWF object in the HTML wrapper. You use this name to refer to the SWF object in JavaScript
or when using the ExternalInterface API. This value should not contain any spaces or special characters. This
attribute sets the value of the
<embed> tag's name attribute and the <object> tag's id attribute.
bgcolor
Specifies the background color of the application. Use this property to override the background color
setting specified in the SWF file. This property does not affect the background color of the HTML page. This
attribute sets the value of the
<embed> tag's bgcolor attribute and the <object> tag's bgcolor param-
eter. The default value is white.
file
Sets the file name of the HTML output file. The default value is "index.html".
height
Defines the height, in pixels, of the SWF file. Adobe® Flash® Player makes a best guess to determine the
height of the application if none is provided. This attribute sets the value of the
<embed> tag's height
attribute and the
<object> tag's height attribute. The default value is 400.
history
Set to true to include deep linking support (also referred to as history management) in the HTML wrapper.
Set to
false to exclude deep linking from the wrapper. Use this attribute in combination with the
template attribute to determine which template is used. The default value is false. For more information
on deep linking, see
“Deep Linking” on page 1065 in Adobe Flex 3 Developer Guide.
output
Sets the directory that Ant writes the generated files to.
swf
Sets the name of the SWF file that the HTML wrapper embeds (for example, Main). Do not include the *.swf
extension; the extension is appended to the name for you. This attribute sets the value of the
<embed> tag's
src attribute and the <object> tag's movie parameter. This SWF file does not have to exist when you
generate the HTML wrapper. It is used by the
<object> and <embed> tags to point to the location of the
SWF file at deployment time.
template
The type of template to output. The value of this attribute must be one of the following:
• client-side-detection
• express-installation
• no-player-detection
Use this attribute in combination with the history attribute to determine which template is used. The
default value is
express-installation.
title
Sets the value of the <title> tag in the head of the HTML page. The default value is Flex Application.
version-major
Sets the value of the requiredMajorVersion global JavaScript variable in the HTML wrapper. The default
value is 9. The value of this attribute only matters if you include version detection in your wrapper by setting
the
template attribute to express-installation or client-side-detection.
version-minor
Sets the value of the requiredMinorVersion global JavaScript variable in the HTML wrapper. The default
value is 0. The value of this attribute only matters if you include version detection in your wrapper by setting
the
template attribute to express-installation or client-side-detection.