TextSnapshot - Guida di riferimento alle API Adobe ActionScript® 3 (AS3 )

Pacchetto	flash.text
Classe	public class TextSnapshot
Ereditarietà	TextSnapshot Object

Versione linguaggio:

ActionScript 3.0

Versioni runtime:

AIR 1.0, Flash Player 9, Flash Lite 4

Gli oggetti TextSnapshot consentono di eseguire operazioni con il testo statico in un clip filmato. Ad esempio, è possibile utilizzarli per disporre il testo con una precisione decisamente superiore a quella consentita dal testo dinamico, anche se il testo risulta di sola lettura.

Non è necessario utilizzare una funzione di costruzione per creare un oggetto TextSnapshot, poiché viene restituito dalla proprietà flash.display.DisplayObjectContainer.textSnapshot.

Elementi API correlati

flash.display.DisplayObjectContainer.textSnapshot

Proprietà pubbliche

Nascondi proprietà pubbliche ereditate

Mostra proprietà pubbliche ereditate

	Proprietà		Definito da
		charCount : int [sola lettura] Il numero di caratteri presenti in un oggetto TextSnapshot.	TextSnapshot
		constructor : Object Un riferimento all'oggetto classe o alla funzione di costruzione per una determinata istanza di oggetto.	Object

Metodi pubblici

Nascondi metodi pubblici ereditati

Mostra metodi pubblici ereditati

	Metodo		Definito da
		findText(beginIndex:int, textToFind:String, caseSensitive:Boolean):int Cerca l'oggetto TextSnapshot specificato e restituisce la posizione della prima occorrenza di textToFind trovata in corrispondenza o dopo indiceIniziale.	TextSnapshot
		getSelected(beginIndex:int, endIndex:int):Boolean Restituisce un valore booleano che specifica se un oggetto TextSnapshot contiene il testo selezionato nell'intervallo specificato.	TextSnapshot
		getSelectedText(includeLineEndings:Boolean = false):String Restituisce una stringa che contiene tutti i caratteri specificati dal metodo setSelected() corrispondente.	TextSnapshot
		getText(beginIndex:int, endIndex:int, includeLineEndings:Boolean = false):String Restituisce una stringa che contiene tutti i caratteri specificati dai parametri indiceIniziale e indiceFinale.	TextSnapshot
		getTextRunInfo(beginIndex:int, endIndex:int):Array Restituisce un array di oggetti che contiene informazioni su una sequenza di testo.	TextSnapshot
		hasOwnProperty(name:String):Boolean Indica se per un oggetto è definita una proprietà specifica.	Object
		hitTestTextNearPos(x:Number, y:Number, maxDistance:Number = 0):Number Consente di determinare quale carattere all'interno di un oggetto TextSnapshot si trova sopra o vicino alle coordinate x e y specificate del clip filmato che contiene il testo nell'oggetto TextSnapshot.	TextSnapshot
		isPrototypeOf(theClass:Object):Boolean Indica se un'istanza della classe Object si trova nella catena di prototipi dell'oggetto specificato come parametro.	Object
		propertyIsEnumerable(name:String):Boolean Indica se la proprietà specificata esiste ed è enumerabile.	Object
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Imposta la disponibilità di una proprietà dinamica per le operazioni cicliche.	Object
		setSelectColor(hexColor:uint = 0xFFFF00):void Specifica il colore da utilizzare per evidenziare i caratteri selezionati mediante il metodo setSelected().	TextSnapshot
		setSelected(beginIndex:int, endIndex:int, select:Boolean):void Specifica un intervallo di caratteri da selezionare o deselezionare in un oggetto TextSnapshot.	TextSnapshot
		toLocaleString():String Restituisce la rappresentazione in formato stringa di questo oggetto, formattato in base alle convenzioni specifiche per le versioni localizzate.	Object
		toString():String Restituisce la rappresentazione in formato stringa dell'oggetto specificato.	Object
		valueOf():Object Restituisce il valore di base dell'oggetto specificato.	Object

Descrizione delle proprietà

charCount

proprietà

charCount:int [sola lettura]

Versione linguaggio:

ActionScript 3.0

Versioni runtime:

AIR 1.0, Flash Player 9, Flash Lite 4

Il numero di caratteri presenti in un oggetto TextSnapshot.

Implementazione
public function get charCount():int

Elementi API correlati

flash.text.TextSnapshot.getText()

Descrizione dei metodi

findText

()

metodo

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

Versione linguaggio:

ActionScript 3.0

Versioni runtime:

AIR 1.0, Flash Player 9, Flash Lite 4

Cerca l'oggetto TextSnapshot specificato e restituisce la posizione della prima occorrenza di textToFind trovata in corrispondenza o dopo beginIndex. Se textToFind non viene trovato, il metodo restituisce -1.

