| Pacote | flash.text |
| Classe | public class TextSnapshot |
| Herança | TextSnapshot  Object |
| Versão da linguagem: | ActionScript 3.0 |
| Versões de runtime: | AIR 1.0, Flash Player 9, Flash Lite 4 |
Você não usa um construtor para criar um objeto TextSnapshot; ele é retornado pela propriedade flash.display.DisplayObjectContainer.textSnapshot.
Elementos da API relacionados
Ocultar propriedades públicas herdadas
Mostrar propriedades públicas herdadas| Propriedade | Definido por | ||
|---|---|---|---|
| charCount : int [somente leitura]
O número de caracteres em um objeto TextSnapshot. | TextSnapshot | ||
 | constructor : Object
Uma referência ao objeto de classe ou à função de construtor de uma determinada ocorrência de objeto. | Object | |
| Método | Definido por | ||
|---|---|---|---|
Pesquisa o objeto TextSnapshot especificado e retorna a posição da primeira ocorrência de textToFind encontrada em ou após beginIndex. | TextSnapshot | ||
Retorna um valor booliano que especifica se um objeto TextSnapshot contém texto selecionado no intervalo especificado. | TextSnapshot | ||
Retorna uma string que contém todos os caracteres especificados pelo método setSelected() correspondente. | TextSnapshot | ||
Retorna uma string que contém todos os caracteres especificados pelos parâmetros beginIndex e endIndex. | TextSnapshot | ||
Retorna uma matriz de objetos que contém informações sobre uma execução de texto. | TextSnapshot | ||
|
Indica se um objeto tem uma propriedade especificada definida. | Object | |
Permite determinar qual caractere em um objeto TextSnapshot está nas ou próximo às coordenadas x, y especificadas do clipe de filme que contém o texto no objeto TextSnapshot. | TextSnapshot | ||
|
Indica se uma ocorrência da classe Object está na cadeia de protótipos do objeto especificado como o parâmetro. | Object | |
|
Indica se a propriedade especificada existe e é enumerável. | Object | |
|
Define a disponibilidade de uma propriedade dinâmica para operações de repetição. | Object | |
Especifica a cor a ser utilizada ao realçar caracteres que foram selecionados com o método setSelected(). | TextSnapshot | ||
Especifica um intervalo de caracteres em um objeto TextSnapshot a ser selecionado ou não. | TextSnapshot | ||
|
Retorna a representação da string deste objeto, formatado segundo as convenções específicas para a localidade. | Object | |
|
Retorna a representação de string do objeto especificado. | Object | |
|
Retorna o valor primitivo do objeto especificado. | Object | |
charCount | propriedade |
findText | () | método |
public function findText(beginIndex:int, textToFind:String, caseSensitive:Boolean):int| Versão da linguagem: | ActionScript 3.0 |
| Versões de runtime: | AIR 1.0, Flash Player 9, Flash Lite 4 |
Pesquisa o objeto TextSnapshot especificado e retorna a posição da primeira ocorrência de textToFind encontrada em ou após beginIndex. Se textToFind não for encontrado, o método retornará -1.
Parâmetros
beginIndex:int — Especifica o ponto de início para pesquisar o texto especificado.
| |
textToFind:String — Especifica o texto a ser pesquisado. Se você especificar um literal de string, em vez de uma variável do tipo String, coloque a string entre aspas.
| |
caseSensitive:Boolean — Especifica se o texto deve diferenciar maiúsculas de minúsculas na string em textToFind.
|
int — A posição do índice com base em zero da primeira ocorrência do texto especificado ou -1.
|
Elementos da API relacionados
getSelected | () | método |
public function getSelected(beginIndex:int, endIndex:int):Boolean| Versão da linguagem: | ActionScript 3.0 |
| Versões de runtime: | AIR 1.0, Flash Player 9, Flash Lite 4 |
Retorna um valor booliano que especifica se um objeto TextSnapshot contém texto selecionado no intervalo especificado.
Para pesquisar todos os caracteres, passe um valor 0 para start e charCount (ou qualquer outro número muito grande) para end. Para pesquisar um único caractere, passe um valor ao parâmetro end superior em um com relação ao parâmetro start.
Parâmetros
beginIndex:int — Indica a posição do primeiro caractere a ser examinado. Os valores válidos para beginIndex são 0 a TextSnapshot.charCount - 1. Se beginIndex for um valor negativo, 0 será utilizado.
| |
endIndex:int — Um valor superior em um ao índice do último caractere a ser examinado. Os valores válidos para endIndex são 0 a charCount. O caractere indexado pelo parâmetro endIndex não é incluído na string extraída. Se o parâmetro for omitido, charCount será utilizado. Se o valor for menor ou igual ao valor de beginIndex, beginIndex + 1 será utilizado.
|
Boolean — Um valor booliano que indica se pelo menos um caractere em determinado intervalo foi selecionado pelo método setSelected() correspondente (true); do contrário, false.
|
Elementos da API relacionados
getSelectedText | () | método |
public function getSelectedText(includeLineEndings:Boolean = false):String| Versão da linguagem: | ActionScript 3.0 |
| Versões de runtime: | AIR 1.0, Flash Player 9., Flash Lite 4 |
Retorna uma string que contém todos os caracteres especificados pelo método setSelected() correspondente. Se nenhum caractere for especificado (pelo método setSelected()), uma string vazia será retornada.
Se você passar true para includeLineEndings, caracteres de novas linhas serão inseridos na string de retorno e ela pode ser maior do que o intervalo de entrada. Se includeLineEndings for false ou omitido, o método retornará o texto selecionado sem adicionar caracteres.
Parâmetros
includeLineEndings:Boolean (default = false)false.
|
String — Uma string que contém todos os caracteres especificados pelo comando setSelected() correspondente.
|
Elementos da API relacionados
getText | () | método |
public function getText(beginIndex:int, endIndex:int, includeLineEndings:Boolean = false):String| Versão da linguagem: | ActionScript 3.0 |
| Versões de runtime: | AIR 1.0, Flash Player 9., Flash Lite 4 |
Retorna uma string que contém todos os caracteres especificados pelos parâmetros beginIndex e endIndex. Se nenhum caractere for selecionado, uma string vazia será retornada.
Para retornar todos os caracteres, passe um valor 0 para beginIndex e charCount (ou qualquer outro número muito grande) para endIndex. Para retornar um único caractere, passe um valor beginIndex + 1 para endIndex.
Se você passar um valor true para includeLineEndings, caracteres de novas linhas serão inseridos na string retornada, onde for apropriado. Nesse caso, a string de retorno pode ser maior do que o intervalo de entrada. Se includeLineEndings for false ou omitido, o texto selecionado será retornado sem que qualquer caractere tenha sido adicionado.
Parâmetros
beginIndex:int — Indica a posição do primeiro caractere a ser incluído na string retornada. Os valores válidos para beginIndex são 0 a charCount - 1. Se beginIndex for um valor negativo, 0 será utilizado.
| |
endIndex:int — Um valor superior em um ao índice do último caractere a ser examinado. Os valores válidos para endIndex são 0 a charCount. O caractere indexado pelo parâmetro endIndex não é incluído na string extraída. Se o parâmetro for omitido, charCount será utilizado. Se o valor for menor ou igual ao valor de beginIndex, beginIndex + 1 será utilizado.
| |
includeLineEndings:Boolean (default = false)true) ou não (false) na string retornada. O valor padrão é false.
|
String — Uma string que contém os caracteres no intervalo especificado ou uma string vazia se nenhum caractere for encontrado no intervalo especificado.
|
Elementos da API relacionados
getTextRunInfo | () | método |
public function getTextRunInfo(beginIndex:int, endIndex:int):Array| Versão da linguagem: | ActionScript 3.0 |
| Versões de runtime: | AIR 1.0, Flash Player 9, Flash Lite 4 |
Retorna uma matriz de objetos que contém informações sobre uma execução de texto. Cada objeto corresponde a um caractere no intervalo de caracteres especificado pelos dois parâmetros de método.
Observação: o uso do método getTextRunInfo() para um intervalo grande de texto pode retornar um objeto grande. A Adobe recomenda limitar o intervalo de texto definido pelos parâmetros beginIndex e endIndex.
Parâmetros
beginIndex:int — O valor de índice do primeiro caractere em um intervalo de caracteres em um objeto TextSnapshot.
| |
endIndex:int — O valor de índice do último caractere em um intervalo de caracteres em um objeto TextSnapshot.
|
Array — Uma matriz de objetos na qual cada objeto contém informações sobre um caractere específico no intervalo de caracteres especificado pelos parâmetros beginIndex e endIndex. Cada objeto contém as onze seguintes propriedades:
|
Elementos da API relacionados
hitTestTextNearPos | () | método |
public function hitTestTextNearPos(x:Number, y:Number, maxDistance:Number = 0):Number| Versão da linguagem: | ActionScript 3.0 |
| Versões de runtime: | AIR 1.0, Flash Player 9., Flash Lite 4 |
Permite determinar qual caractere em um objeto TextSnapshot está nas ou próximo às coordenadas x, y especificadas do clipe de filme que contém o texto no objeto TextSnapshot.
Se você omitir ou passar um valor 0 para maxDistance, o local especificado pelas coordenadas x, y deve estar dentro da caixa delimitadora do objeto TextSnapshot.
Esse método funciona corretamente somente com fontes que incluem informações de métrica do caractere; no entanto, por padrão, a ferramenta de criação Flash não inclui essas informações para campos de texto estáticos. Portanto, o método talvez retorne -1, em vez de um valor de índice. Para garantir que um valor de índice seja retornado, é possível forçar a ferramenta de criação Flash para incluir as informações de métrica do caractere para uma fonte. Para fazer isso, adicione um campo de texto dinâmico que usa a fonte, selecione Opções de caractere do campo de texto dinâmico e especifique que contornos de fonte devem ser incorporados em pelo menos um caractere. (Não importa quais caracteres você especifique nem se são caracteres utilizados nos campos de texto estáticos.)
Parâmetros
x:Number — Um número que representa a coordenada x do clipe de filme que contém o texto.
| |
y:Number — Um número que representa a coordenada y do clipe de filme que contém o texto.
| |
maxDistance:Number (default = 0)x, y que pode ser pesquisada quanto a texto. A distância é medida a partir do ponto central de cada caractere. O valor padrão é 0.
|
Number — Um número que representa o valor de índice do caractere mais próximo da coordenada x, y especificada. Retorna -1 se nenhum caractere for encontrado ou se a fonte não possuir informações de métrica do caractere.
|
Elementos da API relacionados
setSelectColor | () | método |
public function setSelectColor(hexColor:uint = 0xFFFF00):void| Versão da linguagem: | ActionScript 3.0 |
| Versões de runtime: | AIR 1.0, Flash Player 9., Flash Lite 4 |
Especifica a cor a ser utilizada ao realçar caracteres que foram selecionados com o método setSelected(). A cor é sempre opaca; não é possível especificar um valor de transparência.
Esse método funciona corretamente somente com fontes que incluem informações de métrica do caractere; no entanto, por padrão, a ferramenta de criação Flash não inclui essas informações para campos de texto estáticos. Portanto, o método talvez retorne -1, em vez de um valor de índice. Para garantir que um valor de índice seja retornado, é possível forçar a ferramenta de criação Flash para incluir as informações de métrica do caractere para uma fonte. Para fazer isso, adicione um campo de texto dinâmico que usa a fonte, selecione Opções de caractere do campo de texto dinâmico e especifique que contornos de fonte devem ser incorporados em pelo menos um caractere. (Não importa quais caracteres você especifique nem se são caracteres utilizados nos campos de texto estáticos.)
Parâmetros
hexColor:uint (default = 0xFFFF00)setSelected() correspondente, expressa em formato hexadecimal (0xRRGGBB).
|
Elementos da API relacionados
setSelected | () | método |
public function setSelected(beginIndex:int, endIndex:int, select:Boolean):void| Versão da linguagem: | ActionScript 3.0 |
| Versões de runtime: | AIR 1.0, Flash Player 9., Flash Lite 4 |
Especifica um intervalo de caracteres em um objeto TextSnapshot a ser selecionado ou não. Os caracteres selecionados são desenhados com um retângulo colorido atrás deles, ocupando a caixa delimitadora do caractere. A cor da caixa delimitadora é definida por setSelectColor().
Para marcar ou desmarcar todos os caracteres, passe um valor 0 para beginIndex e charCount (ou qualquer outro número muito grande) para endIndex. Para especificar um único caractere, passe um valor start + 1 para endIndex.
Como os caracteres são marcados individualmente conforme selecionados, é possível chamar esse método várias vezes para selecionar vários caracteres; ou seja, utilizar esse método não desmarca outros caracteres que tenham sido definidos pelo método.
O retângulo colorido que indica uma seleção é exibido somente para fontes que incluem informações de métrica do caractere; por padrão, o Flash não inclui essas informações para campos de texto estáticos. Em alguns casos, esse comportamento significa que o texto selecionado não será exibido para seleção na tela. Para garantir que todo o texto selecionado seja exibido para seleção, é possível forçar a ferramenta de criação Flash para incluir as informações de métrica do caractere para uma fonte. Para fazer isso, adicione um campo de texto dinâmico que usa a fonte, selecione Opções de caractere do campo de texto dinâmico e especifique que contornos de fonte devem ser incorporados em pelo menos um caractere. Não importa quais caracteres você especifique nem se são caracteres utilizados nos campos de texto estáticos em questão.
Parâmetros
beginIndex:int — Indica a posição do primeiro caractere a ser selecionado. Os valores válidos para beginIndex são 0 a charCount - 1. Se beginIndex for um valor negativo, 0 será utilizado.
| |
endIndex:int — Um número inteiro que é 1+ o índice do último caractere a ser examinado. Os valores válidos para end são 0 a charCount. O caractere indexado pelo parâmetro end não está incluído na string extraída. Se você omitir esse parâmetro, TextSnapshot.charCount será utilizado. Se o valor de beginIndex for menor ou igual ao valor de endIndex, beginIndex + 1 será utilizado.
| |
select:Boolean — Um valor booliano que especifica se o texto deve ser selecionado (true) ou não (false).
|
Elementos da API relacionados
Wed Jun 13 2018, 11:10 AM Z