ActionScript® 3.0 Referenzhandbuch für die Adobe® Flash®-Plattform
Home  |  Liste der Pakete und Klassen ausblenden |  Pakete  |  Klassen  |  Neue Funktionen  |  Stichwortverzeichnis  |  Anhänge  |  Warum auf Englisch?
Filter: Daten werden vom Server abgerufen...
Daten werden vom Server abgerufen...
flash.text.engine 

ElementFormat  - AS3

Paketflash.text.engine
Klassepublic final class ElementFormat
VererbungElementFormat Inheritance Object

Sprachversion: ActionScript 3.0
Laufzeitversionen: Flash Player 10, AIR 1.5, Flash Lite 4

Die ElementFormat-Klasse repräsentiert Formatierungsinformationen, die auf ein ContentElement angewendet werden können. Verwenden Sie die ElementFormat-Klasse, um spezifische Textformatierungen für die verschiedenen Unterklassen von ContentElement zu erstellen. Die Eigenschaften der ElementFormat-Klasse gelten für Geräte- und eingebettete Schriftarten.

Ein ElementFormat-Objekt, das auf ein ContentElement in einem TextBlock angewendet wird, macht den TextBlock nicht ungültig. Nachdem ein ElementFormat auf ein ContentElement angewendet wurde, wird seine lockedEigenschaft auf true eingestellt. Die Eigenschaften eines gesperrten ElementFormat-Objekts können nicht geändert werden. Erstellen Sie stattdessen mit der clone()-Methode eine nicht gesperrte Kopie des Objekts, die geändert und dem ContentElement zugewiesen werden kann.

Beispiele anzeigen

Verwandte API-Elemente



Öffentliche Eigenschaften
 EigenschaftDefiniert von
  alignmentBaseline : String
Gibt den Typ der Grundlinie im enthaltenden Element an, mit der die dominanten Grundlinien von Elementen mit diesem Format ausgerichtet werden.
ElementFormat
  alpha : Number
Gibt die Transparenz der Linienelemente an, die von diesem Objekt betroffen sind.
ElementFormat
  baselineShift : Number
Gibt die Grundlinienverschiebung für das Element in Pixeln an.
ElementFormat
  breakOpportunity : String
Die Zeilenumbruchmöglichkeit, die auf diesen Text angewendet wird.
ElementFormat
  color : uint
Gibt die Textfarbe an.
ElementFormat
 Inheritedconstructor : Object
Ein Verweis auf das Klassenobjekt oder die Konstruktorfunktion für eine angegebene Objektinstanz.
Object
  digitCase : String
Die Ziffernschreibweise, die für diesen Text verwendet wird.
ElementFormat
  digitWidth : String
Die Ziffernbreite, die für diesen Text verwendet wird.
ElementFormat
  dominantBaseline : String
Gibt den Typ der Grundlinie an, die als dominante Grundlinie verwendet wird.
ElementFormat
  fontDescription : FontDescription
Ein Objekt, dessen Eigenschaften eine Schriftart beschreiben.
ElementFormat
  fontSize : Number
Die Größe des Texts in Pixeln.
ElementFormat
  kerning : String
Beim Kerning werden die Pixel zwischen bestimmten Zeichenpaaren angepasst, um die Lesbarkeit zu verbessern.
ElementFormat
  ligatureLevel : String
Die Ligaturstufe, die für diesen Text verwendet wird.
ElementFormat
  locale : String
Das Gebietsschema für den Text.
ElementFormat
  locked : Boolean
Gibt an, ob das ElementFormat gesperrt ist.
ElementFormat
  textRotation : String
Legt die Drehung fest, die auf einzelne Glyphen angewendet wird.
ElementFormat
  trackingLeft : Number
Die Laufweite bzw. manuelles Kerning, das links neben jeder Glyphe angewendet wird, als Pixelwert.
ElementFormat
  trackingRight : Number
Die Laufweite bzw. manuelles Kerning, das rechts neben jeder Glyphe angewendet wird, als Pixelwert.
ElementFormat
  typographicCase : String
Die Groß-/Kleinschreibung, die für diesen Text verwendet wird.
ElementFormat
Öffentliche Methoden
 MethodeDefiniert von
  
ElementFormat(fontDescription:FontDescription = null, fontSize:Number = 12.0, color:uint = 0x000000, alpha:Number = 1.0, textRotation:String = "auto", dominantBaseline:String = "roman", alignmentBaseline:String = "useDominantBaseline", baselineShift:Number = 0.0, kerning:String = "on", trackingRight:Number = 0.0, trackingLeft:Number = 0.0, locale:String = "en", breakOpportunity:String = "auto", digitCase:String = "default", digitWidth:String = "default", ligatureLevel:String = "common", typographicCase:String = "default")
Erstellt ein ElementFormat-Objekt.
ElementFormat
  
Erstellt eine nicht gesperrte geklonte Kopie von ElementFormat.
ElementFormat
  
Gibt ein FontMetrics-Objekt mit Eigenschaften zurück, die die emBox, die Position der Durchstreichen-Linie, die Dicke der Durchstreichen-Linie, die Position der Unterstreichen-Linie und die Dicke der Unterstreichen-Linie für die mit fontDescription und fontSize angegebene Schriftart beschreiben.
ElementFormat
 Inherited
Gibt an, ob für ein Objekt eine bestimmte Eigenschaft definiert wurde.
Object
 Inherited
Gibt an, ob eine Instanz der Object-Klasse in der Prototypkette des Objekts vorhanden ist, das als Parameter angegeben wurde.
Object
 Inherited
Gibt an, ob die angegebene Eigenschaft vorhanden ist und durchlaufen werden kann.
Object
 Inherited
Legt die Verfügbarkeit einer dynamischen Eigenschaft für Schleifenoperationen fest.
Object
 Inherited
Gibt die Stringdarstellung dieses Objekts zurück, formatiert entsprechend den Konventionen des Gebietsschemas.
Object
 Inherited
Gibt das angegebene Objekt als String zurück.
Object
 Inherited
Gibt den Grundwert des angegebenen Objekts zurück.
Object
Eigenschaftendetails