Parametri

	`beginIndex:int` — Specifica il punto di partenza dal quale iniziare a cercare il testo specificato.

	`textToFind:String` — Specifica il testo da cercare. Se specificate un carattere letterale per la stringa, anziché una variabile di tipo String, racchiudere la stringa tra virgolette.

	`caseSensitive:Boolean` — Specifica se il testo deve rispettare le maiuscole/minuscole della stringa `textToFind`.

Restituisce

int — La posizione dell'indice a base zero della prima occorrenza del testo specificato, oppure -1.

Elementi API correlati

flash.text.TextSnapshot.getText()

getSelected

()

metodo

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

Versione linguaggio:

ActionScript 3.0

Versioni runtime:

AIR 1.0, Flash Player 9, Flash Lite 4

Restituisce un valore booleano che specifica se un oggetto TextSnapshot contiene il testo selezionato nell'intervallo specificato.

Per eseguire la ricerca in tutti i caratteri, passare il valore 0 per start e charCount (o qualunque numero molto elevato) per end. Per cercare un singolo carattere, passate al parametro end un valore maggiore del parametro start.

Parametri

	`beginIndex:int` — Indica la posizione del primo carattere da esaminare. I valori validi per `beginIndex` vanno da `0` a `TextSnapshot.charCount - 1`. Se `beginIndex` è un valore negativo, viene utilizzato `0`.

	`endIndex:int` — Un valore che rappresenta la posizione di indice maggiore dell'ultimo carattere da esaminare. I valori validi per `endIndex` vanno da `0` a `charCount`. Il carattere indicizzato dal parametro `endIndex` non è compreso nella stringa estratta. Se si omette questo parametro, viene utilizzato `charCount`. Se questo valore è minore o uguale al valore di `beginIndex`, viene utilizzato `beginIndex + 1`.

Restituisce

Boolean — Un valore booleano che indica se almeno un carattere nell'intervallo specificato è stato selezionato dal corrispondente metodo setSelected()(true); false in caso contrario.

Elementi API correlati

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

getSelectedText

()

metodo

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

Versione linguaggio:

ActionScript 3.0

Versioni runtime:

AIR 1.0, Flash Player 9., Flash Lite 4

Restituisce una stringa che contiene tutti i caratteri specificati dal metodo setSelected() corrispondente. Se non è specificato alcun carattere (dal metodo setSelected()), viene restituita una stringa vuota.

Se si passa true per includeLineEndings, i caratteri newline vengono inseriti nella stringa, cosicché la stringa restituita può essere più lunga dell'intervallo di input. Se includeLineEndings è false oppure è stato omesso, il testo selezionato viene restituito senza che venga aggiunto alcun carattere.

Parametri

includeLineEndings:Boolean (default = false) — Un valore booleano opzionale che specifica se i caratteri newline inseriti nella stringa restituita erano appropriati. Il valore predefinito è false.

Restituisce

String — Una stringa che contiene tutti i caratteri specificati dal comando setSelected() corrispondente.

Elementi API correlati

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

getText

()

metodo

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

Versione linguaggio:

ActionScript 3.0

Versioni runtime:

AIR 1.0, Flash Player 9., Flash Lite 4

Restituisce una stringa che contiene tutti i caratteri specificati dai parametri beginIndex e endIndex. Se non è selezionato alcun carattere, viene restituita una stringa vuota.

Per restituire tutti i caratteri, passare il valore 0 per beginIndex e charCount (o qualunque numero molto elevato) per endIndex. Per restituire un singolo carattere, passare il valore beginIndex + 1 per endIndex.

Se si passa un valore true per includeLineEndings, i caratteri newline vengono inseriti nella stringa nei punti considerati appropriati. In tal caso, la stringa restituita può essere più lunga dell'intervallo di input. Se includeLineEndings è false oppure è stato omesso, il testo selezionato viene restituito senza che vanga aggiunto alcun carattere.

Parametri

	`beginIndex:int` — Indica la posizione del primo carattere da includere nella stringa restituita. I valori validi per `beginIndex` vanno da `0` a `charCount - 1`. Se `beginIndex` è un valore negativo, viene utilizzato `0`.

	`endIndex:int` — Un valore che rappresenta la posizione di indice maggiore dell'ultimo carattere da esaminare. I valori validi per `endIndex` vanno da `0` a `charCount`. Il carattere indicizzato dal parametro `endIndex` non è compreso nella stringa estratta. Se si omette questo parametro, viene utilizzato `charCount`. Se questo valore è minore o uguale al valore di `beginIndex`, viene utilizzato `beginIndex + 1`.

	`includeLineEndings:Boolean` (default = `false`) — Un valore booleano opzionale che specifica se i caratteri newline vengono inseriti (`true`) o meno (`false`) nella stringa restituita. Il valore predefinito è `false`.

