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.events 

FlowElementMouseEvent  - AS3

Packageflashx.textLayout.events
Classepublic class FlowElementMouseEvent
HéritageFlowElementMouseEvent Inheritance Event Inheritance Object

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

Un élément de lien distribue cet événement lorsqu’il détecte une activité de la souris. Text Layout Framework inclut cette version spéciale des événements de souris, car ces derniers sont généralement indésirables lorsqu’un élément d’enchaînement est intégré dans un enchaînement de texte modifiable, et parce que les éléments de lien ne sont pas dans la liste d’affichage (ce ne sont pas des éléments DisplayObject).

Vous pouvez ajouter un écouteur d’événement à un élément de lien pour être à l’écoute de ce type d’événement. Si vous choisissez d’annuler l’événement en appelant la méthode Event.preventDefault(), le comportement par défaut associé à l’événement ne se produit pas.

Si vous choisissez de ne pas ajouter d’écouteur d’événement à l’élément de lien ou si votre fonction d’écouteur d’événement n’annule pas le comportement, l’événement est redistribué, mais cette fois par l’occurrence de TextFlow associée de l’élément de lien, et non par l’élément de lien lui-même. Cela fournit une deuxième opportunité d’écouter cet événement avec un écouteur d’événement associé à l’objet TextFlow.

Les événements FlowElementMouseEvent ne sont distribués que lorsque le texte ne peut pas être modifié ou lorsque la touche Ctrl est activée en simultané avec une action de la souris.

Les six types d’événements suivants ne sont distribués que lorsque le texte ne peut pas être modifié ou lorsque la touche Ctrl est activée :

  • FlowElementMouseEvent.CLICK
  • FlowElementMouseEvent.MOUSE_DOWN
  • FlowElementMouseEvent.MOUSE_UP
  • FlowElementMouseEvent.MOUSE_MOVE
  • FlowElementMouseEvent.ROLL_OVER
  • FlowElementMouseEvent.ROLL_OUT

Consulter les exemples

Eléments de l’API associés



Propriétés publiques
 PropriétéDéfini par
 Inheritedbubbles : Boolean
[lecture seule] Indique si un événement peut se propager vers le haut (bubbling).
Event
 Inheritedcancelable : Boolean
[lecture seule] Indique si le comportement associé à l’événement peut être évité.
Event
 Inheritedconstructor : Object
Référence à l’objet de classe ou à la fonction constructeur d’une occurrence donnée d’un objet.
Object
 InheritedcurrentTarget : Object
[lecture seule] L’objet qui traite activement l’objet Event avec un écouteur d’événements.
Event
 InheritedeventPhase : uint
[lecture seule] Phase actuelle du flux d’événements.
Event
  flowElement : FlowElement
Elément FlowElement qui a distribué l’événement.
FlowElementMouseEvent
  originalEvent : MouseEvent
Evénement de souris d’origine généré par l’activité de la souris.
FlowElementMouseEvent
 Inheritedtarget : Object
[lecture seule] Cible de l’événement.
Event
 Inheritedtype : String
[lecture seule] Type d’événement.
Event
Méthodes publiques
 MéthodeDéfini par
  
FlowElementMouseEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = true, flowElement:FlowElement = null, originalEvent:MouseEvent = null)
Crée un objet d’événement contenant des informations sur l’activité de la souris.
FlowElementMouseEvent
 Inherited
Duplique une occurrence d’une sous-classe Event.
Event
 Inherited
formatToString(className:String, ... arguments):String
Fonction d’un utilitaire permettant d’implémenter la méthode toString() dans des classes Event ActionScript 3.0 personnalisées.
Event
 Inherited
Indique si la propriété spécifiée d’un objet est définie.
Object
 Inherited
Vérifie si la méthode preventDefault() a été appelée pour l’événement.
Event
 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
Annule le comportement par défaut d’un événement si cette opération est possible.
Event
 Inherited
Indique si la propriété spécifiée existe et est énumérable.
Object
 Inherited
Définit la disponibilité d’une propriété dynamique pour les opérations en boucle.
Object
 Inherited
Bloque le traitement des écouteurs d’événement dans le nœud actuel et les suivants dans le flux d’événements.
Event
 Inherited
Bloque le traitement des écouteurs d’événement dans les nœuds qui suivent le nœud actuel dans le flux d’événements.
Event
 Inherited
Renvoie la représentation de chaîne de cet objet, formatée selon les paramètres régionaux en vigueur.
Object
 Inherited
Renvoie une chaîne répertoriant toutes les propriétés de l’objet Event.
Event
 Inherited
Renvoie la valeur primitive de l’objet spécifié.
Object
Constantes publiques
 ConstanteDéfini par
  CLICK : String = "click"
