TextSnapshot - Adobe ActionScript® 3 (AS3 ) API-Referenz

Paket	flash.text
Klasse	public class TextSnapshot
Vererbung	TextSnapshot Object

Sprachversion:

ActionScript 3.0

Laufzeitversionen:

AIR 1.0, Flash Player 9, Flash Lite 4

Mit TextSnapshot-Objekten können Sie mit statischem Text in einem Movieclip arbeiten. Sie können die Objekte beispielsweise für ein präziseres Textlayout verwenden, als dies mit dynamischem Text möglich ist, jedoch weiterhin gewährleisten, dass der Text beim Zugriff schreibgeschützt ist.

Zum Erstellen eines TextSnapshot-Objekts ist kein Konstruktor erforderlich. Das Objekt wird von der Eigenschaft flash.display.DisplayObjectContainer.textSnapshot zurückgegeben.

Verwandte API-Elemente

flash.display.DisplayObjectContainer.textSnapshot

Öffentliche Eigenschaften

Vererbte öffentliche Eigenschaften ausblenden

Vererbte öffentliche Eigenschaften anzeigen

	Eigenschaft		Definiert von
		charCount : int [schreibgeschützt] Gibt die Zeichenanzahl in einem TextSnapshot-Objekt zurück.	TextSnapshot
		constructor : Object Ein Verweis auf das Klassenobjekt oder die Konstruktorfunktion für eine angegebene Objektinstanz.	Object

Öffentliche Methoden

Vererbte öffentliche Methoden ausblenden

Vererbte öffentliche Methoden anzeigen

	Methode		Definiert von
		findText(beginIndex:int, textToFind:String, caseSensitive:Boolean):int Sucht nach dem angegebenen TextSnapshot-Objekt und gibt die Position des ersten Auftretens von „textToFind“ bei oder nach „beginIndex“ zurück.	TextSnapshot
		getSelected(beginIndex:int, endIndex:int):Boolean Gibt einen booleschen Wert zurück, der angibt, ob ein TextSnapshot-Objekt ausgewählten Text im angegebenen Bereich enthält.	TextSnapshot
		getSelectedText(includeLineEndings:Boolean = false):String Gibt einen String zurück, der alle von der entsprechenden setSelected()-Methode angegebenen Zeichen enthält.	TextSnapshot
		getText(beginIndex:int, endIndex:int, includeLineEndings:Boolean = false):String Gibt einen String zurück, der alle Zeichen enthält, die mit den Parametern „beginIndex“ und „endIndex“ angegeben werden.	TextSnapshot
		getTextRunInfo(beginIndex:int, endIndex:int):Array Gibt ein Array von Objekten zurück, das Informationen über eine Textreihe enthält.	TextSnapshot
		hasOwnProperty(name:String):Boolean Gibt an, ob für ein Objekt eine bestimmte Eigenschaft definiert wurde.	Object
		hitTestTextNearPos(x:Number, y:Number, maxDistance:Number = 0):Number Hiermit können Sie bestimmen, welches Zeichen innerhalb eines TextSnapshot-Objekts sich nahe an oder auf den angegebenen x- und y-Koordinaten des Movieclips befindet, der den Text im TextSnapshot-Objekt enthält.	TextSnapshot
		isPrototypeOf(theClass:Object):Boolean Gibt an, ob eine Instanz der Object-Klasse in der Prototypkette des Objekts vorhanden ist, das als Parameter angegeben wurde.	Object
		propertyIsEnumerable(name:String):Boolean Gibt an, ob die angegebene Eigenschaft vorhanden ist und durchlaufen werden kann.	Object
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Legt die Verfügbarkeit einer dynamischen Eigenschaft für Schleifenoperationen fest.	Object
		setSelectColor(hexColor:uint = 0xFFFF00):void Gibt die zu verwendende Farbe zum Hervorheben von Zeichen an, die mit der Methode „setSelected()“ ausgewählt wurden.	TextSnapshot
		setSelected(beginIndex:int, endIndex:int, select:Boolean):void Gibt eine Reihe von Zeichen in einem TextSnapshot-Objekt an, die ausgewählt werden sollen bzw. deren Auswahl aufgehoben werden soll.	TextSnapshot
		toLocaleString():String Gibt die Stringdarstellung dieses Objekts zurück, formatiert entsprechend den Konventionen des Gebietsschemas.	Object
		toString():String Gibt das angegebene Objekt als String zurück.	Object
		valueOf():Object Gibt den Grundwert des angegebenen Objekts zurück.	Object

