Guide de référence ActionScript® 3.0 pour la plate-forme Adobe® Flash®
Accueil  |  Masquer la liste des packages et des classes |  Packages  |  Classes  |  Nouveautés  |  Index  |  Annexes  |  Pourquoi existe-t-il du contenu en anglais ?
Filtres : Récupération des données du serveur...
Récupération des données du serveur...
flashx.textLayout.elements 

LinkElement  - AS3

Packageflashx.textLayout.elements
Classepublic final class LinkElement
HéritageLinkElement Inheritance SubParagraphGroupElementBase Inheritance FlowGroupElement Inheritance FlowElement Inheritance Object
Implémente IEventDispatcher

Version du langage: ActionScript 3.0
Versions du moteur d’exécution: Flash Player 10, AIR 1.5

La classe LinkElement définit un lien vers un URI, qui est exécuté lorsque l’utilisateur clique dessus. La classe LinkElement est une sous-classe de la classe SubParagraphGroupElementBase et peut contenir un ou plusieurs objets FlowElement, par exemple un objet SpanElement qui stocke le texte du lien. Un objet LinkElement vide, qui ne contient pas d’objet FlowElement, est ignoré.

Normalement, lorsque vous cliquez dessus, l’objet LinkElement appellera la méthode flash.net.navigateToURL(). Un schéma d’URI spécial event: est également pris en charge. Ce schéma générera un événement TextFlow que l’utilisateur peut écouter afin d’exécuter le code AS3. Un exemple est fourni ci-dessous.

Si vous spécifiez une cible, elle doit avoir l’une des valeurs suivantes :

Valeur cibledescription
_selfRemplace la page HTML actuelle. Si elle est dans un cadre ou un jeu de cadres, elle doit se charger dans ce cadre. S’il s’agit de la base du navigateur, il s’ouvre pour remplacer la page à partir de laquelle il provient.
_blankOuvre un nouveau nom de navigateur sans nom.
_parentRemplace la page HTML dont il provient.
_topSe charge dans le navigateur ouvert, en remplaçant tout ce qu’il contient, par exemple, un jeu de cadres.

Propriété MXML par défautmxmlChildren

Consulter les exemples

Eléments de l’API associés



Propriétés publiques
 PropriétéDéfini par
 InheritedalignmentBaseline : *
TextLayoutFormat : spécifie la ligne de base sur laquelle la ligne de base dominante s’aligne.
FlowElement
 InheritedbackgroundAlpha : *
TextLayoutFormat : valeur alpha (transparence) pour l’arrière-plan (adopte la valeur par défaut si undefined pendant la cascade).
FlowElement
 InheritedbackgroundColor : *
TextLayoutFormat : couleur d’arrière-plan du texte (adopte la valeur par défaut si undefined pendant la propagation en cascade).
FlowElement
 InheritedbaselineShift : *
TextLayoutFormat : valeur de décalage de la ligne de base par rapport à la valeur dominantBaseline.
FlowElement
 InheritedblockProgression : *
TextLayoutFormat : spécifie la progression verticale ou horizontale du positionnement de la ligne.
FlowElement
 InheritedbreakOpportunity : *
TextLayoutFormat : contrôle l’autorisation des sauts de ligne lors de la séparation de l’habillage du texte en plusieurs lignes.
FlowElement
 InheritedcffHinting : *
TextLayoutFormat : type de repère CFF utilisé pour ce texte.
FlowElement
 InheritedclearFloats : *
TextLayoutFormat : contrôle la manière dont le texte enveloppe un élément flottant.
FlowElement
 Inheritedcolor : *
TextLayoutFormat : couleur du texte.
FlowElement
 InheritedcolumnCount : *
TextLayoutFormat : nombre de colonnes de texte (adopte la valeur par défaut si la valeur est undefined pendant la propagation en cascade).
FlowElement
 InheritedcolumnGap : *
TextLayoutFormat : spécifie la quantité d’espace de gouttière, en pixels, à laisser entre les colonnes (adopte la valeur par défaut si undefined pendant la propagation en cascade).
FlowElement
 InheritedcolumnWidth : *
TextLayoutFormat : largeur de colonne en pixels (adopte la valeur par défaut si undefined pendant la propagation en cascade).
FlowElement
 InheritedcomputedFormat : flashx.textLayout.formats:ITextLayoutFormat
[lecture seule] Renvoie les attributs de format de caractère calculés qui sont appliqués à cet élément.
FlowElement
 Inheritedconstructor : Object
Référence à l’objet de classe ou à la fonction constructeur d’une occurrence donnée d’un objet.
Object
 InheritedcoreStyles : Object
[lecture seule] Renvoie l’objet coreStyles sur cet objet FlowElement.
FlowElement
 InheriteddigitCase : *
TextLayoutFormat : le type de casse de chiffres utilisée pour ce texte.
FlowElement
 InheriteddigitWidth : *
