ContentElement

Package	flash.text.engine
Classe	public class ContentElement
Héritage	ContentElement Object
Sous-classes	GraphicElement, GroupElement, TextElement

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5, Flash Lite 4

La classe ContentElement sert de classe de base pour les types d’éléments susceptibles d’apparaître dans un GroupElement, c’est-à-dire un GraphicElement, un autre GroupElement ou un TextElement.

ContentElement est une classe de base abstraite. De ce fait, il est impossible de l’instancier directement. Appeler new ContentElement() renvoie une exception ArgumentError.

Vous pouvez affecter un élément ContentElement à un GroupElement précisément ou à la propriété content d’un seul bloc de texte.

Eléments de l’API associés

ElementFormat
GraphicElement
GroupElement
TextBlock.content
TextElement
TextLineMirrorRegion
TextRotation

Propriétés publiques

Masquer les propriétés publiques héritées

Afficher les propriétés publiques héritées

	Propriété		Défini par
		constructor : Object Référence à l’objet de classe ou à la fonction constructeur d’une occurrence donnée d’un objet.	Object
		elementFormat : ElementFormat Objet ElementFormat utilisé pour l’élément.	ContentElement
		eventMirror : EventDispatcher Objet EventDispatcher qui reçoit des copies de chaque événement distribué pour valider les lignes de texte créées en fonction de cet élément de contenu.	ContentElement
		groupElement : GroupElement [lecture seule] Objet GroupElement contenant cet élément, ou null s’il ne fait pas partie d’un groupe.	ContentElement
		rawText : String [lecture seule] Copie du texte dans l’élément, y compris les caractères U+FDEF.	ContentElement
		text : String [lecture seule] Copie du texte dans l’élément, à l’exception des caractères U+FDEF représentant les éléments graphiques dans la chaîne.	ContentElement
		textBlock : flash.text.engine:TextBlock [lecture seule] TextBlock auquel appartient l’élément.	ContentElement
		textBlockBeginIndex : int [lecture seule] Index du premier caractère de cet élément dans le bloc de texte.	ContentElement
		textRotation : String Rotation à appliquer à l’élément en tant qu’unité.	ContentElement
		userData : * Permet à une application d’associer des données arbitraires à l’élément.	ContentElement

Méthodes publiques

Masquer les méthodes publiques héritées

Afficher les méthodes publiques héritées

	Méthode		Défini par
		ContentElement(elementFormat:ElementFormat = null, eventMirror:EventDispatcher = null, textRotation:String = "rotate0") L’appel du constructeur new ContentElement() renvoie une exception ArgumentError.	ContentElement
		hasOwnProperty(name:String):Boolean Indique si la propriété spécifiée d’un objet est définie.	Object
		isPrototypeOf(theClass:Object):Boolean 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
		propertyIsEnumerable(name:String):Boolean Indique si la propriété spécifiée existe et est énumérable.	Object
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Définit la disponibilité d’une propriété dynamique pour les opérations en boucle.	Object
		toLocaleString():String Renvoie la représentation de chaîne de cet objet, formatée selon les paramètres régionaux en vigueur.	Object
		toString():String Renvoie la représentation sous forme de chaîne de l’objet spécifié.	Object
		valueOf():Object Renvoie la valeur primitive de l’objet spécifié.	Object

Constantes publiques

	Constante		Défini par
		GRAPHIC_ELEMENT : uint = 0xFDEF [statique] Indique la présence d’un élément graphique dans le texte.	ContentElement

Détails de la propriété

elementFormat

propriété

elementFormat:ElementFormat

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5, Flash Lite 4

Objet ElementFormat utilisé pour l’élément.

La valeur par défaut est null.

Lorsque la propriété elementFormat est définie, l’objet ElementFormat fourni est bloqué : sa propriété locked est définie sur true. Il est impossible de modifier un objet ElementFormat bloqué.

Implémentation
public function get elementFormat():ElementFormat
public function set elementFormat(value:ElementFormat):void

Eléments de l’API associés

ElementFormat
TextBlock
TextElement

eventMirror

propriété

eventMirror:EventDispatcher

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5, Flash Lite 4

Objet EventDispatcher qui reçoit des copies de chaque événement distribué pour valider les lignes de texte créées en fonction de cet élément de contenu. L’objet spécifié peut être utilisé pour configurer des écouteurs pour un lien texte ou un autre morceau de texte interactif. En effet, il peut s’avérer difficile de déterminer au moment de l’exécution quelles parties des lignes résultent de tels ou tels éléments de contenu. Vous pouvez également utiliser des écouteurs pour appliquer des décorations, telles que des soulignements, dont vous ne pouvez pas déterminer les mesures après la disposition du texte. La valeur par défaut est null, c’est-à-dire que aucun des événements mis en miroir n’est déclenché.

Les miroirs d’événements se manifestent dans les lignes de texte sous forme d’occurrence de la classe TextLineMirrorRegion. Selon le traitement bidirectionnel et les sauts de ligne, une ou plusieurs zones miroir peuvent être produites.

La valeur par défaut est null.

Implémentation
public function get eventMirror():EventDispatcher
public function set eventMirror(value:EventDispatcher):void

Eléments de l’API associés

flash.events.EventDispatcher
TextLineMirrorRegion

groupElement

propriété

groupElement:GroupElement [lecture seule]

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5, Flash Lite 4

Objet GroupElement contenant cet élément, ou null s’il ne fait pas partie d’un groupe.

La valeur par défaut est null.

Implémentation
public function get groupElement():GroupElement

Eléments de l’API associés

GroupElement

rawText

propriété

rawText:String [lecture seule]

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5, Flash Lite 4