Eigenschaftendetails

charCount

Eigenschaft

charCount:int [schreibgeschützt]

Sprachversion:

ActionScript 3.0

Laufzeitversionen:

AIR 1.0, Flash Player 9, Flash Lite 4

Gibt die Zeichenanzahl in einem TextSnapshot-Objekt zurück.

Implementierung
public function get charCount():int

Verwandte API-Elemente

flash.text.TextSnapshot.getText()

Methodendetails

findText

()

Methode

public function findText(beginIndex:int, textToFind:String, caseSensitive:Boolean):int

Sprachversion:

ActionScript 3.0

Laufzeitversionen:

AIR 1.0, Flash Player 9, Flash Lite 4

Sucht nach dem angegebenen TextSnapshot-Objekt und gibt die Position des ersten Auftretens von textToFind bei oder nach beginIndex zurück. Wenn textToFind nicht gefunden wird, gibt die Methode -1 zurück.

Parameter

	`beginIndex:int` — Gibt den Startpunkt für die Suche nach dem angegebenen Text an.

	`textToFind:String` — Gibt den zu suchenden Text an. Wenn Sie ein Stringliteral statt einer Variable vom Typ „String“ angeben, setzen Sie Anführungszeichen um den String.

	`caseSensitive:Boolean` — Gibt an, ob der Text dem String aus `textToFind` in Groß- und Kleinschreibung entsprechen muss.

Rückgabewerte

int — Die auf null basierende Indexposition des ersten Vorkommens des angegebenen Texts (oder -1).

Verwandte API-Elemente

flash.text.TextSnapshot.getText()

getSelected

()

Methode

public function getSelected(beginIndex:int, endIndex:int):Boolean

Sprachversion:

ActionScript 3.0

Laufzeitversionen:

AIR 1.0, Flash Player 9, Flash Lite 4

Gibt einen booleschen Wert zurück, der angibt, ob ein TextSnapshot-Objekt ausgewählten Text im angegebenen Bereich enthält.

Wenn Sie alle Zeichen durchsuchen möchten, übergeben Sie den Wert 0 für start und charCount (oder eine sehr große Zahl) für end. Wenn Sie nur ein Zeichen durchsuchen möchten, übergeben Sie für den Parameter end eine Zahl, die um eins größer ist als der Wert des Parameters start.

Parameter

	`beginIndex:int` — Gibt die Position des ersten zu untersuchenden Zeichens an. Gültige Werte für `beginIndex` sind `0` bis `TextSnapshot.charCount - 1`. Ist `beginIndex` ein negativer Wert, wird `0` verwendet.

	`endIndex:int` — Ein Wert, der gegenüber der Indexposition des letzten zu prüfenden Zeichens um eins erhöht wurde. Gültige Werte für `endIndex` sind `0` bis `charCount`. Das durch den Parameter `endIndex` indizierte Zeichen wird nicht in den extrahierten String aufgenommen. Wenn Sie diesen Parameter weglassen, wird `charCount` verwendet. Ist dieser Wert kleiner oder gleich dem Wert von `beginIndex`, wird `beginIndex + 1` verwendet.

Rückgabewerte

Boolean — Ein boolescher Wert, der angibt, ob mindestens ein Zeichen im Bereich von der jeweiligen setSelected()-Methode ausgewählt wurde (true) oder nicht (false).

Verwandte API-Elemente

flash.text.TextSnapshot.charCount
flash.text.TextSnapshot.getText()
flash.text.TextSnapshot.getSelectedText()
flash.text.TextSnapshot.setSelected()

getSelectedText

()

Methode

public function getSelectedText(includeLineEndings:Boolean = false):String

Sprachversion:

ActionScript 3.0

Laufzeitversionen:

AIR 1.0, Flash Player 9., Flash Lite 4

Gibt einen String zurück, der alle von der entsprechenden setSelected()-Methode angegebenen Zeichen enthält. Werden (von der setSelected()-Methode) keine Zeichen angegeben, wird ein leerer String zurückgegeben.

Wenn Sie true für includeLineEndings übergeben, werden in den Rückgabe-String Zeilenumbrüche integriert, sodass dieser länger als der Eingabebereich sein kann. Ist includeLineEndings false oder wird dieser Wert weggelassen, gibt die Methode den ausgewählten Text zurück, ohne Zeichen hinzuzufügen.