alignmentBaseline

Eigenschaft
alignmentBaseline:String

Sprachversion: ActionScript 3.0
Laufzeitversionen: Flash Player 10, AIR 1.5, Flash Lite 4

Gibt den Typ der Grundlinie im enthaltenden Element an, mit der die dominanten Grundlinien von Elementen mit diesem Format ausgerichtet werden. Verwenden Sie TextBaseline-Konstanten für diese Eigenschaft.

Das größte vertikale Element in der Zeile bestimmt die Ausrichtung der Grundlinie, es sei denn, dieser Grundsatz wird durch die Festsetzung von TextBlock.baselineFontDescription und TextBlock.baselineFontSize aufgehoben.

Der Standardwert ist TextBaseline.USE_DOMINANT_BASELINE.

Wenn Sie Werte für diese Eigenschaft definieren möchten, verwenden Sie die folgenden Stringwerte:

StringwertBeschreibung
TextBaseline.ROMANDie dominantBaseline wird an der Roman-Grundlinie der Zeile ausgerichtet.
TextBaseline.ASCENTDie dominantBaseline wird an der Oberlängen-Grundlinie der Zeile ausgerichtet.
TextBaseline.DESCENTDie dominantBaseline wird an der Unterlängen-Grundlinie der Zeile ausgerichtet.
TextBaseline.IDEOGRAPHIC_TOPDie dominantBaseline wird an der oberen ideografischen Grundlinie der Zeile ausgerichtet.
TextBaseline.IDEOGRAPHIC_CENTERDie dominantBaseline wird an der mittleren ideografischen Grundlinie der Zeile ausgerichtet.
TextBaseline.IDEOGRAPHIC_BOTTOMDie dominantBaseline wird an der unteren ideografischen Grundlinie der Zeile ausgerichtet.
TextBaseline.USE_DOMINANT_BASELINEDie dominantBaseline wird an derselben Grundlinie der Zeile ausgerichtet.

UnterklasseEffekt der Einstellung der Eigenschaft
GraphicElementLegt die Ausrichtungsgrundlinie der Zeile fest, an der die dominantBaseline des Grafikelements ausgerichtet wird.
GroupElementHat keinen Effekt.
TextElementLegt die Ausrichtungsgrundlinie der Zeile fest, an der die dominantBaseline des Textelements ausgerichtet wird.



Implementierung
    public function get alignmentBaseline():String
    public function set alignmentBaseline(value:String):void

Auslöser
ArgumentError — Falls ein Wert verwendet wird, der kein Mitglied von TextBaseline ist.
 
IllegalOperationError — Falls die Einstellung erfolgt, nachdem das ElementFormat-Objekt gesperrt wurde (locked ist true).

Verwandte API-Elemente

alpha

Eigenschaft 
alpha:Number

Sprachversion: ActionScript 3.0
Laufzeitversionen: Flash Player 10, AIR 1.5, Flash Lite 4

Gibt die Transparenz der Linienelemente an, die von diesem Objekt betroffen sind. Die zulässigen Werte liegen zwischen 0 (vollständig transparent) und 1 (vollständig undurchsichtig). Anzeigeobjekte mit einem alpha-Wert von 0 sind aktiv, auch wenn sie nicht sichtbar sind.

Der Standardwert ist 1.

UnterklasseEffekt der Einstellung der Eigenschaft
GraphicElementWendet den angegebenen Alphawert auf das Grafikelement an. Wird multiplikativ mit dem für das grafische DisplayObject oder für die TextLine kombiniert.
GroupElementHat keinen Effekt.
TextElementWendet den angegebenen Alphawert auf das Textelement an. Wird multiplikativ mit dem für die TextLine festgelegten Alphawert kombiniert.



Implementierung
    public function get alpha():Number
    public function set alpha(value:Number):void

Auslöser
IllegalOperationError — Falls die Einstellung erfolgt, nachdem das ElementFormat-Objekt gesperrt wurde (locked ist true).

Verwandte API-Elemente

baselineShift

Eigenschaft 
baselineShift:Number

Sprachversion: ActionScript 3.0
Laufzeitversionen: Flash Player 10, AIR 1.5, Flash Lite 4

Gibt die Grundlinienverschiebung für das Element in Pixeln an.

Das Element wird um diesen Betrag von der dominantBaseline verschoben. Die Verschiebung wird der y-Position der Mitglieder des Elements hinzugefügt, sodass in nicht gedrehtem Text eine positive Grundlinienverschiebung das Element nach unten verschiebt und eine negative Grundlinienverschiebung das Element nach oben verschiebt.

Der Standardwert ist 0,0, was bedeutet, das keine Verschiebung erfolgt.

UnterklasseEffekt der Einstellung der Eigenschaft
GraphicElementVerschiebt die Grafik weg von der Grundlinie.
GroupElementHat keinen Effekt.
TextElementVerschiebt den Text weg von der Grundlinie.



Implementierung
    public function get baselineShift():Number
    public function set baselineShift(value:Number):void

Auslöser
IllegalOperationError — Falls die Einstellung erfolgt, nachdem das ElementFormat-Objekt gesperrt wurde (locked ist true).

breakOpportunity

Eigenschaft 
breakOpportunity:String

Sprachversion: ActionScript 3.0
Laufzeitversionen: Flash Player 10, AIR 1.5, Flash Lite 4

Die Zeilenumbruchmöglichkeit, die auf diesen Text angewendet wird. Diese Eigenschaft bestimmt, welche Zeichen für einen Umbruch in Frage kommen, wenn Text über mehrere Zeilen verteilt wird. Verwenden Sie BreakOpportunity-Konstanten für diese Eigenschaft.

Der Standardwert lautet BreakOpportunity.AUTO.

Wenn Sie Werte für diese Eigenschaft definieren möchten, verwenden Sie die folgenden Stringwerte:

StringwertBeschreibung
BreakOpportunity.AUTOZeilenumbruchmöglichkeiten basieren auf standardmäßigen Unicode-Zeicheneigenschaften, zum Beispiel Umbrüche zwischen Wörtern und bei Trennstrichen.
BreakOpportunity.ANYJedes Zeichen im ContentElement-Objekt wird als Zeilenumbruchmöglichkeit behandelt. Dieser Wert wird normalerweise verwendet, wenn Roman-Text in asiatischen Text eingebettet ist und Zeilenumbrüche in Wörtern vorkommen können.
BreakOpportunity.NONEKein Zeichen im Bereich wird als Zeilenumbruchmöglichkeit behandelt.
BreakOpportunity.ALLAlle Zeichen in diesem Bereich werden als Zeilenumbruchmöglichkeit behandelt, was bedeutet, dass nach jedem Zeichen ein Zeilenumbruch erfolgt. Dies ist hilfreich beim Erstellen von Effekten wie Text auf einem Pfad.

UnterklasseEffekt der Einstellung der Eigenschaft
GraphicElementHat keinen Effekt.
GroupElementBestimmt die Umbruchmöglichkeit zwischen benachbarten Textelementen in der Gruppe. Wenn das elementFormat der Gruppe null ist, wird das Format des ersten benachbarten Elements verwendet.
TextElementBestimmt die Zeilenumbruchmöglichkeit zwischen den Zeichen im Textelement.



Implementierung
    public function get breakOpportunity():String
    public function set breakOpportunity(value:String):void

Auslöser
ArgumentError — Falls ein Wert verwendet wird, der kein Mitglied von BreakOpportunity ist.
 
IllegalOperationError — Falls die Einstellung erfolgt, nachdem das ElementFormat-Objekt gesperrt wurde (locked ist true).

Verwandte API-Elemente

color

Eigenschaft 
color:uint

Sprachversion: ActionScript 3.0
Laufzeitversionen: Flash Player 10, AIR 1.5, Flash Lite 4

Gibt die Textfarbe an. Eine Ganzzahl mit drei 8-Bit-RGB-Komponenten; 0xFF0000 ist beispielsweise Rot und 0x00FF00 ist Grün.

Der Standardwert lautet 0x000000, was schwarz ist.

UnterklasseEffekt der Einstellung der Eigenschaft
GraphicElementHat keinen Effekt.
GroupElementHat keinen Effekt.
TextElementLegt die Textfarbe fest.



Implementierung
    public function get color():uint
    public function set color(value:uint):void

Auslöser
IllegalOperationError — Falls die Einstellung erfolgt, nachdem das ElementFormat-Objekt gesperrt wurde (locked ist true).

digitCase

Eigenschaft 
digitCase:String

Sprachversion: ActionScript 3.0
Laufzeitversionen: Flash Player 10, AIR 1.5, Flash Lite 4

Die Ziffernschreibweise, die für diesen Text verwendet wird. Die Ziffernschreibweise wirkt sich auf den Stil und die Platzierung von numerischen Zeichengruppen aus. Verwenden Sie DigitCase-Konstanten für diese Eigenschaft.

Der Standardwert lautet DigitCase.DEFAULT.

Wenn Sie Werte für diese Eigenschaft definieren möchten, verwenden Sie die folgenden Stringwerte:

StringwertBeschreibung
DigitCase.DEFAULTWendet die Standardschreibweise für Ziffern auf den Text an.
DigitCase.LININGWendet die Versalschreibweise für Ziffern auf den Text an.
DigitCase.OLD_STYLEWendet die Mediävalschreibweise für Ziffern auf den Text an.

UnterklasseEffekt der Einstellung der Eigenschaft
GraphicElementHat keinen Effekt.
GroupElementHat keinen Effekt.
TextElementBestimmt die Schreibweise für Ziffern, die für den Text im Element verwendet wird.



Implementierung
    public function get digitCase():String
    public function set digitCase(value:String):void

Auslöser
ArgumentError — Falls ein Wert verwendet wird, der kein Mitglied von DigitCase ist.
 
IllegalOperationError — Falls die Einstellung erfolgt, nachdem das ElementFormat-Objekt gesperrt wurde (locked ist true).

Verwandte API-Elemente

digitWidth

Eigenschaft 
digitWidth:String

Sprachversion: ActionScript 3.0
Laufzeitversionen: Flash Player 10, AIR 1.5, Flash Lite 4

Die Ziffernbreite, die für diesen Text verwendet wird. Verwenden Sie DigitWidth-Konstanten für diese Eigenschaft.

Der Standardwert lautet DigitWidth.DEFAULT.

Wenn Sie Werte für diese Eigenschaft definieren möchten, verwenden Sie die folgenden Stringwerte:

StringwertBeschreibung
DigitWidth.DEFAULTWendet die Standardziffernbreite auf den Text an.
DigitWidth.PROPORTIONALWendet die proportionale Ziffernbreite auf den Text an.
DigitWidth.TABULARWendet die Tabstopp-Ziffernbreite auf den Text an.

UnterklasseEffekt der Einstellung der Eigenschaft
GraphicElementHat keinen Effekt.
GroupElementHat keinen Effekt.
TextElementBestimmt die Ziffernbreite, die für den Text im Element verwendet wird.



Implementierung
    public function get digitWidth():String
    public function set digitWidth(value:String):void

Auslöser
ArgumentError — Falls ein Wert verwendet wird, der kein Mitglied von DigitWidth ist.
 
IllegalOperationError — Falls die Einstellung erfolgt, nachdem das ElementFormat-Objekt gesperrt wurde (locked ist true).

Verwandte API-Elemente

dominantBaseline

Eigenschaft 
dominantBaseline:String

Sprachversion: ActionScript 3.0
Laufzeitversionen: Flash Player 10, AIR 1.5, Flash Lite 4

Gibt den Typ der Grundlinie an, die als dominante Grundlinie verwendet wird. Die dominante Grundlinie wird mit der Ausrichtungsgrundlinie ausgerichtet, um die vertikale Position des Elements in der Zeile zu bestimmen. Verwenden Sie TextBaseline-Konstanten für diese Eigenschaft.

Der Inhalt des Elements bestimmt die Grundlinien. Bei einem TextElement bestimmen Schriftart und Schriftgrad die Grundlinien. Bei einem GraphicElement bestimmt die Höhe des Elements die Grundlinien.