TextLayoutFormat : type de largeur de chiffres utilisée pour ce texte.
FlowElement
 Inheriteddirection : *
TextLayoutFormat : spécifie le niveau d’intégration bidirectionnelle par défaut du texte dans le bloc de texte.
FlowElement
 InheriteddominantBaseline : *
TextLayoutFormat : spécifie la ligne de base de l’élément s’alignant sur alignmentBaseline pour déterminer la position verticale de l’élément sur la ligne.
FlowElement
 InheritedfirstBaselineOffset : *
TextLayoutFormat : spécifie la position de ligne de base de la première ligne du conteneur.
FlowElement
 InheritedfontFamily : *
TextLayoutFormat : nom de la police à utiliser, ou liste de noms de police séparés par une virgule.
FlowElement
 InheritedfontLookup : *
TextLayoutFormat : recherche de police à utiliser.
FlowElement
 InheritedfontSize : *
TextLayoutFormat : taille du texte en pixels.
FlowElement
 InheritedfontStyle : *
TextLayoutFormat : style du texte.
FlowElement
 InheritedfontWeight : *
TextLayoutFormat : épaisseur du texte.
FlowElement
 Inheritedformat : flashx.textLayout.formats:ITextLayoutFormat
Propriétés TextLayoutFormat appliquées directement à cet élément.
FlowElement
  href : String
URI (Uniform Resource Identifier) associée à l’objet LinkElement.
LinkElement
 Inheritedid : String
Attribue un identifiant à l’élément. De fait, il est possible de définir le style de l’élément, vous pouvez donc référencer l’identifiant.
FlowElement
 InheritedjustificationRule : *
TextLayoutFormat : règle utilisée pour justifier le texte dans un paragraphe.
FlowElement
 InheritedjustificationStyle : *
TextLayoutFormat : style utilisé pour la justification du paragraphe.
FlowElement
 Inheritedkerning : *
TextLayoutFormat : le crénage ajuste les pixels entre certaines paires de caractères pour améliorer la lisibilité.
FlowElement
 InheritedleadingModel : *
TextLayoutFormat : spécifie le modèle d’interlignage, qui est une combinaison de la base et de la direction de l’interlignage.
FlowElement
 InheritedligatureLevel : *
TextLayoutFormat : contrôle laquelle des ligatures qui sont définies dans la police peut être utilisée dans le texte.
FlowElement
 InheritedlineBreak : *
TextLayoutFormat : contrôle le retour à la ligne dans le conteneur (adopte la valeur par défaut si undefined pendant cascade).
FlowElement
 InheritedlineHeight : *
TextLayoutFormat : contrôles d’interlignage pour le texte.
FlowElement
 InheritedlineThrough : *
TextLayoutFormat : si la valeur est true, applique le style de formatage barré, une ligne au milieu du texte.
FlowElement
 InheritedlinkActiveFormat : *
TextLayoutFormat : définit les attributs de mise en forme utilisés pour les liens à l’état normal.
FlowElement
 InheritedlinkHoverFormat : *
TextLayoutFormat : définit les attributs de mise en forme utilisés pour les liens à l’état pointé, c’est-à-dire lorsque l’utilisateur survole un lien avec la souris.
FlowElement
 InheritedlinkNormalFormat : *
TextLayoutFormat : définit les attributs de mise en forme utilisés pour les liens à l’état normal.
FlowElement
  linkState : String
[lecture seule] L’état actuel du lien.
LinkElement
 InheritedlistAutoPadding : *
TextLayoutFormat : spécifie un retrait automatique pour le bord de début des listes, lorsque la valeur d’espacement de la liste de ce côté est auto.
FlowElement
 InheritedlistMarkerFormat : *
TextLayoutFormat : définit les marqueurs de liste d’attributs de mise en forme.
FlowElement
 InheritedlistStylePosition : *
TextLayoutFormat : les valeurs valides sont ListStylePosition.INSIDE, ListStylePosition.OUTSIDE et FormatValue.INHERIT. La valeur par défaut est undefined, ce qui indique qu’elle n’est pas définie. Si lors de la propagation en cascade, la valeur est undefined, cette propriété héritera ses valeurs d’un ancêtre.
FlowElement
 InheritedlistStyleType : *