Parameter

includeLineEndings:Boolean (default = false) — Ein optionaler boolescher Wert, der festlegt, ob bei Bedarf Zeilenumbrüche in den Rückgabestring integriert werden. Der Standardwert ist false.

Rückgabewerte

String — Ein String, der alle vom entsprechenden setSelected()-Befehl angegebenen Zeichen enthält.

Verwandte API-Elemente

flash.text.TextSnapshot.getSelected()
flash.text.TextSnapshot.setSelected()

getText

()

Methode

public function getText(beginIndex:int, endIndex:int, includeLineEndings:Boolean = false):String

Sprachversion:

ActionScript 3.0

Laufzeitversionen:

AIR 1.0, Flash Player 9., Flash Lite 4

Gibt einen String zurück, der alle Zeichen enthält, die mit den Parametern beginIndex und endIndex angegeben werden. Werden keine Zeichen ausgewählt, wird ein leerer String zurückgegeben.

Wenn alle Zeichen zurückgegeben werden sollen, übergeben Sie den Wert 0 für beginIndex und charCount (oder eine sehr große Zahl) für endIndex. Um ein einzelnes Zeichen zurückzugeben, geben Sie den Wert beginIndex + 1 für endIndex an.

Wenn Sie den Wert true für includeLineEndings übergeben, werden bei Bedarf Zeilenumbrüche in den Rückgabestring eingefügt. In diesem Fall überschreitet der Rückgabestring unter Umständen den zulässigen Eingabebereich. Ist includeLineEndings false oder wird dieser Wert weggelassen, wird der ausgewählte Text ohne zusätzliche Zeichen zurückgegeben.

Parameter

	`beginIndex:int` — Gibt die Position des ersten Zeichens an, das in den Rückgabestring aufgenommen werden soll. Gültige Werte für `beginIndex` sind `0` bis `charCount - 1`. Ist `beginIndex` ein negativer Wert, wird `0` verwendet.

	`endIndex:int` — Ein Wert, der gegenüber der Indexposition des letzten zu prüfenden Zeichens um eins erhöht wurde. Gültige Werte für `endIndex` sind `0` bis `charCount`. Das durch den Parameter `endIndex` indizierte Zeichen wird nicht in den extrahierten String aufgenommen. Wenn Sie diesen Parameter weglassen, wird `charCount` verwendet. Ist dieser Wert kleiner oder gleich dem Wert von `beginIndex`, wird `beginIndex + 1` verwendet.

	`includeLineEndings:Boolean` (default = `false`) — Ein optionaler boolescher Wert, der festlegt, ob bei Bedarf Zeilenumbrüche in den Rückgabestring integriert werden (`true`) oder nicht (`false`). Der Standardwert ist `false`.

Rückgabewerte

String — Ein String, der die Zeichen des angegebenen Bereichs enthält, oder ein leerer String, wenn im angegebenen Bereich keine Zeichen gefunden wurden.

Verwandte API-Elemente

flash.text.TextSnapshot.charCount
flash.text.TextSnapshot.getSelectedText()

getTextRunInfo

()

Methode

public function getTextRunInfo(beginIndex:int, endIndex:int):Array

Sprachversion:

ActionScript 3.0

Laufzeitversionen:

AIR 1.0, Flash Player 9, Flash Lite 4

Gibt ein Array von Objekten zurück, das Informationen über eine Textreihe enthält. Jedes Objekt entspricht einem Zeichen in dem mit den zwei Methodenparametern angegebenen Zeichenbereich.

Hinweis: Bei Verwendung der getTextRunInfo()-Methode für einen großen Textbereich kann ein großes Objekt zurückgegeben werden. Adobe empfiehlt, den durch die Parameter beginIndex und endIndex definierten Textbereich zu begrenzen.

Parameter

	`beginIndex:int` — Der Indexwert des ersten Zeichens in einem Zeichenbereich eines TextSnapshot-Objekts.

	`endIndex:int` — Der Indexwert des letzten Zeichens in einem Zeichenbereich eines TextSnapshot-Objekts.

Rückgabewerte

Array — Ein Objekt-Array, in dem jedes Objekt Informationen zu einem bestimmten Zeichen im von den Parametern beginIndex und endIndex angegebenen Bereich enthält. Jedes Objekt enthält die folgenden elf Eigenschaften:

indexInRun: Ganzzahliger Index des Zeichens mit der Basis null. Dieser ist nicht relativ zur ausgewählten Textreihe, sondern zum gesamten String.
selected: Ein boolescher Wert, der angibt, ob das Zeichen ausgewählt ist (true) oder nicht (false).
font: Die Schriftart des Zeichens.
color: Der kombinierte Alpha- und Farbwert des Zeichens. Die ersten beiden hexadezimalen Stellen stehen für den Alphawert, die übrigen für den Farbwert.
height: Die Höhe des Zeichens in Pixel.
matrix_a, matrix_b, matrix_c, matrix_d, matrix_tx und matrix_ty: Die Werte einer Matrix, die die geometrische Umwandlung des Zeichens definieren. In der Regel weist aufrechter Text eine Matrix in der Form [1 0 0 1 x y] auf. Hierbei stehen x und y für die Position des Zeichens im übergeordneten Movieclip (unabhängig von der Texthöhe). Die Matrix liegt im Koordinatensystem des übergeordneten Movieclips und umfasst keine Transformationen im Movieclip selbst (oder in dessen übergeordnetem Element).
corner0x, corner0y, corner1x, corner1y, corner2x, corner2y, corner3x und corner3y: Die Ecken des Begrenzungsrahmens des Zeichens, basierend auf dem Koordinatensystem des übergeordneten Movieclips. Diese Werte stehen nur dann zur Verfügung, wenn die vom Zeichen verwendete Schrift in die SWF-Datei eingebettet ist.

Verwandte API-Elemente

Matrix-Klasse

hitTestTextNearPos

()

Methode

public function hitTestTextNearPos(x:Number, y:Number, maxDistance:Number = 0):Number

Sprachversion:

ActionScript 3.0

Laufzeitversionen:

AIR 1.0, Flash Player 9., Flash Lite 4

Damit können Sie bestimmen, welches Zeichen innerhalb eines TextSnapshot-Objekts sich nahe an oder auf den angegebenen x, y-Koordinaten des Movieclips befindet, der den Text im TextSnapshot-Objekt enthält.

Wenn Sie den Wert 0 für maxDistance übergeben oder diesen Parameter auslassen, muss sich der durch die x-, y-Koordinaten angegebene Ort innerhalb der Begrenzungsbox des TextSnapshot-Objekts befinden.

Diese Methode funktioniert nur für Schriftarten ordnungsgemäß, die metrische Zeicheninformationen enthalten. Das Flash-Authoring-Tool nimmt diese Informationen für statische Textfelder jedoch standardmäßig nicht auf. Aus diesem Grund kann die Methode an Stelle eines Indexwerts -1 zurückgeben. Um die Rückgabe eines Indexwerts sicherzustellen, können Sie die Flash-Authoring-Anwendung zwingen, die metrischen Zeicheninformationen für eine Schriftart aufzunehmen. Dazu müssen Sie ein dynamisches Textfeld hinzufügen, das diese Schriftart verwendet, für dieses dynamische Textfeld „Zeichenoptionen“ auswählen und angeben, dass die Schriftkonturen für mindestens ein Zeichen eingebettet werden sollen. Es ist gleich, welche Zeichen Sie angeben; sie müssen nicht einmal in den fraglichen statischen Textfeldern verwendet werden.

Parameter

	`x:Number` — Eine Zahl, die für die `x`-Koordinate des Movieclips mit dem Text steht.

	`y:Number` — Eine Zahl, die für die `y`-Koordinate des Movieclips mit dem Text steht.

	`maxDistance:Number` (default = `0`) — Eine optionale Zahl, die den maximalen Abstand von dem durch `x` und `y` definierten Punkt darstellt, an dem nach Text gesucht werden kann. Der Abstand wird vom Mittelpunkt der einzelnen Zeichen gemessen. Der Standardwert ist `0`.

Rückgabewerte

Number — Eine Zahl, die für den Indexwert des Zeichens steht, das sich am nächsten an der angegebenen x- und y-Koordinate befindet. Gibt -1 zurück, wenn kein Zeichen gefunden wurde oder die Schriftart keine metrischen Zeicheninformationen enthält.

Verwandte API-Elemente

flash.display.DisplayObject.x
flash.display.DisplayObject.y

setSelectColor

()

Methode

public function setSelectColor(hexColor:uint = 0xFFFF00):void

Sprachversion:

ActionScript 3.0

