Referenshandbok för ActionScript® 3.0 i Adobe® Flash®-plattformen
Hem  |  Dölj paket och klasslista |  Paket  |  Klasser  |  Nyheter  |  Index  |  Bilagor  |  Varför på engelska?
Filter: Hämtar data från servern ...
Hämtar data från servern ...
flash.text 

TextSnapshot  - AS3

Paketflash.text
Klasspublic class TextSnapshot
ArvTextSnapshot Inheritance Object

Språkversion: ActionScript 3.0
Körningsmiljöversioner: AIR 1.0, Flash Player 9, Flash Lite 4

TextSnapshot-objekt gör att du kan arbeta med statisk text i ett filmklipp. Du kan till exempel använda dem för att göra textlayout med högre precision än vad som är möjligt med dynamisk text, men ändå låta texten vara skrivskyddad.

TextSnapshot-objekt skapas inte med konstruktor. De returneras av egenskapen flash.display.DisplayObjectContainer.textSnapshot.

Relaterade API-element



Publika egenskaper
 EgenskapDefinieras med
  charCount : int
[skrivskyddad] Antalet tecken i ett TextSnapshot-objekt.
TextSnapshot
 Inheritedconstructor : Object
En referens till klassobjektet eller konstruktorfunktionen för en given objektinstans.
Object
Publika metoder
 MetodDefinieras med
  
findText(beginIndex:int, textToFind:String, caseSensitive:Boolean):int
Söker i det angivna TextSnabshot-objektet och returnerar positionen för den första instansen av textToFind som påträffas vid eller efter beginIndex.
TextSnapshot
  
getSelected(beginIndex:int, endIndex:int):Boolean
Returnerar ett booleskt värde som anger om ett TextSnapshot-objekt innehåller markerad text i det angivna området.
TextSnapshot
  
getSelectedText(includeLineEndings:Boolean = false):String
Returnerar en sträng som innehåller alla tecken som anges av motsvarande setSelected()-metod.
TextSnapshot
  
getText(beginIndex:int, endIndex:int, includeLineEndings:Boolean = false):String
Returnerar en sträng som innehåller alla tecken som anges av parametrarna beginIndex och endIndex.
TextSnapshot
  
getTextRunInfo(beginIndex:int, endIndex:int):Array
Returnerar en array med objekt som innehåller information om en text.
TextSnapshot
 Inherited
Anger om det finns en egenskap angiven för ett objekt.
Object
  
Gör att du kan avgöra vilket tecken i ett TextSnapshot-objekt som är på eller nära de angivna x- och y-koordinaterna i filmklippet som innehåller texten i TextSnapshot-objektet.
TextSnapshot
 Inherited
Anger om en instans av klassen Object finns i prototypkedjan för objektet som anges som parameter.
Object
 Inherited
Anger om den angivna egenskapen finns och är uppräkningsbar.
Object
 Inherited
Anger tillgänglighet för en dynamisk egenskap för slingåtgärder.
Object
  
setSelectColor(hexColor:uint = 0xFFFF00):void
Anger vilken färg som ska användas för att markera tecken med metoden setSelected().
TextSnapshot
  
setSelected(beginIndex:int, endIndex:int, select:Boolean):void
Anger ett teckenområde i ett TextSnapshot-objekt som ska markeras eller avmarkeras.
TextSnapshot
 Inherited
Returnerar det här objektets strängrepresentation, formaterad i enlighet med språkspecifika konventioner.
Object
 Inherited
Returnerar det angivna objektets strängbeteckning.
Object
 Inherited
Returnerar det angivna objektets primitiva värde.
Object
Egenskapsdetaljer

charCount

egenskap
charCount:int  [skrivskyddad]

Språkversion: ActionScript 3.0
Körningsmiljöversioner: AIR 1.0, Flash Player 9, Flash Lite 4

Antalet tecken i ett TextSnapshot-objekt.



Implementering
    public function get charCount():int

Relaterade API-element

Metoddetaljer

findText

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

Språkversion: ActionScript 3.0
Körningsmiljöversioner: AIR 1.0, Flash Player 9, Flash Lite 4

Söker i det angivna TextSnabshot-objektet och returnerar positionen för den första instansen av textToFind som påträffas vid eller efter beginIndex. Om textToFind inte hittas, returneras -1.

