TextSnapshot - Referencia de la API de Adobe ActionScript® 3 (AS3 )

Paquete	flash.text
Clase	public class TextSnapshot
Herencia	TextSnapshot Object

Versión del lenguaje:

ActionScript 3.0

Versiones de motor de ejecución:

AIR 1.0, Flash Player 9, Flash Lite 4

Los objetos TextSnapshot permiten trabajar con texto estático en un clip de película. Puede utilizar estos objetos, por ejemplo, para disponer el texto con mayor precisión que la que permite el texto dinámico, pero continuar accediendo al texto en modo de sólo lectura.

No es necesario utilizar un constructor para crear un objeto TextSnapshot, ya que lo devuelve la propiedad flash.display.DisplayObjectContainer.textSnapshot.

Elementos de API relacionados

flash.display.DisplayObjectContainer.textSnapshot

Propiedades públicas

Ocultar propiedades públicas heredadas

Mostrar propiedades públicas heredadas

	Propiedad		Definido por
		charCount : int [solo lectura] El número de caracteres del objeto TextSnapshot.	TextSnapshot
		constructor : Object Una referencia a la clase de objeto o función constructora para una instancia de objeto determinada.	Object

Métodos públicos

Ocultar métodos públicos heredados

Mostrar métodos públicos heredados

	Método		Definido por
		findText(beginIndex:int, textToFind:String, caseSensitive:Boolean):int Realiza una búsqueda en el objeto TextSnapshot especificado y devuelve la posición en la que aparece por primera vez textToFind en la posición de beginIndex o después de dicha posición.	TextSnapshot
		getSelected(beginIndex:int, endIndex:int):Boolean Devuelve un valor booleano que especifica si un objeto TextSnapshot contiene texto seleccionado en el rango especificado.	TextSnapshot
		getSelectedText(includeLineEndings:Boolean = false):String Devuelve una cadena que contiene todos los caracteres especificados por el método setSelected() correspondiente.	TextSnapshot
		getText(beginIndex:int, endIndex:int, includeLineEndings:Boolean = false):String Devuelve una cadena que contiene todos los caracteres especificados por los parámetros beginIndex y endIndex.	TextSnapshot
		getTextRunInfo(beginIndex:int, endIndex:int):Array Devuelve un conjunto de objetos que contiene información acerca de una extensión de texto.	TextSnapshot
		hasOwnProperty(name:String):Boolean Indica si un objeto tiene definida una propiedad especificada.	Object
		hitTestTextNearPos(x:Number, y:Number, maxDistance:Number = 0):Number Le permite determinar qué carácter de un objeto TextSnapshot está en las coordenadas x, y especificadas (o cerca de ellas) del clip de película que contiene el texto del objeto TextSnapshot.	TextSnapshot
		isPrototypeOf(theClass:Object):Boolean Indica si hay una instancia de la clase Object en la cadena de prototipo del objeto especificado como parámetro.	Object
		propertyIsEnumerable(name:String):Boolean Indica si existe la propiedad especificada y si es enumerable.	Object
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Establece la disponibilidad de una propiedad dinámica para operaciones de bucle.	Object
		setSelectColor(hexColor:uint = 0xFFFF00):void Especifica el color que se va a utilizar al resaltar caracteres seleccionados con el método setSelected().	TextSnapshot
		setSelected(beginIndex:int, endIndex:int, select:Boolean):void Especifica un rango de caracteres de un objeto TextSnapshot que debe seleccionarse o no.	TextSnapshot
		toLocaleString():String Devuelve la representación de cadena de este objeto, con formato según las convenciones específicas de configuración regional.	Object
		toString():String Devuelve la representación de cadena del objeto especificado.	Object
		valueOf():Object Devuelve el valor simple del objeto especificado.	Object

Información sobre propiedades

charCount

propiedad

charCount:int [solo lectura]

Versión del lenguaje:

ActionScript 3.0

Versiones de motor de ejecución:

AIR 1.0, Flash Player 9, Flash Lite 4

El número de caracteres del objeto TextSnapshot.

Implementación
public function get charCount():int

Elementos de API relacionados

flash.text.TextSnapshot.getText()

Información sobre métodos

findText

()

método

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

Versión del lenguaje:

ActionScript 3.0

Versiones de motor de ejecución:

AIR 1.0, Flash Player 9, Flash Lite 4