Copie du texte dans l’élément, y compris les caractères U+FDEF. Le caractère Unicode U+FDEF marque l’emplacement d’un élément graphique dans la chaîne.

Implémentation
public function get rawText():String

text

propriété

text:String [lecture seule]

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5, Flash Lite 4

Copie du texte dans l’élément, à l’exception des caractères U+FDEF représentant les éléments graphiques dans la chaîne.

Implémentation
public function get text():String

Eléments de l’API associés

TextElement.text

textBlock

propriété

textBlock:flash.text.engine:TextBlock [lecture seule]

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5, Flash Lite 4

TextBlock auquel appartient l’élément.

La valeur par défaut est null.

Implémentation
public function get textBlock():flash.text.engine:TextBlock

Eléments de l’API associés

TextBlock

textBlockBeginIndex

propriété

textBlockBeginIndex:int [lecture seule]

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5, Flash Lite 4

Index du premier caractère de cet élément dans le bloc de texte. Cette valeur n’est pas mise en cache mais calculée à chaque appel de cette méthode.

La valeur par défaut est -1.

Implémentation
public function get textBlockBeginIndex():int

textRotation

propriété

textRotation:String

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5, Flash Lite 4

Rotation à appliquer à l’élément en tant qu’unité. Utilisez les constantes TextRotation pour cette propriété.

La valeur par défaut est TextRotation.ROTATE_0.

La rotation finale des glyphes est la somme de , ElementFormat.textRotation, ContentElement.textRotation et TextBlock.lineRotation.

ContentElement.textRotation est généralement utilisé pour créer une brève exécution de texte dont la rotation diffère de la ligne conteneur. Les exécutions TCY du texte japonais en sont un exemple. TCY est l’acronyme de Tate-Chu-Yoko et fait référence à une petite séquence de texte horizontale (généralement un nombre) dans un texte japonais vertical. Pour créer un paragraphe de texte japonais vertical contenant une séquence TCY, procédez comme suit :

Définissez TextBlock.lineRotation=TextRotation.ROTATE_90
Définissez TextBlock.content sur un GroupElement, composé de trois objets TextElement. Le premier de ces éléments est le texte japonais avant l’exécution TCY, le second est le texte latin de l’exécution TCY et le troisième est le texte japonais après l’exécution TCY.
Définissez la propriété textRotation du TextElement TCY sur TextRotation.ROTATE_270. L’élément de texte TCY pivote en tant qu’unité. Il commence par une rotation de 90 degrés héritée de la ligne. Une nouvelle rotation de 270 degrés le ramène à l’horizontale.

Les éléments de contenu qui ont subi une rotation ne peuvent pas être imbriqués. Dans toute hiérarchie d’éléments de contenu, quelle que soit la complexité, il n’est possible de définir la propriété textRotation que d’un seul élément de contenu. Les méthodes et définitions de propriétés suivantes renvoient une erreur d’argument si des rotations imbriquées sont détectées :

ContentElement.textRotation
GroupElement.setElements
GroupElement.replaceElements

Pour définir les valeurs pour cette propriété, utilisez les valeurs de chaîne suivantes :

Valeur de chaîne	Description
`TextRotation.ROTATE_0`	L’élément ne pivote pas.
`TextRotation.ROTATE_90`	L’élément pivote de 90 degrés vers la droite.
`TextRotation.ROTATE_180`	L’élément pivote de 180 degrés.
`TextRotation.ROTATE_270`	L’élément pivote de 270 degrés vers la droite.
`TextRotation.AUTO`	Non pris en charge.

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

Valeur émise

	`ArgumentError` — Si la propriété est définie sur une valeur n’appartenant pas à TextRotation.

	`ArgumentError` — Si la propriété est définie sur `TextRotation.AUTO`.

	`ArgumentError` — Si l’opération résulte en rotations imbriquées dans un GroupElement.

Eléments de l’API associés

TextRotation
ElementFormat.textRotation
TextBlock.lineRotation

userData

propriété

public var userData:*

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5, Flash Lite 4

Permet à une application d’associer des données arbitraires à l’élément.

La valeur par défaut est null.

Détails du constructeur

()

Constructeur

public function ContentElement(elementFormat:ElementFormat = null, eventMirror:EventDispatcher = null, textRotation:String = "rotate0")

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5, Flash Lite 4

L’appel du constructeur new ContentElement() renvoie une exception ArgumentError. Vous pouvez cependant appeler des constructeurs pour les sous-classes suivantes de ContentElement :

new GraphicElement()
new GroupElement()
new TextElement()

Paramètres

	`elementFormat:ElementFormat` (default = `null`) — Format de l’élément pour le texte dans l’élément. La valeur par défaut est `null`.

	`eventMirror:EventDispatcher` (default = `null`) — Objet `EventDispatcher` qui reçoit des copies de chaque événement déclenché pour valider les lignes de texte créées en fonction de cet élément de contenu. La valeur par défaut est `null`.

	`textRotation:String` (default = "`rotate0`") — Rotation appliquée à l’élément en tant qu’unité. Utilisez les constantes `TextRotation` pour cette propriété. La valeur par défaut est `TextRotation.ROTATE_0`.

Détails de la constante

GRAPHIC_ELEMENT

Constante

public static const GRAPHIC_ELEMENT:uint = 0xFDEF

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5, Flash Lite 4

Indique la présence d’un élément graphique dans le texte.

Eléments de l’API associés

rawText

Informations juridiques | Politique de confidentialité en ligne

ContentElement - AS3

Packagesx

Eléments du langage

Annexes

Package flash.text.engine

elementFormat

eventMirror

groupElement

rawText

text

textBlock

textBlockBeginIndex

textRotation

userData

ContentElement

GRAPHIC_ELEMENT