TextLayoutFormat : les valeurs valides sont ListStyleType.UPPER_ALPHA, ListStyleType.LOWER_ALPHA, ListStyleType.UPPER_ROMAN, ListStyleType.LOWER_ROMAN, ListStyleType.NONE, ListStyleType.DISC, ListStyleType.CIRCLE, ListStyleType.SQUARE, ListStyleType.BOX, ListStyleType.CHECK, ListStyleType.DIAMOND, ListStyleType.HYPHEN, ListStyleType.ARABIC_INDIC, ListStyleType.BENGALI, ListStyleType.DECIMAL, ListStyleType.DECIMAL_LEADING_ZERO, ListStyleType.DEVANAGARI, ListStyleType.GUJARATI, ListStyleType.GURMUKHI, ListStyleType.KANNADA, ListStyleType.PERSIAN, ListStyleType.THAI, ListStyleType.URDU, ListStyleType.CJK_EARTHLY_BRANCH, ListStyleType.CJK_HEAVENLY_STEM, ListStyleType.HANGUL, ListStyleType.HANGUL_CONSTANT, ListStyleType.HIRAGANA, ListStyleType.HIRAGANA_IROHA, ListStyleType.KATAKANA, ListStyleType.KATAKANA_IROHA, ListStyleType.LOWER_ALPHA, ListStyleType.LOWER_GREEK, ListStyleType.LOWER_LATIN, ListStyleType.UPPER_ALPHA, ListStyleType.UPPER_GREEK, ListStyleType.UPPER_LATIN et FormatValue.INHERIT. La valeur par défaut est undefined, ce qui indique qu’elle n’est pas définie. Si lors de la propagation en cascade, la valeur est undefined, cette propriété héritera ses valeurs d’un ancêtre.
FlowElement
 Inheritedlocale : *
TextLayoutFormat : paramètres régionaux du texte.
FlowElement
 InheritedmxmlChildren : Array
Ajoute un tableau d’enfants à cet objet.
FlowGroupElement
 InheritednumChildren : int
[lecture seule] Renvoie le nombre d’enfants FlowElement que possède cet objet FlowGroupElement.
FlowGroupElement
 InheritedpaddingBottom : *
TextLayoutFormat : encart inférieur en pixels.
FlowElement
 InheritedpaddingLeft : *
TextLayoutFormat : encart à gauche en pixels.
FlowElement
 InheritedpaddingRight : *
TextLayoutFormat : encart à droite en pixels.
FlowElement
 InheritedpaddingTop : *
TextLayoutFormat : encart supérieur en pixels.
FlowElement
 InheritedparagraphEndIndent : *
TextLayoutFormat : nombre qui indique, en pixels, la valeur de retrait du bord de la fin du paragraphe.
FlowElement
 InheritedparagraphSpaceAfter : *
TextLayoutFormat : un nombre qui spécifie la quantité d’espace, en pixels, à laisser après le paragraphe.
FlowElement
 InheritedparagraphSpaceBefore : *
TextLayoutFormat : nombre qui spécifie la quantité d’espace, en pixels, à conserver avant le paragraphe.
FlowElement
 InheritedparagraphStartIndent : *
TextLayoutFormat : nombre qui indique, en pixels, la valeur de retrait du bord du début du paragraphe.
FlowElement
 Inheritedparent : FlowGroupElement
[lecture seule] Renvoie le parent de ce objet FlowElement.
FlowElement
 InheritedparentRelativeEnd : int
[lecture seule] Renvoie la fin relative de cet objet FlowElement dans le parent.
FlowElement
 InheritedparentRelativeStart : int
[lecture seule] Renvoie le début relatif de cet objet FlowElement dans le parent.
FlowElement
 InheritedrenderingMode : *
TextLayoutFormat : mode de rendu utilisé pour ce texte.
FlowElement
 InheritedstyleName : *
TextLayoutFormat : attribue une classe d’identification à l’élément, ce qui permet de définir le style de l’élément en référençant la propriété styleName.
FlowElement
 Inheritedstyles : Object
[lecture seule] Renvoie les styles sur cet objet FlowElement.
FlowElement
 InheritedtabStops : *
TextLayoutFormat : spécifie les taquets de tabulation associés au paragraphe.
FlowElement
  target : String
La valeur cible associée à l’objet LinkElement.
LinkElement
 InheritedtextAlign : *
TextLayoutFormat : alignement des lignes du paragraphe par rapport au conteneur.
FlowElement
 InheritedtextAlignLast : *
TextLayoutFormat : alignement de la dernière (ou unique) ligne dans le paragraphe par rapport au conteneur dans un texte justifié.
FlowElement
 InheritedtextAlpha : *
TextLayoutFormat : valeur alpha (transparence) du texte.
FlowElement
 InheritedtextDecoration : *
TextLayoutFormat : décoration du texte.
FlowElement
 InheritedtextIndent : *
TextLayoutFormat : nombre qui indique la quantité, en pixels, pour mettre en retrait la première ligne du paragraphe.
FlowElement
 InheritedtextJustify : *
TextLayoutFormat : spécifie des options de justification de texte.
FlowElement
 InheritedtextLength : int
[lecture seule] Renvoie la longueur totale de texte administrée par cet objet FlowElement et ses enfants.
FlowElement
 InheritedtextRotation : *
TextLayoutFormat : détermine le nombre de degrés de rotation de ce texte.
FlowElement
 Inheritedtracking : Object
[écriture seule] Définit le suivi et est synonyme de la propriété trackingRight.
FlowElement
 InheritedtrackingLeft : *
TextLayoutFormat : nombre de pixels (ou pourcentage de taille fontSize, comme 120 %) indiquant la quantité de l’approche (crénage manuel) à appliquer à gauche de chaque caractère.
FlowElement
 InheritedtrackingRight : *
