| Pacote | mx.controls |
| Classe | public class FlexNativeMenu |
| Herança | FlexNativeMenu  EventDispatcher Object |
| Implementações | ILayoutManagerClient, IFlexContextMenu, IAutomationObject |
| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | AIR 1.1 |
Like other Flex menu components, to define the structure of a menu represented by a
FlexNativeMenu component, you create a data provider such as an XML hierarchy or an array
of objects containing data to be used to define the menu. Several properties can be set to
define how the data provider data is interpreted, such as the labelField property
to specify the data field that is used for the menu item label, the keyEquivalentField
property to specify the field that defines a keyboard equivalent shortcut for the menu item,
and the mnemonicIndexField property to specify the field that defines the index
position of the character in the label that is used as the menu item's mnemonic.
The data provider for FlexNativeMenu items can specify several attributes that determine how the item is displayed and behaves, as the following XML data provider shows:
<mx:XML format="e4x" id="myMenuData">
<root>
<menuitem label="MenuItem A">
<menuitem label="SubMenuItem A-1" enabled="False"/>
<menuitem label="SubMenuItem A-2"/>
</menuitem>
<menuitem label="MenuItem B" type="check" toggled="true"/>
<menuitem label="MenuItem C" type="check" toggled="false"/>
<menuitem type="separator"/>
<menuitem label="MenuItem D">
<menuitem label="SubMenuItem D-1"/>
<menuitem label="SubMenuItem D-2"/>
<menuitem label="SubMenuItem D-3"/>
</menuitem>
</root>
</mx:XML>
The following table lists the attributes you can specify, their data types, their purposes, and how the data provider must represent them if the menu uses the DefaultDataDescriptor class to parse the data provider:
| Attribute | Type | Description |
|---|---|---|
altKey
| Boolean | Specifies whether the Alt key is required as part of the key equivalent for the item. |
cmdKey
| Boolean |
Note: this attribute is deprecated as of Flex 3.2. Use
commandKey instead. Specifies whether the Command key is required as part
of the key equivalent for the item. |
commandKey
| Boolean | Specifies whether the Command key is required as part of the key equivalent for the item. |
controlKey
| Boolean | Specifies whether the Control key is required as part of the key equivalent for the item. |
ctrlKey
| Boolean |
Note: this attribute is deprecated as of Flex 3.2. Use
controlKey instead. Specifies whether the Control key is required as part
of the key equivalent for the item. |
enabled
| Boolean | Specifies whether the user can select the menu item (true),
or not (false). If not specified, Flex treats the item as if
the value were true.
If you use the default data descriptor, data providers must use an enabled
XML attribute or object field to specify this characteristic. |
keyEquivalent
| String | Specifies a keyboard character which, when pressed, triggers an event as though
the menu item was selected. The menu's keyEquivalentField or
keyEquivalentFunction property determines the name of the field
in the data that specifies the key equivalent, or a function for determining
the key equivalents. (If the data provider is in E4X XML format, you must specify
one of these properties to assign a key equivalent.) |
label
| String | Specifies the text that appears in the control. This item is used for all
menu item types except separator.
The menu's labelField or labelFunction property
determines the name of the field in the data that specifies the label,
or a function for determining the labels. (If the data provider is in E4X XML format,
you must specify one of these properties to display a label.)
If the data provider is an Array of Strings, Flex uses the String value as the label. |
mnemonicIndex
| Integer | Specifies the index position of the character in the label that is used as the
mnemonic for the menu item. The menu's mnemonicIndexField or
mnemonicIndexFunction property determines the name of the field
in the data that specifies the mnemonic index, or a function for determining
mnemonic index. (If the data provider is in E4X XML format, you must specify
one of these properties to specify a mnemonic index in the data.) Alternatively,
you can indicate that a character in the label is the menu item's mnemonic by
including an underscore immediately to the left of that character. |
shiftKey
| Boolean | Specifies whether the Shift key is required as part of the key equivalent for the item. |
toggled
| Boolean | Specifies whether a check item is selected.
If not specified, Flex treats the item as if the value were false
and the item is not selected.
If you use the default data descriptor, data providers must use a toggled
XML attribute or object field to specify this characteristic. |
type
| String | Specifies the type of menu item. Meaningful values are separator and
check. Flex treats all other values,
or nodes with no type entry, as normal menu entries.
If you use the default data descriptor, data providers must use a type
XML attribute or object field to specify this characteristic. |
To create a window menu, set the FlexNativeMenu as the menu property of the
Window or WindowedApplication instance on which the menu should appear. To create an application
menu, assign the FlexNativeMenu as the menu property of the application's
WindowedApplication. To assign a FlexNativeMenu as the context menu for a portion of the user interface,
call the FlexNativeMenu instance's setContextMenu() method, passing the UI object
as an argument. Call the FlexNativeMenu component's display() method to display the
menu as a pop-up menu anywhere on one of the application's windows.
To detect when menu items commands are triggered, register a listener for the itemClick
event. You can also register a listener for the menuShow event to determine when
any menu or submenu is opened.
Mostrar sintaxe MXML
Ocultar sintaxe MXMLThe <mx:FlexNativeMenu> tag supports the following tag attributes:
<mx:FlexNativeMenu
Properties
dataDescriptor="mx.controls.treeClasses.DefaultDataDescriptor"
dataProvider="undefined"
keyEquivalentField="keyEquivalent"
keyEquivalentFunction="undefined"
keyEquivalentModifiersFunction="undefined"
labelField="label"
labelFunction="undefined"
mnemonicIndexField="mnemonicIndex"
mnemonicIndexFunction="undefined"
showRoot="true"
Events
itemClick="No default"
menuShow="No default"
/>
Elementos da API relacionados
| Propriedade | Definido por | ||
|---|---|---|---|
| automationDelegate : Object
The delegate object that handles the automation-related functionality. | FlexNativeMenu | ||
| automationEnabled : Boolean [somente leitura]
True if this component is enabled for automation, false
otherwise. | FlexNativeMenu | ||
| automationName : String
Name that can be used as an identifier for this object. | FlexNativeMenu | ||
| automationOwner : DisplayObjectContainer
The owner of this component for automation purposes. | FlexNativeMenu | ||
| automationParent : DisplayObjectContainer
The parent of this component for automation purposes. | FlexNativeMenu | ||
| automationTabularData : Object [somente leitura]
An implementation of the IAutomationTabularData interface, which
can be used to retrieve the data. | FlexNativeMenu | ||
| automationValue : Array [somente leitura]
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. | FlexNativeMenu | ||
| automationVisible : Boolean [somente leitura]
True if this component is visible for automation, false
otherwise. | FlexNativeMenu | ||
 | constructor : Object
