TextFlow  - AS3

L’objet Configuration pour cet objet TextFlow. L’objet Configuration spécifie le caractère initial et les formats de paragraphe, le format de conteneur initial, et les attributs de mise en surbrillance de sélection, les liens, le focus, et le défilement.

Si vous ne spécifiez pas d’objet Configuration, Text Layout Framework utilise un objet Configuration par défaut, qui est référencé par la propriété defaultConfiguration.

Eléments de l’API associés

Configuration par défaut à utiliser pour tous les nouveaux objets TextFlow si la configuration n’est pas spécifiée.

Eléments de l’API associés

Gère les conteneurs pour cet élément.

Les classes TextLine créées à partir de l’élément apparaissent comme des enfants du conteneur. Le composeur flowComposer gère les conteneurs, et à mesure que le texte est modifié, il ajoute et supprime les lignes depuis les conteneurs. Le composeur flowComposer conserve également la trace de certains attributs critiques, tels que les valeurs de largeur et de hauteur pour composer, si le défilement est activé, et ainsi de suite.

Le conteneur et le composeur flowComposer sont étroitement liés. Si vous rétablissez le composeur flowComposer, le conteneur est réinitialisé sur le nouveau conteneur du composeur flowComposer. De même si le conteneur est réinitialisé, le composeur flowComposer est réinitialisé en fonction du nouveau composeur flowComposer du conteneur.

Eléments de l’API associés

Une fonction de rappel pour la résolution des styles d’éléments. Vous pouvez l’utiliser pour fournir le style à l’aide des styles CSS ou nommés, par exemple.

Eléments de l’API associés

Le numéro de génération pour cet objet TextFlow. Les fonctions Annuler et Rétablir des opérations utilisent le numéro de génération pour garantir qu’il est possible d’annuler ou de rétablir une opération. Les numéros de génération doivent correspondre.

Chaque changement de modèle incrémente la generation par conséquent, si le numéro de génération change, vous savez quel modèle a changé

L’objet TextLayoutFormat pour cet objet TextFlow. Cela active plusieurs optimisations pour la réutilisation de formats hôtes. Par exemple :

        textFlowA.hostFormat = textFlowB.hostFormat
        

        format = new TextLayoutFormat()
        textFlow.hostFormat = format
        format.fontSize = 24;
        

Eléments de l’API associés

Le gestionnaire InteractionManager associé à cet objet TextFlow.

Contrôle toutes les sélections et modifications sur le texte. Si l’objet TextFlow n’est pas sélectionnable, le gestionnaire interactionManager est null. Pour que l’objet TextFlow soit modifiable, affectez un gestionnaire interactionManager qui soit à la fois une interface ISelectionManager et une interface IEditManager. Pour qu’un objet TextFlow soit en lecture seule et autorise la sélection, affectez un gestionnaire interaction Manager qui ne soit qu’une interface ISelectionManager.

Eléments de l’API associés

Constructeur : crée une nouvelle occurrence TextFlow.

Si vous fournissez un paramètre config, le contenu de l’objet de configuration est copié et vous ne pouvez y apporter aucune modification. Vous pouvez accéder aux paramètres de configuration, toutefois, via la propriété.configuration. Si le paramètre config est null, vous pouvez accéder aux paramètres de configuration par défaut via la propriété.defaultConfiguration.

L’objet de configuration fournit un mécanisme permettant de définir les attributs configurables par défaut sur un objet TextFlow. Alors que vous ne pouvez pas modifier l’objet de configuration, vous pouvez remplacer les attributs par défaut, si nécessaire, en définissant les attributs de l’objet TextFlow et ses enfants.

Eléments de l’API associés

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

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

Renvoie un élément dont la propriété de l’id correspond au paramètre idName. Permet d’appliquer un style basé sur l’id.

Par exemple, la ligne suivante définit le style « color » sur 0xFF0000 (rouge), pour l’élément dont l’id est span1.

         textFlow.getElementByID("span1").setStyle("color", 0xFF0000);
         

Remarque : dans le code suivant, la valeur p.addChild(s) removes s de son parent original et l’ajoute à p, le nouveau parent.

         var s:SpanElement = new SpanElement();
         var p:ParagraphElement = new ParagraphElement();
         ...
         s = textFlow.getElementByID("span3") as SpanElement;
         p.addChild(s);
         textFlow.addChild(p);
         