TextLayoutFormat : nombre de pixels (ou pourcentage de taille fontSize, comme 120 %) indiquant la quantité de l’approche (crénage manuel) à appliquer à droite de chaque caractère.
FlowElement
 InheritedtypeName : String
Chaque objet FlowElement a une propriété typeName.
FlowElement
 InheritedtypographicCase : *
TextLayoutFormat : le type de casse typographique utilisée pour ce texte.
FlowElement
 InheriteduserStyles : Object
Permet de lire les styles d’écriture de l’utilisateur sur un objet FlowElement.
FlowElement
 InheritedverticalAlign : *
TextLayoutFormat : alignement vertical ou justification (adopte la valeur par défaut si undefined pendant la propagation en cascade).
FlowElement
 InheritedwhiteSpaceCollapse : *
TextLayoutFormat : réduit ou conserve les espaces lors de l’importation de texte dans un TextFlow.
FlowElement
 InheritedwordSpacing : *
TextLayoutFormat : spécifie les espacements optimal, minimal et maximal (comme multiplicateur de la largeur d’un espace normal) entres les mots à utiliser lors de la justification.
FlowElement
Méthodes publiques
 MéthodeDéfini par
  
Constructeur : crée une nouvelle occurrence LinkElement.
LinkElement
 Inherited
Ajoute un objet FlowElement objet.
FlowGroupElement
 Inherited
Ajoute un objet FlowElement enfant à la position d’index spécifiée.
FlowGroupElement
  
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.
LinkElement
 Inherited
Supprime le style spécifié par le paramètre styleProp à partir de cet objet FlowElement.
FlowElement
 Inherited
deepCopy(relativeStart:int = 0, relativeEnd:int = -1):FlowElement
Effectue une copie en profondeur de cette objet FlowElement, y compris tout enfant, copiant le contenu entre les deux emplacements de caractère et renvoyant la copie en tant qu’objet FlowElement.
FlowElement
  
Distribue un événement dans le flux d’événements.
LinkElement
 Inherited
Comparez ces styles utilisateur avec les styles utilisateur d’autres éléments.
FlowElement
 Inherited
findChildIndexAtPosition(relativePosition:int):int
En fonction d’une position de texte relative, recherchez l’index du premier objet FlowElement enfant qui contient la position relative.
FlowGroupElement
 Inherited
findLeaf(relativePosition:int):FlowLeafElement
En fonction d’une position du texte relative, recherchez l’élément de nœud terminal qui contient la position.
FlowGroupElement
 Inherited
Renvoie l’emplacement de départ de l’élément dans l’enchaînement de texte avec un index absolu.
FlowElement
 Inherited
getCharAtPosition(relativePosition:int):String
Renvoie le caractère à la position spécifiée, par rapport à cet objet FlowElement.
FlowElement
 Inherited
getCharCodeAtPosition(relativePosition:int):int
Renvoie le code de caractère à la position spécifiée, par rapport à cet objet FlowElement.
FlowElement
 Inherited
Renvoie l’enfant de l’objet FlowElement à l’index spécifié.
FlowGroupElement
 Inherited
Recherche dans les enfants pour l’objet FLowElement et renvoie sa position d’index.
FlowGroupElement
 Inherited
Renvoie la valeur de début de cet élément par rapport à l’élément ancêtre.
FlowElement
 Inherited
Renvoie le premier objet FlowLeafElement descendant de ce groupe.
FlowGroupElement
 Inherited
Renvoie le dernier objet FlowLeafElement descendant de ce groupe.
FlowGroupElement
 Inherited
Renvoie le prochain objet FlowElement frère dans la hiérarchie de l’enchaînement de texte.
FlowElement
 Inherited
Renvoie l’objet ParagraphElement associé à cet élément.
FlowElement
 Inherited
Renvoie l’objet FlowElement frère précédent dans la hiérarchie de l’enchaînement de texte.
FlowElement
 Inherited
getStyle(styleProp:String):*
Renvoie la valeur du style spécifié par le paramètre styleProp, qui spécifie le nom du style et peut être n’importe quel nom de style d’utilisateur.
FlowElement
 Inherited
getText(relativeStart:int = 0, relativeEnd:int = -1, paragraphSeparator:String = " "):String
[override]
FlowGroupElement
 Inherited
Gravit la hiérarchie de l’enchaînement de texte pour renvoyer l’objet TextFlow racine pour l’élément.
FlowElement
  
Vérifie si des écouteurs sont enregistrés auprès de l’objet EventDispatcher pour un type spécifique d’événement.
LinkElement
 Inherited
Indique si la propriété spécifiée d’un objet est définie.
Object
 Inherited
Appelé pour des objets MXML une fois que l’objet d’implémentation a été créé et que toutes les propriétés de composants spécifiées sur la balise MXML ont été initialisées.
FlowElement
 Inherited
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
 Inherited