Realiza una búsqueda en el objeto TextSnapshot especificado y devuelve la posición en la que aparece por primera vez textToFind en la posición de beginIndex o después de dicha posición. Si no se encuentra textToFind, el método devuelve -1.

Parámetros

	`beginIndex:int` — Especifica el punto inicial de búsqueda del texto especificado.

	`textToFind:String` — Especifica el texto que se va a buscar. Si especifica un literal de cadena y no una variable de tipo String, cierre la cadena entre comillas.

	`caseSensitive:Boolean` — Especifica si las mayúsculas/minúsculas del texto deben coincidir con la cadena de `textToFind`.

Valor devuelto

int — La posición de índice basado en cero de la primera vez que aparece el texto especificado, o bien, -1.

Elementos de API relacionados

flash.text.TextSnapshot.getText()

getSelected

()

método

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

Versión del lenguaje:

ActionScript 3.0

Versiones de motor de ejecución:

AIR 1.0, Flash Player 9, Flash Lite 4

Devuelve un valor booleano que especifica si un objeto TextSnapshot contiene texto seleccionado en el rango especificado.

Para buscar todos los caracteres, pase un valor de 0 para start y TextSnapshot.getCount() (o un valor muy grande) para end. Para buscar un solo carácter, pase al parámetro end un valor superior en uno al parámetro start.

Parámetros

	`beginIndex:int` — Indica la posición del primer carácter que se va a examinar. Los valores válidos para `beginIndex` van desde `0` hasta `TextSnapshot.charCount - 1`. Si `beginIndex` es un valor negativo, se utiliza `0`.

	`endIndex:int` — Un valor que es un número mayor que el índice del último carácter que se va a examinar. Los valores adminidos para `endIndex`son de `0` a `charCount`. El carácter indexado por el parámetro `endIndex` no se incluye en la cadena extraída. Si se omite este parámetro, se empleará `charCount`. Si este valor es menor o igual que el valor de `beginIndex`, se utiliza `beginIndex + 1`.

Valor devuelto

Boolean — Un valor booleano que indica si al menos un carácter del rango especificado se ha seleccionado mediante el correspondiente método setSelected() (true); en caso contrario, false.

Elementos de API relacionados

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

getSelectedText

()

método

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

Versión del lenguaje:

ActionScript 3.0

Versiones de motor de ejecución:

AIR 1.0, Flash Player 9., Flash Lite 4

Devuelve una cadena que contiene todos los caracteres especificados por el método setSelected() correspondiente. Si no hay ningún carácter seleccionado (por el método setSelected()), se devuelve una cadena vacía.

Si pasa true para includeLineEndings, se insertan caracteres de nueva línea en la cadena devuelta y es posible que ésta sea más larga que el rango de entrada. Si includeLineEndings es false o se omite, el método devuelve el texto seleccionado sin añadir ningún carácter.

Parámetros

includeLineEndings:Boolean (default = false) — Un valor booleano opcional que especifica si los caracteres de nueva línea se insertan en la cadena devuelta cuando proceda. El valor predeterminado es false.

Valor devuelto

String — Devuelve una cadena que contiene todos los caracteres especificados por el comando setSelected() correspondiente.

Elementos de API relacionados

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

getText

()

método

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

Versión del lenguaje:

ActionScript 3.0

Versiones de motor de ejecución:

AIR 1.0, Flash Player 9., Flash Lite 4

Devuelve una cadena que contiene todos los caracteres especificados por los parámetros beginIndex y endIndex. Si no se selecciona ningún carácter, se devuelve una cadena vacía.

Para obtener todos los caracteres, pase un valor de 0 para beginIndex y charCount (o un valor muy grande) para endIndex. Para devolver un solo carácter, pase un valor de beginIndex + 1 para endIndex.

Si se transmite un valor true para includeLineEndings, los caracteres de nueva línea se insertarán en la cadena devuelta cuando sea apropiado. En este caso, la cadena devuelta puede ser más larga que el rango de entrada. Si includeLineEndings es false o se omite, el texto seleccionado se devuelve sin añadir ningún carácter.

