Package | mx.controls |
Classe | public class FlexNativeMenu |
Héritage | FlexNativeMenu EventDispatcher Object |
Implémente | ILayoutManagerClient, IFlexContextMenu, IAutomationObject |
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | AIR 1.1 |
Tout comme d’autres composants de menus Flex, pour définir la structure d’un menu représenté par un composant FlexNativeMenu, vous devez créer un fournisseur de données comme une hiérarchie XML ou un tableau d’objets contenant les données à utiliser pour définir le menu. Plusieurs propriétés peuvent être définies pour spécifier la façon dont le fournisseur de données est interprété, par exemple la propriété labelField
pour spécifier le champ de données qui est utilisé pour l’étiquette de l’élément de menu, la propriété keyEquivalentField
pour spécifier le champ qui définit un raccourci clavier pour l’élément de menu et la propriété mnemonicIndexField
pour spécifier le champ qui définit la position d’index du caractère dans l’étiquette qui est utilisée comme mnémonique de l’élément de menu.
Le fournisseur de données des éléments FlexNativeMenu peut spécifier différents attributs qui déterminent la façon dont l’élément est affiché et se comporte, comme le montre le fournisseur de données XML suivant :
<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>
Le tableau suivant répertorie les attributs que vous pouvez spécifier, leurs types de données, leurs objectifs et la façon dont le fournisseur de données doit les représenter, si le menu utilise la classe DefaultDataDescriptor par défaut pour analyser le fournisseur de données :
Attribut | Type | Description |
---|---|---|
altKey
| Boolean | Indique si la touche Alt est requise dans l’équivalence de touches de l’élément. |
cmdKey
| Boolean |
Remarque : cet attribut est déconseillé depuis Flex 3.2. Utilisez à la place commandKey . Indique si la touche Cmd est requise dans l’équivalence de touches de l’élément. |
commandKey
| Boolean | Indique si la touche Cmd est requise dans l’équivalence de touches de l’élément. |
controlKey
| Boolean | Indique si la touche Ctrl est requise dans l’équivalence de touches de l’élément. |
ctrlKey
| Boolean |
Remarque : cet attribut est déconseillé depuis Flex 3.2. Utilisez à la place controlKey . Indique si la touche Ctrl est requise dans l’équivalence de touches de l’élément. |
enabled
| Boolean | Indique si l’utilisateur peut sélectionner l’élément de menu (true ) ou non (false ). Si cela n’est pas spécifié, Flex traite l’élément comme si la valeur était true . Si vous utilisez le descripteur de données par défaut, les fournisseurs de données doivent utiliser un attribut XML enabled ou un champ d’objet pour spécifier cette caractéristique. |
keyEquivalent
| String | Spécifie un caractère clavier qui, lorsqu’il est activé, déclenche un événement comme si l’élément de menu était sélectionné. La propriété keyEquivalentField ou keyEquivalentFunction du menu détermine le nom du champ des données qui spécifie l’équivalence de touches, ou une fonction qui détermine les équivalences de touches (si le fournisseur de données est au format E4X XML, vous devez spécifier une de ces propriétés pour assigner une équivalence de touches). |
label
| String | Spécifie le texte qui s’affiche dans le contrôle. Cet élément est utilisé pour tous les types d’éléments de menu, à l’exception du separator . La propriété labelField ou labelFunction du menu détermine le nom du champ des données qui spécifie l’étiquette, ou une fonction qui détermine les étiquettes (si le fournisseur de données est au format E4X XML, vous devez spécifier une de ces propriétés pour afficher une étiquette). Si le fournisseur de données est un tableau de chaînes, Flex utilise la valeur de chaîne comme étiquette. |
mnemonicIndex
| Nombre entier | Spécifie la position d’index des caractères de l’étiquette qui sert de mnémonique pour l’élément de menu. La propriété mnemonicIndexField ou mnemonicIndexFunction du menu détermine le nom du champ des données qui spécifie l’index mnémonique, ou une fonction qui détermine l’index mnémonique (si le fournisseur de données est au format E4X XML, vous devez spécifier une de ces propriétés pour spécifier un index mnémonique dans les données). Vous pouvez également indiquer qu’un caractère de l’étiquette est le mnémonique de l’élément de menu en incluant un caractère de soulignement sur la gauche immédiate de ce caractère. |
shiftKey
| Boolean | Indique si la touche Maj est requise dans l’équivalence de touches de l’élément. |
toggled
| Boolean | Indique si un élément de case à cocher est sélectionné. Si cela n’est pas spécifié, Flex traite l’élément comme si la valeur était false et l’élément n’est pas sélectionné. Si vous utilisez le descripteur de données par défaut, les fournisseurs de données doivent utiliser un attribut XML toggled ou un champ d’objet pour spécifier cette caractéristique. |
type
| String | Indique le type d’élément de menu. Les valeurs significatives sont separator et check . Flex traite toutes les autres valeurs, ou les nœuds sans entrée de type, comme des entrées de menu normales. Si vous utilisez le descripteur de données par défaut, les fournisseurs de données doivent utiliser un attribut XML type ou un champ d’objet pour spécifier cette caractéristique. |
Pour créer un menu de fenêtre, définissez le composant FlexNativeMenu comme propriété menu
de l’instance Window ou WindowedApplication sur laquelle le menu doit apparaître. Pour créer un menu d’application, assignez le composant FlexNativeMenu comme propriété menu
de l’instance WindowedApplication de l’application. Pour assigner un composant FlexNativeMenu comme menu contextuel d’une portion de l’interface utilisateur, appelez la méthode setContextMenu()
de l’instance FlexNativeMenu en transmettant l’objet d’interface utilisateur comme argument. Appelez la méthode display()
du composant FlexNativeMenu pour afficher le menu sous forme de menu contextuel à un endroit quelconque de l’une des fenêtres de l’application.
Pour détecter le moment où les commandes des éléments sont déclenchées, enregistrez un écouteur pour l’événement itemClick
. Vous pouvez également enregistrer un écouteur pour l’événement menuShow
dans le but de déterminer à quel moment l’ouverture d’un menu ou d’un sous-menu a lieu.
The <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" />
Eléments de l’API associés
Propriété | Défini par | ||
---|---|---|---|
automationDelegate : Object
Objet délégué qui traite la fonction d’automatisation. | FlexNativeMenu | ||
automationEnabled : Boolean [lecture seule]
True si ce composant est activé pour l’automatisation, false dans le cas contraire. | FlexNativeMenu | ||
automationName : String
Nom pouvant être utilisé comme identifiant de cet objet. | FlexNativeMenu | ||
automationOwner : DisplayObjectContainer
Propriétaire de ce composant à des fins d’automatisation. | FlexNativeMenu | ||
automationParent : DisplayObjectContainer
Parent de ce composant à des fins d’automatisation. | FlexNativeMenu | ||
automationTabularData : Object [lecture seule]
Implémentation de l’interface IAutomationTabularData, qui peut être utilisée pour récupérer les données. | FlexNativeMenu | ||
automationValue : Array [lecture seule]
Cette valeur correspond généralement à l’apparence rendue de l’objet et doit être utilisable pour associer l’identifiant à l’objet lorsqu’il apparaît visuellement dans l’application. | FlexNativeMenu | ||
automationVisible : Boolean [lecture seule]
True si ce composant est visible pour l’automatisation, false dans le cas contraire. | FlexNativeMenu | ||
constructor : Object
Référence à l’objet de classe ou à la fonction constructeur d’une occurrence donnée d’un objet. | Object | ||
dataDescriptor : IMenuDataDescriptor
Objet qui accède aux objets du fournisseur de données et les manipule. | FlexNativeMenu | ||
dataProvider : Object
Hiérarchie des objets qui sont utilisés pour définir la structure des éléments de menu dans le composant NativeMenu. | FlexNativeMenu | ||
hasRoot : Boolean [lecture seule]
Indicateur précisant que le fournisseur de données actuel comporte un nœud racine. Par exemple, un nœud supérieur unique dans une structure hiérarchique. | FlexNativeMenu | ||
initialized : Boolean
Indicateur déterminant si un objet a traversé les trois phases de présentation : validation, mesure et présentation (si besoin était). | FlexNativeMenu | ||
keyEquivalentField : String
Nom du champ dans le fournisseur de données qui détermine l’équivalence de touches de chaque élément de menu. | FlexNativeMenu | ||
keyEquivalentFunction : Function
Fonction qui détermine l’équivalence de touches de chaque élément de menu. | FlexNativeMenu | ||
keyEquivalentModifiersFunction : Function
Fonction qui détermine les modificateurs d’équivalence de touches de chaque élément de menu. | FlexNativeMenu | ||
labelField : String
Nom du champ dans le fournisseur de données qui détermine le texte à afficher pour chaque élément de menu. | FlexNativeMenu | ||
labelFunction : Function
Fonction qui détermine le texte à afficher pour chaque élément de menu. | FlexNativeMenu | ||
mnemonicIndexField : String
Nom du champ dans le fournisseur de données qui détermine l’index mnémonique de chaque élément de menu. | FlexNativeMenu | ||
mnemonicIndexFunction : Function
Fonction qui détermine l’index mnémonique de chaque élément de menu. | FlexNativeMenu | ||
nativeMenu : NativeMenu [lecture seule]
Renvoie l’instance flash.display.NativeMenu gérée par cet objet, ou la valeur null s’il n’en existe aucune. | FlexNativeMenu | ||
nestLevel : int
Profondeur de cet objet dans la hiérarchie de confinement. | FlexNativeMenu | ||
numAutomationChildren : int [lecture seule]
Nombre d’enfants d’automatisation que ce conteneur comporte. | FlexNativeMenu | ||
processedDescriptors : Boolean
Définie sur true après la création d’enfant immédiate ou différée, en fonction de celle effectuée. | FlexNativeMenu | ||
showInAutomationHierarchy : Boolean
Indicateur qui détermine si un objet d’automatisation s’affiche dans la hiérarchie d’automatisation. | FlexNativeMenu | ||
showRoot : Boolean
Indicateur booléen spécifiant si le nœud racine du fournisseur de données doit être affiché. | FlexNativeMenu | ||
updateCompletePendingFlag : Boolean
Indicateur déterminant si un objet a traversé les trois phases de validation de mise en forme (si besoin était). | FlexNativeMenu |
Méthode | Défini par | ||
---|---|---|---|
Constructeur. | FlexNativeMenu | ||
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Enregistre un objet écouteur d’événement auprès d’un objet EventDispatcher afin que l’écouteur soit averti d’un événement. | EventDispatcher | ||
Renvoie un ensemble de propriétés qui identifient l’enfant au sein de ce conteneur. | FlexNativeMenu | ||
Renvoie un ensemble de propriétés qui identifient l’enfant au sein de ce conteneur. | FlexNativeMenu | ||
Distribue un événement dans le flux d’événements. | EventDispatcher | ||
Déroule ce menu à l’emplacement spécifié. | FlexNativeMenu | ||
Fournit l’objet d’automatisation à l’index spécifié. | FlexNativeMenu | ||
Fournit la liste d’objets d’automatisation. | FlexNativeMenu | ||
Vérifie si des écouteurs sont enregistrés auprès de l’objet EventDispatcher pour un type spécifique d’événement. | EventDispatcher | ||
Indique si la propriété spécifiée d’un objet est définie. | Object | ||
Marque un composant de sorte que sa méthode commitProperties() soit appelée au cours d’une actualisation d’écran ultérieure. | FlexNativeMenu | ||
Indique si une occurrence de la classe Object figure dans la chaîne de prototype de l’objet spécifié en tant que paramètre. | Object | ||
Indique si la propriété spécifiée existe et est énumérable. | Object | ||
Supprime un écouteur de l’objet EventDispatcher. | EventDispatcher | ||
Réexécute l’événement spécifié. | FlexNativeMenu | ||
Résout un enfant en utilisant l’ID fourni. | FlexNativeMenu | ||
Définit le menu contextuel du composant InteractiveObject sur le menu natif sous-jacent. | FlexNativeMenu | ||
Définit la disponibilité d’une propriété dynamique pour les opérations en boucle. | Object | ||
Renvoie la représentation de chaîne de cet objet, formatée selon les paramètres régionaux en vigueur. | Object | ||
Renvoie la représentation sous forme de chaîne de l’objet spécifié. | Object | ||
Annule la définition du menu contextuel du composant InteractiveObject qui a été défini sur le menu natif sous-jacent. | FlexNativeMenu | ||
Valide la position et la taille des enfants, et trace d’autres effets visuels. | FlexNativeMenu | ||
Valide et actualise les propriétés et la mise en forme de cet objet, puis le retrace si nécessaire. | FlexNativeMenu | ||
Valide les propriétés d’un composant. | FlexNativeMenu | ||
Valide la taille mesurée du composant si la méthode LayoutManager.invalidateSize() est appelée avec cette interface ILayoutManagerClient, puis la méthode validateSize() est appelée lorsqu’il est temps d’effectuer les mesures. | FlexNativeMenu | ||
Renvoie la valeur primitive de l’objet spécifié. | Object | ||
Vérifie si un écouteur d’événement est enregistré auprès de cet objet EventDispatcher ou de ses ancêtres pour le type d’événement spécifié. | EventDispatcher |
Méthode | Défini par | ||
---|---|---|---|
Traite les propriétés définies sur le composant. | FlexNativeMenu | ||
Renvoie l’équivalence de touches de l’objet de données fourni en fonction des propriétés keyEquivalentField et keyEquivalentFunction. | FlexNativeMenu | ||
Renvoie les modificateurs d’équivalence de touches de l’objet de données fourni en fonction de la propriété keyEquivalentModifiersFunction. | FlexNativeMenu | ||
Renvoie la chaîne à utiliser comme étiquette d’élément de menu pour l’objet de données fourni en fonction des propriétés labelField et labelFunction. | FlexNativeMenu | ||
Renvoie l’index mnémonique de l’objet de données fourni en fonction des propriétés mnemonicIndexField et mnemonicIndexFunction. | FlexNativeMenu | ||
Extrait l’index mnémonique d’une étiquette en fonction de la présence d’un caractère de soulignement. | FlexNativeMenu | ||
Détermine l’étiquette réelle à utiliser pour le composant NativeMenuItem en supprimant les caractères de soulignement et en convertissant les caractères de soulignement ignorés, s’il en existe. | FlexNativeMenu |
Evénement | Synthèse | Défini par | ||
---|---|---|---|---|
[Evénement de diffusion] Distribué lorsque l’application Flash Player obtient le focus du système d’exploitation et devient active. | EventDispatcher | |||
[Evénement de diffusion] Distribué lorsque l’application Flash Player ou AIR perd le focus du système d’exploitation et devient inactive. | EventDispatcher | |||
Distribué lorsqu’un élément de menu est sélectionné. | FlexNativeMenu | |||
Distribué avant l’affichage d’un menu ou sous-menu. | FlexNativeMenu |
automationDelegate | propriété |
automationDelegate:Object
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | AIR 1.1 |
Objet délégué qui traite la fonction d’automatisation.
Implémentation
public function get automationDelegate():Object
public function set automationDelegate(value:Object):void
automationEnabled | propriété |
automationName | propriété |
automationOwner | propriété |
automationOwner:DisplayObjectContainer
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | AIR 1.1 |
Propriétaire de ce composant à des fins d’automatisation.
Implémentation
public function get automationOwner():DisplayObjectContainer
public function set automationOwner(value:DisplayObjectContainer):void
automationParent | propriété |
automationParent:DisplayObjectContainer
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | AIR 1.1 |
Parent de ce composant à des fins d’automatisation.
Implémentation
public function get automationParent():DisplayObjectContainer
public function set automationParent(value:DisplayObjectContainer):void
automationTabularData | propriété |
automationTabularData:Object
[lecture seule] Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | AIR 1.1 |
Implémentation de l’interface IAutomationTabularData
, qui peut être utilisée pour récupérer les données.
Implémentation
public function get automationTabularData():Object
automationValue | propriété |
automationValue:Array
[lecture seule] Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | AIR 1.1 |
Cette valeur correspond généralement à l’apparence rendue de l’objet et doit être utilisable pour associer l’identifiant à l’objet lorsqu’il apparaît visuellement dans l’application.
Implémentation
public function get automationValue():Array
automationVisible | propriété |
dataDescriptor | propriété |
dataDescriptor:IMenuDataDescriptor
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | AIR 1.1 |
Objet qui accède aux objets du fournisseur de données et les manipule. Le contrôle FlexNativeMenu délègue au descripteur de données pour obtenir des informations sur ses données. Ces données sont ensuite utilisées pour analyser et déplacer la source de données. Le descripteur de données défini pour le contrôle FlexNativeMenu est utilisé pour tous les menus enfant et les sous-menus.
Lorsque vous spécifiez cette propriété comme attribut dans MXML, vous devez utiliser une référence au descripteur de données et pas le nom de chaîne du descripteur. Utilisez le format suivant pour définir la propriété :
<mx:FlexNativeMenu id="flexNativeMenu" dataDescriptor="{new MyCustomDataDescriptor()}"/>
Vous pouvez également spécifier la propriété dans MXML comme sous-balise imbriquée, comme le montre l’exemple suivant :
<mx:FlexNativeMenu> <mx:dataDescriptor> <myCustomDataDescriptor> </mx:dataDescriptor> ...
Valeur par défaut d’une instance interne de la classe DefaultDataDescriptor.
Implémentation
public function get dataDescriptor():IMenuDataDescriptor
public function set dataDescriptor(value:IMenuDataDescriptor):void
dataProvider | propriété |
dataProvider:Object
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | AIR 1.1 |
Hiérarchie des objets qui sont utilisés pour définir la structure des éléments de menu dans le composant NativeMenu. Les objets de données individuels définissent les éléments de menu et les éléments dotés d’éléments enfant deviennent des menus et sous-menus.
Le contrôle FlexNativeMenu gère l’objet de données source comme suit :
- Une chaîne contenant du texte XML valide est convertie en objet XML.
- Un objet XMLNode est converti en objet XML.
- Un objet XMLList est converti en objet XMLListCollection.
- N’importe quel objet qui implémente l’interface ICollectionView est distribué à un objet ICollectionView.
- Un objet Array est converti en objet ArrayCollection.
- Tout autre type d’objet est enroulé dans un objet Array (l’objet étant sa seule entrée).
La valeur par défaut est "undefined".
Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement collectionChange
.
Implémentation
public function get dataProvider():Object
public function set dataProvider(value:Object):void
hasRoot | propriété |
hasRoot:Boolean
[lecture seule] Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | AIR 1.1 |
Indicateur précisant que le fournisseur de données actuel comporte un nœud racine. Par exemple, un nœud supérieur unique dans une structure hiérarchique. XML et Object sont des exemples de types dotés de nœuds racine, tandis que List and Array n’en ont pas.
Implémentation
public function get hasRoot():Boolean
initialized | propriété |
initialized:Boolean
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | AIR 1.1 |
Indicateur déterminant si un objet a traversé les trois phases de présentation : validation, mesure et présentation (si besoin était).
Implémentation
public function get initialized():Boolean
public function set initialized(value:Boolean):void
keyEquivalentField | propriété |
keyEquivalentField:String
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | AIR 1.1 |
Nom du champ dans le fournisseur de données qui détermine l’équivalence de touches de chaque élément de menu. Le jeu de valeurs est défini dans la classe Keyboard, dans les constantes KEYNAME_XXXX
. Par exemple, consultez cette liste pour connaître la valeur d’un caractère de contrôle comme Début, Inser, etc.
Si vous définissez la propriété keyEquivalentFunction
, elle est ignorée.
La valeur par défaut est "keyEquivalent".
Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement keyEquivalentChanged
.
Implémentation
public function get keyEquivalentField():String
public function set keyEquivalentField(value:String):void
Eléments de l’API associés
keyEquivalentFunction | propriété |
keyEquivalentFunction:Function
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | AIR 1.1 |
Fonction qui détermine l’équivalence de touches de chaque élément de menu. Si vous omettez cette propriété, Flex utilise le contenu du champ ou de l’attribut spécifié par la propriété keyEquivalentField
. Si vous spécifiez cette propriété, Flex ignore toute valeur de la propriété keyEquivalentField
.
La propriété keyEquivalentFunction
permet de gérer la mise en forme, la localisation et l’indépendance des plates-formes.
La fonction d’équivalence de touches doit prendre un seul argument, qui est l’élément dans le fournisseur de données et renvoyer une chaîne.
myKeyEquivalentFunction(item:Object):String
La valeur par défaut est "undefined".
Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement keyEquivalentFunctionChanged
.
Implémentation
public function get keyEquivalentFunction():Function
public function set keyEquivalentFunction(value:Function):void
Eléments de l’API associés
keyEquivalentModifiersFunction | propriété |
keyEquivalentModifiersFunction:Function
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | AIR 1.1 |
Fonction qui détermine les modificateurs d’équivalence de touches de chaque élément de menu. Si vous omettez cette propriété, Flex utilise sa propre fonction pour déterminer le tableau de modificateurs en recherchant dans les données du fournisseur de données la présence des champs (booléens) suivants : altKey
, commandKey
, controlKey
et shiftKey
.
La propriété keyEquivalentModifiersFunction
permet de gérer la mise en forme, la localisation et l’indépendance des plates-formes.
Les modificateurs d’équivalence de touches doivent prendre un seul argument, qui est l’élément dans le fournisseur de données et renvoyer un tableau de noms de touches de modificateurs.
myKeyEquivalentModifiersFunction(item:Object):Array
La valeur par défaut est "undefined".
Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement keyEquivalentModifiersFunctionChanged
.
Implémentation
public function get keyEquivalentModifiersFunction():Function
public function set keyEquivalentModifiersFunction(value:Function):void
labelField | propriété |
labelField:String
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | AIR 1.1 |
Nom du champ dans le fournisseur de données qui détermine le texte à afficher pour chaque élément de menu. Si le fournisseur de données est un tableau de chaînes, Flex utilise chaque valeur de chaîne comme libellé. Si le fournisseur de données est un objet E4X XML, vous devez définir explicitement cette propriété. Par exemple, si chaque élément XML d’un objet E4X XML inclut un attribut « label » qui comporte le texte à afficher pour chaque élément de menu, définissez la propriété labelField sur "@label"
.
Dans une étiquette, vous pouvez spécifier le caractère à utiliser comme index mnémonique en le faisant précéder d’un caractère de soulignement. Par exemple, la valeur d’étiquette "C_ut"
définit l’index mnémonique sur 1. Seul le premier caractère de soulignement présent est utilisé dans ce but. Pour afficher un caractère de soulignement littéral dans l’étiquette, utilisez deux caractères de soulignement. Par exemple, la valeur d’étiquette "C__u_t"
donnera un élément de menu portant l’étiquette « C_ut » et doté d’un index mnémonique de 3 (le caractère « t »). Si le champ défini dans la propriété mnemonicIndexField
est présent et défini sur une valeur supérieure à zéro, cette valeur a priorité par rapport à toute valeur d’index mnémonique spécifiée par un caractère de soulignement.
Si vous définissez la propriété labelFunction
, elle est ignorée.
La valeur par défaut est "label".
Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement labelFieldChanged
.
Implémentation
public function get labelField():String
public function set labelField(value:String):void
labelFunction | propriété |
labelFunction:Function
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | AIR 1.1 |
Fonction qui détermine le texte à afficher pour chaque élément de menu. La fonction d’étiquette doit trouver le ou les champs appropriés dans le fournisseur de données et renvoyer une chaîne à afficher.
Si vous omettez cette propriété, Flex utilise le contenu du champ ou de l’attribut spécifié par la propriété labelField
. Si vous spécifiez cette propriété, Flex ignore toute valeur de la propriété labelField
.
La propriété labelFunction
permet de gérer la mise en forme, la localisation et l’indépendance des plates-formes.
La fonction d’étiquette doit prendre un seul argument, qui est l’élément dans le fournisseur de données et renvoyer une chaîne.
myLabelFunction(item:Object):String
La valeur par défaut est "undefined".
Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement labelFunctionChanged
.
Implémentation
public function get labelFunction():Function
public function set labelFunction(value:Function):void
mnemonicIndexField | propriété |
mnemonicIndexField:String
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | AIR 1.1 |
Nom du champ dans le fournisseur de données qui détermine l’index mnémonique de chaque élément de menu.
Si le champ spécifié par cette propriété contient un nombre supérieur à zéro, cet index mnémonique a priorité par rapport à un autre index spécifié par un caractère de soulignement dans l’étiquette.
Si vous définissez la propriété mnemonicIndexFunction
, elle est ignorée.
La valeur par défaut est "mnemonicIndex".
Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement mnemonicIndexChanged
.
Implémentation
public function get mnemonicIndexField():String
public function set mnemonicIndexField(value:String):void
Eléments de l’API associés
mnemonicIndexFunction | propriété |
mnemonicIndexFunction:Function
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | AIR 1.1 |
Fonction qui détermine l’index mnémonique de chaque élément de menu.
Si vous omettez cette propriété, Flex utilise le contenu du champ ou de l’attribut spécifié par la propriété mnemonicIndexField
. Si vous spécifiez cette propriété, Flex ignore toute valeur de la propriété mnemonicIndexField
.
Si cette propriété est définie et que la fonction renvoie un nombre supérieur à zéro pour l’élément de données, l’index mnémonique renvoyé a priorité par rapport à celui qui est spécifié par un caractère de soulignement dans l’étiquette.
La propriété mnemonicIndexFunction
permet de gérer la mise en forme, la localisation et l’indépendance des plates-formes.
La fonction d’index mnémonique doit prendre un seul argument, qui est l’élément dans le fournisseur de données et renvoyer un nombre entier.
myMnemonicIndexFunction(item:Object):int
La valeur par défaut est "undefined".
Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement mnemonicIndexFunctionChanged
.
Implémentation
public function get mnemonicIndexFunction():Function
public function set mnemonicIndexFunction(value:Function):void
nativeMenu | propriété |
nativeMenu:NativeMenu
[lecture seule] Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | AIR 1.1 |
Renvoie l’instance flash.display.NativeMenu gérée par cet objet, ou la valeur null s’il n’en existe aucune. Toute modification apportée directement à l’instance NativeMenu sous-jacente risque d’être perdue lorsque des changements sont apportés au menu ou au fournisseur de données sous-jacent.
Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement nativeMenuUpdate
.
Implémentation
public function get nativeMenu():NativeMenu
nestLevel | propriété |
nestLevel:int
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | AIR 1.1 |
Profondeur de cet objet dans la hiérarchie de confinement. Ce nombre est utilisé par le code de mesure et de présentation. La valeur est 0 si ce composant n’est pas dans la liste DisplayList.
Implémentation
public function get nestLevel():int
public function set nestLevel(value:int):void
numAutomationChildren | propriété |
numAutomationChildren:int
[lecture seule] Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | AIR 1.1 |
Nombre d’enfants d’automatisation que ce conteneur comporte. Cette somme ne doit inclure aucun enfant composite, bien qu’elle inclue les enfants non significatifs dans la hiérarchie d’automatisation.
Implémentation
public function get numAutomationChildren():int
processedDescriptors | propriété |
processedDescriptors:Boolean
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | AIR 1.1 |
Définie sur true
après la création d’enfant immédiate ou différée, en fonction de celle effectuée. Pour un objet Container, elle est définie sur true
à la fin de la méthode createComponentsFromDescriptors()
, donc après la création des enfants du conteneur à partir de ses descripteurs enfant.
Par exemple, si un conteneur Accordion utilise l’instanciation différée, la propriété processedDescriptors
pour le deuxième volet du conteneur Accordion ne prend pas la valeur true
jusqu’à ce que l’utilisateur accède au volet et que le volet crée ses enfants. Si toutefois le composant Accordion a défini la propriété creationPolicy
sur "all"
, la propriété processedDescriptors
de son deuxième panneau est définie sur true
au démarrage de l’application.
Pour les classes qui ne sont pas des conteneurs, qui n’ont pas de descripteurs, elle est définie sur true
après la création des enfants de composant internes éventuels par la méthode createChildren()
.
Implémentation
public function get processedDescriptors():Boolean
public function set processedDescriptors(value:Boolean):void
showInAutomationHierarchy | propriété |
showInAutomationHierarchy:Boolean
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | AIR 1.1 |
Indicateur qui détermine si un objet d’automatisation s’affiche dans la hiérarchie d’automatisation. Les enfants des conteneurs qui ne sont pas visibles dans la hiérarchie apparaissent en tant qu’enfants du parent visible le plus élevé suivant. En général, les conteneurs utilisés pour la présentation (par exemple, cases et dessins) n’apparaissent pas dans la hiérarchie.
Certains contrôles forcent leurs enfants à apparaître dans la hiérarchie lorsque cela est approprié. Par exemple, une liste force toujours les fonctionnalités de rendu d’éléments, y compris les cases, à apparaître dans la hiérarchie. Les implémentateurs doivent prendre en charge la définition de cette propriété sur true
.
Implémentation
public function get showInAutomationHierarchy():Boolean
public function set showInAutomationHierarchy(value:Boolean):void
showRoot | propriété |
showRoot:Boolean
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | AIR 1.1 |
Indicateur booléen spécifiant si le nœud racine du fournisseur de données doit être affiché.
Si le fournisseur de données comporte un nœud racine et si la propriété showRoot
est définie sur false
, les éléments du menu de niveau supérieur affichés par le contrôle FlexNativeMenu correspondent aux descendants immédiats du nœud racine.
Cet indicateur n’a aucun effet lorsque vous utilisez un fournisseur de données sans nœud racine, comme l’objet List ou Array.
La valeur par défaut est true.
Implémentation
public function get showRoot():Boolean
public function set showRoot(value:Boolean):void
Eléments de l’API associés
updateCompletePendingFlag | propriété |
updateCompletePendingFlag:Boolean
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | AIR 1.1 |
Indicateur déterminant si un objet a traversé les trois phases de validation de mise en forme (si besoin était).
Implémentation
public function get updateCompletePendingFlag():Boolean
public function set updateCompletePendingFlag(value:Boolean):void
FlexNativeMenu | () | Constructeur |
public function FlexNativeMenu()
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | AIR 1.1 |
Constructeur.
commitProperties | () | méthode |
protected function commitProperties():void
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | AIR 1.1 |
Traite les propriétés définies sur le composant.
Eléments de l’API associés
createAutomationIDPart | () | méthode |
public function createAutomationIDPart(child:IAutomationObject):Object
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | AIR 1.1 |
Renvoie un ensemble de propriétés qui identifient l’enfant au sein de ce conteneur. Ces valeurs ne doivent pas changer pendant la durée de vie de l’application.
Paramètres
child:IAutomationObject — Enfant pour lequel fournir l’ID.
|
Object — Ensemble de propriétés décrivant l’enfant qui peut par la suite être utilisé pour résoudre le composant.
|
createAutomationIDPartWithRequiredProperties | () | méthode |
public function createAutomationIDPartWithRequiredProperties(child:IAutomationObject, properties:Array):Object
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | AIR 1.1 |
Renvoie un ensemble de propriétés qui identifient l’enfant au sein de ce conteneur. Ces valeurs ne doivent pas changer pendant la durée de vie de l’application.
Paramètres
child:IAutomationObject — Enfant pour lequel fournir l’ID.
| |
properties:Array |
Object — Ensemble de propriétés décrivant l’enfant qui peut par la suite être utilisé pour résoudre le composant.
|
display | () | méthode |
public function display(stage:Stage, x:int, y:int):void
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | AIR 1.1 |
Déroule ce menu à l’emplacement spécifié.
Paramètres
stage:Stage — L’objet Stage sur lequel afficher ce menu.
| |
x:int — Nombre de pixels horizontaux, par rapport à l’origine de la scène, sur laquelle afficher ce menu.
| |
y:int — Nombre de pixels verticaux, par rapport à l’origine de la scène, sur laquelle afficher ce menu.
|
getAutomationChildAt | () | méthode |
public function getAutomationChildAt(index:int):IAutomationObject
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | AIR 1.1 |
Fournit l’objet d’automatisation à l’index spécifié. Cette liste ne doit inclure aucun enfant composite.
Paramètres
index:int — Index de l’enfant à renvoyer.
|
IAutomationObject — Enfant à l’index spécifié.
|
getAutomationChildren | () | méthode |
invalidateProperties | () | méthode |
public function invalidateProperties():void
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | AIR 1.1 |
Marque un composant de sorte que sa méthode commitProperties()
soit appelée au cours d’une actualisation d’écran ultérieure.
L’invalidation est un mécanisme efficace pour éliminer la répétition inutile d’opérations. Elle retarde le traitement des modifications apportées à un composant à une actualisation d’écran ultérieure. Par exemple, si vous souhaitez modifier la couleur du texte et la taille de la police, il est inutile de mettre à jour la couleur immédiatement après sa modification, puis de réaliser une autre mise à jour pour la taille de police. Il est plus efficace de modifier les deux propriétés et de rendre le texte une seule fois avec sa nouvelle couleur et sa nouvelle taille.
Les méthodes d’invalidation sont rarement appelées. En général, le fait de définir une propriété sur un composant provoque automatiquement l’appel de la méthode d’invalidation adaptée.
itemToKeyEquivalent | () | méthode |
protected function itemToKeyEquivalent(data:Object):String
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | AIR 1.1 |
Renvoie l’équivalence de touches de l’objet de données fourni en fonction des propriétés keyEquivalentField
et keyEquivalentFunction
. Si la méthode ne peut pas convertir le paramètre en chaîne, elle renvoie une chaîne vide.
Paramètres
data:Object — Objet à afficher.
|
String — Equivalence de touche en fonction des données.
|
itemToKeyEquivalentModifiers | () | méthode |
protected function itemToKeyEquivalentModifiers(data:Object):Array
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | AIR 1.1 |
Renvoie les modificateurs d’équivalence de touches de l’objet de données fourni en fonction de la propriété keyEquivalentModifiersFunction
. Si la méthode ne peut pas convertir le paramètre en tableau de modificateurs, elle renvoie un tableau vide.
Paramètres
data:Object — Objet à afficher.
|
Array — Tableau des modificateurs d’équivalence de touches en fonction des données.
|
itemToLabel | () | méthode |
protected function itemToLabel(data:Object):String
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | AIR 1.1 |
Renvoie la chaîne à utiliser comme étiquette d’élément de menu pour l’objet de données fourni en fonction des propriétés labelField
et labelFunction
. Si la méthode ne peut pas convertir le paramètre en chaîne, elle renvoie un espace unique.
Paramètres
data:Object — Objet à afficher.
|
String — Chaîne à afficher en fonction des données.
|
itemToMnemonicIndex | () | méthode |
protected function itemToMnemonicIndex(data:Object):int
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | AIR 1.1 |
Renvoie l’index mnémonique de l’objet de données fourni en fonction des propriétés mnemonicIndexField
et mnemonicIndexFunction
. Si la méthode ne peut pas convertir le paramètre en nombre entier, elle renvoie la valeur -1.
Paramètres
data:Object — Objet à afficher.
|
int — Index mnémonique en fonction des données.
|
parseLabelToMnemonicIndex | () | méthode |
protected function parseLabelToMnemonicIndex(data:String):int
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | AIR 1.1 |
Extrait l’index mnémonique d’une étiquette en fonction de la présence d’un caractère de soulignement. Elle trouve le caractère de soulignement de début s’il existe et l’utilise comme index.
Paramètres
data:String — Données à analyser pour l’index.
|
int — Index.
|
parseLabelToString | () | méthode |
protected function parseLabelToString(data:String):String
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | AIR 1.1 |
Détermine l’étiquette réelle à utiliser pour le composant NativeMenuItem en supprimant les caractères de soulignement et en convertissant les caractères de soulignement ignorés, s’il en existe.
Paramètres
data:String — Données à analyser pour l’étiquette.
|
String — Etiquette.
|
replayAutomatableEvent | () | méthode |
public function replayAutomatableEvent(event:Event):Boolean
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | AIR 1.1 |
Réexécute l’événement spécifié. Un auteur de composant doit probablement appeler l’événement super.replayAutomatableEvent si le comportement de réexécution par défaut a été défini dans une super-classe.
Paramètres
event:Event — Evénement à réexécuter.
|
Boolean — true si une réexécution a réussi.
|
resolveAutomationIDPart | () | méthode |
public function resolveAutomationIDPart(criteria:Object):Array
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | AIR 1.1 |
Résout un enfant en utilisant l’ID fourni. L’ID est un ensemble de propriétés tel que fourni par la méthode createAutomationIDPart()
.
Paramètres
criteria:Object — Ensemble de propriétés décrivant l’enfant. Le critère peut contenir des valeurs d’expressions régulières résultant dans l’association de plusieurs enfants.
|
Array — Tableau d’enfants qui correspondent au critère ou null si aucun enfant n’a pu être résolu.
|
setContextMenu | () | méthode |
public function setContextMenu(component:InteractiveObject):void
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | AIR 1.1 |
Définit le menu contextuel du composant InteractiveObject sur le menu natif sous-jacent.
Paramètres
component:InteractiveObject — Objet interactif.
|
unsetContextMenu | () | méthode |
public function unsetContextMenu(component:InteractiveObject):void
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | AIR 1.1 |
Annule la définition du menu contextuel du composant InteractiveObject qui a été défini sur le menu natif sous-jacent.
Paramètres
component:InteractiveObject — Objet interactif.
|
validateDisplayList | () | méthode |
public function validateDisplayList():void
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | AIR 1.1 |
Valide la position et la taille des enfants, et trace d’autres effets visuels. Si la méthode LayoutManager.invalidateDisplayList()
est appelée avec cette interface ILayoutManagerClient, la méthode validateDisplayList()
est alors appelée lorsqu’il est temps de mettre à jour la liste d’affichage.
validateNow | () | méthode |
public function validateNow():void
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | AIR 1.1 |
Valide et actualise les propriétés et la mise en forme de cet objet, puis le retrace si nécessaire.
validateProperties | () | méthode |
public function validateProperties():void
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | AIR 1.1 |
Valide les propriétés d’un composant. Si la méthode LayoutManager.invalidateProperties()
est appelée avec cette interface ILayoutManagerClient, la méthode validateProperties()
est alors appelée lorsqu’il est temps de valider les valeurs de propriété.
validateSize | () | méthode |
public function validateSize(recursive:Boolean = false):void
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | AIR 1.1 |
Valide la taille mesurée du composant si la méthode LayoutManager.invalidateSize()
est appelée avec cette interface ILayoutManagerClient, puis la méthode validateSize()
est appelée lorsqu’il est temps d’effectuer les mesures.
Paramètres
recursive:Boolean (default = false ) — Si la valeur est true , cette méthode est appelée sur les enfants des objets.
|
itemClick | Evénement |
mx.events.FlexNativeMenuEvent
propriété FlexNativeMenuEvent.type =
mx.events.FlexNativeMenuEvent.ITEM_CLICK
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | AIR 1.1 |
Distribué lorsqu’un élément de menu est sélectionné.
La constante de type d’événement FlexNativeMenuEvent.ITEM_CLICK indique que l’utilisateur a sélectionné un élément de menu.Les valeurs des propriétés de l’objet d’événement de ce type d’événement sont les suivantes. Toutes les propriétés ne sont pas pertinentes pour chaque catégorie d’événements. Pour plus d’informations, voir les descriptions détaillées des propriétés.
Propriété | Valeur |
---|---|
bubbles | false |
cancelable | true |
currentTarget | Objet définissant l’écouteur d’événement qui traite l’événement. Par exemple, si vous utilisez myButton.addEventListener() pour enregistrer un écouteur d’événement, myButton est la valeur de currentTarget . |
index | Index de l’élément de menu sélectionné dans le menu. |
item | Elément sélectionné dans le fournisseur dataProvider. |
label | Texte du libellé de l’élément de menu sélectionné. |
nativeMenu | Instance NativeMenu spécifique associée à cet événement. |
nativeMenuItem | Instance NativeMenuItem spécifique associée à cet événement. |
target | Objet qui a distribué l’événement (il ne s’agit pas toujours de l’objet qui écoute l’événement). Pour accéder systématiquement à l’objet qui écoute l’événement, utilisez la propriété currentTarget . |
type | FlexNativeMenuEvent.ITEM_CLICK |
menuShow | Evénement |
mx.events.FlexNativeMenuEvent
propriété FlexNativeMenuEvent.type =
mx.events.FlexNativeMenuEvent.MENU_SHOW
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | AIR 1.1 |
Distribué avant l’affichage d’un menu ou sous-menu.
La constante de type FlexNativeMenuEvent.MENU_SHOW indique que le pointeur de la souris a survolé un menu ou un sous-menu ouvert.Les valeurs des propriétés de l’objet d’événement de ce type d’événement sont les suivantes. Toutes les propriétés ne sont pas pertinentes pour chaque catégorie d’événements. Pour plus d’informations, voir les descriptions détaillées des propriétés.
Propriété | Valeur |
---|---|
bubbles | false |
cancelable | true |
currentTarget | Objet définissant l’écouteur d’événement qui traite l’événement. Par exemple, si vous utilisez myButton.addEventListener() pour enregistrer un écouteur d’événement, myButton est la valeur de currentTarget . |
index | -1. Cette propriété n’est pas définie pour ce type d’événement. |
item | null. Cette propriété n’est pas définie pour ce type d’événement. |
label | null. Cette propriété n’est pas définie pour ce type d’événement. |
nativeMenu | Instance NativeMenu spécifique associée à cet événement. |
nativeMenuItem | null. Cette propriété n’est pas définie pour ce type d’événement. |
target | Objet qui a distribué l’événement (il ne s’agit pas toujours de l’objet qui écoute l’événement). Pour accéder systématiquement à l’objet qui écoute l’événement, utilisez la propriété currentTarget . |
type | FlexNativeMenuEvent.MENU_SHOW |
Tue Jun 12 2018, 09:30 AM Z