Indique si la propriété spécifiée existe et est énumérable.
Object
 Inherited
Supprime l’objet FlowElement enfant spécifié du groupe.
FlowGroupElement
 Inherited
Supprime l’objet FlowElement enfant de la position d’index spécifiée.
FlowGroupElement
  
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Supprime un écouteur de l’objet EventDispatcher.
LinkElement
 Inherited
replaceChildren(beginChildIndex:int, endChildIndex:int, ... rest):void
Remplace les éléments enfant dans le groupe avec les nouveaux éléments spécifiés.
FlowGroupElement
 Inherited
Définit la disponibilité d’une propriété dynamique pour les opérations en boucle.
Object
 Inherited
setStyle(styleProp:String, newValue:*):void
Définit le style spécifié par le paramètre styleProp à la valeur spécifiée par le paramètre newValue.
FlowElement
 Inherited
shallowCopy(relativeStart:int = 0, relativeEnd:int = -1):FlowElement
Effectue une copie de cet objet FlowElement, copie le contenu entre deux positions de caractères spécifiées.
FlowElement
 Inherited
Divise cet objet à la position spécifiée par le paramètre childIndex.
FlowGroupElement
 Inherited
splitAtPosition(relativePosition:int):FlowElement
Divise cet objet FlowElement à la position spécifiée par le paramètre relativePosition, qui est une position relative dans le texte pour cet élément.
FlowElement
 Inherited
Renvoie la représentation de chaîne de cet objet, formatée selon les paramètres régionaux en vigueur.
Object
 Inherited
Renvoie la représentation sous forme de chaîne de l’objet spécifié.
Object
 Inherited
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é.
LinkElement
Evénements
 Evénement Synthèse Défini par
  Distribué lorsque le lien est activé.LinkElement
  Distribué lorsque l’utilisateur clique sur le bouton de la souris sur un lien.LinkElement
  Distribué lorsque la souris survole le lien.LinkElement
  Distribué lorsque le bouton de la souris est relâché au-dessus d’un lien.LinkElement
  Distribué lorsque la souris sort du lien.LinkElement
  Distribué lorsque la souris entre pour la première fois dans le lien.LinkElement
Détails de la propriété

href

propriété
href:String

Version du langage: ActionScript 3.0
Versions du moteur d’exécution: Flash Player 10, AIR 1.5

URI (Uniform Resource Identifier) associée à l’objet LinkElement. L’URI peut être tout URI pris en charge par la méthode flash.net.navigateToURL(). Cette propriété est mappée au paramètre request pour cette méthode. L’URI peut également être de la forme event:eventType. Lorsque vous cliquez dessus, l’objet TextFlow générera un événement du type eventType.



Implémentation
    public function get href():String
    public function set href(value:String):void

Eléments de l’API associés

linkState

propriété 
linkState:String  [lecture seule]

Version du langage: ActionScript 3.0
Versions du moteur d’exécution: Flash Player 10, AIR 1.5

L’état actuel du lien.



Implémentation
    public function get linkState():String

Eléments de l’API associés

target

propriété 
target:String

Version du langage: ActionScript 3.0
Versions du moteur d’exécution: Flash Player 10, AIR 1.5

La valeur cible associée à l’objet LinkElement. Les valeurs possibles sont « _self », « _blank », « _parent » et « _top ». Cette valeur est mappée au paramètre window de la méthode flash.net.navigateToURL().



Implémentation
    public function get target():String
    public function set target(value:String):void

Eléments de l’API associés

Détails du constructeur

LinkElement

()Constructeur
public function LinkElement()

Version du langage: ActionScript 3.0
Versions du moteur d’exécution: Flash Player 10, AIR 1.5

Constructeur : crée une nouvelle occurrence LinkElement.

Détails de la méthode

addEventListener

()méthode
public function addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void

Version du langage: ActionScript 3.0
Versions du moteur d’exécution: Flash Player 10, AIR 1.5

Enregistre un objet écouteur d’événement auprès d’un objet EventDispatcher afin que l’écouteur soit averti d’un événement. Vous pouvez enregistrer les écouteurs d’événement dans tous les nœuds de la liste d’affichage pour un type spécifique d’événement, de phase et de priorité.

Après l’enregistrement d’un écouteur d’événement, vous ne pouvez plus modifier sa priorité par d’autres appels de addEventListener(). Pour modifier la priorité d’un écouteur, vous devez d’abord appeler removeEventListener(). Vous pouvez ensuite réenregistrer l’écouteur avec le nouveau niveau de priorité.

Après l’enregistrement de l’écouteur, tous les futurs appels de addEventListener() avec une valeur type ou useCapture différente entraîneront la création d’un autre enregistrement d’écouteur. Si, par exemple, vous enregistrez un écouteur dans lequel la propriété useCapture est définie sur true, il écoute uniquement pendant la phase de capture. Si vous appelez addEventListener() à l’aide du même objet écouteur, mais en définissant useCapture sur false, vous obtenez deux écouteurs distincts : l’un qui écoute pendant la phase de capture et l’autre qui écoute pendant les phases cible et de propagation vers le haut.

