The delegate object that handles the automation-related functionality.

True if this component is enabled for automation, false otherwise.

Name that can be used as an identifier for this object.

The owner of this component for automation purposes.

The parent of this component for automation purposes.

An implementation of the IAutomationTabularData interface, which can be used to retrieve the data.

This value generally corresponds to the rendered appearance of the object and should be usable for correlating the identifier with the object as it appears visually within the application.

True if this component is visible for automation, false otherwise.

The object that accesses and manipulates data in the data provider. The FlexNativeMenu control delegates to the data descriptor for information about its data. This data is then used to parse and move about the data source. The data descriptor defined for the FlexNativeMenu is used for all child menus and submenus.

When you specify this property as an attribute in MXML, you must use a reference to the data descriptor, not the string name of the descriptor. Use the following format for setting the property:

<mx:FlexNativeMenu id="flexNativeMenu" dataDescriptor="{new MyCustomDataDescriptor()}"/>

Alternatively, you can specify the property in MXML as a nested subtag, as the following example shows:

<mx:FlexNativeMenu>
      <mx:dataDescriptor>
         <myCustomDataDescriptor>
      </mx:dataDescriptor>
      ...

The default value is an internal instance of the DefaultDataDescriptor class.

The hierarchy of objects that are used to define the structure of menu items in the NativeMenu. Individual data objects define menu items, and items with child items become menus and submenus.

The FlexNativeMenu control handles the source data object as follows:

• A String containing valid XML text is converted to an XML object.
• An XMLNode is converted to an XML object.
• An XMLList is converted to an XMLListCollection.
• Any object that implements the ICollectionView interface is cast to an ICollectionView.
• An Array is converted to an ArrayCollection.
• Any other type object is wrapped in an Array with the object as its sole entry.

The default value is "undefined".

This property can be used as the source for data binding. When this property is modified, it dispatches the collectionChange event.

A flag that indicates that the current data provider has a root node; for example, a single top node in a hierarchical structure. XML and Object are examples of types that have a root node, while Lists and Arrays do not.

A flag that determines if an object has been through all three phases of layout: commitment, measurement, and layout (provided that any were required).

The name of the field in the data provider that determines the key equivalent for each menu item. The set of values is defined in the Keyboard class, in the KEYNAME_XXXX constants. For example, consult that list for the value for a control character such as Home, Insert, etc.

Setting the keyEquivalentFunction property causes this property to be ignored.

The default value is "keyEquivalent".

This property can be used as the source for data binding. When this property is modified, it dispatches the keyEquivalentChanged event.

See also

The function that determines the key equivalent for each menu item. If you omit this property, Flex uses the contents of the field or attribute specified by the keyEquivalentField property. If you specify this property, Flex ignores any keyEquivalentField property value.

The keyEquivalentFunction property is good for handling formatting, localization, and platform independence.

The key equivalent function must take a single argument, which is the item in the data provider, and must return a String.

myKeyEquivalentFunction(item:Object):String

The default value is "undefined".

This property can be used as the source for data binding. When this property is modified, it dispatches the keyEquivalentFunctionChanged event.

See also

The function that determines the key equivalent modifiers for each menu item. If you omit this property, Flex uses its own default function to determine the Array of modifiers by looking in the data provider data for the presence of the following (boolean) fields: altKey, commandKey, controlKey, and shiftKey.

The keyEquivalentModifiersFunction property is good for handling formatting, localization, and platform independence.

The key equivalent modifiers function must take a single argument, which is the item in the data provider, and must return an array of modifier key names.

myKeyEquivalentModifiersFunction(item:Object):Array

The default value is "undefined".

This property can be used as the source for data binding. When this property is modified, it dispatches the keyEquivalentModifiersFunctionChanged event.

The name of the field in the data provider that determines the text to display for each menu item. If the data provider is an Array of Strings, Flex uses each string value as the label. If the data provider is an E4X XML object, you must set this property explicitly. For example, if each XML elementin an E4X XML Object includes a "label" attribute containing the text to display for each menu item, set the labelField to "@label".

In a label, you can specify the character to be used as the mnemonic index by preceding it with an underscore. For example, a label value of "C_ut" sets the mnemonic index to 1. Only the first underscore present is used for this purpose. To display a literal underscore character in the label, you can escape it using a double underscore. For example, a label value of "C__u_t" would result in a menu item with the label "C_ut" and a mnemonic index of 3 (the "t" character). If the field defined in the mnemonicIndexField property is present and set to a value greater than zero, that value takes precedence over any underscore-specified mnemonic index value.

Setting the labelFunction property causes this property to be ignored.

The default value is "label".

This property can be used as the source for data binding. When this property is modified, it dispatches the labelFieldChanged event.

The function that determines the text to display for each menu item. The label function must find the appropriate field or fields in the data provider and return a displayable string.

If you omit this property, Flex uses the contents of the field or attribute specified by the labelField property. If you specify this property, Flex ignores any labelField property value.

The labelFunction property can be helpful for handling formatting, localization, and platform-independence.

The label function must take a single argument, which is the item in the data provider, and must return a String.

myLabelFunction(item:Object):String

The default value is "undefined".

This property can be used as the source for data binding. When this property is modified, it dispatches the labelFunctionChanged event.

The name of the field in the data provider that determines the mnemonic index for each menu item.

If the field specified by this property contains a number greater than zero, that mnemonic index takes precedence over one specified by an underscore in the label.

Setting the mnemonicIndexFunction property causes this property to be ignored.

The default value is "mnemonicIndex".

This property can be used as the source for data binding. When this property is modified, it dispatches the mnemonicIndexChanged event.

See also

