Flash CS3 Documentation

ActionScript 2.0 Components Language Reference > Menu component > MenuDataProvider class

MenuDataProvider class

ActionScript Class Name mx.controls.menuclasses.MenuDataProvider

The MenuDataProvider class is a decorator (mix-in) class that adds functionality to the XMLNode global class. This functionality lets XML instances assigned to a Menu.dataProvider property use the MenuDataProvider methods and properties to manipulate their own data as well as the associated menu views.

NOTE

The MenuDataProvider class is supported only if you are working in a document that specifies ActionScript 2.0 in its Publish Settings.

Keep in mind these concepts about the MenuDataProvider class:

MenuDataProvider is a decorator (mix-in) class. You do not need to instantiate it to use it.
Menus natively accept XML as a dataProvider property value.
If a Menu class is instantiated, all XML instances in the SWF file are decorated by the MenuDataProvider class.
Only MenuDataProvider methods broadcast events to the Menu components. You can still use native XML methods, but they do not broadcast events that refresh the Menu views. To control the data model, use MenuDataProvider methods. For read-only operations like moving through the Menu hierarchy, use XML methods.
All items in the Menu component are XML objects decorated with the MenuDataProvider class.
Changes to item attributes are not reflected in the onscreen menu until redrawing occurs.

Method summary for the MenuDataProvider class

The following table lists the methods of the MenuDataProvider class.

Method	Description
MenuDataProvider.addMenuItem()	Adds a child item.
MenuDataProvider.addMenuItemAt()	Adds a child item at a specified location.
MenuDataProvider.getMenuItemAt()	Gets a reference to a menu item at a specified location.
MenuDataProvider.indexOf()	Returns the index of a specified menu item.
MenuDataProvider.removeMenuItem()	Removes a menu item.
MenuDataProvider.removeMenuItemAt()	Removes a menu item at a specified location.

Flash CS3