Uma referência ao objeto de classe ou à função de construtor de uma determinada ocorrência de objeto. | Object | |
| dataDescriptor : IMenuDataDescriptor
The object that accesses and manipulates data in the data provider. | FlexNativeMenu | ||
| dataProvider : Object
The hierarchy of objects that are used to define the structure
of menu items in the NativeMenu. | FlexNativeMenu | ||
| hasRoot : Boolean [somente leitura]
A flag that indicates that the current data provider has a root node; for example,
a single top node in a hierarchical structure. | FlexNativeMenu | ||
| initialized : Boolean
A flag that determines if an object has been through all three phases
of layout: commitment, measurement, and layout (provided that any were required). | FlexNativeMenu | ||
| keyEquivalentField : String
The name of the field in the data provider that determines the
key equivalent for each menu item. | FlexNativeMenu | ||
| keyEquivalentFunction : Function
The function that determines the key equivalent for each menu item. | FlexNativeMenu | ||
| keyEquivalentModifiersFunction : Function
The function that determines the key equivalent modifiers for each menu item. | FlexNativeMenu | ||
| labelField : String
The name of the field in the data provider that determines the
text to display for each menu item. | FlexNativeMenu | ||
| labelFunction : Function
The function that determines the text to display for each menu item. | FlexNativeMenu | ||
| mnemonicIndexField : String
The name of the field in the data provider that determines the
mnemonic index for each menu item. | FlexNativeMenu | ||
| mnemonicIndexFunction : Function
The function that determines the mnemonic index for each menu item. | FlexNativeMenu | ||
| nativeMenu : NativeMenu [somente leitura]
Returns the flash.display.NativeMenu managed by this object,
or null if there is not one. | FlexNativeMenu | ||
| nestLevel : int
Depth of this object in the containment hierarchy. | FlexNativeMenu | ||
| numAutomationChildren : int [somente leitura]
The number of automation children this container has. | FlexNativeMenu | ||
| processedDescriptors : Boolean
Set to true after immediate or deferred child creation,
depending on which one happens. | FlexNativeMenu | ||
| showInAutomationHierarchy : Boolean
A flag that determines if an automation object
shows in the automation hierarchy. | FlexNativeMenu | ||
| showRoot : Boolean
A Boolean flag that specifies whether to display the data provider's
root node. | FlexNativeMenu | ||
| updateCompletePendingFlag : Boolean
A flag that determines if an object has been through all three phases
of layout validation (provided that any were required). | FlexNativeMenu | ||
| Método | Definido por | ||
|---|---|---|---|
Constructor. | FlexNativeMenu | ||
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registra um objeto de ouvinte de evento em um objeto EventDispatcher, de forma que o ouvinte receba a notificação de um evento. | EventDispatcher | |
Returns a set of properties that identify the child within
this container. | FlexNativeMenu | ||
Returns a set of properties that identify the child within
this container. | FlexNativeMenu | ||
|
Envia um evento para o fluxo de eventos. | EventDispatcher | |
Pops up this menu at the specified location. | FlexNativeMenu | ||
Provides the automation object at the specified index. | FlexNativeMenu | ||
Provides the automation object list . | FlexNativeMenu | ||
|
Verifica se o objeto EventDispatcher tem ouvintes registrados para um tipo específico de evento. | EventDispatcher | |
|
Indica se um objeto tem uma propriedade especificada definida. | Object | |
Marks a component so that its commitProperties()
method gets called during a later screen update. | FlexNativeMenu | ||
|
Indica se uma ocorrência da classe Object está na cadeia de protótipos do objeto especificado como o parâmetro. | Object | |
|
Indica se a propriedade especificada existe e é enumerável. | Object | |
|
Remove um ouvinte do objeto EventDispatcher. | EventDispatcher | |
Replays the specified event. | FlexNativeMenu | ||
Resolves a child by using the id provided. | FlexNativeMenu | ||
Sets the context menu of the InteractiveObject to the underlying native menu. | FlexNativeMenu | ||
|
Define a disponibilidade de uma propriedade dinâmica para operações de repetição. | Object | |
|
Retorna a representação da string deste objeto, formatado segundo as convenções específicas para a localidade. | Object | |
|
Retorna a representação de string do objeto especificado. | Object | |
Unsets the context menu of the InteractiveObject that has been set to
the underlying native menu. | FlexNativeMenu | ||
Validates the position and size of children and draws other
visuals. | FlexNativeMenu | ||
Validates and updates the properties and layout of this object
and redraws it, if necessary. | FlexNativeMenu | ||
Validates the properties of a component. | FlexNativeMenu | ||
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. | FlexNativeMenu | ||
|
Retorna o valor primitivo do objeto especificado. | Object | |
|
Verifica se um ouvinte de evento está registrado nesse objeto EventDispatcher ou em qualquer um de seus ancestrais para o tipo de evento especificado. | EventDispatcher | |
| Método | Definido por | ||
|---|---|---|---|
Processes the properties set on the component. | FlexNativeMenu | ||
Returns the key equivalent for the given data object
based on the keyEquivalentField and keyEquivalentFunction
properties. | FlexNativeMenu | ||
Returns the key equivalent modifiers for the given data object
based on the keyEquivalentModifiersFunction property. | FlexNativeMenu | ||
Returns the String to use as the menu item label for the given data
object, based on the labelField and labelFunction
properties. | FlexNativeMenu | ||
Returns the mnemonic index for the given data object
based on the mnemonicIndexField and mnemonicIndexFunction
properties. | FlexNativeMenu | ||
Extracts the mnemonic index from a label based on the presence of
an underscore character. | FlexNativeMenu | ||
Determines the actual label to be used for the NativeMenuItem
by removing underscore characters and converting escaped underscore
characters, if there are any. | FlexNativeMenu | ||
| Evento | Resumo | Definido por | ||
|---|---|---|---|---|
| [transmissão de evento] Despachado quando o Flash Player ou o aplicativo do AIR ganha o foco do sistema operacional e está se tornando inativo. | EventDispatcher | ||
| [transmissão de evento] Despachado quando o Flash Player ou o aplicativo do AIR perde o foco do sistema operacional e está se tornando inativo. | EventDispatcher | ||
| Dispatched when a menu item is selected. | FlexNativeMenu | |||
| Dispatched before a menu or submenu is displayed. | FlexNativeMenu | |||
automationDelegate | propriedade |
automationDelegate:Object| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | AIR 1.1 |
The delegate object that handles the automation-related functionality.
Implementação
public function get automationDelegate():Object public function set automationDelegate(value:Object):void automationEnabled | propriedade |
automationName | propriedade |
automationOwner | propriedade |
automationOwner:DisplayObjectContainer| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | AIR 1.1 |
The owner of this component for automation purposes.
Implementação
public function get automationOwner():DisplayObjectContainer public function set automationOwner(value:DisplayObjectContainer):void automationParent | propriedade |
automationParent:DisplayObjectContainer| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | AIR 1.1 |
The parent of this component for automation purposes.
Implementação
public function get automationParent():DisplayObjectContainer public function set automationParent(value:DisplayObjectContainer):void automationTabularData | propriedade |
automationTabularData:Object [somente leitura] | Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | AIR 1.1 |
An implementation of the IAutomationTabularData interface, which
can be used to retrieve the data.
Implementação
public function get automationTabularData():Object automationValue | propriedade |
automationValue:Array [somente leitura] | Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | AIR 1.1 |
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.
Implementação
public function get automationValue():Array automationVisible | propriedade |
dataDescriptor | propriedade |
dataDescriptor:IMenuDataDescriptor| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | AIR 1.1 |
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.
Implementação
public function get dataDescriptor():IMenuDataDescriptor public function set dataDescriptor(value:IMenuDataDescriptor):void dataProvider | propriedade |
dataProvider:Object| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | AIR 1.1 |
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.
O valor padrão é "undefined".
Essa propriedade pode ser usada como a origem para o vínculo de dados. Quando essa propriedade é modificada, ela despacha o evento collectionChange .
Implementação
public function get dataProvider():Object public function set dataProvider(value:Object):void hasRoot | propriedade |
hasRoot:Boolean [somente leitura] | Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | AIR 1.1 |
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.
Implementação
public function get hasRoot():Boolean initialized | propriedade |
initialized:Boolean| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | AIR 1.1 |
A flag that determines if an object has been through all three phases of layout: commitment, measurement, and layout (provided that any were required).
Implementação
public function get initialized():Boolean public function set initialized(value:Boolean):void keyEquivalentField | propriedade |
keyEquivalentField:String| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | AIR 1.1 |
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.
O valor padrão é "keyEquivalent".
Essa propriedade pode ser usada como a origem para o vínculo de dados. Quando essa propriedade é modificada, ela despacha o evento keyEquivalentChanged .
Implementação
public function get keyEquivalentField():String public function set keyEquivalentField(value:String):voidElementos da API relacionados
keyEquivalentFunction | propriedade |
keyEquivalentFunction:Function| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | AIR 1.1 |
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 O valor padrão é "undefined".
Essa propriedade pode ser usada como a origem para o vínculo de dados. Quando essa propriedade é modificada, ela despacha o evento keyEquivalentFunctionChanged .
Implementação
public function get keyEquivalentFunction():Function public function set keyEquivalentFunction(value:Function):voidElementos da API relacionados
keyEquivalentModifiersFunction | propriedade |
keyEquivalentModifiersFunction:Function| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | AIR 1.1 |
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 O valor padrão é "undefined".
Essa propriedade pode ser usada como a origem para o vínculo de dados. Quando essa propriedade é modificada, ela despacha o evento keyEquivalentModifiersFunctionChanged .
Implementação
public function get keyEquivalentModifiersFunction():Function public function set keyEquivalentModifiersFunction(value:Function):void labelField | propriedade |
labelField:String| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | AIR 1.1 |
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.
O valor padrão é "label".
Essa propriedade pode ser usada como a origem para o vínculo de dados. Quando essa propriedade é modificada, ela despacha o evento labelFieldChanged .
Implementação
public function get labelField():String public function set labelField(value:String):void labelFunction | propriedade |
labelFunction:Function| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | AIR 1.1 |
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 O valor padrão é "undefined".
Essa propriedade pode ser usada como a origem para o vínculo de dados. Quando essa propriedade é modificada, ela despacha o evento labelFunctionChanged .
Implementação
public function get labelFunction():Function public function set labelFunction(value:Function):void mnemonicIndexField | propriedade |
mnemonicIndexField:String| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | AIR 1.1 |
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.
O valor padrão é "mnemonicIndex".
Essa propriedade pode ser usada como a origem para o vínculo de dados. Quando essa propriedade é modificada, ela despacha o evento mnemonicIndexChanged .
Implementação
public function get mnemonicIndexField():String public function set mnemonicIndexField(value:String):voidElementos da API relacionados
mnemonicIndexFunction | propriedade |
mnemonicIndexFunction:Function| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | AIR 1.1 |
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 O valor padrão é "undefined".
Essa propriedade pode ser usada como a origem para o vínculo de dados. Quando essa propriedade é modificada, ela despacha o evento mnemonicIndexFunctionChanged .
Implementação
public function get mnemonicIndexFunction():Function public function set mnemonicIndexFunction(value:Function):void nativeMenu | propriedade |
nativeMenu:NativeMenu [somente leitura] | Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | AIR 1.1 |
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.
Essa propriedade pode ser usada como a origem para o vínculo de dados. Quando essa propriedade é modificada, ela despacha o evento nativeMenuUpdate .
Implementação
public function get nativeMenu():NativeMenu nestLevel | propriedade |
nestLevel:int| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | AIR 1.1 |
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.
Implementação
public function get nestLevel():int public function set nestLevel(value:int):void numAutomationChildren | propriedade |
numAutomationChildren:int [somente leitura] | Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | AIR 1.1 |
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.
Implementação
public function get numAutomationChildren():int processedDescriptors | propriedade |
processedDescriptors:Boolean| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | AIR 1.1 |
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.
Implementação
public function get processedDescriptors():Boolean public function set processedDescriptors(value:Boolean):void showInAutomationHierarchy | propriedade |
showInAutomationHierarchy:Boolean| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | AIR 1.1 |
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.
Implementação
public function get showInAutomationHierarchy():Boolean public function set showInAutomationHierarchy(value:Boolean):void showRoot | propriedade |
showRoot:Boolean| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | AIR 1.1 |
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.
O valor padrão é true.
Implementação
public function get showRoot():Boolean public function set showRoot(value:Boolean):voidElementos da API relacionados
updateCompletePendingFlag | propriedade |
updateCompletePendingFlag:Boolean| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | AIR 1.1 |
A flag that determines if an object has been through all three phases of layout validation (provided that any were required).
Implementação
public function get updateCompletePendingFlag():Boolean public function set updateCompletePendingFlag(value:Boolean):void FlexNativeMenu | () | Construtor |
public function FlexNativeMenu()| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | AIR 1.1 |
Constructor.
commitProperties | () | método |
protected function commitProperties():void| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | AIR 1.1 |
Processes the properties set on the component.
Elementos da API relacionados
createAutomationIDPart | () | método |
public function createAutomationIDPart(child:IAutomationObject):Object| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | AIR 1.1 |
Returns a set of properties that identify the child within this container. These values should not change during the lifespan of the application.
Parâmetros
child:IAutomationObject — Child for which to provide the id.
|
Object — Sets of properties describing the child which can
later be used to resolve the component.
|
createAutomationIDPartWithRequiredProperties | () | método |
public function createAutomationIDPartWithRequiredProperties(child:IAutomationObject, properties:Array):Object| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | AIR 1.1 |
Returns a set of properties that identify the child within this container. These values should not change during the lifespan of the application.
Parâmetros
child:IAutomationObject — Child for which to provide the id.
| |
properties:Array |
Object — Sets of properties describing the child which can
later be used to resolve the component.
|
display | () | método |
public function display(stage:Stage, x:int, y:int):void| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | AIR 1.1 |
Pops up this menu at the specified location.
Parâmetros
stage:Stage — The Stage object on which to display this menu.
| |
x:int — The number of horizontal pixels, relative to the origin of stage,
at which to display this menu.
| |
y:int — The number of vertical pixels, relative to the origin of stage,
at which to display this menu.
|
getAutomationChildAt | () | método |
public function getAutomationChildAt(index:int):IAutomationObject| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | AIR 1.1 |
Provides the automation object at the specified index. This list should not include any children that are composites.
Parâmetros
index:int — The index of the child to return
|
IAutomationObject — The child at the specified index.
|
getAutomationChildren | () | método |
invalidateProperties | () | método |
public function invalidateProperties():void| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | AIR 1.1 |
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.
itemToKeyEquivalent | () | método |
protected function itemToKeyEquivalent(data:Object):String| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | AIR 1.1 |
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.
Parâmetros
data:Object — Object to be displayed.
|
String — The key equivalent based on the data.
|
itemToKeyEquivalentModifiers | () | método |
protected function itemToKeyEquivalentModifiers(data:Object):Array| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | AIR 1.1 |
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.
Parâmetros
data:Object — Object to be displayed.
|
Array — The array of key equivalent modifiers based on the data.
|
itemToLabel | () | método |
protected function itemToLabel(data:Object):String| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | AIR 1.1 |
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.
Parâmetros
data:Object — Object to be displayed.
|
String — The string to be displayed based on the data.
|
itemToMnemonicIndex | () | método |
protected function itemToMnemonicIndex(data:Object):int| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | AIR 1.1 |
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.
Parâmetros
data:Object — Object to be displayed.
|
int — The mnemonic index based on the data.
|
parseLabelToMnemonicIndex | () | método |
protected function parseLabelToMnemonicIndex(data:String):int| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | AIR 1.1 |
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.
Parâmetros
data:String — The data to parse for the index.
|
int — The index.
|
parseLabelToString | () | método |
protected function parseLabelToString(data:String):String| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | AIR 1.1 |
Determines the actual label to be used for the NativeMenuItem by removing underscore characters and converting escaped underscore characters, if there are any.
Parâmetros
data:String — The data to parse for the label.
|
String — The label.
|
replayAutomatableEvent | () | método |
public function replayAutomatableEvent(event:Event):Boolean| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | AIR 1.1 |
Replays the specified event. A component author should probably call super.replayAutomatableEvent in case default replay behavior has been defined in a superclass.
Parâmetros
event:Event — The event to replay.
|
Boolean — true if a replay was successful.
|
resolveAutomationIDPart | () | método |
public function resolveAutomationIDPart(criteria:Object):Array| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | AIR 1.1 |
Resolves a child by using the id provided. The id is a set
of properties as provided by the createAutomationIDPart() method.
Parâmetros
criteria:Object — Set of properties describing the child.
The criteria can contain regular expression values
resulting in multiple children being matched.
|
Array — Array of children that matched the criteria
or null if no children could not be resolved.
|
setContextMenu | () | método |
public function setContextMenu(component:InteractiveObject):void| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | AIR 1.1 |
Sets the context menu of the InteractiveObject to the underlying native menu.
Parâmetros
component:InteractiveObject — The interactive object.
|
unsetContextMenu | () | método |
public function unsetContextMenu(component:InteractiveObject):void| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | AIR 1.1 |
Unsets the context menu of the InteractiveObject that has been set to the underlying native menu.
Parâmetros
component:InteractiveObject — The interactive object.
|
validateDisplayList | () | método |
public function validateDisplayList():void| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | AIR 1.1 |
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.
validateNow | () | método |
public function validateNow():void| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | AIR 1.1 |
Validates and updates the properties and layout of this object and redraws it, if necessary.
validateProperties | () | método |
public function validateProperties():void| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | AIR 1.1 |
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.
validateSize | () | método |
public function validateSize(recursive:Boolean = false):void| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | AIR 1.1 |
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.
Parâmetros
recursive:Boolean (default = false)true, call this method
on the objects children.
|
itemClick | Evento |
mx.events.FlexNativeMenuEventpropriedade FlexNativeMenuEvent.type =
mx.events.FlexNativeMenuEvent.ITEM_CLICK| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | AIR 1.1 |
Dispatched when a menu item is selected.
The FlexNativeMenuEvent.ITEM_CLICK event type constant indicates that the user selected a menu item.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.
| Property | Value |
|---|---|
bubbles | false |
cancelable | true |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget. |
index | The index in the menu of the selected menu item. |
item | The item in the dataProvider that was selected. |
label | The label text of the selected menu item. |
nativeMenu | The specific NativeMenu instance associated with this event. |
nativeMenuItem | The specific NativeMenuItem instance associated with this event. |
target | The Object that dispatched the
event; it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
type | FlexNativeMenuEvent.ITEM_CLICK |
menuShow | Evento |
mx.events.FlexNativeMenuEventpropriedade FlexNativeMenuEvent.type =
mx.events.FlexNativeMenuEvent.MENU_SHOW| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | AIR 1.1 |
Dispatched before a menu or submenu is displayed.
The FlexNativeMenuEvent.MENU_SHOW type constant indicates that the mouse pointer rolled a menu or submenu opened.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.
| Property | Value |
|---|---|
bubbles | false |
cancelable | true |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget. |
index | -1. This property is not set for this type of event. |
item | null. This property is not set for this type of event. |
label | null. This property is not set for this type of event. |
nativeMenu | The specific NativeMenu instance associated with this event. |
nativeMenuItem | null. This property is not set for this type of event. |
target | The Object that dispatched the
event; it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
type | FlexNativeMenuEvent.MENU_SHOW |
Wed Jun 13 2018, 11:10 AM Z