Der Standardwert ist TextBaseline.ROMAN.

Wenn Sie Werte für diese Eigenschaft definieren möchten, verwenden Sie die folgenden Stringwerte:

StringwertBeschreibung
TextBaseline.ROMANDie Roman-Grundlinie des Elements wird an der alignmentBaseline ausgerichtet.
TextBaseline.ASCENTDie Oberlängen-Grundlinie des Elements wird an der alignmentBaseline ausgerichtet.
TextBaseline.DESCENTDie Unterlängen-Grundlinie des Elements wird an der alignmentBaseline ausgerichtet.
TextBaseline.IDEOGRAPHIC_TOPDie obere ideografische Grundlinie des Elements wird an der alignmentBaseline ausgerichtet.
TextBaseline.IDEOGRAPHIC_CENTERDie mittlere ideografische Grundlinie des Elements wird an der alignmentBaseline ausgerichtet.
TextBaseline.IDEOGRAPHIC_BOTTOMDie untere ideografische Grundlinie des Elements wird an der alignmentBaseline ausgerichtet.

UnterklasseEffekt der Einstellung der Eigenschaft
GraphicElementBestimmt, welche der Grundlinien des Grafikelements an der alignmentBaseline ausgerichtet wird.
GroupElementHat keinen Effekt.
TextElementBestimmt, welche der Grundlinien des Textelements an der alignmentBaseline ausgerichtet wird.



Implementierung
    public function get dominantBaseline():String
    public function set dominantBaseline(value:String):void

Auslöser
ArgumentError — Falls ein Wert verwendet wird, der kein Mitglied von TextBaseline ist.
 
IllegalOperationError — Falls die Einstellung erfolgt, nachdem das ElementFormat-Objekt gesperrt wurde (locked ist true).

Verwandte API-Elemente

fontDescription

Eigenschaft 
fontDescription:FontDescription

Sprachversion: ActionScript 3.0
Laufzeitversionen: Flash Player 10, AIR 1.5, Flash Lite 4

Ein Objekt, dessen Eigenschaften eine Schriftart beschreiben.

Der Standardwert ist ein standardmäßig konstruiertes FontDescription-Objekt.

Wenn die fontDescription-Eigenschaft eingestellt ist, ist das bereitgestellte FontDescription-Objekt gesperrt, d. h. seine lockedEigenschaft ist auf true eingestellt. Ein gesperrtes FontDescription-Objekt kann nicht geändert werden.

UnterklasseEffekt der Einstellung der Eigenschaft
GraphicElementHat keinen Effekt.
GroupElementHat keinen Effekt.
TextElementBestimmt die Schriftart, die für den Text im Element verwendet wird.



Implementierung
    public function get fontDescription():FontDescription
    public function set fontDescription(value:FontDescription):void

Auslöser
IllegalOperationError — Falls die Einstellung erfolgt, nachdem das ElementFormat-Objekt gesperrt wurde (locked ist true).

Verwandte API-Elemente

fontSize

Eigenschaft 
fontSize:Number

Sprachversion: ActionScript 3.0
Laufzeitversionen: Flash Player 10, AIR 1.5, Flash Lite 4

Die Größe des Texts in Pixeln.

Der Standardwert ist 12,0.

UnterklasseEffekt der Einstellung der Eigenschaft
GraphicElementHat keinen Effekt.
GroupElementHat keinen Effekt.
TextElementBestimmt die Größe in Pixel, die für den Text im Element verwendet wird.



Implementierung
    public function get fontSize():Number
    public function set fontSize(value:Number):void

Auslöser
ArgumentError — Bei der Einstellung auf einen Wert, der kleiner als null ist.
 
IllegalOperationError — Falls die Einstellung erfolgt, nachdem das ElementFormat-Objekt gesperrt wurde (locked ist true).

kerning

Eigenschaft 
kerning:String

Sprachversion: ActionScript 3.0
Laufzeitversionen: Flash Player 10, AIR 1.5, Flash Lite 4

Beim Kerning werden die Pixel zwischen bestimmten Zeichenpaaren angepasst, um die Lesbarkeit zu verbessern. Kerning wird für alle Schriftarten unterstützt, die über Kerningtabellen verfügen.

Der Standardwert lautet Kerning.ON.

Um Werte für diese Eigenschaft festzulegen, verwenden Sie die folgenden Konstanten in der Kerning-Klasse:

StringwertBeschreibung
Kerning.ONKerning ist aktiviert.
Kerning.OFFKerning ist deaktiviert.
Kerning.AUTOKerning ist aktiviert, außer wenn es in der asiatischen Typografie unpassend ist. Kerning wird zwischen zwei Zeichen angewendet, wenn keines von beiden Kanji, Hiragana oder Katakana ist.

UnterklasseEffekt der Einstellung der Eigenschaft
GraphicElementHat keinen Effekt.
GroupElementBestimmt, ob Kerning zwischen benachbarten Textelementen in der Gruppe angewendet wird. Wenn das elementFormat der Gruppe null ist, wird das Format des ersten benachbarten Elements verwendet.
TextElementBestimmt, ob Kerning zwischen den Zeichen im Textelement angewendet wird.



Implementierung
    public function get kerning():String
    public function set kerning(value:String):void

Auslöser
IllegalOperationError — Falls die Einstellung erfolgt, nachdem das ElementFormat-Objekt gesperrt wurde (locked ist true).

Verwandte API-Elemente

ligatureLevel

Eigenschaft 
ligatureLevel:String

Sprachversion: ActionScript 3.0
Laufzeitversionen: Flash Player 10, AIR 1.5, Flash Lite 4

Die Ligaturstufe, die für diesen Text verwendet wird. Als Ligatur bezeichnet man zwei oder Buchstabenformen, die zu einer einzelnen Glyphe verbunden werden. Ligaturen ersetzen in der Regel aufeinanderfolgende Zeichen, die gemeinsame Komponenten aufweisen, beispielsweise die Buchstabenpaare fi, fl und ae. Sie werden sowohl für lateinische als auch nicht-lateinische Zeichensätze verwendet. Verwenden Sie LigatureLevel-Konstanten für diese Eigenschaft.

