TabStopFormat

Package	flashx.textLayout.formats
Classe	public class TabStopFormat
Héritage	TabStopFormat Object
Implémente	ITabStopFormat

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

La classe TabStopFormat représente les propriétés d’un taquet de tabulation dans un paragraphe. Vous pouvez définir la propriété TextLayoutFormat.tabstops sur un tableau d’objets TabStopFormat.

Consulter les exemples

Eléments de l’API associés

flashx.textLayout.elements.TabElement
flashx.textLayout.formats.TextLayoutFormat.tabStops

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
		alignment : * Alignement de tabulation de ce taquet de tabulation.	TabStopFormat
		constructor : Object Référence à l’objet de classe ou à la fonction constructeur d’une occurrence donnée d’un objet.	Object
		decimalAlignmentToken : * Jeton d’alignement à utiliser si l’alignement est DECIMAL.	TabStopFormat
		defaultFormat : flashx.textLayout.formats:ITabStopFormat [statique] [lecture seule] Crée un objet TabStopFormat avec des paramètres par défaut.	TabStopFormat
		position : * Position du taquet de tabulation, en pixels, par rapport au bord de début de la colonne.	TabStopFormat

Méthodes publiques

Masquer les méthodes publiques héritées

Afficher les méthodes publiques héritées

	Méthode		Défini par
		TabStopFormat(initialValues:flashx.textLayout.formats:ITabStopFormat = null) Crée un nouvel objet TabStopFormat.	TabStopFormat
		apply(incoming:flashx.textLayout.formats:ITabStopFormat):void Remplace les valeurs des propriétés de cet objet TabStopFormat par les valeurs des propriétés qui sont définies dans l’occurrence incoming ITabStopFormat.	TabStopFormat
		concat(incoming:flashx.textLayout.formats:ITabStopFormat):void Concatène les valeurs des propriétés de l’occurrence incoming ITabStopFormat avec les valeurs de cet objet TabStopFormat.	TabStopFormat
		concatInheritOnly(incoming:flashx.textLayout.formats:ITabStopFormat):void Concatène les valeurs des propriétés de l’occurrence incoming ITabStopFormat avec les valeurs de cet objet TabStopFormat.	TabStopFormat
		copy(values:flashx.textLayout.formats:ITabStopFormat):void Copie les paramètres TabStopFormat à partir de l’occurrence values ITabStopFormat dans cet objet TabStopFormat.	TabStopFormat
		getStyle(styleName:String):* Renvoie la valeur du style spécifié par le paramètre styleProp qui spécifie le nom du style.	TabStopFormat
		hasOwnProperty(name:String):Boolean Indique si la propriété spécifiée d’un objet est définie.	Object
		isEqual(p1:flashx.textLayout.formats:ITabStopFormat, p2:flashx.textLayout.formats:ITabStopFormat):Boolean [statique] Compare les propriétés de l’occurrence p1 ITabStopFormat avec celles de l’occurrence p2 ITabStopFormat et renvoie la valeur true si toutes les propriétés correspondent.	TabStopFormat
		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
		removeClashing(incoming:flashx.textLayout.formats:ITabStopFormat):void Définit les propriétés de cet objet TabStopFormat sur undefined si elles ne correspondent pas à celles de l’occurrence ITabStopFormat incoming.	TabStopFormat
		removeMatching(incoming:flashx.textLayout.formats:ITabStopFormat):void Définit les propriétés de cet objet TabStopFormat sur undefined si elles correspondent à celles de l’occurrence ITabStopFormat incoming.	TabStopFormat
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Définit la disponibilité d’une propriété dynamique pour les opérations en boucle.	Object
		setStyle(styleName:String, value:*):void Définissez la valeur du style spécifié par le paramètre styleProp qui spécifie le nom du style sur value.	TabStopFormat
		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

Détails de la propriété

alignment

propriété

alignment:*

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Alignement de tabulation de ce taquet de tabulation.

Les valeurs valides sont TabAlignment.START, TabAlignment.CENTER, TabAlignment.END, TabAlignment.DECIMAL 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é aura la valeur TabAlignment.START.

Implémentation
public function get alignment():*
public function set alignment(value:any):void

Valeur émise

RangeError — lorsque la valeur définie n’est pas située dans les limites de cette propriété

Eléments de l’API associés

FormatValue.INHERIT
flash.text.engine.TabAlignment

decimalAlignmentToken

propriété

decimalAlignmentToken:*

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Jeton d’alignement à utiliser si l’alignement est DECIMAL.

La valeur par défaut est undefined, ce qui indique qu’elle n’est pas définie.

Si undefined pendant la cascade cette propriété aura la valeur null.

