IIMEClient - Referência da API Adobe ActionScript® 3 (AS3 )

Pacote	flash.text.ime
Interface	public interface IIMEClient

Versão da linguagem:

ActionScript 3.0

Versões de runtime:

Flash Player 10.1, AIR 2

Interface de clientes IME (editor de método de entrada). Os componentes com base no pacote flash.text.engine devem implementar esta interface para suportar a edição de texto incorporada utilizando um IME. Esta interface não é usada com objetos TextField. TextLayoutFramework (TLF) usa esta interface para suportar o IME em linha, portanto os clientes que usam TLF não precisam implementar esta interface.

Para suportar IME em linha, defina a propriedade imeClient de um evento ImeEvent.IME_START_COMPOSITION para um objeto que implementa esta interface.

Os seguintes termos muitas vezes são usados na API relacionada ao IME:

A conversação é a transferência entre o IME e o aplicativo. Durante uma conversação, uma composição é atualizada uma ou mais vezes e depois confirmada pelo usuário.
A composição identifica o texto introduzido pelo usuário pelo IME; inclusive informações de estado de entrada associadas, como o intervalo selecionado e o ponto de qualquer cláusula.
A cláusula é um intervalo da composição que possivelmente compartilha informações semânticas, como indicação se a entrada está em um estado selecionado ou convertido. Uma composição contém zero ou mais cláusulas.

Elementos da API relacionados

flash.text.ime.CompositionAttributeRange
flash.events.IMEEvent.imeClient

Propriedades públicas

	Propriedade		Definido por
		compositionEndIndex : int [somente leitura] O valor de índice de caractere com base em zero do fim do texto de sessão de edição atual (como todo o texto na sessão em linha que ainda não foi confirmada para o documento).	IIMEClient
		compositionStartIndex : int [somente leitura] O valor de índice de caractere com base em zero no início do texto de sessão de edição atual (como todo o texto da sessão em linha que ainda não foi confirmada para o documento).	IIMEClient
		selectionActiveIndex : int [somente leitura] O valor de índice de caractere com base em zero do último caractere na seleção atual.	IIMEClient
		selectionAnchorIndex : int [somente leitura] O valor de índice de caractere com base em zero do primeiro caractere na seleção atual.	IIMEClient
		verticalTextLayout : Boolean [somente leitura] Indica se o texto no componente é a vertical ou não.	IIMEClient

Métodos públicos

	Método		Definido por
		confirmComposition(text:String = null, preserveSelection:Boolean = false):void Use esta rechamada para terminar a sessão de edição em linha e confirmar o texto.	IIMEClient
		getTextBounds(startIndex:int, endIndex:int):Rectangle O IME usa este método para consultar a caixa delimitadora do texto atualmente editada com o cliente IME.	IIMEClient
		getTextInRange(startIndex:int, endIndex:int):String Adquire o intervalo de texto especificado do componente.	IIMEClient
		selectRange(anchorIndex:int, activeIndex:int):void Define o intervalo do texto selecionado no componente.	IIMEClient
		updateComposition(text:String, attributes:Vector.<CompositionAttributeRange>, compositionStartIndex:int, compositionEndIndex:int):void Retorno de chamada para atualizar os conteúdos da sessão de edição em linha.	IIMEClient

Eventos

Clique para obter mais informações sobre eventos

	Evento		Resumo	Definido por
		imeStartComposition	Despachado quando o usuário começa a usar um IME (editor de método de entrada).	IIMEClient
		textInput	Despachado quando o usuário insere texto.	IIMEClient

Detalhes da propriedade

compositionEndIndex

propriedade

compositionEndIndex:int [somente leitura]

Versão da linguagem:

ActionScript 3.0

Versões de runtime:

Flash Player 10.1, AIR 2

O valor de índice de caractere com base em zero do fim do texto de sessão de edição atual (como todo o texto na sessão em linha que ainda não foi confirmada para o documento).

Implementação
public function get compositionEndIndex():int