Parametrar

beginIndex:int — Anger referenspunkten för sökning efter den angivna texten.
 
textToFind:String — Anger den text som ska sökas efter. Om du anger en stränglitteral i stället för en variabel av String-typ, ska sökvägen skrivas inom citattecken.
 
caseSensitive:Boolean — Anger om texten måste matcha skiftläget i strängen i textToFind.

Returnerar
int — Den nollbaserade indexpositionen för den första instansen av den angivna texten eller -1.

Relaterade API-element

getSelected

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

Språkversion: ActionScript 3.0
Körningsmiljöversioner: AIR 1.0, Flash Player 9, Flash Lite 4

Returnerar ett booleskt värde som anger om ett TextSnapshot-objekt innehåller markerad text i det angivna området.

Om du vill söka efter alla tecken anger du värdet 0 för start och charCount (eller ett annat högt tal) för end. Om du vill söka efter ett enda tecken skickar du parametern end ett värde som är ett mer än parametern start.

Parametrar

beginIndex:int — Visar positionen för det första tecknet som ska utvärderas. Giltiga värden för beginIndex är 0 till och med TextSnapshot.charCount - 1. Om beginIndex är ett negativt värde används 0.
 
endIndex:int — Ett värde som är ett större än indexvärdet för det sista tecknet som ska utvärderas. Giltiga värden för endIndex är 0 till och med charCount. Det tecken som anges av parametern endIndex ingår inte i den extraherade strängen. Om parametern utelämnas används charCount. Om det här värdet är mindre än eller lika med värdet för beginIndex används beginIndex + 1.

Returnerar
Boolean — Ett booleskt värde som anger om minst ett tecken i det givna intervallet har markerats av motsvarande setSelected()-metod (true);i annat fall false.

Relaterade API-element

getSelectedText

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

Språkversion: ActionScript 3.0
Körningsmiljöversioner: AIR 1.0, Flash Player 9., Flash Lite 4

Returnerar en sträng som innehåller alla tecken som anges av motsvarande setSelected()-metod. Om inga tecken anges (av metoden setSelected()) returneras en tom sträng.

Om du skickar true för includeLineEndings infogas radmatningstecken i retursträngen och retursträngen kan bli längre än indataintervallet. Om includeLineEndings är false eller inte anges, returnerar metoden den markerade texten utan att några tecken läggs till.

Parametrar

includeLineEndings:Boolean (default = false) — Ett valfritt booleskt värde som anger om radmatningstecken ska infogas på lämplig plats i den sträng som returneras. Standardvärdet är false.

Returnerar
String — En sträng som innehåller alla tecken som anges av motsvarande setSelected()-kommando.

Relaterade API-element

getText

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

Språkversion: ActionScript 3.0
Körningsmiljöversioner: AIR 1.0, Flash Player 9., Flash Lite 4

Returnerar en sträng som innehåller alla tecken som anges av parametrarna beginIndex och endIndex. Om inga tecken är markerade returneras en tom sträng.

Om du vill returnera alla tecken anger du värdet 0 för beginIndex och charCount (eller ett annat högt tal) för endIndex. Om du vill returnera ett enda tecken skickar du värdet beginIndex + 1 för endIndex.

Om du skickar värdet true för includeLineEndings infogas radmatningstecken i den returnerade strängen där det anses lämpligt. I det här fallet kan retursträngen bli längre än indataintervallet. Om includeLineEndings är false eller inte anges, returnerar metoden den markerade texten utan att några tecken läggs till.

Parametrar

beginIndex:int — Ett heltal som anger positionen för det första tecknet som ska tas med i retursträngen. Giltiga värden för beginIndex är 0 till och med charCount - 1. Om beginIndex är ett negativt värde används 0.
 
endIndex:int — Ett värde som är ett större än indexvärdet för det sista tecknet som ska utvärderas. Giltiga värden för endIndex är 0 till och med charCount. Det tecken som anges av parametern endIndex ingår inte i den extraherade strängen. Om parametern utelämnas används charCount. Om det här värdet är mindre än eller lika med värdet för beginIndex används beginIndex + 1.
 
includeLineEndings:Boolean (default = false) — Ett valfritt booleskt värde som anger om radmatningstecken ska infogas (true) eller inte (false) i den sträng som returneras. Standardvärdet är false.