Implémentation
public function get decimalAlignmentToken():*
public function set decimalAlignmentToken(value:any):void

Valeur émise

RangeError — lorsque la valeur définie n’est pas située dans les limites de cette propriété

defaultFormat

propriété

defaultFormat:flashx.textLayout.formats:ITabStopFormat [lecture seule]

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Renvoie un objet TabStopFormat avec des paramètres par défaut. Cette fonction renvoie toujours le même objet.

Implémentation
public static function get defaultFormat():flashx.textLayout.formats:ITabStopFormat

position

propriété

position:*

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Position du taquet de tabulation, en pixels, par rapport au bord de début de la colonne.

Les valeurs valides sont les nombres compris entre 0 et 10 000, 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é aura la valeur 0.

Implémentation
public function get position():*
public function set position(value:any):void

Valeur émise

RangeError — lorsque la valeur définie n’est pas située dans les limites de cette propriété

Eléments de l’API associés

FormatValue.INHERIT

Détails du constructeur

()

Constructeur

public function TabStopFormat(initialValues:flashx.textLayout.formats:ITabStopFormat = null)

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Crée un nouvel objet TabStopFormat. Tous les paramètres sont vides ou peuvent être initialisés à partir de l’objet initialValues fourni.

Paramètres

initialValues:flashx.textLayout.formats:ITabStopFormat (default = null) — Occurrence facultative à partir de laquelle copier les valeurs initiales.

Eléments de l’API associés

defaultFormat

Détails de la méthode

apply

()

méthode

public function apply(incoming:flashx.textLayout.formats:ITabStopFormat):void

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Remplace les valeurs des propriétés de cet objet TabStopFormat par les valeurs des propriétés qui sont définies dans l’occurrence incoming ITabStopFormat. Les propriétés dont les valeurs sont undefined dans l’occurrence incoming ITabStopFormat ne sont pas modifiées dans cet objet.

Paramètres

incoming:flashx.textLayout.formats:ITabStopFormat — Occurrence dont les valeurs des propriétés sont appliquées à cet objet TabStopFormat.

concat

()

méthode

public function concat(incoming:flashx.textLayout.formats:ITabStopFormat):void

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Concatène les valeurs des propriétés de l’occurrence incoming ITabStopFormat avec les valeurs de cet objet TabStopFormat. Dans cet objet TabStopFormat (l’objet récepteur), les propriétés dont les valeurs sont FormatValue.INHERIT et les propriétés héritières dont les valeurs sont undefined reçoivent de nouvelles valeurs de la part de l’objet incoming. Les propriétés non héritières dont les valeurs sont undefined reçoivent leurs valeurs par défaut. Les valeurs de toutes les autres propriétés restent inchangées.

Paramètres

incoming:flashx.textLayout.formats:ITabStopFormat — Occurrence partir de laquelle les valeurs sont concaténées.

Eléments de l’API associés

flashx.textLayout.formats.FormatValue.INHERIT

concatInheritOnly

()

méthode

public function concatInheritOnly(incoming:flashx.textLayout.formats:ITabStopFormat):void

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Concatène les valeurs des propriétés de l’occurrence incoming ITabStopFormat avec les valeurs de cet objet TabStopFormat. Dans cet objet TabStopFormat (l’objet récepteur), les propriétés dont les valeurs sont FormatValue.INHERIT et les propriétés héritières dont les valeurs sont undefined reçoivent de nouvelles valeurs de la part de l’objet incoming. Les valeurs de toutes les autres propriétés restent inchangées.

Paramètres

incoming:flashx.textLayout.formats:ITabStopFormat — Occurrence partir de laquelle les valeurs sont concaténées.

Eléments de l’API associés

flashx.textLayout.formats.FormatValue.INHERIT

copy

()

méthode

public function copy(values:flashx.textLayout.formats:ITabStopFormat):void

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Copie les paramètres TabStopFormat à partir de l’occurrence values ITabStopFormat dans cet objet TabStopFormat. Si les valeurs sontnull, cet objet TabStopFormat est initialisé avec des valeurs non définies pour toutes les propriétés.

Paramètres

values:flashx.textLayout.formats:ITabStopFormat — Occurrence facultative à partir de laquelle copier les valeurs.

getStyle

()

méthode

public function getStyle(styleName:String):*

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Renvoie la valeur du style spécifié par le paramètre styleProp qui spécifie le nom du style.

Paramètres

styleName:String — Le nom du style dont la valeur est à récupérer.

Valeur renvoyée

* — La valeur du style spécifié. Le type varie selon le type de style en cours d’accès. Renvoie undefined si le style n’est pas défini.

