TextSnapshot - Adobe ActionScript® 3 (AS3 ) — dokumentacja interfejsu API

Pakiet	flash.text
Klasa	public class TextSnapshot
Dziedziczenie	TextSnapshot Object

Wersja języka:

ActionScript 3.0

Wersje środowiska wykonawczego:

AIR 1.0, Flash Player 9, Flash Lite 4

Obiekty TextSnapshot zapewniają kontrolę nad statycznym tekstem w klipie filmowym. Za ich pomocą można na przykład rozłożyć tekst z większą precyzją niż ta dopuszczona dla tekstu dynamicznego, jednakże wciąż tylko w trybie do odczytu.

Konstruktora nie używa się do tworzenia obiektu TextSnapshot; jest on zwracany przez właściwość flash.display.DisplayObjectContainer.textSnapshot.

Powiązane elementy interfejsu API

flash.display.DisplayObjectContainer.textSnapshot

Właściwości publiczne

Ukryj dziedziczone właściwości publiczne

Pokaż dziedziczone właściwości publiczne

	Właściwość		Zdefiniowane przez
		charCount : int [tylko do odczytu] Liczba znaków wewnątrz obiektu TextSnapshot.	TextSnapshot
		constructor : Object Odwołanie do obiektu klasy lub funkcji konstruktora, dotyczące danej instancji obiektu.	Object

Metody publiczne

Ukryj dziedziczone metody publiczne

Pokaż dziedziczone metody publiczne

	Metoda		Zdefiniowane przez
		findText(beginIndex:int, textToFind:String, caseSensitive:Boolean):int Przeszukuje określony obiekt TextSnapshot i zwraca położenie pierwszego wystąpienia argumentu textToFind, począwszy od parametru beginIndex.	TextSnapshot
		getSelected(beginIndex:int, endIndex:int):Boolean Zwraca wartość typu Boolean wskazującą, czy w podanym zakresie obiektu TextSnapshot zawiera się zaznaczony tekst.	TextSnapshot
		getSelectedText(includeLineEndings:Boolean = false):String Zwraca ciąg znaków, który zawiera wszystkie znaki określone za pomocą metody setSelected().	TextSnapshot
		getText(beginIndex:int, endIndex:int, includeLineEndings:Boolean = false):String Zwraca ciąg znaków zawierający wszystkie znaki określone za pomocą parametrów beginIndex oraz endIndex.	TextSnapshot
		getTextRunInfo(beginIndex:int, endIndex:int):Array Zwraca tablicę obiektów z informacjami o wyglądzie tekstu.	TextSnapshot
		hasOwnProperty(name:String):Boolean Wskazuje, czy dla obiektu zdefiniowano określoną właściwość.	Object
		hitTestTextNearPos(x:Number, y:Number, maxDistance:Number = 0):Number Pozwala określić, który ze znaków wewnątrz obiektu TextSnapshot ma położenie najbliższe określonym współrzędnym (x, y) klipu filmowego z tekstem.	TextSnapshot
		isPrototypeOf(theClass:Object):Boolean Wskazuje, czy instancja klasy Object należy do łańcucha prototypów obiektu określonego jako parametr.	Object
		propertyIsEnumerable(name:String):Boolean Wskazuje, czy określona właściwość istnieje i jest przeliczalna.	Object
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Ustawia dostępność właściwości dynamicznej używanej w pętlach.	Object
		setSelectColor(hexColor:uint = 0xFFFF00):void Określa kolor, jaki ma być używany do podświetlania znaków zanzaczonych przez metodę setSelected().	TextSnapshot
		setSelected(beginIndex:int, endIndex:int, select:Boolean):void Określa zakres znaków wewnątrz obiektu TextSnapshot — zakres, który ma być zaznaczony lub odznaczony.	TextSnapshot
		toLocaleString():String Zwraca ciąg reprezentujący obiekt — sformatowany zgodnie z konwencjami właściwymi dla ustawień regionalnych.	Object
		toString():String Zwraca ciąg reprezentujący określony obiekt.	Object
		valueOf():Object Zwraca pierwotną wartość dla określonego obiektu.	Object

Szczegół właściwości

charCount

właściwość

charCount:int [tylko do odczytu]

Wersja języka:

ActionScript 3.0

Wersje środowiska wykonawczego:

AIR 1.0, Flash Player 9, Flash Lite 4

Liczba znaków wewnątrz obiektu TextSnapshot.

Implementacja
public function get charCount():int

Powiązane elementy interfejsu API

flash.text.TextSnapshot.getText()

Szczegół metody

findText

()

metoda

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

Wersja języka:

ActionScript 3.0

Wersje środowiska wykonawczego:

AIR 1.0, Flash Player 9, Flash Lite 4

Wyszukuje określony obiekt TextSnapshot i zwraca położenie pierwszego wystąpienia argumentu textToFind znalezionego w miejscu lub po miejscu parametru beginIndex. Jeśli obiekt nie zostanie znaleziony textToFind, wartość zwrócona przez metodę to -1.

Parametry

	`beginIndex:int` — Określa punkt początkowy dla wyszukiwania określonego tekstu.

	`textToFind:String` — Określa tekst wyszukiwania. Jeśli użytkownik w ciągu znaków zamiast zmiennych zawrze literały, ten ciąg znaków należy ująć w cudzysłowie.

	`caseSensitive:Boolean` — Określa, czy tekst powinien zgadzać się z wielkością liter w ciągu znaków we właściwości `textToFind`.

Zwraca

int — Liczony od 0 Indeks pierwszego wystąpienia określonego tekstu lub wartość -1.

Powiązane elementy interfejsu API

flash.text.TextSnapshot.getText()

getSelected

()

metoda

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

Wersja języka:

ActionScript 3.0

Wersje środowiska wykonawczego:

AIR 1.0, Flash Player 9, Flash Lite 4

Zwraca wartość typu Boolean wskazującą, czy w podanym zakresie obiektu TextSnapshot zawiera się zaznaczony tekst.

Aby wyszukać wszystkie znaki, należy dla parametru start ustawić wartość 0, a dla parametru end wartość charCount (lub dowolną bardzo dużą liczbę). Aby wyszukać pojedynczy znak, należy dla parametru end ustawić wartość większą niż dla parametru start.

Parametry

	`beginIndex:int` — Wskazuje położenie pierwszego znaku, który będzie analizowany. Zakres poprawnych wartości dla parametru `beginIndex` zawiera wartości od `0` do wartości `TextSnapshot.charCount - 1`. Cyfra `0` reprezentuje ujemną wartość parametru `beginIndex`.

	`endIndex:int` — Wartość większa o jeden od indeksu ostatniego analizowanego znaku. Zakres poprawnych wartości dla parametru `endIndex` zawiera wartości od `0` do wartości `charCount`. Znak o indeksie określonym za pomocą parametru `endIndex` nie jest włączony do wyodrębnionego ciągu znaków. W przypadku pominięcia tego parametru zostaje użyta właściwość `charCount`. Wartość `beginIndex + 1` określa wartość mniejszą lub równą wartości parametru `beginIndex`.

Zwraca

Boolean — Wartość typu Boolean, która wskazuje czy przynajmniej jeden znak z danego zakresu został zaznaczony przy użyciu metody setSelected() (wartośćtrue); jeśli nie — wartość false.

Powiązane elementy interfejsu API

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

getSelectedText

()

metoda

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

Wersja języka:

ActionScript 3.0

Wersje środowiska wykonawczego:

AIR 1.0, Flash Player 9., Flash Lite 4

Zwraca ciąg znaków zawierający wszystkie znaki określone za pomocą metody setSelected(). W przypadku, gdy żadne znaki nie zostaną określone (za pomocą metody setSelected()), zwracany jest pusty ciąg znaków.

Jeśli dla właściwości includeLineEndings zostanie ustawiona wartość true, zwrócony ciąg znaków, który może być większy niż zakres wprowadzenia, będzie zawierał znaki nowego wiersza. Jeśli dla właściwości includeLineEndings zostanie ustawiona wartość false lub parametr zostanie pominięty, metoda zwróci zaznaczony tekst bez dodawania znaków.

Parametry

includeLineEndings:Boolean (default = false) — Opcjonalna wartość typu Boolean, która określa, czy znaki nowego wiersza są wstawione we właściwym miejscu zwróconego ciągu znaków. Wartością domyślną jest false.