Returnerar
String — En sträng som innehåller tecknen i det angivna intervallet, eller en tom sträng om inga tecken hittas i det angivna intervallet.

Relaterade API-element

getTextRunInfo

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

Språkversion: ActionScript 3.0
Körningsmiljöversioner: AIR 1.0, Flash Player 9, Flash Lite 4

Returnerar en array med objekt som innehåller information om en text. Varje objekt motsvarar ett tecken i teckenintervallet som anges av de två metodparametrarna.

Obs! Om metoden getTextRunInfo() används för ett stort textintervall kan det returnerade objektet bli stort. Adobe rekommenderar att textintervallet som definieras av parametrarna beginIndex och endIndex begränsas.

Parametrar

beginIndex:int — Indexvärdet för det första tecknet i teckenintervallet i ett TextSnapshot-objekt.
 
endIndex:int — Indexvärdet för det sista tecknet i teckenintervallet i ett TextSnapshot-objekt.

Returnerar
Array — En array med objekt där varje objekt innehåller information om ett visst tecken i intervallet som anges av parametrarna beginIndex och endIndex. Varje objekt innehåller följande elva egenskaper:
  • indexInRun – ett nollbaserat heltalsindexvärde för tecknet (i förhållande till hela strängen, inte i den markerade texten).
  • selected Ett booleskt värde som anger om tecknet är markerat true; i annat fall false.
  • font – namnet på tecknets teckensnitt.
  • color – tecknets kombinerade alfa- och färgvärde. De två första hexadecimala siffrorna representerar alfavärdet och de återstående siffrorna representerar färgvärdet.
  • height – tecknets höjd i pixlar.
  • matrix_a, matrix_b, matrix_c, matrix_d, matrix_tx och matrix_ty - Värdena för en matris som definierar tecknets geometriska omformning. Normal upprätt text har alltid en matris i formen [1 0 0 1 x y] där x och y är tecknets position i det överordnade filmklippet oavsett textens höjd. Matrisen finns i det överordnade filmklippets koordinatsystem och inkluderar inte eventuella omformningar som finns i själva filmklippet (eller det överordnade filmklippet).
  • corner0x, corner0y, corner1x, corner1y, corner2x, corner2y, corner3x och corner3y – Hörnen på tecknets begränsningsram, baserat på det överordnade filmklippets koordinatsystem. Värdena är bara tillgängliga om det teckensnitt som används av tecknet är inbäddat i SWF-filen.

Relaterade API-element

hitTestTextNearPos

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

Språkversion: ActionScript 3.0
Körningsmiljöversioner: AIR 1.0, Flash Player 9., Flash Lite 4

Gör att du kan avgöra vilket tecken i ett TextSnapshot-objekt som är på eller nära de angivna x och y-koordinaterna i filmklippet som innehåller texten i TextSnapshot-objektet.

Om du utelämnar eller anger värdet 0 för maxDistance måste platsen som anges av koordinaterna x och y vara inuti TextSnapshot-objektets begränsningsram.

Den här metoden fungerar bara korrekt med teckensnitt som innehåller teckenmåttsinformation. Denna information finns inte med som standard för statiska textfält i Flash utvecklingsverktyg. Därför kan metoden returnera -1 i stället för ett indexvärde. För att vara säker på att ett indexvärde returneras kan du tvinga Flash-utvecklingsverktyget att inkludera teckenmåttsinformationen för ett teckensnitt. För att göra detta lägger du till ett dynamiskt textfält som använder teckensnittet, väljer Teckenalternativ för det dynamiska textfältet och anger att teckensnittskonturer ska bäddas in för minst ett tecken. (Det spelar ingen roll vilka tecken du anger eller om de är de tecken som används i det statiska textfältet).

Parametrar

x:Number — Ett tal som representerar x-koordinaten för ett filmklipp som innehåller texten.
 
y:Number — Ett tal som representerar y-koordinaten för ett filmklipp som innehåller texten.
 
maxDistance:Number (default = 0) — Ett valfritt tal som representerar det maximala avståndet från x och y som det går att söka efter text vid. Avståndet mäts från varje teckens mittpunkt. Standardvärdet är 0.