Il est impossible d’enregistrer un écouteur d’événement uniquement pour la phase cible ou la phase de propagation vers le haut. Ces deux phases sont associées pendant l’enregistrement car la propagation vers le haut s’applique uniquement aux ancêtres du nœud cible.

Si vous n’avez plus besoin d’un écouteur d’événement, supprimez-le en appelant EventDispatcher.removeEventListener(), pour éviter tout problème de mémoire. Les objets associés à des écouteurs d’événement enregistrés ne sont pas automatiquement supprimés de la mémoire, car le nettoyeur de mémoire n’efface pas les objets auxquels il est toujours fait référence.

Lors de la copie d’une occurrence d’EventDispatcher, les écouteurs d’événement qui lui sont associés ne sont pas pris en compte (si le nouveau nœud nécessite un écouteur d’événement, vous devez associer celui-ci après la création du nœud). Toutefois, si vous déplacez une occurrence d’EventDispatcher, les écouteurs d’événement qui lui sont associés la suivent.

Si un écouteur d’événement est enregistré sur un nœud alors qu’un événement est en cours de traitement sur ce nœud, l’écouteur n’est pas déclenché pendant la phase actuelle, mais il peut l’être pendant une phase ultérieure du flux d’événements, telle que la phase de propagation vers le haut.

Si un écouteur d’événement est supprimé d’un nœud sur lequel un événement est en cours de traitement, il est cependant déclenché par les actions en cours. Une fois supprimé, l’écouteur d’événement n’est plus jamais appelé (à moins d’être réenregistré à des fins de traitement ultérieur).

Paramètres

type:String — Type d’événement.
 
listener:Function — Fonction d’auditeur qui traite l’événement. Cette fonction doit accepter un objet Event comme paramètre unique et ne rien renvoyer, comme dans l’exemple ci-dessous :

function(evt:Event):void

Le nom de cette fonction n’a aucune importance.
 
useCapture:Boolean (default = false) — Détermine si l’écouteur est actif pendant la phase de capture ou pendant les phases cible et de propagation vers le haut. Si la propriété useCapture est définie sur true, l’écouteur traite l’événement uniquement pendant la phase de capture et non pendant les phases cible et de propagation. Si la propriété useCapture est définie sur false, l’écouteur traite l’événement uniquement pendant les phases cible et de propagation. Pour écouter l’événement dans les trois phases, appelez addEventListener() à deux reprises, une première fois avec la propriété useCapture définie sur true, puis une nouvelle fois avec useCapture définie sur false.
 
priority:int (default = 0) — Niveau de priorité de l’écouteur d’événement. La priorité est désignée par un entier de 32 bits. Plus le nombre est élevé, plus la priorité est élevée. Tous les écouteurs de priorité n sont traités avant les écouteurs de priorité n-1. Les écouteurs dont la priorité est identique sont traités dans l’ordre où ils ont été ajoutés. La priorité par défaut est 0.
 
useWeakReference:Boolean (default = false) — Détermine si la référence à l’écouteur est forte ou faible. Une référence forte (valeur par défaut) empêche le nettoyage de votre écouteur, Cela n’est pas le cas avec une référence faible.

Les fonctions de membres de niveau classe n’étant pas soumises au nettoyage, vous pouvez définir useWeakReference sur true pour ces fonctions. Si vous définissez useWeakReference sur true pour un écouteur correspondant à une fonction imbriquée interne, la fonction sera nettoyée et ne sera donc pas permanente. Si vous créez des références à la fonction interne (enregistrée dans une autre variable), celle-ci n’est pas nettoyée et reste permanente.

dispatchEvent

()méthode 
public function dispatchEvent(evt:Event):Boolean

Version du langage: ActionScript 3.0
Versions du moteur d’exécution: Flash Player 10, AIR 1.5

Distribue un événement dans le flux d’événements. La cible de l’événement est l’objet EventDispatcher sur lequel la méthode dispatchEvent() est appelée.

Paramètres

evt:Event — Objet d’événement distribué dans le flux d’événements.

Valeur renvoyée
Booleantrue, sauf si la méthode preventDefault() est appelée sur l’événement, auquel cas la valeur false est renvoyée.

hasEventListener

()méthode 
public function hasEventListener(type:String):Boolean

Version du langage: ActionScript 3.0
Versions du moteur d’exécution: Flash Player 10, AIR 1.5

Vérifie si des écouteurs sont enregistrés auprès de l’objet EventDispatcher pour un type spécifique d’événement. Vous pouvez ainsi déterminer précisément où un objet EventDispatcher a modifié la gestion d’un type d’événement dans la hiérarchie du flux d’événements. Pour savoir si un type d’événement spécifique déclenche réellement un écouteur d’événement, utilisez IEventDispatcher.willTrigger().