Parámetros

	`beginIndex:int` — Indica la posición del primer carácter que se va a incluir en la cadena devuelta. Los valores válidos para `beginIndex` van desde `0` hasta `charCount - 1`. Si `beginIndex` es un valor negativo, se utiliza `0`.

	`endIndex:int` — Un valor que es un número mayor que el índice del último carácter que se va a examinar. Los valores adminidos para `endIndex`son de `0` a `charCount`. El carácter indexado por el parámetro `endIndex` no se incluye en la cadena extraída. Si se omite este parámetro, se empleará `charCount`. Si este valor es menor o igual que el valor de `beginIndex`, se utiliza `beginIndex + 1`.

	`includeLineEndings:Boolean` (default = `false`) — Un valor booleano que especifica si los caracteres de nueva línea se han insertado (`true`) o no se han insertado (`false`) en la cadena devuelta. El valor predeterminado es `false`.

Valor devuelto

String — Una cadena que contiene los caracteres incluidos en el rango especificado o una cadena vacía si no se encuentran caracteres en el rango especificado.

Elementos de API relacionados

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

getTextRunInfo

()

método

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

Versión del lenguaje:

ActionScript 3.0

Versiones de motor de ejecución:

AIR 1.0, Flash Player 9, Flash Lite 4

Devuelve un conjunto de objetos que contiene información acerca de una extensión de texto. Cada objeto se corresponde con un carácter del rango de caracteres especificado por los dos parámetros del método.

Nota: si se usa el método getTextRunInfo() para un gran rango de texto, se puede obtener un objeto grande. Adobe recomienda limitar el rango de texto definido por los parámetros beginIndex y endIndex.

Parámetros

	`beginIndex:int` — El valor de índice del primer carácter en el rango de caracteres en un objeto TextSnapshot.

	`endIndex:int` — El valor de índice del último carácter en el rango de caracteres en un objeto TextSnapshot.

Valor devuelto

Array — Un conjunto de objetos en la que cada objeto contiene información sobre un carácter determinado del rango especificado por los parámetros beginIndex y endIndex. Cada objeto contiene las siguientes once propiedades:

indexInRun: un índice de número entero basado en cero del carácter (en relación a la cadena completa, en lugar de a la extensión de texto seleccionada).
selected: valor booleano que indica si el carácter está seleccionado true; en caso contrario, false.
font: el nombre de la fuente del carácter.
color: el valor de color y alfa combinado del carácter. Los dos primeros dígitos hexadecimales representan el valor alfa y los demás dígitos, el valor de color.
height: altura del carácter, expresada en píxeles.
matrix_a, matrix_b, matrix_c, matrix_d, matrix_tx y matrix_ty: los valores de una matriz que define la transformación geométrica en el carácter. El texto normal vertical tiene siempre una matriz [1 0 0 1 x y], donde x e y equivalen a la posición del carácter en el clip de película principal, independientemente de la altura del texto. La matriz está en el sistema de coordenadas del clip de película principal y no incluye ninguna transformación que pueda estar en el propio clip (o en su elemento principal).
corner0x, corner0y, corner1x, corner1y, corner2x, corner2y, corner3x ycorner3y: las esquinas del cuadro de delimitación del carácter, basadas en el sistema de coordenadas del clip de película principal. Estos valores sólo están disponibles si la fuente que utiliza el carácter está incorporada en el archivo SWF.

Elementos de API relacionados

Clase Matrix

hitTestTextNearPos

()

método

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

Versión del lenguaje:

ActionScript 3.0

Versiones de motor de ejecución:

AIR 1.0, Flash Player 9., Flash Lite 4

Le permite determinar qué carácter de un objeto TextSnapshot está en las coordenadas x, y especificadas (o cerca de ellas) del clip de película que contiene el texto del objeto TextSnapshot.

Si omite o pasa el valor 0 para maxDistance, la ubicación especificada por las coordenadas x, y deberá encontrarse dentro del recuadro de delimitación del objeto TextSnapshot.

Este método sólo funciona correctamente con fuentes que incluyen información de medidas de caracteres; sin embargo, de manera predeterminada, la herramienta de edición de Flash no incluye esta información para campos de texto estáticos. Por lo tanto, el método puede devolver -1 en lugar de un valor de índice. Para garantizar que se devuelve un valor de índice, puede hacer que la herramienta de edición de Flash incluya información de medidas de caracteres para una fuente. Para ello, añada un campo de texto dinámico que utilice dicha fuente, seleccione Opciones de caracteres para dicho campo de texto dinámico y luego especifique que los contornos de fuentes deben incorporarse al menos para un carácter. (No importa qué caracteres especifique ni tampoco si son los que se utilizan en los campos de texto estáticos.)