[statique] Définit la valeur de la propriété type d’un objet d’événement click.
FlowElementMouseEvent
  MOUSE_DOWN : String = "mouseDown"
[statique] Définit la valeur de la propriété type d’un objet d’événement mouseDown.
FlowElementMouseEvent
  MOUSE_MOVE : String = "mouseMove"
[statique] Définit la valeur de la propriété type d’un objet d’événement mouseMove.
FlowElementMouseEvent
  MOUSE_UP : String = "mouseUp"
[statique] Définit la valeur de la propriété type d’un objet d’événement mouseUp.
FlowElementMouseEvent
  ROLL_OUT : String = "rollOut"
[statique] Définit la valeur de la propriété type d’un objet d’événement rollOut.
FlowElementMouseEvent
  ROLL_OVER : String = "rollOver"
[statique] Définit la valeur de la propriété type d’un objet d’événement rollOver.
FlowElementMouseEvent
Détails de la propriété

flowElement

propriété
flowElement:FlowElement

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

Elément FlowElement qui a distribué l’événement.



Implémentation
    public function get flowElement():FlowElement
    public function set flowElement(value:FlowElement):void

Eléments de l’API associés

originalEvent

propriété 
originalEvent:MouseEvent

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

Evénement de souris d’origine généré par l’activité de la souris. Cette propriété peut contenir l’une des valeurs suivantes :

  • MouseEvent.CLICK
  • MouseEvent.MOUSE_DOWN
  • MouseEvent.MOUSE_UP
  • MouseEvent.MOUSE_MOVE
  • MouseEvent.MOUSE_OVER
  • MouseEvent.MOUSE_OUT

Dans la plupart des cas, l’événement d’origine correspond à l’événement que l’élément de lien distribue. Les événements correspondent aux événements click, mouseDown, mouseOut et mouseOver. Il existe deux cas, toutefois, dans lesquels l’événement d’origine est converti par l’élément de lien en événement associé. Si un élément de lien détecte un événement mouseOver, il distribue un événement rollOver. De même, si un lément de lien détecte un événement mouseOut, il distribue un événement rollOut. Généralement, la cible de l’événement et les coordonnées de la souris sont liées à l’occurrence de TextLine contenant l’élément de lien.



Implémentation
    public function get originalEvent():MouseEvent
    public function set originalEvent(value:MouseEvent):void

Eléments de l’API associés

Détails du constructeur

FlowElementMouseEvent

()Constructeur
public function FlowElementMouseEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = true, flowElement:FlowElement = null, originalEvent:MouseEvent = null)

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

Crée un objet d’événement contenant des informations sur l’activité de la souris. Les objets Event sont transmis en tant que paramètres aux écouteurs d’événement. Utilisez le constructeur si vous prévoyez de distribuer manuellement un événement. Il n’est pas nécessaire d’utiliser le constructeur pour écouter les objets FlowElementMouseEvent générés par un objet FlowElement.

Paramètres
type:String — Type de l’événement. Les écouteurs d’événement peuvent accéder à cette information par le biais de la propriété type héritée. Il existe six types : FlowElementMouseEvent.CLICK; FlowElementMouseEvent.MOUSE_DOWN; FlowElementMouseEvent.MOUSE_MOVE; FlowElementMouseEvent.MOUSE_UP; FlowElementMouseEvent.ROLL_OVER et FlowElementMouseEvent.ROLL_OUT.
 
bubbles:Boolean (default = false) — Détermine si l’objet Event prend part à la phase de propagation du flux d’événements. Les objets FlowElementMouseEvent ne se propagent pas.
 
cancelable:Boolean (default = true) — Détermine si l’objet Event peut être annulé. Les écouteurs d’événement peuvent accéder à cette information par le biais de la propriété cancelable héritée. Les objets FlowElementMouseEvent peuvent être annulés. Vous pouvez annuler le comportement par défaut associé à cet événement en appelant la méthode preventDefault() dans votre écouteur d’événement.
 
flowElement:FlowElement (default = null) — Occurrence de l’objet FlowElement, actuellement un objet LinkElement, associée à cet événement. Les écouteurs d’événement peuvent accéder à cette information par le biais de la propriété flowElement.
 
originalEvent:MouseEvent (default = null) — Evénement de souris d’origine qui s’est produit dans l’objet flowElement. Les écouteurs d’événement peuvent accéder à cette information par le biais de la propriété originalEvent.
Détails de la constante

CLICK

Constante
public static const CLICK:String = "click"

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

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

Eléments de l’API associés

MOUSE_DOWN

Constante 
public static const MOUSE_DOWN:String = "mouseDown"

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

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

Eléments de l’API associés

MOUSE_MOVE