Laufzeitversionen:

AIR 1.0, Flash Player 9., Flash Lite 4

Gibt die zu verwendende Farbe zum Hervorheben von Zeichen an, die mit der Methode setSelected() ausgewählt wurden. Die Farbe ist immer undurchsichtig; Sie können keinen Transparenzwert festlegen.

Parameter

hexColor:uint (default = 0xFFFF00) — Die Farbe für die Begrenzungen um Zeichen, die mit dem entsprechenden setSelected()-Befehl ausgewählt wurden. Die Farbe wird im Hexadezimalformat (0xRRGGBB) angegeben.

Verwandte API-Elemente

flash.text.TextSnapshot.setSelected()

setSelected

()

Methode

public function setSelected(beginIndex:int, endIndex:int, select:Boolean):void

Sprachversion:

ActionScript 3.0

Laufzeitversionen:

AIR 1.0, Flash Player 9., Flash Lite 4

Gibt eine Reihe von Zeichen in einem TextSnapshot-Objekt an, die ausgewählt werden sollen bzw. deren Auswahl aufgehoben werden soll. Ausgewählte Zeichen werden mit einem farbigen Rechteck hinterlegt dargestellt, das der Begrenzungsbox des Zeichens entspricht. Die Farbe der Begrenzungsbox wird von setSelectColor() definiert.

Wenn Sie alle Zeichen auswählen oder die Auswahl für alle Zeichen aufheben möchten, übergeben Sie den Wert 0 für beginIndex und charCount (oder eine sehr große Zahl) für endIndex. Um ein einzelnes Zeichen anzugeben, geben Sie den Wert start + 1 für endIndex an.

Da Zeichen individuell als ausgewählt markiert sind, können Sie diese Methode mehrfach aufrufen, um mehrere Zeichen auszuwählen; d. h., durch Verwendung dieser Methode wird die Auswahl anderer Zeichen, die durch diesen Befehl gesetzt wurden, nicht aufgehoben.

Das farbige Rechteck, mit dem eine Auswahl markiert ist, wird nur für Schriftarten angezeigt, die metrische Zeicheninformationen enthalten. Flash nimmt diese Informationen für statische Textfelder standardmäßig nicht auf. In einigen Fällen bedeutet dieses Verhalten, dass ausgewählter Text nicht als ausgewählt auf dem Bildschirm angezeigt wird. Um sicherzustellen, dass ausgewählter Text auch ausgewählt angezeigt wird, können Sie die Flash-Authoring-Anwendung zwingen, die Flash-Authoring-Anwendung für eine Schriftart aufzunehmen. Dazu müssen Sie ein dynamisches Textfeld hinzufügen, das diese Schriftart verwendet, für dieses dynamische Textfeld „Zeichenoptionen“ auswählen und angeben, dass die Schriftkonturen für mindestens ein Zeichen eingebettet werden sollen. Es spielt keine Rolle, welche Zeichen Sie angeben; sie müssen nicht einmal in den fraglichen statischen Textfeldern verwendet werden.

Parameter

	`beginIndex:int` — Gibt die Position des ersten auszuwählenden Zeichens an. Gültige Werte für `beginIndex` sind `0` bis `charCount - 1`. Ist `beginIndex` ein negativer Wert, wird `0` verwendet.

	`endIndex:int` — Eine Ganzzahl, die um 1 größer ist als der Index des letzten zu prüfenden Zeichens. Gültige Werte für `end` sind `0` bis `charCount`. Das durch den Parameter `end` indizierte Zeichen wird nicht in den extrahierten String aufgenommen. Wenn Sie diesen Parameter weglassen, wird `TextSnapshot.charCount` verwendet. Ist der Wert von `beginIndex` kleiner oder gleich dem Wert von `endIndex`, wird `beginIndex + 1` verwendet.

	`select:Boolean` — Ein boolescher Wert, der angibt, ob der Text ausgewählt werden soll (`true`) oder ob die Textauswahl aufgehoben werden soll (`false`).

Verwandte API-Elemente

flash.text.TextSnapshot.charCount
flash.text.TextSnapshot.setSelectColor()

Rechtliche Hinweise | Onlinedatenschutzerklärung

TextSnapshot - AS3

Paketex

Sprachelemente

Anhänge

Paket flash.text

charCount

findText

getSelected

getSelectedText

getText

getTextRunInfo

hitTestTextNearPos

setSelectColor

setSelected