Der Standardwert lautet LigatureLevel.COMMON.

Wenn Sie Werte für diese Eigenschaft definieren möchten, verwenden Sie die folgenden Stringwerte:

StringwertBeschreibung
LigatureLevel.NONEEs werden keine Ligaturen erstellt.
LigatureLevel.MINIMUMEs werden minimale Ligaturen erstellt.
LigatureLevel.COMMONEs werden gebräuchliche Ligaturen erstellt.
LigatureLevel.UNCOMMONEs werden nicht gebräuchliche Ligaturen erstellt.
LigatureLevel.EXOTICEs werden exotische Ligaturen erstellt.

UnterklasseEffekt der Einstellung der Eigenschaft
GraphicElementHat keinen Effekt.
GroupElementBestimmt die Ligaturstufe zwischen benachbarten Textelementen in der Gruppe. Wenn das elementFormat der Gruppe null ist, wird das Format des ersten benachbarten Elements verwendet.
TextElementBestimmt die Ligaturstufe zwischen den Zeichen im Textelement.



Implementierung
    public function get ligatureLevel():String
    public function set ligatureLevel(value:String):void

Auslöser
ArgumentError — Falls ein Wert verwendet wird, der kein Mitglied von LigatureLevel ist.
 
IllegalOperationError — Falls die Einstellung erfolgt, nachdem das ElementFormat-Objekt gesperrt wurde (locked ist true).

Verwandte API-Elemente

locale

Eigenschaft 
locale:String

Sprachversion: ActionScript 3.0
Laufzeitversionen: Flash Player 10, AIR 1.5, Flash Lite 4

Das Gebietsschema des Texts. Steuert die Transformation und Form von Groß- und Kleinschreibung. Es werden Standardkennzeichner für Gebietsschemas verwendet. So sind „en“, „en_US“ und „en-US“ zum Beispiel alle Englisch, „ja“ ist Japanisch. Eine Liste der Gebietsschemacodes finden Sie unter iso639-2 code list.

Der Standardwert ist "en".

UnterklasseEffekt der Einstellung der Eigenschaft
GraphicElementHat keinen Effekt.
GroupElementHat keinen Effekt.
TextElementBestimmt Transformationen und Formen für den Text im Element.



Implementierung
    public function get locale():String
    public function set locale(value:String):void

Auslöser
IllegalOperationError — Falls die Einstellung erfolgt, nachdem das ElementFormat-Objekt gesperrt wurde (locked ist true).

locked

Eigenschaft 
locked:Boolean

Sprachversion: ActionScript 3.0
Laufzeitversionen: Flash Player 10, AIR 1.5., Flash Lite 4

Gibt an, ob das ElementFormat gesperrt ist. Falls der Wert true lautet, kann ElementFormat nicht geändert werden. Rufen Sie ElementFormat.clone() auf, um eine nicht gesperrte Kopie des ElementFormat-Objekts zu erstellen.



Implementierung
    public function get locked():Boolean
    public function set locked(value:Boolean):void

Auslöser
IllegalOperationError — Falls die Einstellung erfolgt, nachdem das ElementFormat-Objekt gesperrt wurde (locked ist true).

textRotation

Eigenschaft 
textRotation:String

Sprachversion: ActionScript 3.0
Laufzeitversionen: Flash Player 10, AIR 1.5, Flash Lite 4

Legt die Drehung fest, die auf einzelne Glyphen angewendet wird. Verwenden Sie für diese Eigenschaft die in der TextRotation-Klasse definierten Konstanten.

Der Standardwert lautet TextRotation.AUTO.

Die endgültige Drehung jeder Glyphe ist die Summe von ElementFormat.textRotation, ContentElement.textRotation und TextBlock.lineRotation.

Sie verwenden diese Eigenschaft typischerweise für asiatischen Text, in dem Zeichen für die korrekte Anzeige im vertikalen Layout gedreht werden müssen. Verwenden Sie TextRotation.AUTO zusammen mit TextBlock.lineRotation = TextRotation.ROTATE_90, um dies zu erreichen.

Wenn Sie diese Eigenschaft für Schriftarten einstellen, die keine Informationen zu vertikalem Layout enthalten, kann dies zu unerwünschten Ergebnissen führen. Schriftarten, wie die japanische Schrift MS Mincho, die eine vmtx- oder VORG-Tabelle enthalten, funktionieren ordnungsgemäß, da diese Tabellen die Daten bereitstellen, die die Layout-Engine für das richtige Layout benötigt. Bei Schriftarten wie Verdana, die die notwendigen Informationen nicht erhalten, ist dies hingegen nicht der Fall.

Wenn Sie Werte für diese Eigenschaft definieren möchten, verwenden Sie die folgenden Stringwerte:

StringwertBeschreibung
TextRotation.ROTATE_0Glyphen werden nicht gedreht.
TextRotation.ROTATE_90Glyphen werden um 90 Grad im Uhrzeigersinn gedreht.
TextRotation.ROTATE_180Glyphen werden um 180 Grad gedreht.
TextRotation.ROTATE_270Glyphen werden um 270 Grad im Uhrzeigersinn gedreht.
TextRotation.AUTOGibt eine Drehung um 90 Grad gegen den Uhrzeigersinn speziell für Glyphen mit voller Breite und breite Glyphen an, gemäß Unicode-Eigenschaften der Glyphe. Dieser Wert wird normalerweise bei asiatischem Text verwendet, um nur die Glyphen zu drehen, die eine Drehung erfordern. Diese Drehung wird nur in vertikalem Text angewendet, um Zeichen mit voller Breite bzw. breite Zeichen wieder vertikal auszurichten, ohne dabei andere Zeichen zu beeinträchtigen.

UnterklasseEffekt der Einstellung der Eigenschaft
GraphicElementHat keinen Effekt.
GroupElementHat keinen Effekt.
TextElementBestimmt die Drehung der Glyphen im Textelement.



Implementierung
    public function get textRotation():String
    public function set textRotation(value:String):void