Restituisce

String — Una stringa che contiene i caratteri nell'intervallo specificato oppure una stringa vuota se nell'intervallo specificato non viene trovato alcun carattere.

Elementi API correlati

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

getTextRunInfo

()

metodo

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

Versione linguaggio:

ActionScript 3.0

Versioni runtime:

AIR 1.0, Flash Player 9, Flash Lite 4

Restituisce un array di oggetti che contiene informazioni su una sequenza di testo. Ogni oggetto corrisponde a un carattere dell'intervallo di caratteri specificato dai due parametri del metodo.

Nota: l'uso del metodo getTextRunInfo() per un intervallo di testo esteso può restituire un oggetto di grandi dimensioni. Adobe consiglia di limitare l'intervallo di testo definito dai parametri beginIndex e endIndex.

Parametri

	`beginIndex:int` — Il valore di indice del primo carattere di un intervallo di caratteri in un oggetto TextSnapshot.

	`endIndex:int` — Il valore di indice dell'ultimo carattere di un intervallo di caratteri in un oggetto TextSnapshot.

Restituisce

Array — Un array di oggetti in cui ogni oggetto contiene informazioni su un carattere specifico nell'intervallo di caratteri indicato dai parametri beginIndex e endIndex. Ogni oggetto contiene le undici proprietà seguenti:

indexInRun - Indice di un numero intero a base zero del carattere (relativo all'intera stringa, anziché alla sequenza di testo selezionata).
selected - Un valore booleano che indica se il carattere è selezionato (true) o non selezionato (false).
font - Il nome del carattere.
color - Il valore combinato di trasparenza alfa e colore del carattere. Le prime due cifre esadecimali rappresentano il valore alfa e le restanti rappresentano il valore del colore.
height - L'altezza del carattere espressa in pixel.
matrix_a, matrix_b, matrix_c, matrix_d, matrix_tx e matrix_ty - I valori di una matrice che definiscono la trasformazione geometrica del carattere. Il testo normale ha una matrice di forma [1 0 0 1 x y], dove x e y rappresentano la posizione del carattere nel clip filmato principale, indipendentemente dall'altezza del testo. La matrice si trova nel sistema di coordinate del clip filmato principale e non comprende le trasformazioni relative al clip filmato (o al clip filmato principale).
corner0x, corner0y, corner1x, corner1y, corner2x, corner2y, corner3x e corner3y - Gli angoli del riquadro di delimitazione del carattere, riferiti alle coordinate del clip filmato principale. Questi valori sono disponibili solo se il font utilizzato dal carattere è incorporato nel file SWF.

Elementi API correlati

Classe Matrix

hitTestTextNearPos

()

metodo

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

Versione linguaggio:

ActionScript 3.0

Versioni runtime:

AIR 1.0, Flash Player 9., Flash Lite 4

Consente di determinare quale carattere all'interno di un oggetto TextSnapshot si trova sopra o vicino alle coordinate x, y specificate del clip filmato che contiene il testo nell'oggetto TextSnapshot.

Se si omette o si passa il valore 0 per maxDistance, la posizione specificata dalle coordinate x e y deve trovarsi all'interno del riquadro di delimitazione dell'oggetto TextSnapshot.

Questo metodo funziona correttamente solo con i caratteri che includono le informazioni sulla metrica dei caratteri; per impostazione predefinita, lo strumento di creazione Flash non include queste informazioni per i campi di testo statici. Questo metodo potrebbe quindi restituire -1 anziché un valore di indice. Per garantire che venga restituito un valore di indice, è possibile fare in modo che lo strumento di creazione Flash includa le informazioni sulle metriche di un carattere. A questo scopo, aggiungete un campo di testo dinamico che utilizza il carattere, selezionate Opzioni per i caratteri per il campo di testo dinamico aggiunto, quindi specificate che i profili di carattere devono essere incorporati per almeno un carattere. (Non ha importanza quali caratteri vengono specificati, né che si tratti dei caratteri utilizzati nei campi di testo statici in questione.)

Parametri

	`x:Number` — Un numero che rappresenta la coordinata `x` del clip filmato contenente il testo.

	`y:Number` — Un numero che rappresenta la coordinata `y` del clip filmato contenente il testo.

	`maxDistance:Number` (default = `0`) — Un numero opzionale che rappresenta la distanza massima da `x`, `y` nella quale è possibile cercare testo. La distanza viene misurata dal punto centrale di ciascun carattere. Il valore predefinito è `0`.

Restituisce

Number — Un numero che rappresenta il valore di indice del carattere che si trova più vicino alla coordinata x, y specificata. Restituisce -1 se non viene trovato alcun carattere o se il carattere non contiene le informazioni sulle metriche del carattere.

Elementi API correlati

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

setSelectColor

()

metodo

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

Versione linguaggio:

ActionScript 3.0

Versioni runtime:

AIR 1.0, Flash Player 9., Flash Lite 4

Specifica il colore da utilizzare per evidenziare i caratteri selezionati mediante il metodo setSelected(). Il colore è sempre opaco; non è possibile specificare un valore di trasparenza.

Questo metodo funziona correttamente solo con i caratteri che includono le informazioni sulla metrica dei caratteri; per impostazione predefinita, lo strumento di creazione Flash non include queste informazioni per i campi di testo statici. Questo metodo potrebbe quindi restituire -1 anziché un valore di indice. Per garantire che venga restituito un valore di indice, è possibile fare in modo che lo strumento di creazione Flash includa le informazioni sulle metriche di un carattere. A questo scopo, aggiungete un campo di testo dinamico che utilizza il carattere, selezionate Opzioni per i caratteri per il campo di testo dinamico aggiunto, quindi specificate che i profili di carattere devono essere incorporati per almeno un carattere. Non ha importanza quali caratteri vengono specificati, né che si tratti dei caratteri utilizzati nei campi di testo statici in questione.

Parametri

hexColor:uint (default = 0xFFFF00) — Il colore utilizzato per il bordo collocato intorno ai caratteri che sono stati selezionati mediante il comando setSelected() corrispondente, espresso in formato esadecimale (0x RRGGBB).

Elementi API correlati

flash.text.TextSnapshot.setSelected()

setSelected

()

metodo

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

Versione linguaggio:

ActionScript 3.0

Versioni runtime:

AIR 1.0, Flash Player 9., Flash Lite 4

Specifica un intervallo di caratteri da selezionare o deselezionare in un oggetto TextSnapshot. Dietro ai caratteri selezionati viene disegnato un rettangolo colorato, che corrisponde al riquadro di delimitazione del carattere. Il colore del riquadro di delimitazione è definito da setSelectColor().

Per selezionare o deselezionare tutti i caratteri, passate il valore 0 per beginIndex e charCount (o qualunque numero molto elevato) per endIndex. Per specificare un singolo carattere, passate il valore start + 1 per endIndex.

Dal momento che i caratteri selezionati sono contrassegnati singolarmente, è possibile chiamare questo metodo più volte per selezionare più caratteri; in altre parole, l'uso di questo metodo non deseleziona gli altri caratteri eventualmente impostati dal metodo stesso.

Il rettangolo colorato che indica una selezione viene visualizzato solo con i caratteri che includono le informazioni sulla metrica dei caratteri; per impostazione predefinita, Flash non include queste informazioni per i campi di testo statici. In alcuni casi, questo comportamento indica che il testo selezionato non appare come selezionato sullo schermo. Per garantire che tutto il testo selezionato appaia selezionato, è possibile impostare lo strumento di creazione Flash in modo da imporre l'inclusione delle informazioni sulle metriche di un carattere. A questo scopo, aggiungete un campo di testo dinamico che utilizza il carattere, selezionate Opzioni per i caratteri per il campo di testo dinamico aggiunto, quindi specificate che i profili di carattere devono essere incorporati per almeno un carattere. Non ha importanza quali caratteri vengono specificati e nemmeno se si tratta dei caratteri utilizzati nei campi di testo statici in questione.

Parametri

	`beginIndex:int` — Indica la posizione del primo carattere da selezionare. I valori validi per `beginIndex` vanno da `0` a `charCount - 1`. Se `beginIndex` è un valore negativo, viene utilizzato `0`.

	`endIndex:int` — Un numero intero corrispondente al valore 1+ l'indice dell'ultimo carattere da esaminare. I valori validi per `end` vanno da `0` a `charCount`. Il carattere indicizzato dal parametro `end` non è compreso nella stringa estratta. Se si omette questo parametro, viene usato `TextSnapshot.charCount`. Se il valore di `beginIndex` è minore o uguale al valore di `endIndex`, viene utilizzato `beginIndex + 1`.

	`select:Boolean` — Un valore booleano che specifica se il testo deve essere selezionato (`true`) o deselezionato (`false`).

Elementi API correlati

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

Note legali | Informativa sulla privacy online

TextSnapshot - AS3

Pacchettix

Elementi del linguaggio

Appendici

Pacchetto flash.text

charCount

findText

getSelected

getSelectedText

getText

getTextRunInfo

hitTestTextNearPos

setSelectColor

setSelected