METHODS

addIcon

Availability

Flash Player 6.

Description

Adds an icon identifier (and possible data string) to the icon list.

Arguments

addIcon(String)
addIcon([String, String])
addIcon({identifier:String, data:String})

Example

menu_ib.addIcon("icon1");
menu_ib.addIcon(["icon1", "http://www.27Bobs.com"]);
menu_ib.addIcon({identifier:"icon1", data:"http://www.27Bobs.com"});

enableRightClick

Availability

Flash Player 7.

Description

Enables the user to set the layout of the icon bar from a right-click context menu (MX 2004 only).

An additional parameter may be passed as well to limit the options in the menu. Acceptable values are "HT", "HB", "VR" and "VL" for horizontal top, horizontal bottom, vertical right and vertical left, respectively.

Arguments

enableRightClick(Boolean)
enableRightClick(Boolean, [String(s)])

Example

menu_ib.enableRightClick(true);
menu_ib.enableRightClick(true, ["HB", "HR"]);

getIcon

Availability

Flash Player 6.

Description

Returns a reference to the movie clip instance used as an icon in the menu at the index position specified.

Arguments

getIcon(Number)

Example

menu_ib.getIcon(1).gotoAndPlay("clicked");

refresh

Availability

Flash Player 6.

Description

Redraws icon bar once changes have been made to its parameters.

Arguments

none

Example

menu_ib.refresh();

setBuffer

Availability

Flash Player 6.

Description

Sets the pixel distance between icons.

Arguments

setBuffer(Number)

Example

menu_ib.setBuffer(5);

setClickHandler

Availability

Flash Player 6.

Description

Sets the function to be called when an icon is clicked. If only one parameter is passed, the function is looked for on the icon bar parent's timeline. The second parameter allows the user to specify the timeline of the function.

Arguments

setClickHandler(String)
setClickHandler(String, MovieClip)

Example

menu_ib.setClickHandler("openWindow");
menu_ib.setClickHandler("openWindow", _root);

setFallOff

Availability

Flash Player 6.

Description

Sets the pixel range within which the icons are affected by the mouse position.

Arguments

setFallOff(Number)

Example

menu_ib.setFallOff(50);

setIcons

Availability

Flash Player 6.

Description

Sets the icons that the iconbarMenu instance will display. This overwrites any previous icons set (to add icons instead of replacing them wholly, see addIcon()).

Arguments

setIcons(Array)

Example

menu_ib.setIcons(["icon0", "icon1", "icon2", "icon3"]);

setLayout

Availability

Flash Player 6.

Description

Sets the layout of the icon bar on the interface. Acceptable values are "horizontal bottom center", "horizontal bottom left", "horizontal bottom right", "horizontal top center", "horizontal top left", "horizontal top right", "vertical left middle", "vertical left top", "vertical left bottom", "vertical right middle", "vertical right top" and "vertical right bottom".

Arguments

setLayout(String)

Example

menu_ib.setLayout("vertical left middle");

setMagnification

Availability

Flash Player 6.

Description

Sets scale factor for an icon when rolled over.

Arguments

setMagnification(Number)

Example

menu_ib.setMagnification(10);

setMinSize

Availability

Flash Player 6.

Description

Sets default size of the icons when the mouse is not over.

Arguments

setMinSize(Number)

Example

menu_ib.setMinSize(15);

setRollOverHandler

Availability

Flash Player 6.

Description

Sets the function to be called when an icon is first rolled over. If only one parameter is passed, the function is looked for on the icon bar parent's timeline. The second parameter allows the user to specify the timeline of the function.

Arguments

setRollOverHandler(String)
setRollOverHandler(String, MovieClip)

Example

menu_ib.setRollOverHandler("showTooltip");
menu_ib.setRollOverHandler("showTooltip", _root);

setRollOverCursor

Availability

Flash Player 6.

Description

Enables the default hand cursor when the user rolls over an icon.

Arguments

setRollOverCursor(Boolean)

Example

menu_ib.setRollOverCursor(true);

setTweenRate

Availability

Flash Player 6.

Description

Sets the rate at which the icons are tweened into position. Higher numbers translate into longer tweens.

Arguments

setTweenRate(Number)

Example

menu_ib.setTweenRate(3);