Zwraca

String — Ciąg znaków, który zawiera wszystkie znaki określone za pomocą polecenia setSelected().

Powiązane elementy interfejsu API

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

getText

()

metoda

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

Wersja języka:

ActionScript 3.0

Wersje środowiska wykonawczego:

AIR 1.0, Flash Player 9., Flash Lite 4

Zwraca ciąg znaków zawierający wszystkie znaki określone za pomocą parametrów beginIndex oraz endIndex. W przypadku, gdy żadne znaki nie zostaną zaznaczone, zwracany jest pusty ciąg znaków.

Aby uzyskać zwrot dla wszystkich znaków, należy dla parametru beginIndex ustawić wartość 0, a dla parametru endIndex wartość charCount (lub dowolną bardzo dużą liczbę). Aby uzyskać zwrot dla pojedynczego znaku, należy dla parametru endIndex ustawić wartość beginIndex + 1.

Jeśli dla parametru includeLineEndings zostanie ustawiona wartość true, znaki nowego wiersza zostaną wstawione we właściwym miejscu zwróconego ciągu znaków. W tym przypadku zwrócony ciąg znaków może być dłuższy niż zakres wprowadzenia. Jeśli dla właściwości includeLineEndings zostanie ustawiona wartość false lub parametr zostanie pominięty, zwrócony tekst nie będzie zawierał dodatkowych znaków.

Parametry

	`beginIndex:int` — Wskazuje położenie pierwszego znaku, jaki ma zostać uwzględniony w zwracanym ciągu znaków. Zakres poprawnych wartości dla parametru `beginIndex` zawiera wartości od `0` do wartości `charCount - 1`. Cyfra `0` reprezentuje ujemną wartość parametru `beginIndex`.

	`endIndex:int` — Wartość większa o jeden od indeksu ostatniego analizowanego znaku. Zakres poprawnych wartości dla parametru `endIndex` zawiera wartości od `0` do wartości `charCount`. Znak o indeksie określonym za pomocą parametru `endIndex` nie jest włączony do wyodrębnionego ciągu znaków. W przypadku pominięcia tego parametru zostaje użyta właściwość `charCount`. Wartość `beginIndex + 1` określa wartość mniejszą lub równą wartości parametru `beginIndex`.

	`includeLineEndings:Boolean` (default = `false`) — Opcjonalna wartość typu Boolean, która określa, czy do zwróconego ciągu znaków zostały wstawione znaki nowego wiersza (wartość `true`) czy nie (wartość `false`). Wartością domyślną jest `false`.

Zwraca

String — Ciąg zawierający znaki z określonego zakresu lub pusty ciąg w przypadku, gdy żaden ze znaków z tego zakresu nie zostanie znaleziony.

Powiązane elementy interfejsu API

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

getTextRunInfo

()

metoda

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

Wersja języka:

ActionScript 3.0

Wersje środowiska wykonawczego:

AIR 1.0, Flash Player 9, Flash Lite 4

Zwraca tablicę obiektów z informacjami o wyglądzie tekstu. Każdy obiekt odpowiada jednemu znakowi w zakresie znaków określonym przez dwa parametry metody.

Uwaga: Użycie metody getTextRunInfo() w przypadku dużego zakresu tekstu może spowodować zwrot dużego obiektu. Zaleca się ograniczanie zakresu tekstu w programie Adobe za pomocą parametrów beginIndex oraz endIndex.

Parametry

	`beginIndex:int` — Indeks pierwszego znaku w zakresie znaków obiektu TextSnapshot.

	`endIndex:int` — Indeks ostatniego znaku w zakresie znaków obiektu TextSnapshot.

Zwraca

Array — Tablica obiektów zawierających informacje dotyczące konkretnego znaku z zakresu znaków określonego przez parametry beginIndex oraz endIndex. Każdy z obiektów zawiera jedenaście następujących właściwości:

indexInRun — Liczony od 0 ndeks znaku w postaci liczby całkowitej (względny w stosunku do całego ciągu znaków, a nie wybranego fragmentu tekstu).
selected — Wartość typu Boolean, która wskazuje, czy dany znak został zaznaczony (wartość true; a jeśli nie — wartość false).
font — Nazwa czcionki znaku.
color — Połączona wartość alfa i koloru znaku. Dwie pierwsze cyfry szesnastkowe reprezentują wartość alfa, a pozostałe cyfry — wartości koloru.
height — Wysokość znaku wyrażona w pikselach.
matrix_a, matrix_b, matrix_c, matrix_d, matrix_tx oraz matrix_ty — Wartości matrycy definiującej przekształcenie geometryczne znaku. Dla zwykłego tekstu o prostej czcionce matryca przyjmuje wartości [1 0 0 1 x y], gdzie zmienne x i y określają położenie znaku w macierzystym klipie filmowym, niezależnie od wysokości tekstu. Ponieważ matryca znajduje się w układzie współrzędnych macierzystego klipu filmowego, żadne przekształcenia dokonane na samym klipie filmowym (czy obiekcie nadrzędnym ) nie mają na nią wpływu.
corner0x, corner0y, corner1x, corner1y, corner2x, corner2y, corner3x oraz corner3y — Narożniki obwiedni znaku w układzie współrzędnych macierzystego klipu filmowego. Te wartości są dostępne jedynie wówczas, gdy czcionka użytego znaku została osadzona w pliku SWF.

Powiązane elementy interfejsu API

Klasa Matrix

hitTestTextNearPos

()

metoda

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

Wersja języka:

ActionScript 3.0

Wersje środowiska wykonawczego:

AIR 1.0, Flash Player 9., Flash Lite 4

Pozwala określić, który znak w obiekcie TextSnapshot znajduje się na lub w pobliżu określonych współrzędnych x i y klipu filmowego zawierającego tekst w obiekcie TextSnapshot.

Jeśli parametr maxDistance zostanie pominięty, lub zostanie ustawiona dla niego wartość 0, położenie określone za pomocą współrzędnych x i y znajdzie się wewnątrz obwiedni obiektu TextSnapshot.

Ta metoda działa poprawnie tylko w przypadku czcionek, które zawierają informacje o wymiarach. Jednakże narzędzie programu Flash domyślnie nie zawiera tych informacji dla statycznych pól tekstowych. Z tego względu metoda może zamiast indeksu zwrócić wartość -1. Aby zagwarantować, że wartością zwróconą przez metodę będzie indeks, należy wymusić zawarcie informacji o wymiarach czcionki w narzędziu programu Flash. Aby to zrobić, należy dodać dynamiczne pole tekstowe, które używa tej czcionki, wybrać dla niego opcje znaku, a następnie dla przynajmniej jednej czcionki włączyć osadzanie konturów czcionki. (Rodzaj znaku oraz jego zastosowanie w statycznym czy dynamicznym polu tekstowym nie ma znaczenia).

Parametry

	`x:Number` — Liczba reprezentująca współrzędną `x` klipu filmowego zawierającego tekst.

	`y:Number` — Liczba reprezentująca współrzędną `y` klipu filmowego zawierającego tekst.

	`maxDistance:Number` (default = `0`) — Opcjonalna liczba reprezentująca maksymalną odległość od współrzędnych `x` i `y` dla obszaru, w którym tekst będzie wyszukiwany. Odległość mierzy się od punktu wyśrodkowania każdego znaku. Wartość domyślna to `0`.

Zwraca

Number — Liczba reprezentująca indeks znaku znajdującego się najbliżej określonej współrzędnej x i y. Zwraca wartość -1 w przypadku, gdy znak nie został znaleziony lub gdy informacja o wymiarach czcionki nie istnieje.

Powiązane elementy interfejsu API

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

setSelectColor

()

metoda

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

Wersja języka:

ActionScript 3.0

Wersje środowiska wykonawczego:

AIR 1.0, Flash Player 9., Flash Lite 4

Określa kolor, który zostanie użyty do podświetlania znaków zaznaczonych za pomocą metody setSelected(). Kolor jest zawsze kryjący (nie ma możliwości określenia wartości przezroczystości).