Paramètres

Eléments de l’API associés

package flashx.textLayout.elements.examples {
    import flash.display.Sprite;
    
    import flashx.textLayout.conversion.TextConverter;
    import flashx.textLayout.container.ContainerController;
    import flashx.textLayout.elements.ParagraphElement;
    import flashx.textLayout.elements.SpanElement;
    import flashx.textLayout.elements.TextFlow;
    
    public class TextFlow_getElementByIDExample extends Sprite
    {
        public function TextFlow_getElementByIDExample()
        {    
            // create the TextFlow object
            var textFlow:TextFlow = new TextFlow();
            
            // xml markup that defines the attributes and contents of a text flow
            var simpleText:String = "<?xml version=\"1.0\" encoding=\"utf-8\"?>" +
            "<flow:TextFlow xmlns:flow=\"http://ns.adobe.com/textLayout/2008\" verticalScrollPolicy=\"auto\" horizontalScrollPolicy=\"auto\" fontSize=\"14\" textIndent=\"15\" marginBottom=\"15\" paddingTop=\"4\" paddingLeft=\"4\">"+
                "<flow:p>"+
                    "<flow:span id='span1'>In the first paragraph of the </flow:span>"+
                    "<flow:span id='span2' fontStyle=\"italic\">cheap </flow:span>"+
                    "<flow:span id='span3'>Western novel, a cowboy meets a saloon girl.</flow:span>"+
                "</flow:p>"+
            "</flow:TextFlow>";
            var s:SpanElement = new SpanElement();
            var s2:SpanElement = new SpanElement();
            var p:ParagraphElement = new ParagraphElement();
            // import the xml markup into a TextFlow object and display it on the stage
            textFlow = TextConverter.importToFlow(simpleText, TextConverter.TEXT_LAYOUT_FORMAT);
            // get element with ID of span3, make a copy of it
            textFlow.getElementByID("span3").setStyle("color", 0xFF0000); 
            textFlow.flowComposer.addController(new ContainerController(this, 200, 800));
            textFlow.flowComposer.updateAllControllers();
        }
    }
}

            
            

Renvoie tous les éléments qui possèdent également un nom styleName défini sur la valeur styleNameValue.

Paramètres

Eléments de l’API associés

Renvoie tous les éléments dont la propriété typeName est définie sur typeNameValue.

Paramètres

Eléments de l’API associés

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

Annule toutes les informations de mise en forme pour l’objet TextFlow et impose un nouveau calcul. Appelez cette méthode lorsque des styles ont été modifiés.

Eléments de l’API associés

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

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

Distribué lorsqu’un lien est activé.

Distribué à chaque recomposition.

Distribué par un objet TextFlow chaque fois qu’il est endommagé. Cet événement peut vous aider à vérifier que l’objet TextFlow a changé, mais pas accéder à l’objet TextFlow lui-même lorsque cet événement est envoyé. Cet événement est envoyé lorsque les modifications de l’objet TextFlow sont partiellement terminées, il peut donc être dans un état inégal : certaines modifications ont déjà été effectuées et d’autres modifications sont toujours en attente. Obtenez les informations nécessaires à partir de l’événement, et effectuez les modifications requises après le retour du contrôle à votre application.

Modifier une opération à ce stade (après son exécution) risque d’échouer.

Distribué lorsqu’une classe InlineGraphicElement est redimensionnée en raison de la largeur ou hauteur automatique ou en pourcentage et après chargement du graphique.

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

Distribué lorsque la souris survole un lien.

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

Distribué lorsque la souris sort de n’importe quel lien.

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

Distribué par un objet TextFlow après que le texte est déroulé dans un conteneur contrôleur.

Distribué chaque fois que la sélection est modifiée. Principalement utilisé pour mettre à jour l’interface utilisateur qui dépend de la sélection. Il peut également être utilisé pour modifier la sélection, mais pas pour modifier l’objet TextFlow lui-même.

Distribué par un objet TextFlow à chaque fois qu’un conteneur a reçu de nouvelles classes DisplayObjets ou que ces classes ont été mises à jour consécutivement à la composition.