Media - Macromedia Flash Player

Media - Macromedia Flash Player

Allows users to play Flash animations using the Macromedia Flash player.

Component at design time

Drag and drop a
Media - Macromedia Flash Player component onto the page:

The
Media - Macromedia Flash Player component looks like this on the page:

Component at runtime

The
Media - Macromedia Flash Player component varies at runtime depending upon the content of the Flash file selected.

Properties and All Attributes views

The Properties view for a component shows the most common set of attributes you can set on a component, and, depending on the component, you might also see options for adding controls, actions, or other components. To open the Properties view, click

Window | Show View | Properties.

These common attributes for the Macromedia Flash Player component display on the hx:playerFlash, Parameter, and Accessibility tabs in the Properties view. See the Macromedia Flash Player attributes table for a complete list of attributes. Additional configuration options for specifying control parameters are on the hx:playerFlash>Parameter tab:
Table 1. Macromedia Flash Player configuration options

Configuration option

Description

Add the parameters that control the player

Specifies what parameters are used to control the media player component.

The All Attributes view shows a table of all the attributes you can set on a component, which includes those attributes you can access from the Properties view. To switch to the All Attributes view, click the
All Attributes icon in the upper right corner of the Properties view.

Table 2. All Macromedia Flash Player attributes

Attribute name

Represented in Properties view by

Description

accesskey

Accessibility>Access Key

Specifies a single keyboard key as an access key. Pressing the specified access key at runtime gives focus to this component. Pressing ALT plus the specified access key at runtime gives focus to this component (or executes the component if it is a kind of button).

align

Alignment

Specifies the alignment for the component:

left

center

right

relative

alt

Accessibility>Alternate Text

Specifies alternate text for a component. The alternative text is displayed when the element cannot be rendered normally, for example, in browsers that do not support forms and in browsers set to not display images.

archive

Not represented

An attribute associated with the object html tag used to render the Media Components, used to specify a space-separated list of URLs for archives containing resources relevant to the object.

autoStart

Autoplay

If autostart is set to true, the rich media file will start playing automatically in the component. Checking this will cause the component to start automatically at run time.

binding

Not represented

An expression that binds the component's instance (usually a user interface component) to a bean property (usually in the backing file).

border

Not represented

Specifies, in pixels, the size of the border for the player.

codebase

Not represented

Specifies the base path used to resolve relative URIs specified by other attributes in the component.

dir

Not represented

Specifies the component's direction when rendered at runtime. The values can be either:

ltr - left to right

rtl - right to left
If the direction is not specified, a direction appropriate to the encoding of the component is used.

height

Size: Height

Specifies the height of the component (by number of lines, pixels or percentage of the screen).

hspace

Not represented

Specifies the amount of white space in pixels to be inserted to the left and right of the component.

id

ID

Assigns a name to a component. Should be a unique name within a JSP.

lang

Not represented

The language of the component's value(s) and text content. If omitted, the language is inherited from the containing tags (notably the view. Specified as an ISO-standard language abbreviation code. For example, "en" for English, "en-US" for American English, "fr" for French, "de" for German.

Note: This does not "translate" the text in the component, rather, it identifies the language of the component so that operations such as searching, sorting, collating and the like are done correctly.

loop

Not represented

Specifies whether playback of the clip should continue or loop, indefinitely. Default is true.

menu

Not represented

Specifies the displayed menu type:

true - Displays the full menu, allowing the user a variety of options to enhance or control playback.

false - Displays a menu that contains only the Settings option and the About Flash option.

mimeType

Type

Used for declaring the media MIME type when src is bound to binary data.

playerAttributes

Not represented

For adding a list of additional player attributes/parameters, the list should be a comma separated list of name=value pairs.

quality

Options: Quality

Specifies playing quality:

low- Favors playback speed over appearance and never uses anti-aliasing.

autolow - Emphasizes speed at first but improves appearance whenever possible. Playback begins with anti-aliasing turned off. If the Flash Player detects that the processor can handle it, anti-aliasing is turned on.

autohigh - Emphasizes playback speed and appearance equally at first but sacrifices appearance for playback speed if necessary. Playback begins with anti-aliasing turned on. If the actual frame rate drops below the specified frame rate, anti-aliasing is turned off to improve playback speed. Use this setting to emulate the View > Antialias setting in Flash.

