| 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 |
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
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étodo | Definido por | ||
|---|---|---|---|
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 | ||
Devuelve un valor booleano que especifica si un objeto TextSnapshot contiene texto seleccionado en el rango especificado. | TextSnapshot | ||
Devuelve una cadena que contiene todos los caracteres especificados por el método setSelected() correspondiente. | TextSnapshot | ||
Devuelve una cadena que contiene todos los caracteres especificados por los parámetros beginIndex y endIndex. | TextSnapshot | ||
Devuelve un conjunto de objetos que contiene información acerca de una extensión de texto. | TextSnapshot | ||
|
Indica si un objeto tiene definida una propiedad especificada. | Object | |
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 | ||
|
Indica si hay una instancia de la clase Object en la cadena de prototipo del objeto especificado como parámetro. | Object | |
|
Indica si existe la propiedad especificada y si es enumerable. | Object | |
|
Establece la disponibilidad de una propiedad dinámica para operaciones de bucle. | Object | |
Especifica el color que se va a utilizar al resaltar caracteres seleccionados con el método setSelected(). | TextSnapshot | ||
Especifica un rango de caracteres de un objeto TextSnapshot que debe seleccionarse o no. | TextSnapshot | ||
|
Devuelve la representación de cadena de este objeto, con formato según las convenciones específicas de configuración regional. | Object | |
|
Devuelve la representación de cadena del objeto especificado. | Object | |
|
Devuelve el valor simple del objeto especificado. | Object | |
charCount | propiedad |
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.
|
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
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 endIndexson 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.
|
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
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)false.
|
String — Devuelve una cadena que contiene todos los caracteres especificados por el comando setSelected() correspondiente.
|
Elementos de API relacionados
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 endIndexson 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)true) o no se han insertado (false) en la cadena devuelta. El valor predeterminado es false.
|
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
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.
|
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:
|
Elementos de API relacionados
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)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.
|
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
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.
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
hexColor:uint (default = 0xFFFF00)setSelected() correspondiente, expresado en formato hexadecimal (0xRRGGBB).
|
Elementos de API relacionados
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 endson 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
Tue Jun 12 2018, 02:12 PM Z