La différence entre les méthodes hasEventListener() et willTrigger() est la suivante : hasEventListener() examine uniquement l’objet auquel elle appartient, tandis que willTrigger() recherche dans la totalité du flux d’événements l’événement spécifié par le paramètre type.

Paramètres

type:String — Type d’événement.

Valeur renvoyée
Boolean — La valeur true est renvoyée si un écouteur du type spécifié est enregistré. La valeur false est renvoyée dans tous les autres cas.

removeEventListener

()méthode 
public function removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void

Version du langage: ActionScript 3.0
Versions du moteur d’exécution: Flash Player 10, AIR 1.5

Supprime un écouteur de l’objet EventDispatcher. Si aucun écouteur correspondant n’est enregistré auprès de l’objet EventDispatcher, l’appel de cette méthode n’a aucun effet.

Paramètres

type:String — Type d’événement.
 
listener:Function — Objet écouteur à supprimer.
 
useCapture:Boolean (default = false) — Détermine si l’écouteur a été enregistré pendant la phase de capture ou pendant les phases cible et de propagation vers le haut. Si l’écouteur a été enregistré pendant la phase de capture et pendant les phases cible et de propagation vers le haut, il est nécessaire d’appeler removeEventListener() à deux reprises pour le supprimer : une première fois en définissant useCapture sur true, puis une seconde fois avec la propriété useCapture définie sur false.

willTrigger

()méthode 
public function willTrigger(type:String):Boolean

Version du langage: ActionScript 3.0
Versions du moteur d’exécution: Flash Player 10, AIR 1.5

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é. Cette méthode renvoie true si un écouteur d’événement est déclenché pendant toute phase du flux d’événements lorsqu’un événement du type spécifié est distribué à cet objet EventDispatcher ou à l’un de ses descendants.

La différence entre les méthodes hasEventListener() et willTrigger() est la suivante : hasEventListener() examine uniquement l’objet auquel elle appartient, tandis que willTrigger() recherche dans la totalité du flux d’événements l’événement spécifié par le paramètre type.

Paramètres

type:String — Type d’événement.

Valeur renvoyée
Boolean — Renvoie true si un écouteur du type spécifié est enregistré, false dans tous les autres cas.
Détails de l’événement

click

Evénement
Type d’objet d’événement: flashx.textLayout.events.FlowElementMouseEvent
propriété FlowElementMouseEvent.type = flashx.textLayout.events.FlowElementMouseEvent.CLICK

Version du langage: ActionScript 3.0
Versions du moteur d’exécution: Flash Player 10, AIR 1.5

Distribué lorsque le lien est activé. Les clients peuvent remplacer la façon dont le lien gère cet événement en le gérant eux-mêmes et en appelant par défaut preventDefault().

Définit la valeur de la propriété type d’un objet d’événement click.

mouseDown

Evénement  
Type d’objet d’événement: flashx.textLayout.events.FlowElementMouseEvent
propriété FlowElementMouseEvent.type = flashx.textLayout.events.FlowElementMouseEvent.MOUSE_DOWN

Version du langage: ActionScript 3.0
Versions du moteur d’exécution: Flash Player 10, AIR 1.5

Distribué lorsque l’utilisateur clique sur le bouton de la souris sur un lien.

Définit la valeur de la propriété type d’un objet d’événement mouseDown.

mouseMove

Evénement  
Type d’objet d’événement: flashx.textLayout.events.FlowElementMouseEvent
propriété FlowElementMouseEvent.type = flashx.textLayout.events.FlowElementMouseEvent.MOUSE_MOVE

Version du langage: ActionScript 3.0
Versions du moteur d’exécution: Flash Player 10, AIR 1.5

Distribué lorsque la souris survole le lien.

Définit la valeur de la propriété type d’un objet d’événement mouseMove.

mouseUp

Evénement  
Type d’objet d’événement: flashx.textLayout.events.FlowElementMouseEvent
propriété FlowElementMouseEvent.type = flashx.textLayout.events.FlowElementMouseEvent.MOUSE_UP

Version du langage: ActionScript 3.0
Versions du moteur d’exécution: Flash Player 10, AIR 1.5

Distribué lorsque le bouton de la souris est relâché au-dessus d’un lien.

Définit la valeur de la propriété type d’un objet d’événement mouseUp.

rollOut

Evénement  
Type d’objet d’événement: flashx.textLayout.events.FlowElementMouseEvent
propriété FlowElementMouseEvent.type = flashx.textLayout.events.FlowElementMouseEvent.ROLL_OUT

Version du langage: ActionScript 3.0
Versions du moteur d’exécution: Flash Player 10, AIR 1.5

Distribué lorsque la souris sort du lien.

Définit la valeur de la propriété type d’un objet d’événement rollOut.

rollOver

Evénement  
Type d’objet d’événement: flashx.textLayout.events.FlowElementMouseEvent
propriété FlowElementMouseEvent.type = flashx.textLayout.events.FlowElementMouseEvent.ROLL_OVER