Returnerar
Number — Ett tal som motsvarar indexvärdet för det tecken som är närmast den angivna koordinaten x y. Returnerar -1 om inget tecken hittas eller om teckensnittet inte innehåller teckenmåttsinformation.

Relaterade API-element

setSelectColor

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

Språkversion: ActionScript 3.0
Körningsmiljöversioner: AIR 1.0, Flash Player 9., Flash Lite 4

Anger vilken färg som ska användas för att markera tecken med metoden setSelected(). Färgen är alltid ogenomskinlig. Det går inte att ange genomskinlighetsvärde.

Den här metoden fungerar bara korrekt med teckensnitt som innehåller teckenmåttsinformation. Denna information finns inte med som standard för statiska textfält i Flash utvecklingsverktyg. Därför kan metoden returnera -1 i stället för ett indexvärde. För att vara säker på att ett indexvärde returneras kan du tvinga Flash-utvecklingsverktyget att inkludera teckenmåttsinformationen för ett teckensnitt. För att göra detta lägger du till ett dynamiskt textfält som använder teckensnittet, väljer Teckenalternativ för det dynamiska textfältet och anger att teckensnittskonturer ska bäddas in för minst ett tecken. (Det spelar ingen roll vilka tecken du anger eller om de är de tecken som används i det statiska textfältet.)

Parametrar

hexColor:uint (default = 0xFFFF00) — Den färg som används för kantlinjen som placeras runt tecken som har markerats med motsvarande setSelected()-kommando, uttryckt i hexadecimalt format (0x RRGGBB).

Relaterade API-element

setSelected

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

Språkversion: ActionScript 3.0
Körningsmiljöversioner: AIR 1.0, Flash Player 9., Flash Lite 4

Anger ett teckenområde i ett TextSnapshot-objekt som ska markeras eller avmarkeras. Tecken som markeras skrivs med en färgad rektangel som matchar tecknets begränsningsram bakom sig. Begränsningsramens färg definieras av setSelectColor().

Om du vill markera eller avmarkera alla tecken anger du värdet 0 för beginIndex och charCount (eller ett annat högt tal) för endIndex. Om du vill ange ett enda tecken skickar du värdet start + 1 för endIndex.

Eftersom tecken markeras var för sig kan du anropa den här metoden flera gånger för att markera flera tecken. Andra tecken som redan har markerats med den här metoden avmarkeras alltså inte när metoden används igen.

Den röda triangeln som markerar ett val, visas bara för teckensnitt som innehåller teckenmåttsinformation. Denna information finns inte med som standard för statiska textfält i Adobe Flash. I vissa fall kan det innebära att text som är markerad inte visas markerad på skärmen. För att vara säker på att all markerad text visas som markerad kan du tvinga Flash-utvecklingsverktyget att inkludera teckenmåttsinformationen för ett teckensnitt. För att göra detta lägger du till ett dynamiskt textfält som använder teckensnittet, väljer Teckenalternativ för det dynamiska textfältet och anger att teckensnittskonturer ska bäddas in för minst ett tecken. Det spelar ingen roll vilka tecken du anger eller om de är de tecken som används i det statiska textfältet i fråga.

Parametrar

beginIndex:int — Visar positionen för det första tecknet som ska markeras. Giltiga värden för beginIndex är 0 till och med charCount - 1. Om beginIndex är ett negativt värde används 0.
 
endIndex:int — Ett heltal som är 1 + indexvärdet för det sista tecknet som ska utvärderas. Giltiga värden för end är 0 till och med charCount. Det tecken som anges av parametern end ingår inte i den extraherade strängen. Om du inte anger parametern används TextSnapshot.charCount. Om värdet för beginIndex är mindre eller lika med värdet för endIndex, används beginIndex + 1.
 
select:Boolean — Ett booleskt värde som anger om texten ska markeras (true) eller avmarkeras (false).

Relaterade API-element





[ X ]Varför på engelska?
Innehåll i Referenshandbok för ActionScript 3.0 i Adobe Flash-plattformen är på engelska

Det är inte alla delar av Referenshandbok för ActionScript 3.0 i Adobe Flash-plattformen som översätts till alla språk. Om ett språkelement inte översätts visas det på engelska. Klassen ga.controls.HelpBox översätts till exempel inte till något språk. I den svenska versionen av referenshandboken visas därför klassen ga.controls.HelpBox på engelska.