| 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 |
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
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 | |
| Metoda | Zdefiniowane przez | ||
|---|---|---|---|
Przeszukuje określony obiekt TextSnapshot i zwraca położenie pierwszego wystąpienia argumentu textToFind, począwszy od parametru beginIndex. | TextSnapshot | ||
Zwraca wartość typu Boolean wskazującą, czy w podanym zakresie obiektu TextSnapshot zawiera się zaznaczony tekst. | TextSnapshot | ||
Zwraca ciąg znaków, który zawiera wszystkie znaki określone za pomocą metody setSelected(). | TextSnapshot | ||
Zwraca ciąg znaków zawierający wszystkie znaki określone za pomocą parametrów beginIndex oraz endIndex. | TextSnapshot | ||
Zwraca tablicę obiektów z informacjami o wyglądzie tekstu. | TextSnapshot | ||
|
Wskazuje, czy dla obiektu zdefiniowano określoną właściwość. | Object | |
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 | ||
|
Wskazuje, czy instancja klasy Object należy do łańcucha prototypów obiektu określonego jako parametr. | Object | |
|
Wskazuje, czy określona właściwość istnieje i jest przeliczalna. | Object | |
|
Ustawia dostępność właściwości dynamicznej używanej w pętlach. | Object | |
Określa kolor, jaki ma być używany do podświetlania znaków zanzaczonych przez metodę setSelected(). | TextSnapshot | ||
Określa zakres znaków wewnątrz obiektu TextSnapshot — zakres, który ma być zaznaczony lub odznaczony. | TextSnapshot | ||
|
Zwraca ciąg reprezentujący obiekt — sformatowany zgodnie z konwencjami właściwymi dla ustawień regionalnych. | Object | |
|
Zwraca ciąg reprezentujący określony obiekt. | Object | |
|
Zwraca pierwotną wartość dla określonego obiektu. | Object | |
charCount | właściwość |
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.
|
int — Liczony od 0 Indeks pierwszego wystąpienia określonego tekstu lub wartość -1.
|
Powiązane elementy interfejsu API
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.
|
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
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)false.
|
String — Ciąg znaków, który zawiera wszystkie znaki określone za pomocą polecenia setSelected().
|
Powiązane elementy interfejsu API
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)true) czy nie (wartość false). Wartością domyślną jest false.
|
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
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.
|
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:
|
Powiązane elementy interfejsu API
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)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.
|
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
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)setSelected(), wyrażony w formacie szesnastkowym (0xRRGGBB).
|
Powiązane elementy interfejsu API
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
Tue Jun 12 2018, 12:06 PM Z