Constante 
public static const MOUSE_MOVE:String = "mouseMove"

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

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

Eléments de l’API associés

MOUSE_UP

Constante 
public static const MOUSE_UP:String = "mouseUp"

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

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

Eléments de l’API associés

ROLL_OUT

Constante 
public static const ROLL_OUT:String = "rollOut"

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

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

Eléments de l’API associés

ROLL_OVER

Constante 
public static const ROLL_OVER:String = "rollOver"

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

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

Eléments de l’API associés

FlowElementMouseEvent_example.as

L’exemple suivant montre comment écouter les événements de souris susceptibles de se produire sur des occurrences LinkElement. Les deux principales étapes consistent à appeler la méthode addEventListener() pour chaque événement et à créer une fonction de gestionnaire d’événement.

L’appel de la méthode addEventListener() s’effectue sur l’occurrence LinkElement. Vous pouvez utiliser des chaînes simples, comme click ou mouseDown, mais il est plus sûr d’utiliser des constantes statiques. L’exemple utilise les constantes de la classe MouseEvent parce que la classe FlowElementMouseEvent ne possède pas de constantes statiques.

Cet exemple contient une seule fonction de gestionnaire d’événement, car le code est le même pour tous les événements. En général, le code qui répond à chaque type d’événement est différent. Dans ce cas, il peut être préférable d’utiliser une fonction de gestionnaire d’événement distincte pour chaque appel de la méthode addEventListener().

package flashx.textLayout.events.examples {
    import flash.display.Sprite;
    import flash.events.MouseEvent;
    import flashx.textLayout.container.ContainerController;
    import flashx.textLayout.elements.TextFlow;
    import flashx.textLayout.elements.ParagraphElement;
    import flashx.textLayout.elements.SpanElement;
    import flashx.textLayout.elements.LinkElement;
    import flashx.textLayout.events.FlowElementMouseEvent;
    import flashx.textLayout.formats.TextLayoutFormat;


    public class FlowElementMouseEvent_example extends Sprite
    {
        private var tf:TextFlow;
        
        public function FlowElementMouseEvent_example()
        {
            // define TextFlow
            tf = new TextFlow();
            
            // define link element
            var linkPar:ParagraphElement = new ParagraphElement();
            var linkEl:LinkElement = new LinkElement();
            linkEl.href = "http://www.adobe.com/go/flashplayer";
            linkEl.target = "_blank"; // when link is clicked, open a new browser window
            var span1:SpanElement = new SpanElement(); // for text associated with link
            span1.text = "Get Flash Player";
            linkEl.addChild(span1);
            
            // define paragraph element for name of events dispatched
            var textPar:ParagraphElement = new ParagraphElement();
            var span2:SpanElement = new SpanElement();
            span2.text ="Three most recent events:";
            
            // add span (text) and link elements to the TextFlow
            linkPar.addChild(linkEl);    // add LinkElement to first paragraph
            textPar.addChild(span2);     // add header text to second paragraph
            tf.addChild(linkPar);        // add paragraph with link to text flow 
            tf.addChild(textPar);        // add paragraph for events to text flow

            
            // add event listeners for all six FlowElementMouseEvent types
            linkEl.addEventListener(FlowElementMouseEvent.CLICK, linkHandler);
            linkEl.addEventListener(FlowElementMouseEvent.MOUSE_DOWN, linkHandler);
            linkEl.addEventListener(FlowElementMouseEvent.MOUSE_MOVE, linkHandler);
            linkEl.addEventListener(FlowElementMouseEvent.MOUSE_UP, linkHandler);
            linkEl.addEventListener(FlowElementMouseEvent.ROLL_OVER, linkHandler);
            linkEl.addEventListener(FlowElementMouseEvent.ROLL_OUT, linkHandler);
            
            // create text container for link and event listing text
            var linkContainer:Sprite = new Sprite();
            linkContainer.x = 10;
            linkContainer.y = 10;
            var linkController:ContainerController = new ContainerController(linkContainer,200,80);
            var linkControllerFormat:TextLayoutFormat = new TextLayoutFormat();
            linkControllerFormat.paddingTop = 3;
            linkController.format = linkControllerFormat;
            tf.flowComposer.addController(linkController);
            
            // Add linkContainer to Display List
            addChild(linkContainer);
            
            tf.flowComposer.updateAllControllers();   
        }
        
        // event handler function        
        private function linkHandler(ev:FlowElementMouseEvent):void {
            var par:ParagraphElement = new ParagraphElement();
            var span:SpanElement = new SpanElement();
            span.text = ev.type;
            par.addChild(span);
            tf.replaceChildren(2,2,par);
            if (tf.numChildren > 5) {
                tf.removeChildAt(5);
            }
            tf.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.