MenuDataProvider.addMenuItemAt()

Availability

Flash Player 6 (6.0.79.0).

Edition

Flash MX Professional 2004.

Usage

Usage 1:

myMenuDataProvider.addMenuItemAt(index, initObject)

Usage 2:

myMenuDataProvider.addMenuItemAt(index, childMenuItem)

Parameters

index An integer.

initObject An object containing the specific attributes that initialize a Menu item's attributes. For more information, see About menu item XML attributes.

childMenuItem An XML node.

Returns

A reference to the added XML node.

Description

Method; Usage 1 adds a child item at the specified index position in the parent menu item (which could be the menu itself). The menu item is constructed from the values passed in the initObject parameter. Usage 2 adds a child item that is defined in the specified XML childMenuItem parameter to the specified index of a parent menu item.

Any node or menu item in a MenuDataProvider instance can call the methods of the MenuDataProvider class.

Example

The following example creates a menu with one menu item and then calls the addMenuItemAt() method to add a second item.

You first drag a Menu component to the library and then add the following code to Frame 1:

/**
 Requires:
  - Menu component in library
*/

import mx.controls.Menu;

// Create an XML object to act as a factory.
var my_xml:XML = new XML();

// The item created next does not appear in the menu.
// The createMenu() method call (below) expects to
// receive a root element whose children will become
// the items. This is just a simple way to create that
// root element and give it a convenient name.
var menuDP_obj:Object = my_xml.addMenuItem("XXXXX");

// Add the menu items.
menuDP_obj.addMenuItem({label:"Edit"});

// Create the Menu object.
var my_menu:Menu = Menu.createMenu(this, menuDP_obj);

// Show and position the menu.
my_menu.show(100, 20);

// Add the menu item.
menuDP_obj.addMenuItemAt(1, {label:"Save", instanceName:"saveItem1"});