compositionStartIndex

propriedade

compositionStartIndex:int [somente leitura]

Versão da linguagem:

ActionScript 3.0

Versões de runtime:

Flash Player 10.1, AIR 2

O valor de índice de caractere com base em zero no início do texto de sessão de edição atual (como todo o texto da sessão em linha que ainda não foi confirmada para o documento).

Implementação
public function get compositionStartIndex():int

selectionActiveIndex

propriedade

selectionActiveIndex:int [somente leitura]

Versão da linguagem:

ActionScript 3.0

Versões de runtime:

Flash Player 10.1, AIR 2

O valor de índice de caractere com base em zero do último caractere na seleção atual.

Implementação
public function get selectionActiveIndex():int

selectionAnchorIndex

propriedade

selectionAnchorIndex:int [somente leitura]

Versão da linguagem:

ActionScript 3.0

Versões de runtime:

Flash Player 10.1, AIR 2

O valor de índice de caractere com base em zero do primeiro caractere na seleção atual.

Implementação
public function get selectionAnchorIndex():int

verticalTextLayout

propriedade

verticalTextLayout:Boolean [somente leitura]

Versão da linguagem:

ActionScript 3.0

Versões de runtime:

Flash Player 10.1, AIR 2

Indica se o texto no componente é a vertical ou não. Esta propriedade dirige o posicionamento da janela candidata (como ao lado do texto vertical ou abaixo do texto horizontal).

Implementação
public function get verticalTextLayout():Boolean

Detalhes do método

confirmComposition

()

método

public function confirmComposition(text:String = null, preserveSelection:Boolean = false):void

Versão da linguagem:

ActionScript 3.0

Versões de runtime:

Flash Player 10.1, AIR 2

Use esta rechamada para terminar a sessão de edição em linha e confirmar o texto.

Parâmetros

	`text:String` (default = `null`) — o estado final do texto na sessão em linha (o texto confirmado).

	`preserveSelection:Boolean` (default = `false`) — quando verdadeiro, você não deve redefinir a seleção atual ao fim do texto confirmado.

getTextBounds

()

método

public function getTextBounds(startIndex:int, endIndex:int):Rectangle

Versão da linguagem:

ActionScript 3.0

Versões de runtime:

Flash Player 10.1, AIR 2

O IME usa este método para consultar a caixa delimitadora do texto atualmente editada com o cliente IME. Use este método para inserir a janela candidata e definir o cursor do mouse no cliente IME quando o mouse estiver sobre o campo de texto ou outro componente que suporta IME.

Parâmetros

	`startIndex:int` — Um número inteiro que especifica o local inicial do intervalo do texto da caixa delimitadora que você está medindo.

	`endIndex:int` — Opcional; um número inteiro que especifica o local final do intervalo de texto da caixa delimitadora que você está medindo.

Retorna

Rectangle — A caixa delimitadora do intervalo especificado de texto, ou null se um dos dois ou ambos os índices forem inválidos. Este método devolve o mesmo valor se startIndex for maior ou menor do que endIndex. O mesmo valor deve ser retornado independentemente se startIndex for maior ou menor do que endIndex.

getTextInRange

()

método

public function getTextInRange(startIndex:int, endIndex:int):String

Versão da linguagem:

ActionScript 3.0

Versões de runtime:

Flash Player 10.1, AIR 2

Adquire o intervalo de texto especificado do componente. Este método é chamado durante a reconversão de IME.

Parâmetros

	`startIndex:int` — um número inteiro que especifica o local inicial do intervalo do texto a ser recuperado.

	`endIndex:int` — um número inteiro que especifica o local final do intervalo do texto a ser recuperado.

Retorna

String — O texto solicitado, ou null se nenhum texto está disponível no intervalo solicitado ou se ou ambos dos índices forem inválidos. O mesmo valor deve ser devolvido independentemente ou se startIndex é maior ou menor do que endIndex.

selectRange

()

método