medium - Applies some anti-aliasing and does not smooth bitmaps. It produces a better quality than the Low setting, but lower quality than the High setting.

high - Favors appearance over playback speed and always applies anti-aliasing. If the movie does not contain animation, bitmaps are smoothed; if the movie has animation, bitmaps are not smoothed.

best - Provides the best display quality and does not consider playback speed. All output is anti-aliased and all bitmaps are smoothed.

rendered

Not represented

Can be set to true or false:

false - Component will not be rendered to the browser at runtime.

true - Component will get rendered. This is the default value.

salign

Not represented

Specifies alignment:

<default> - Centers the movie in the browser window and crops edges if the browser window is smaller than the movie.

left - Aligns the movie along the left edge of the browser window and crop the remaining three sides as needed.

right - Aligns the movie along the right edge of the browser window and crop the remaining three sides as needed.

top - Aligns the movie along the top edge of the browser window and crop the remaining three sides as needed.

bottom - Aligns the movie along the bottom edge of the browser window and crop the remaining three sides as needed.

scale

Not represented

Specifies scale:

showall - This is the default value; it makes the entire movie visible in the specified area without distortion, while maintaining the original aspect ratio of the movie.

noborder - Scales the movie to fill the specified area, without distortion but possibly with some cropping, while maintaining the original aspect ratio of the movie.

exactfit - Makes the entire movie visible in the specified area without trying to preserve the original aspect ratio. Distortion may occur.

src

File

Media file to be played. Specifies the file to be used by the component.

standby

Not represented

Specifies a message that a browser may render while loading the component's implementation and data.

style

Style: Props

Specifies CSS style information for the component (for example, style="font-size : 8pt ; color : red"). Defines the properties (such as font and color) of the selected component. This may be done manually, or by clicking the button and selecting the desired properties from within the window.

styleClass

Style: Classes

Space-separated list of CSS style classes to be applied when this element is rendered. This value must be passed through as the class attribute on generated markup. Defines the classes (such as style sheets) of the selected component. This may be done manually, or by clicking the button and selecting the desired Classes from within the window.

tabindex

Accessibility>Tab order index

Specifies the position of the component in the tabbing order in the JSP. This value must be a number between 0 and 32767.

title

Accessibility>Title

Specifies the title text, shown in browser as a tooltip at runtime. Used by a browser as the alternative text of a component if the alternative text is not specified.

vspace

Not represented

Specifies the amount of white space, in pixels, to be inserted to the top and bottom of the component.

width

Size: Width

Specifies the initial width of the component. The width is given in pixels except in the case of a text input component where its value refers to the number of characters.

wmode

Not represented

Specifies the window mode property of the Flash movie for transparency, layering, and positioning in the browser:

window - movie plays in its own rectangular window on a Web page.

opaque - the movie hides everything on the page behind it.

transparent - the background of the HTML page shows through all transparent portions of the movie. This option may slow animation performance.