The function that determines the mnemonic index for each menu item.

If you omit this property, Flex uses the contents of the field or attribute specified by the mnemonicIndexField property. If you specify this property, Flex ignores any mnemonicIndexField property value.

If this property is defined and the function returns a number greater than zero for a data item, the returned mnemonic index takes precedence over one specified by an underscore in the label.

The mnemonicIndexFunction property is good for handling formatting, localization, and platform independence.

The mnemonic index function must take a single argument which is the item in the data provider and return an int.

myMnemonicIndexFunction(item:Object):int

The default value is "undefined".

This property can be used as the source for data binding. When this property is modified, it dispatches the mnemonicIndexFunctionChanged event.

Returns the flash.display.NativeMenu managed by this object, or null if there is not one. Any changes made directly to the underlying NativeMenu instance may be lost when changes are made to the menu or the underlying data provider.

This property can be used as the source for data binding. When this property is modified, it dispatches the nativeMenuUpdate event.

Depth of this object in the containment hierarchy. This number is used by the measurement and layout code. The value is 0 if this component is not on the DisplayList.

The number of automation children this container has. This sum should not include any composite children, though it does include those children not significant within the automation hierarchy.

Set to true after immediate or deferred child creation, depending on which one happens. For a Container object, it is set to true at the end of the createComponentsFromDescriptors() method, meaning after the Container object creates its children from its child descriptors.

For example, if an Accordion container uses deferred instantiation, the processedDescriptors property for the second pane of the Accordion container does not become true until after the user navigates to that pane and the pane creates its children. But, if the Accordion had set the creationPolicy property to "all", the processedDescriptors property for its second pane is set to true during application startup.

For classes that are not containers, which do not have descriptors, it is set to true after the createChildren() method creates any internal component children.

A flag that determines if an automation object shows in the automation hierarchy. Children of containers that are not visible in the hierarchy appear as children of the next highest visible parent. Typically containers used for layout, such as boxes and Canvas, do not appear in the hierarchy.

Some controls force their children to appear in the hierarchy when appropriate. For example a List will always force item renderers, including boxes, to appear in the hierarchy. Implementers must support setting this property to true.

A Boolean flag that specifies whether to display the data provider's root node.

If the data provider has a root node, and the showRoot property is set to false, the top-level menu items displayed by the FlexNativeMenu control correspond to the immediate descendants of the root node.

This flag has no effect when using a data provider without a root nodes, such as a List or Array.

The default value is true.

See also

A flag that determines if an object has been through all three phases of layout validation (provided that any were required).

Constructor.

Processes the properties set on the component.

See also

Returns a set of properties that identify the child within this container. These values should not change during the lifespan of the application.

Parameters

Returns a set of properties that identify the child within this container. These values should not change during the lifespan of the application.

Parameters

Pops up this menu at the specified location.

Parameters

Provides the automation object at the specified index. This list should not include any children that are composites.

Parameters

Provides the automation object list . This list does not include any children that are composites.

Marks a component so that its commitProperties() method gets called during a later screen update.

Invalidation is a useful mechanism for eliminating duplicate work by delaying processing of changes to a component until a later screen update. For example, if you want to change the text color and size, it would be wasteful to update the color immediately after you change it and then update the size when it gets set. It is more efficient to change both properties and then render the text with its new size and color once.

Invalidation methods rarely get called. In general, setting a property on a component automatically calls the appropriate invalidation method.

Returns the key equivalent for the given data object based on the keyEquivalentField and keyEquivalentFunction properties. If the method cannot convert the parameter to a String, it returns an empty string.

Parameters

Returns the key equivalent modifiers for the given data object based on the keyEquivalentModifiersFunction property. If the method cannot convert the parameter to an Array of modifiers, it returns an empty Array.

Parameters

Returns the String to use as the menu item label for the given data object, based on the labelField and labelFunction properties. If the method cannot convert the parameter to a String, it returns a single space.

Parameters

Returns the mnemonic index for the given data object based on the mnemonicIndexField and mnemonicIndexFunction properties. If the method cannot convert the parameter to an integer, it returns -1.

Parameters

Extracts the mnemonic index from a label based on the presence of an underscore character. It finds the leading underscore character if there is one and uses that as the index.

Parameters

Determines the actual label to be used for the NativeMenuItem by removing underscore characters and converting escaped underscore characters, if there are any.

Parameters

Replays the specified event. A component author should probably call super.replayAutomatableEvent in case default replay behavior has been defined in a superclass.

Parameters

Resolves a child by using the id provided. The id is a set of properties as provided by the createAutomationIDPart() method.

Parameters

Sets the context menu of the InteractiveObject to the underlying native menu.

Parameters

Unsets the context menu of the InteractiveObject that has been set to the underlying native menu.

Parameters

Validates the position and size of children and draws other visuals. If the LayoutManager.invalidateDisplayList() method is called with this ILayoutManagerClient, then the validateDisplayList() method is called when it's time to update the display list.

Validates and updates the properties and layout of this object and redraws it, if necessary.

Validates the properties of a component. If the LayoutManager.invalidateProperties() method is called with this ILayoutManagerClient, then the validateProperties() method is called when it's time to commit property values.

Validates the measured size of the component If the LayoutManager.invalidateSize() method is called with this ILayoutManagerClient, then the validateSize() method is called when it's time to do measurements.

Parameters

Dispatched when a menu item is selected.

The properties of the event object for this event type have the following values. Not all properties are meaningful for all kinds of events. See the detailed property descriptions for more information.

Dispatched before a menu or submenu is displayed.

The properties of the event object for this event type have the following values. Not all properties are meaningful for all kinds of events. See the detailed property descriptions for more information.