public function selectRange(anchorIndex:int, activeIndex:int):void

Versão da linguagem:

ActionScript 3.0

Versões de runtime:

Flash Player 10.1, AIR 2

Define o intervalo do texto selecionado no componente. Se qualquer dos argumentos está fora de limites a seleção não deve ser modificada.

Parâmetros

	`anchorIndex:int` — O valor de índice com base em zero do caractere no fim da âncora da seleção

	`activeIndex:int` — O valor de índice com base em zero do caractere no final ativo da seleção.

updateComposition

()

método

 public function updateComposition(text:String, attributes:Vector.<CompositionAttributeRange>, compositionStartIndex:int, compositionEndIndex:int):void

Versão da linguagem:

ActionScript 3.0

Versões de runtime:

Flash Player 10.1, AIR 2

Retorno de chamada para atualizar os conteúdos da sessão de edição em linha. Esse método é chamado sempre que o texto que é editado com o IME tiver sido modificado e os seu conteúdo for usado pelo cliente para desenhar novamente a sessão de edição em linha inteira.

Parâmetros

	`text:String` — Contém o texto da sessão de edição em linha a partir do IME.

	`attributes:Vector.<CompositionAttributeRange>` — Contém uma matriz de cláusulas de composição com informações de adorno.

	`compositionStartIndex:int` — Início da sessão em linha quanto ao início do objeto de texto.

	`compositionEndIndex:int` — Fim da sessão em linha quanto ao início do objeto de texto.

Detalhe do evento

imeStartComposition

Evento

Tipo do objeto de evento: flash.events.IMEEvent
propriedade IMEEvent.type = flash.events.IMEEvent.IME_START_COMPOSITION

Versão da linguagem:

ActionScript 3.0

Versões de runtime:

Flash Player 10.1, AIR 2

Despachado quando o usuário começa a usar um IME (editor de método de entrada).

Para controlar a entrada de texto IME, o receptor deve definir o campo imeClient do evento a um objeto que implementa a interface de IIMEClient. Se imeClient não for definido, o tempo de execução usa a composição não correspondente de IME e envia a composição final como um evento TEXT_INPUT.

Esse evento tem as seguintes propriedades:

Propriedade	Valor
`bubbles`	`false`
`cancelable`	`false`; não há comportamento padrão a ser cancelado.
`currentTarget`	O objeto que está processando ativamente o objeto Event com um ouvinte de evento.
`target`	O objeto IME.

textInput

Evento

Tipo do objeto de evento: flash.events.TextEvent
propriedade TextEvent.type = flash.events.TextEvent.TEXT_INPUT

Versão da linguagem:

ActionScript 3.0

Versões de runtime:

Flash Player 10.1, AIR 2

Despachado quando o usuário insere texto. Para clientes IME (editor de método de entrada), o receptor deve inserir a string contida na propriedade text do objeto de evento no ponto de inserção atual.

Define o valor da propriedade type de um objeto de evento textInput.

Observação: Este evento não é despachado para as teclas Excluir ou Backspace.

Esse evento tem as seguintes propriedades:

Propriedade	Valor
`bubbles`	`true`
`cancelable`	`true`; chama o método `preventDefault()` para cancelar o comportamento padrão.
`currentTarget`	O objeto que está processando ativamente o objeto Event com um ouvinte de evento.
`target`	O campo de texto no qual os caracteres estão sendo inseridos. target não é sempre o objeto na lista de exibição que registrou o ouvinte de evento. Use a propriedade `currentTarget` para acessar o objeto na lista de exibição que está processando o evento no momento.
`text`	O caractere ou a string de caracteres inserida pelo usuário.

Aspectos jurídicos | Política de privacidade on-line

IIMEClient - AS3

Classes x

compositionEndIndex

compositionStartIndex

selectionActiveIndex

selectionAnchorIndex

verticalTextLayout

confirmComposition

getTextBounds

getTextInRange

selectRange

updateComposition

imeStartComposition

textInput