Auslöser
ArgumentError — Falls ein Wert verwendet wird, der kein Mitglied von TextRotation ist.
 
IllegalOperationError — Falls die Einstellung erfolgt, nachdem das ElementFormat-Objekt gesperrt wurde (locked ist true).

Verwandte API-Elemente

trackingLeft

Eigenschaft 
trackingLeft:Number

Sprachversion: ActionScript 3.0
Laufzeitversionen: Flash Player 10, AIR 1.5., Flash Lite 4

Die Laufweite bzw. manuelles Kerning, das links neben jeder Glyphe angewendet wird, als Pixelwert. Wenn kerning aktiviert ist, wird der trackingLeft-Wert den Werten in der Kerningtabelle dieser Schriftart hinzugefügt. Wenn kerning deaktiviert ist, wird der trackingLeft-Wert als manueller Kerningwert verwendet. Unterstützt sowohl positive als auch negative Werte.

Der gewünschte Laufweitenwert wird in der Regel auf trackingRight und trackingLeft aufgeteilt. In Text mit gemischter Direktionalität tritt ansonsten an der einen bidirektionalen Grenze eine doppelte Laufweite auf und an der anderen Grenze keine.

Der Standardwert ist 0,0.

UnterklasseEffekt der Einstellung der Eigenschaft
GraphicElementBestimmt die auf die linke Seite der Grafik angewandte Laufweite.
GroupElementHat keinen Effekt.
TextElementBestimmt die auf die linke Seite der Zeichen im Textelement angewandte Laufweite.

Beispiel:

          //positive tracking added to kerning
          var ef1:ElementFormat = new ElementFormat();
          ef1.kerning = flash.text.engine.Kerning.ON;
          ef1.trackingLeft = 0.5;
     
          //negative manual kerning
          var ef2:ElementFormat = new ElementFormat();
          ef2.kerning = flash.text.engine.Kerning.OFF;
          ef2.trackingLeft = -1.0;
     



Implementierung
    public function get trackingLeft():Number
    public function set trackingLeft(value:Number):void

Auslöser
IllegalOperationError — Falls die Einstellung erfolgt, nachdem das ElementFormat-Objekt gesperrt wurde (locked ist true).

trackingRight

Eigenschaft 
trackingRight:Number

Sprachversion: ActionScript 3.0
Laufzeitversionen: Flash Player 10, AIR 1.5., Flash Lite 4

Die Laufweite bzw. manuelles Kerning, das rechts neben jeder Glyphe angewendet wird, als Pixelwert. Wenn kerning aktiviert ist, wird der trackingRight-Wert den Werten in der Kerningtabelle dieser Schriftart hinzugefügt. Wenn kerning deaktiviert ist, wird der trackingRight-Wert als manueller Kerningwert verwendet. Unterstützt sowohl positive als auch negative Werte.

Der gewünschte Laufweitenwert wird in der Regel auf trackingRight und trackingLeft aufgeteilt. In Text mit gemischter Direktionalität tritt ansonsten an der einen bidirektionalen Grenze eine doppelte Laufweite auf und an der anderen Grenze keine.

Der Standardwert ist 0,0.

UnterklasseEffekt der Einstellung der Eigenschaft
GraphicElementBestimmt die auf die rechte Seite der Grafik angewandte Laufweite.
GroupElementHat keinen Effekt.
TextElementBestimmt die auf die rechte Seite der Zeichen im Textelement angewandte Laufweite.

Beispiel:

          //positive tracking added to kerning
          var ef1:ElementFormat = new ElementFormat();
          ef1.kerning = flash.text.engine.Kerning.ON;
          ef1.trackingRight = 0.5;
     
          //negative manual kerning
          var ef2:ElementFormat = new ElementFormat();
          ef2.kerning = flash.text.engine.Kerning.OFF;
          ef2.trackingRight = -1.0;
     



Implementierung
    public function get trackingRight():Number
    public function set trackingRight(value:Number):void

Auslöser
IllegalOperationError — Falls die Einstellung erfolgt, nachdem das ElementFormat-Objekt gesperrt wurde (locked ist true).

typographicCase

Eigenschaft 
typographicCase:String

Sprachversion: ActionScript 3.0
Laufzeitversionen: Flash Player 10, AIR 1.5, Flash Lite 4

Die Groß-/Kleinschreibung, die für diesen Text verwendet wird. Verwenden Sie für diese Eigenschaft die in der TypographicCase-Klasse definierten Konstanten.

Der Standardwert lautet TypographicCase.DEFAULT.

Wenn Sie Werte für diese Eigenschaft definieren möchten, verwenden Sie die folgenden Stringwerte:

StringwertBeschreibung
TypographicCase.DEFAULTGibt an, dass die normale Buchstabenart für alle Zeichen verwendet wird.
TypographicCase.TITLEGibt an, dass Großbuchstaben bei der Ausgabe Titelglyphen verwenden.
TypographicCase.CAPSGibt an, dass der Abstand bei der Ausgabe für Großbuchstaben angepasst wird.
TypographicCase.SMALL_CAPSGibt an, dass Großbuchstaben bei der Ausgabe Kapitälchenglyphen verwenden.
TypographicCase.UPPERCASEGibt an, dass alle Buchstaben bei der Ausgabe Großbuchstabenglyphen verwenden.
TypographicCase.LOWERCASEGibt an, dass alle Buchstaben bei der Ausgabe Kleinbuchstabenglyphen verwenden.
TypographicCase.CAPS_AND_SMALL_CAPSGibt an, dass alle Kleinbuchstaben bei der Ausgabe Kapitälchenglyphen verwenden.

UnterklasseEffekt der Einstellung der Eigenschaft
GraphicElementHat keinen Effekt.
GroupElementHat keinen Effekt.
TextElementBestimmt die Groß-/Kleinschreibung, die für den Text im Element verwendet wird.



Implementierung
    public function get typographicCase():String
    public function set typographicCase(value:String):void

Auslöser
ArgumentError — Falls ein Wert verwendet wird, der kein Mitglied von TypographicCase ist.
 
