Menu class

Inheritance MovieClip > UIObject class > UIComponent class > View > ScrollView > ScrollSelectList > Menu

ActionScript Class Name mx.controls.Menu

The methods and properties of the Menu class let you create and edit menus at runtime.

Setting a property of the menu class with ActionScript overrides the parameter of the same name set in the Property inspector or Component inspector.

Each component class has a version property, which is a class property. Class properties are available only on the class itself. The version property returns a string that indicates the version of the component. To access this property, use the following code:

trace(mx.controls.Menu.version);

NOTE

The code trace(myMenuInstance.version); returns undefined.

Method summary for the Menu class

The following table lists methods of the Menu class.

Method	Description
Menu.addMenuItem()	Adds a menu item to the menu.
Menu.addMenuItemAt()	Adds a menu item to the menu at a specific location.
Menu.createMenu()	Creates an instance of the Menu class. This is a static method.
Menu.getMenuItemAt()	Gets a reference to a menu item at a specified location.
Menu.hide()	Closes a menu.
Menu.indexOf()	Returns the index of a given menu item.
Menu.removeAll()	Removes all items from a menu.
Menu.removeMenuItem()	Removes the specified menu item.
Menu.removeMenuItemAt()	Removes a menu item from a menu at a specified location.
Menu.setMenuItemEnabled()	Indicates whether a menu item is enabled (`true`) or not (`false`).
Menu.setMenuItemSelected()	Indicates whether a menu item is selected (`true`) or not (`false`).
Menu.show()	Opens a menu at a specific location or at its previous location.

Methods inherited from the UIObject class

The following table lists the methods the Menu class inherits from the UIObject class. When calling these methods from the Menu object, use the form MenuInstance.methodName.

Method	Description
UIObject.createClassObject()	Creates an object on the specified class.
UIObject.createObject()	Creates a subobject on an object.
UIObject.destroyObject()	Destroys a component instance.
UIObject.doLater()	Calls a function when parameters have been set in the Property and Component inspectors.
UIObject.getStyle()	Gets the style property from the style declaration or object.
UIObject.invalidate()	Marks the object so it is redrawn on the next frame interval.
UIObject.move()	Moves the object to the requested position.
UIObject.redraw()	Forces validation of the object so it is drawn in the current frame.
UIObject.setSize()	Resizes the object to the requested size.
UIObject.setSkin()	Sets a skin in the object.
UIObject.setStyle()	Sets the style property on the style declaration or object.

Methods inherited from the UIComponent class

The following table lists the methods the Menu class inherits from the UIComponent class. When calling these methods from the Menu object, use the form MenuInstance.methodName.

Method	Description
UIComponent.getFocus()	Returns a reference to the object that has focus.
UIComponent.setFocus()	Sets focus to the component instance.

Property summary for the Menu class

The following table lists the property of the Menu class.

Property	Description
Menu.dataProvider	The data source for a menu.

Properties inherited from the UIObject class

The following table lists the properties the Menu class inherits from the UIObject class. When accessing these properties from the Menu object, use the form MenuInstance.propertyName.

Property	Description
UIObject.bottom	The position of the bottom edge of the object, relative to the bottom edge of its parent. Read-only.
UIObject.height	The height of the object, in pixels. Read-only.
UIObject.left	The left edge of the object, in pixels. Read-only.
UIObject.right	The position of the right edge of the object, relative to the right edge of its parent. Read-only.
UIObject.scaleX	A number indicating the scaling factor in the x direction of the object, relative to its parent.
UIObject.scaleY	A number indicating the scaling factor in the y direction of the object, relative to its parent.
UIObject.top	The position of the top edge of the object, relative to its parent. Read-only.
UIObject.visible	A Boolean value indicating whether the object is visible (`true`) or not (`false`).
UIObject.width	The width of the object, in pixels. Read-only.
UIObject.x	The left edge of the object, in pixels. Read-only.
UIObject.y	The top edge of the object, in pixels. Read-only.

Properties inherited from the UIComponent class

The following table lists the properties the Menu class inherits from the UIComponent class. When accessing these properties from the Menu object, use the form MenuInstance.propertyName.

Property	Description
UIComponent.enabled	Indicates whether the component can receive focus and input.
UIComponent.tabIndex	A number indicating the tab order for a component in a document.

Event summary for the Menu class

The following table lists events of the Menu class.

Event	Description
Menu.change	Broadcast when a user causes a change in a menu.
Menu.menuHide	Broadcast when a menu closes.
Menu.menuShow	Broadcast when a menu opens.
Menu.rollOut	Broadcast when the pointer rolls off an item.
Menu.rollOver	Broadcast when the pointer rolls over an item.

Events inherited from the UIObject class

The following table lists the events the Menu class inherits from the UIObject class.

Event	Description
UIObject.draw	Broadcast when an object is about to draw its graphics.
UIObject.hide	Broadcast when an object's state changes from visible to invisible.
UIObject.load	Broadcast when subobjects are being created.
UIObject.move	Broadcast when the object has moved.
UIObject.resize	Broadcast when an object has been resized.
UIObject.reveal	Broadcast when an object's state changes from invisible to visible.
UIObject.unload	Broadcast when the subobjects are being unloaded.

Events inherited from the UIComponent class

The following table lists the events the Menu class inherits from the UIComponent class.

Event	Description
UIComponent.focusIn	Broadcast when an object receives focus.
UIComponent.focusOut	Broadcast when an object loses focus.
UIComponent.keyDown	Broadcast when a key is pressed.
UIComponent.keyUp	Broadcast when a key is released.

Flash CS3