Version du langage: ActionScript 3.0
Versions du moteur d’exécution: Flash Player 10, AIR 1.5

Distribué lorsque la souris entre pour la première fois dans le lien.

Définit la valeur de la propriété type d’un objet d’événement rollOver.
LinkElementExample.as

Cet exemple ajoute un objet LinkElement à un paragraphe et remplace le format par défaut pour l’état suspendu, le texte du lien devient rouge.
package flashx.textLayout.elements.examples
{
    import flash.display.Sprite;    
    import flashx.textLayout.container.ContainerController;
    import flashx.textLayout.elements.LinkElement;
    import flashx.textLayout.elements.ParagraphElement;
    import flashx.textLayout.elements.SpanElement;
    import flashx.textLayout.elements.TextFlow;
    import flashx.textLayout.formats.TextLayoutFormat;
    
    public class LinkElementExample extends Sprite
    {
        public function LinkElementExample()
        {
            var textFlow:TextFlow = new TextFlow();
            var textLayoutFormat:TextLayoutFormat = new TextLayoutFormat();
          
            textLayoutFormat.fontFamily = "Arial, Helvetica, _sans";
            textLayoutFormat.fontSize = 18;
            textFlow.hostFormat = textLayoutFormat;

            var p:ParagraphElement = new ParagraphElement();
            var span1:SpanElement = new SpanElement();
            var link:LinkElement = new LinkElement();
            var span2:SpanElement = new SpanElement();
            var inf:Object = {color:0xFF0000};   
            p.linkHoverFormat = inf;
            span1.text = "Text that includes a link to "; 
            link.href = "http://www.adobe.com";
            var linkSpan:SpanElement = new SpanElement();
            linkSpan.text = "Adobe's website";
            link.addChild(linkSpan);
            span2.text = ". Notice the custom formatting when the cursor hovers " + 
                    "over the link.";
            p.addChild(span1);
            p.addChild(link);
            p.addChild(span2);
            textFlow.addChild(p);
            textFlow.flowComposer.addController(new ContainerController(this,stage.stageWidth, stage.stageHeight));
            textFlow.flowComposer.updateAllControllers();
        }
    }
}
LinkElementEventExample.as

Cet exemple utilise le modèle d’URI event: pour générer un événement permettant d’exécuter du code ActionScript sur un simple clic.
package flashx.textLayout.elements.examples
{
    import flash.display.Sprite;
    
    import flashx.textLayout.container.ContainerController;
    import flashx.textLayout.elements.LinkElement;
    import flashx.textLayout.elements.ParagraphElement;
    import flashx.textLayout.elements.SpanElement;
    import flashx.textLayout.elements.TextFlow;
    import flashx.textLayout.events.FlowElementMouseEvent;
    import flashx.textLayout.formats.TextLayoutFormat;
    
    public class LinkElementEventExample extends Sprite
    {
        public function LinkElementEventExample()
        {
            var textFlow:TextFlow = new TextFlow();
          
            textFlow.fontFamily = "Arial, Helvetica, _sans";
            textFlow.fontSize = 18;
            textFlow.paddingLeft = textFlow.paddingRight = textFlow.paddingTop = 20;

            var p:ParagraphElement = new ParagraphElement();
            var span1:SpanElement = new SpanElement();
            var link:LinkElement = new LinkElement();
            var span2:SpanElement = new SpanElement();
            span1.text = "Text that includes a link to "; 
            link.href = "event:changeTextFlowColor";
            var linkSpan:SpanElement = new SpanElement();
            linkSpan.text = "custom event code"
            link.addChild(linkSpan);
            span2.text = ". Clicking the link changes the default color of the TextFlow";
            p.addChild(span1);
            p.addChild(link);
            p.addChild(span2);
            textFlow.addChild(p);
            textFlow.flowComposer.addController(new ContainerController(this,stage.stageWidth, stage.stageHeight));
            textFlow.flowComposer.updateAllControllers();
            textFlow.addEventListener("changeTextFlowColor",changeTextFlowColor)
        }

        private function changeTextFlowColor(e:FlowElementMouseEvent):void
        {
            var textFlow:TextFlow = e.flowElement.getTextFlow();
            textFlow.color = textFlow.color == 0x00ff00 ? 0 : 0x00ff00;
            textFlow.flowComposer.updateAllControllers();
        }
    }
}




[ X ]Pourquoi existe-t-il du contenu en anglais ?
Certaines parties du Guide de référence ActionScript 3.0 sont en anglais

Tout le contenu du Guide de référence ActionScript 3.0 n’a pas été traduit dans toutes les langues. Si un élément de langage n’est pas traduit, il s’affiche en anglais. Par exemple, la classe ga.controls.HelpBox n’est traduite dans aucune langue. Ainsi, dans la version française du guide de référence, la classe ga.controls.HelpBox apparaît en anglais.