Parámetros

	`x:Number` — Un número que representa la coordenada `x` del clip de película que contiene el texto.

	`y:Number` — Un número que representa la coordenada `y` del clip de película que contiene el texto.

	`maxDistance:Number` (default = `0`) — Un número opcional que representa la distancia máxima de `x`, `y` en la que se puede buscar texto. La distancia se mide desde el punto central de cada carácter. El valor predeterminado es `0`.

Valor devuelto

Number — Un número que representa el valor de índice del carácter más cercano a la coordenada x, y especificada. Devuelve -1 si no se encuentra ningún carácter o si la fuente no contiene información de medidas de caracteres.

Elementos de API relacionados

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

setSelectColor

()

método

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

Versión del lenguaje:

ActionScript 3.0

Versiones de motor de ejecución:

AIR 1.0, Flash Player 9., Flash Lite 4

Especifica el color que se va a utilizar al resaltar caracteres seleccionados con el método setSelected(). El color es siempre opaco; no puede especificar un valor de transparencia.

Parámetros

hexColor:uint (default = 0xFFFF00) — El color utilizado en el borde que rodea los caracteres que se han seleccionado mediante el comando setSelected() correspondiente, expresado en formato hexadecimal (0xRRGGBB).

Elementos de API relacionados

flash.text.TextSnapshot.setSelected()

setSelected

()

método

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

Versión del lenguaje:

ActionScript 3.0

Versiones de motor de ejecución:

AIR 1.0, Flash Player 9., Flash Lite 4

Especifica un rango de caracteres de un objeto TextSnapshot que debe seleccionarse o no. Los caracteres seleccionados se dibujan con un rectángulo de color detrás de ellos que coincide con el recuadro de delimitación del carácter. El color del recuadro de delimitación se define mediante setSelectColor().

Para seleccionar o anular la selección de todos los caracteres, pase un valor de 0 para beginIndex y charCount (o un valor muy grande) para endIndex. Para especificar un solo carácter, pase un valor de start + 1 para endIndex.

Dado que los caracteres se marcan individualmente como seleccionados, puede llamar a este método varias veces para seleccionar varios caracteres; es decir, el uso de este método no anula la selección de otros caracteres establecidos por este método.

El rectángulo de color que indica una selección sólo se muestra para fuentes que contengan información de medidas de caracteres; de forma predeterminada, Flash no incluye esta información en campos de texto estáticos. En algunos casos, este comportamiento significa que el texto seleccionado no aparecerá como tal en pantalla. Para asegurarse de que todo el texto seleccionado aparezca como tal, puede hacer que la herramienta de edición de Flash incluya información de medidas de caracteres para una fuente. Para ello, añada un campo de texto dinámico que utilice dicha fuente, seleccione Opciones de caracteres para dicho campo de texto dinámico y luego especifique que los contornos de fuentes deben incorporarse al menos para un carácter. No importa qué caracteres especifique ni tampoco si son los caracteres utilizados en los campos de texto estáticos en cuestión.

Parámetros

	`beginIndex:int` — Indica la posición del primer carácter que se va a seleccionar. Los valores válidos para `beginIndex` van desde `0` hasta `charCount - 1`. Si `beginIndex` es un valor negativo, se utiliza `0`.

	`endIndex:int` — Un entero equivalente a 1+ el índice del último carácter que se va a examinar. Los valores adminidos para `end`son de `0` a `charCount`. El carácter indexado por el parámetro `end` no se incluye en la cadena extraída. Si omite este parámetro, se utiliza `TextSnapshot.charCount`. Si el valor de `beginIndex` es menor o igual que el valor de `endIndex`, se utilizará `beginIndex + 1`.

	`select:Boolean` — Un valor booleano que especifica si el texto debe estar seleccionado (`true`) o no (`false`).

Elementos de API relacionados

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

Avisos legales | Política de privacidad en línea

TextSnapshot - AS3

Paquetesx

Elementos del lenguaje

Apéndices

Paquete flash.text

charCount

findText

getSelected

getSelectedText

getText

getTextRunInfo

hitTestTextNearPos

setSelectColor

setSelected