IllegalOperationError — Falls die Einstellung erfolgt, nachdem das ElementFormat-Objekt gesperrt wurde (locked ist true).

Verwandte API-Elemente

Konstruktordetails

ElementFormat

()Konstruktor
public function ElementFormat(fontDescription:FontDescription = null, fontSize:Number = 12.0, color:uint = 0x000000, alpha:Number = 1.0, textRotation:String = "auto", dominantBaseline:String = "roman", alignmentBaseline:String = "useDominantBaseline", baselineShift:Number = 0.0, kerning:String = "on", trackingRight:Number = 0.0, trackingLeft:Number = 0.0, locale:String = "en", breakOpportunity:String = "auto", digitCase:String = "default", digitWidth:String = "default", ligatureLevel:String = "common", typographicCase:String = "default")

Sprachversion: ActionScript 3.0
Laufzeitversionen: Flash Player 10, AIR 1.5, Flash Lite 4

Erstellt ein ElementFormat-Objekt.

Parameter
fontDescription:FontDescription (default = null) — Das FontDescription-Objekt, das die mit diesem Elementformat verwendete Schriftart angibt. Der Standardwert ist null. Wenn keine FontDescription bereitgestellt ist, wird eine Standard-FontDescription konstruiert.
 
fontSize:Number (default = 12.0) — Die Größe des Texts in Pixeln.
 
color:uint (default = 0x000000) — Die Textfarbe. Eine Hexadezimalzahl mit drei 8-Bit-RGB-Komponenten. 0xFF0000 ist beispielsweise Rot und 0x00FF00 Grün.
 
alpha:Number (default = 1.0) — Die alpha-Eigenschaft, die basierend auf dem Elementformat auf alle Zeilenatome angewendet wird.
 
textRotation:String (default = "auto") — die Drehung, die auf einzelne Glyphen angewendet wird. Verwenden Sie TextRotation-Konstanten für diese Eigenschaft.
 
dominantBaseline:String (default = "roman") — Die Grundlinie, an der die Glyphen im Text ausgerichtet werden. Verwenden Sie TextBaseline-Konstanten für diese Eigenschaft.
 
alignmentBaseline:String (default = "useDominantBaseline") — Die Grundlinie auf der enthaltenden Zeile, an der die dominante Grundlinie ausgerichtet wird. Verwenden Sie TextBaseline-Konstanten für diese Eigenschaft.
 
baselineShift:Number (default = 0.0) — Die Grundlinienverschiebung für den Text in Pixel-Geviert.
 
kerning:String (default = "on") — Das auf diesen Text angewendete Kerning. Verwenden Sie in der Kerning-Klasse definierte Konstanten.
 
trackingRight:Number (default = 0.0) — Die Laufweite bzw. manuelles Kerning, das rechts neben jeder Glyphe angewendet wird, als Pixelwert.
 
trackingLeft:Number (default = 0.0) — Die Laufweite bzw. manuelles Kerning, das links neben jeder Glyphe angewendet wird, als Pixelwert.
 
locale:String (default = "en") — Das Gebietsschema für den Text.
 
breakOpportunity:String (default = "auto") — Die Zeilenumbruchmöglichkeit, die auf diesen Text angewendet wird. Verwenden Sie BreakOpportunity-Konstanten für diese Eigenschaft.
 
digitCase:String (default = "default") — Die Ziffernschreibweise, die für diesen Text verwendet wird. Verwenden Sie DigitCase-Konstanten für diese Eigenschaft.
 
digitWidth:String (default = "default") — Die Ziffernbreite, die für diesen Text verwendet wird. Verwenden Sie DigitWidth-Konstanten für diese Eigenschaft.
 
ligatureLevel:String (default = "common") — Die Ligaturstufe, die für diesen Text verwendet wird. Verwenden Sie LigatureLevel-Konstanten für diese Eigenschaft.
 
typographicCase:String (default = "default") — Die Groß-/Kleinschreibung, die für diesen Text verwendet wird. Verwenden Sie TypographicCase-Konstanten für diese Eigenschaft.

Auslöser
ArgumentError — Die angegebene fontSize ist kleiner als 0.
 
ArgumentError — Die angegebene textRotation ist kein Mitglied von TextRotation.
 
ArgumentError — Die angegebene dominantBaseline ist kein Mitglied von TextBaseline.
 
ArgumentError — Die angegebene alignmentBaseline ist kein Mitglied von TextBaseline.
 
ArgumentError — Das angegebene kerning ist kein Mitglied von Kerning.
 
ArgumentError — Die angegebene breakOpportunity ist kein Mitglied von BreakOpportunity.
 
ArgumentError — Die angegebene digitCase ist kein Mitglied von DigitCase.
 
ArgumentError — Die angegebene digitWidth ist kein Mitglied von DigitWidth.
 
ArgumentError — Der angegebene ligatureLevel ist kein Mitglied von LigatureLevel.
 
ArgumentError — Der angegebene typographicCase ist kein Mitglied von TypographicCase.
Methodendetails

clone

()Methode
public function clone():ElementFormat

Sprachversion: ActionScript 3.0
Laufzeitversionen: Flash Player 10, AIR 1.5, Flash Lite 4

Erstellt eine nicht gesperrte geklonte Kopie von ElementFormat.

Rückgabewerte
ElementFormat — Eine nicht gesperrte Kopie des ElementFormat-Objekts.

Beispiel  ( Verwendung dieses Beispiels )

In diesem Beispiel wird ein ElementFormat-Objekt erstellt und eine FontSize festgelegt. Es wird ein neues TextElement mit ElementFormat erstellt (wodurch es gesperrt wird) und das TextElement wird als Inhalt für einen TextBlock verwendet. Im TextBlock wird eine Textzeile erstellt.

Bevor Sie einElementFormat-Objekt ändern, müssen Sie zuerst dessen locked-Eigenschaft überprüfen. Wenn sie „true“ ist, verwenden Sie die clone()-Methode, um eine nicht gesperrte Kopie des ElementFormat zu erstellen, ändern Sie seine Eigenschaften und verbinden Sie dann das neue ElementFormat mit dem TextBlock. Wenn die Zeilen neu umbrochen werden, weisen die neuen Zeilen die neuen Schrifteinstellungen auf.