Ta metoda działa poprawnie tylko w przypadku czcionek, które zawierają informacje o wymiarach. Jednakże narzędzie do tworzenia treści Flash domyślnie nie uwzględnia tych informacji w przypadku statycznych pól tekstowych. Z tego względu metoda może zamiast indeksu zwrócić wartość -1. Aby zagwarantować, że wartością zwróconą przez metodę będzie indeks, należy wymusić zawarcie informacji o wymiarach czcionki w narzędziu programu Flash. Aby to zrobić, należy dodać dynamiczne pole tekstowe, które używa tej czcionki, wybrać dla niego opcje znaku, a następnie dla przynajmniej jednej czcionki włączyć osadzanie konturów czcionki. (Rodzaj znaku oraz jego zastosowanie w statycznym czy dynamicznym polu tekstowym nie ma znaczenia).

Parametry

hexColor:uint (default = 0xFFFF00) — Kolor użyty dla obramowania wokół znaków zaznaczonych za pomocą metody setSelected(), wyrażony w formacie szesnastkowym (0xRRGGBB).

Powiązane elementy interfejsu API

flash.text.TextSnapshot.setSelected()

setSelected

()

metoda

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

Wersja języka:

ActionScript 3.0

Wersje środowiska wykonawczego:

AIR 1.0, Flash Player 9., Flash Lite 4

Określa zakres znaków wewnątrz obiektu TextSnapshot — zakres, który ma być zaznaczony lub odznaczony. Za zaznaczonymi znakami zostaje narysowany kolorowy prostokąt dopasowany do obwiedni znaku. Kolor obwiedni zostaje zdefiniowany za pomocą metody setSelectColor().

Aby zaznaczyć lub odznaczyć wszystkie znaki, dla parametru beginIndex należy ustawić wartość 0, a dla parametru endIndex wartość charCount (lub dowolną bardzo dużą liczbę). Aby określić pojedynczy znak, należy dla parametru endIndex ustawić wartość start + 1.

Ponieważ znaki są zaznaczane pojedynczo, można wywoływać tę metodę kilkakrotnie, aby wybrać wiele znaków, co oznacza, że ponowne wywołanie tej metody nie powoduje odznaczenia innych znaków zaznaczonych za jej pomocą.

Kolorowy prostokąt zaznaczenia jest wyświetlany tylko dla czcionek, które zawierają informacje o rozmiarach. Narzędzie programu Flash domyślnie nie zawiera tych informacji dla statycznych pól tekstowych. W niektórych przypadkach, zaznaczany tekst może nie pojawić się na ekranie jako zaznaczony. Aby mieć pewność, że zaznaczany tekst pojawi się na ekranie jako tekst zaznaczony, należy wymusić zawarcie informacji o wymiarach czcionki w narzędziu programu Flash. Aby tego dokonać, należy dodać dynamiczne pole tekstowe, które używa tej czcionki, wybrać dla niego opcje znaku, a następnie dla przynajmniej jednej czcionki zaznaczyć osadzanie konturów czcionki. Rodzaj znaku oraz jego zastosowanie w statycznym czy dynamicznym polu tekstowym nie ma znaczenia.

Parametry

	`beginIndex:int` — Wskazuje położenie pierwszego znaku, który będzie zaznaczony. Zakres poprawnych wartości dla parametru `beginIndex` zawiera wartości od `0` do wartości `charCount - 1`. Cyfra `0` reprezentuje ujemną wartość parametru `beginIndex`.

	`endIndex:int` — Liczba całkowita stanowiąca wartość indeksu +1 dla ostatniego znaku, który będzie analizowany. Zakres poprawnych wartości dla parametru `end` zawiera wartości od `0` do wartości `charCount`. Znak o indeksie określonym za pomocą parametru `end` nie jest włączony do wyodrębnionego ciągu znaków. W przypadku pominięcia tego parametru zostaje użyta właściwość `TextSnapshot.charCount`. Jeśli wartość parametru `beginIndex` jest mniejsza lub równa wartości `endIndex`, użyta zostaje wartość `beginIndex + 1`.

	`select:Boolean` — Wartość typu Boolean, która wskazuje czy dany tekst powinien zostać zaznaczony (wartość `true`) lub odznaczony (wartość `false`).

Powiązane elementy interfejsu API

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

Informacje prawne | Zasady prywatności online

TextSnapshot - AS3

Klasy x

charCount

findText

getSelected

getSelectedText

getText

getTextRunInfo

hitTestTextNearPos

setSelectColor

setSelected