isEqual

()

méthode

 public static function isEqual(p1:flashx.textLayout.formats:ITabStopFormat, p2:flashx.textLayout.formats:ITabStopFormat):Boolean

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Compare les propriétés de l’occurrence ITabStopFormat p1 avec celles de l’occurrence ITabStopFormat p2 et renvoie la valeur true si toutes les propriétés correspondent.

Paramètres

	`p1:flashx.textLayout.formats:ITabStopFormat` — Occurrence à comparer avec `p2`.

	`p2:flashx.textLayout.formats:ITabStopFormat` — Occurrence à comparer avec `p1`.

Valeur renvoyée

Boolean — La valeur est true si toutes les propriétés correspondent. Sinon, la valeur est false.

removeClashing

()

méthode

public function removeClashing(incoming:flashx.textLayout.formats:ITabStopFormat):void

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Définit les propriétés de cet objet TabStopFormat sur undefined si elles ne correspondent pas à celles de l’occurrence ITabStopFormat incoming.

Paramètres

incoming:flashx.textLayout.formats:ITabStopFormat — Occurrence avec laquelle comparer les valeurs des propriétés de cet objet TabStopFormat.

removeMatching

()

méthode

public function removeMatching(incoming:flashx.textLayout.formats:ITabStopFormat):void

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Définit les propriétés de cet objet TabStopFormat sur undefined si elles correspondent à celles de l’occurrence ITabStopFormat incoming.

Paramètres

incoming:flashx.textLayout.formats:ITabStopFormat — Occurrence avec laquelle comparer les valeurs des propriétés de cet objet TabStopFormat.

setStyle

()

méthode

public function setStyle(styleName:String, value:*):void

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Définissez la valeur du style spécifié par le paramètre styleProp qui spécifie le nom du style sur value.

Paramètres

	`styleName:String` — Nom du style dont la valeur est à définir.

	`value:*` — Valeur à définir.

Exemples Comment utiliser cet exemple

TabStopFormat_example.as

Le paragraphe est mis en forme avec un tableau de trois taquets de tabulation : une tabulation alignée à gauche à 50 pixels, une tabulation alignée au centre à 150 pixels et une tabulation alignée à droite à 250 pixels.

package flashx.textLayout.formats.examples {
    import flash.display.Sprite;
    import flash.text.engine.TabAlignment;
    import flashx.textLayout.container.ContainerController;
    import flashx.textLayout.compose.StandardFlowComposer;
    import flashx.textLayout.elements.ParagraphElement;
    import flashx.textLayout.elements.SpanElement;
    import flashx.textLayout.elements.TextFlow;
    import flashx.textLayout.formats.TabStopFormat;
    import flashx.textLayout.formats.TextLayoutFormat;

    public class TabStopFormat_example extends Sprite
    {
        public function TabStopFormat_example()
        {
            var firstContainer:Sprite = new Sprite();
            this.stage.addChild( firstContainer );
            var textFlow:TextFlow = new TextFlow();
            var format:TextLayoutFormat = new TextLayoutFormat();
            var tabStop1:TabStopFormat = new TabStopFormat();
            var tabStop2:TabStopFormat = new TabStopFormat();
            var tabStop3:TabStopFormat = new TabStopFormat();
            tabStop1.alignment = flash.text.engine.TabAlignment.START;
            tabStop1.position = 50;
            tabStop2.alignment = flash.text.engine.TabAlignment.CENTER;
            tabStop2.position = 150;
            tabStop3.alignment = flash.text.engine.TabAlignment.END;
            tabStop3.position = 250;
            format.tabStops = new Array(tabStop1,tabStop2,tabStop3);
            textFlow.hostFormat = format;
            var p:ParagraphElement = new ParagraphElement();
            var span:SpanElement = new SpanElement();
            span.text = "1\txxx\txxx\txxx\n2\tyyyyyy\tyyyyyy<\tyyyyyy\n3\tzz\tzz\tzz";
            p.addChild(span);
            textFlow.addChild(p);
            textFlow.flowComposer = new StandardFlowComposer();
            var firstController:ContainerController = new ContainerController(firstContainer, 300, 100 );
            textFlow.flowComposer.addController(firstController);
            textFlow.flowComposer.updateAllControllers(); 
        }
    }        
}

Informations juridiques | Politique de confidentialité en ligne

TabStopFormat - AS3

Packagesx

Eléments du langage

Annexes

Package flashx.textLayout.formats

alignment

decimalAlignmentToken

defaultFormat

position

TabStopFormat

apply

concat

concatInheritOnly

copy

getStyle

isEqual

removeClashing

removeMatching

setStyle