package {

    import flash.display.Sprite;
    import flash.text.engine.*;

    
    public class ElementFormat_cloneExample extends Sprite {
        private var ef1:ElementFormat;
        private var ef2:ElementFormat;
        
        public function ElementFormat_cloneExample():void {
            var fd:FontDescription = new FontDescription();
            fd.fontLookup = flash.text.engine.FontLookup.DEVICE;
            fd.fontName = "Palatino";

            var ef1:ElementFormat = new ElementFormat(fd);
            ef1.fontSize=20;
            
            var str:String = "This is flash text 0123456789";
            var tb:TextBlock = new TextBlock();
            var te1:TextElement = new TextElement(str, ef1);
            tb.content = te1;
            var line1:TextLine = tb.createTextLine(null, 600);
            addChild(line1);
            
            ef2 = (ef1.locked) ? ef1.clone() : ef1;    
            ef2.fontSize = 32;

            tb.content.elementFormat=ef2;
            var line2:TextLine = tb.createTextLine(null, 600);
            addChild(line2);
            
        }
    }    
}

getFontMetrics

()Methode 
public function getFontMetrics():FontMetrics

Sprachversion: ActionScript 3.0
Laufzeitversionen: Flash Player 10, AIR 1.5, Flash Lite 4

Gibt ein FontMetrics-Objekt mit Eigenschaften zurück, die die emBox, die Position der Durchstreichen-Linie, die Stärke der Durchstreichen-Linie, die Position der Unterstreichen-Linie und die Stärke der Unterstreichen-Linie für die mit fontDescription und fontSize angegebene Schriftart beschreiben.

Rückgabewerte
FontMetrics — Ein FontMetrics-Objekt mit beschreibenden Eigenschaften der mit fontDescription angegebenen Schriftart.

Verwandte API-Elemente


Beispiel  ( Verwendung dieses Beispiels )

In diesem Beispiel wird ein ElementFormat-Objekt mit einer zugewiesenen FontDescription erstellt und mit der getFontMetrics-Methode werden Metriken für die ausgewählte 24 Punkt-Schriftart angezeigt.
package {

    import flash.display.Sprite;
    import flash.text.engine.*;

    
    public class FontMetricsExample extends Sprite {
        
        public function FontMetricsExample():void {
            var fd:FontDescription = new FontDescription();
            fd.fontName = "Garamond";
            fd.fontWeight = flash.text.engine.FontWeight.BOLD;

            var ef1:ElementFormat = new ElementFormat(fd);
            ef1.fontSize = 24;            
            var fm1:FontMetrics = ef1.getFontMetrics();

            trace(fm1.emBox);
            trace(fm1.strikethroughOffset);
            trace(fm1.strikethroughThickness);
            trace(fm1.subscriptScale);
            trace(fm1.subscriptOffset);
            trace(fm1.superscriptScale);
            trace(fm1.superscriptOffset);
            trace(fm1.underlineOffset);
            trace(fm1.underlineThickness);
            
            
        }
    }    
}
ElementFormatExample.as

In diesem Beispiel werden zwei ElementFormat-Objekte erstellt und verschiedene ihrer Eigenschaften festgelegt. Die neuen ElementFormat-Objekte werden dann einem TextElement-Objekt zugewiesen, das als Inhalt eines TextBlock zugewiesen wurde. Beachten Sie, dass das Ändern des ElementFormat eines TextElement sich nicht auf TextLines auswirkt, die zuvor vom übergeordneten TextBlock erstellt wurden.

package {

    import flash.display.Sprite;
    import flash.text.engine.*;

    
    public class ElementFormatExample extends Sprite {
        
        public function ElementFormatExample():void {
            var fd:FontDescription = new FontDescription();
            fd.fontName = "Garamond";
            fd.fontWeight = flash.text.engine.FontWeight.BOLD;

            var ef1:ElementFormat = new ElementFormat(fd);
            ef1.fontSize = 30;
            ef1.color = 0xFF0000;
            ef1.alpha = 100;
            ef1.kerning = flash.text.engine.Kerning.ON;
            ef1.trackingRight = 2;
            ef1.typographicCase = flash.text.engine.TypographicCase.UPPERCASE;
            ef1.alignmentBaseline = flash.text.engine.TextBaseline.DESCENT;
            ef1.ligatureLevel = flash.text.engine.LigatureLevel.EXOTIC;
            
            var ef2:ElementFormat = new ElementFormat(fd);
            ef2.fontSize = 30;
            ef2.color = 0xFF0000;
            ef2.alpha = 0.3;
            ef2.kerning = flash.text.engine.Kerning.OFF;
            ef2.typographicCase = flash.text.engine.TypographicCase.LOWERCASE;
            ef2.digitCase = flash.text.engine.DigitCase.OLD_STYLE;
            ef2.textRotation = flash.text.engine.TextRotation.ROTATE_180;
            
            var str:String = "This is flash text 0123456789";
            var tb:TextBlock = new TextBlock();
            var te1:TextElement = new TextElement(str, ef1);
            tb.content = te1;
            var line1:TextLine = tb.createTextLine(null, 600);
            addChild(line1);
            line1.x = 15;
            line1.y = 30;

            tb.content.elementFormat = ef2;
            var line2:TextLine = tb.createTextLine(null, 600);
            addChild(line2);
            line2.x = 15;
            line2.y = 60;
            
        }
    }    
}




[ X ]Warum auf Englisch?
Inhalt des ActionScript 3.0-Referenzhandbuchs wird in englischer Sprache angezeigt

Nicht alle Teile des ActionScript 3.0-Referenzhandbuchs wurden in alle Sprachen übersetzt. Wenn der Text zu einem Sprachelement nicht übersetzt wurde, wird er auf Englisch angezeigt. Zum Beispiel wurden die Informationen zur ga.controls.HelpBox-Klasse nicht in andere Sprachen übersetzt. In der deutschen Version des Referenzhandbuchs erscheint der Abschnitt zur ga.controls.HelpBox-Klasse deshalb auf Englisch.