Attribute name	Represented in Properties view by	Description
accesskey	Accessibility>Access Key	Specifies a single keyboard key as an access key. Pressing the specified access key at runtime gives focus to this component. Pressing ALT plus the specified access key at runtime gives focus to this component (or executes the component if it is a kind of button).
align	Alignment	Specifies the alignment for the component: left center right relative
alt	Accessibility>Alternate Text	Specifies alternate text for a component. The alternative text is displayed when the element cannot be rendered normally, for example, in browsers that do not support forms and in browsers set to not display images.
archive	Not represented	An attribute associated with the object html tag used to render the Media Components, used to specify a space-separated list of URLs for archives containing resources relevant to the object.
autoStart	Autoplay	If autostart is set to true, the rich media file will start playing automatically in the component. Checking this will cause the component to start automatically at run time.
binding	Not represented	An expression that binds the component's instance (usually a user interface component) to a bean property (usually in the backing file).
border	Not represented	Specifies, in pixels, the size of the border for the player.
codebase	Not represented	Specifies the base path used to resolve relative URIs specified by other attributes in the component.
dir	Not represented	Specifies the component's direction when rendered at runtime. The values can be either: ltr - left to right rtl - right to left If the direction is not specified, a direction appropriate to the encoding of the component is used.
height	Size: Height	Specifies the height of the component (by number of lines, pixels or percentage of the screen).
hspace	Not represented	Specifies the amount of white space in pixels to be inserted to the left and right of the component.
id	ID	Assigns a name to a component. Should be a unique name within a JSP.
lang	Not represented	The language of the component's value(s) and text content. If omitted, the language is inherited from the containing tags (notably the view. Specified as an ISO-standard language abbreviation code. For example, "en" for English, "en-US" for American English, "fr" for French, "de" for German. Note: This does not "translate" the text in the component, rather, it identifies the language of the component so that operations such as searching, sorting, collating and the like are done correctly.
loop	Not represented	Specifies whether playback of the clip should continue or loop, indefinitely. Default is true.
menu	Not represented	Specifies the displayed menu type: true - Displays the full menu, allowing the user a variety of options to enhance or control playback. false - Displays a menu that contains only the Settings option and the About Flash option.
mimeType	Type	Used for declaring the media MIME type when src is bound to binary data.
playerAttributes	Not represented	For adding a list of additional player attributes/parameters, the list should be a comma separated list of name=value pairs.
quality	Options: Quality	Specifies playing quality: low- Favors playback speed over appearance and never uses anti-aliasing. autolow - Emphasizes speed at first but improves appearance whenever possible. Playback begins with anti-aliasing turned off. If the Flash Player detects that the processor can handle it, anti-aliasing is turned on. autohigh - Emphasizes playback speed and appearance equally at first but sacrifices appearance for playback speed if necessary. Playback begins with anti-aliasing turned on. If the actual frame rate drops below the specified frame rate, anti-aliasing is turned off to improve playback speed. Use this setting to emulate the View > Antialias setting in Flash. medium - Applies some anti-aliasing and does not smooth bitmaps. It produces a better quality than the Low setting, but lower quality than the High setting. high - Favors appearance over playback speed and always applies anti-aliasing. If the movie does not contain animation, bitmaps are smoothed; if the movie has animation, bitmaps are not smoothed. best - Provides the best display quality and does not consider playback speed. All output is anti-aliased and all bitmaps are smoothed.
rendered	Not represented	Can be set to true or false: false - Component will not be rendered to the browser at runtime. true - Component will get rendered. This is the default value.
salign	Not represented	Specifies alignment: <default> - Centers the movie in the browser window and crops edges if the browser window is smaller than the movie. left - Aligns the movie along the left edge of the browser window and crop the remaining three sides as needed. right - Aligns the movie along the right edge of the browser window and crop the remaining three sides as needed. top - Aligns the movie along the top edge of the browser window and crop the remaining three sides as needed. bottom - Aligns the movie along the bottom edge of the browser window and crop the remaining three sides as needed.
scale	Not represented	Specifies scale: showall - This is the default value; it makes the entire movie visible in the specified area without distortion, while maintaining the original aspect ratio of the movie. noborder - Scales the movie to fill the specified area, without distortion but possibly with some cropping, while maintaining the original aspect ratio of the movie. exactfit - Makes the entire movie visible in the specified area without trying to preserve the original aspect ratio. Distortion may occur.
src	File	Media file to be played. Specifies the file to be used by the component.
standby	Not represented	Specifies a message that a browser may render while loading the component's implementation and data.
style	Style: Props	Specifies CSS style information for the component (for example, style="font-size : 8pt ; color : red"). Defines the properties (such as font and color) of the selected component. This may be done manually, or by clicking the button and selecting the desired properties from within the window.
styleClass	Style: Classes	Space-separated list of CSS style classes to be applied when this element is rendered. This value must be passed through as the class attribute on generated markup. Defines the classes (such as style sheets) of the selected component. This may be done manually, or by clicking the button and selecting the desired Classes from within the window.
tabindex	Accessibility>Tab order index	Specifies the position of the component in the tabbing order in the JSP. This value must be a number between 0 and 32767.
title	Accessibility>Title	Specifies the title text, shown in browser as a tooltip at runtime. Used by a browser as the alternative text of a component if the alternative text is not specified.
vspace	Not represented	Specifies the amount of white space, in pixels, to be inserted to the top and bottom of the component.
width	Size: Width	Specifies the initial width of the component. The width is given in pixels except in the case of a text input component where its value refers to the number of characters.
wmode	Not represented	Specifies the window mode property of the Flash movie for transparency, layering, and positioning in the browser: window - movie plays in its own rectangular window on a Web page. opaque - the movie hides everything on the page behind it. transparent - the background of the HTML page shows through all transparent portions of the movie. This option may slow animation performance.