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

Paquete	flash.text.ime
Interfaz	public interface IIMEClient

Versión del lenguaje:

ActionScript 3.0

Versiones de motor de ejecución:

Flash Player 10.1, AIR 2

Interfaz para clientes IME (editor de método de entrada). Los componentes basados en el paquete flash.text.engine deben implementar esta interfaz para admitir edición de texto en línea mediante un IME. Esta interfaz no se utiliza con objetos TextField. TextLayoutFramework (TLF) utiliza esta interfaz para admitir el IME en línea, de modo que los clientes que utilicen TLF no tengan que implementar esta interfaz.

Para admitir IME en línea, establezca la propiedad imeClient de un evento ImeEvent.IME_START_COMPOSITION en un objeto que implemente esta interfaz.

Los siguientes términos se utilizan a menudo en la API relativa al IME:

Una conversación el intercambio entre el IME y la aplicación. Durante una conversación, una composición se actualiza una o varias veces y, a continuación, se confirma por el usuario.
Una composición identifica el texto introducido por el usuario a través del IME; incluida la información del estado de entrada, como el intervalo seleccionado y la extensión de cualquier cláusula.
Una cláusula es un rango de la composición que posiblemente comparte información semántica como, por ejemplo, si la entrada está en estado seleccionado o convertido. Una composición contiene cero o más cláusulas.

Elementos de API relacionados

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

Propiedades públicas

	Propiedad		Definido por
		compositionEndIndex : int [solo lectura] El valor de índice basado en cero del final de la sesión de edición de texto actual (como todo el texto de la sesión en línea que todavía no se ha confirmado en el documento).	IIMEClient
		compositionStartIndex : int [solo lectura] El valor de índice basado en cero del inicio de la sesión de edición de texto actual (es decir, el texto de la sesión en línea que todavía no se ha confirmado en el documento).	IIMEClient
		selectionActiveIndex : int [solo lectura] El valor de índice basado en cero del último carácter de la selección actual.	IIMEClient
		selectionAnchorIndex : int [solo lectura] El valor de índice basado en cero del primer carácter de la selección actual.	IIMEClient
		verticalTextLayout : Boolean [solo lectura] Indica si el texto del componente es vertical o no.	IIMEClient

Métodos públicos

	Método		Definido por
		confirmComposition(text:String = null, preserveSelection:Boolean = false):void Utilice esta función callback para finalizar la sesión de edición en línea y confirmar el texto.	IIMEClient
		getTextBounds(startIndex:int, endIndex:int):Rectangle El IME utiliza este método para consultar el cuadro delimitador del texto actualmente en edición en el cliente IME.	IIMEClient
		getTextInRange(startIndex:int, endIndex:int):String Obtiene el rango de texto especificado del componente.	IIMEClient
		selectRange(anchorIndex:int, activeIndex:int):void Establece el rango de texto seleccionado en el componente.	IIMEClient
		updateComposition(text:String, attributes:Vector.<CompositionAttributeRange>, compositionStartIndex:int, compositionEndIndex:int):void La función callback para actualizar el contenido de la sesión de edición en línea.	IIMEClient

Eventos

Haga clic para obtener más información sobre los eventos

	Evento		Resumen	Definido por
		imeStartComposition	Se distribuye cuando el usuario comienza a utilizar un IME (editor de método de entrada).	IIMEClient
		textInput	Se distribuye cuando el usuario introduce texto.	IIMEClient

Información sobre propiedades

compositionEndIndex

propiedad

compositionEndIndex:int [solo lectura]

Versión del lenguaje:

ActionScript 3.0

Versiones de motor de ejecución:

Flash Player 10.1, AIR 2

El valor de índice basado en cero del final de la sesión de edición de texto actual (como todo el texto de la sesión en línea que todavía no se ha confirmado en el documento).

Implementación
public function get compositionEndIndex():int

compositionStartIndex

propiedad

compositionStartIndex:int [solo lectura]

Versión del lenguaje:

ActionScript 3.0

Versiones de motor de ejecución:

Flash Player 10.1, AIR 2

El valor de índice basado en cero del inicio de la sesión de edición de texto actual (es decir, el texto de la sesión en línea que todavía no se ha confirmado en el documento).

Implementación
public function get compositionStartIndex():int

selectionActiveIndex

propiedad

selectionActiveIndex:int [solo lectura]

Versión del lenguaje:

ActionScript 3.0

Versiones de motor de ejecución:

Flash Player 10.1, AIR 2

El valor de índice basado en cero del último carácter de la selección actual.

Implementación
public function get selectionActiveIndex():int

selectionAnchorIndex

propiedad

selectionAnchorIndex:int [solo lectura]

Versión del lenguaje:

ActionScript 3.0

Versiones de motor de ejecución:

Flash Player 10.1, AIR 2

El valor de índice basado en cero del primer carácter de la selección actual.

Implementación
public function get selectionAnchorIndex():int

verticalTextLayout

propiedad

verticalTextLayout:Boolean [solo lectura]

Versión del lenguaje:

ActionScript 3.0

Versiones de motor de ejecución:

Flash Player 10.1, AIR 2

Indica si el texto del componente es vertical o no. Esta propiedad dirige la posición de la ventana candidata (por ejemplo, junto al texto vertical o debajo del texto horizontal).

Implementación
public function get verticalTextLayout():Boolean

Información sobre métodos

confirmComposition

()

método

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

Versión del lenguaje:

ActionScript 3.0

Versiones de motor de ejecución:

Flash Player 10.1, AIR 2

Utilice esta función callback para finalizar la sesión de edición en línea y confirmar el texto.

Parámetros

	`text:String` (default = `null`) — el estado final del texto de la sesión en línea (el texto confirmado)

	`preserveSelection:Boolean` (default = `false`) — si es true, no se debe restablecer la selección actual al final del texto confirmado.

getTextBounds

()

método

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

Versión del lenguaje:

ActionScript 3.0

Versiones de motor de ejecución:

Flash Player 10.1, AIR 2

El IME utiliza este método para consultar el cuadro delimitador del texto actualmente en edición en el cliente IME. Utilice este método para colocar la ventana candidata y definir el cursor del ratón en el cliente IME cuando el ratón esté sobre el campo de texto u otro componente que admita IME.

Parámetros

	`startIndex:int` — Un entero que especifica la ubicación inicial del rango de texto desde el cuadro delimitador que está midiendo.

	`endIndex:int` — Opcional; un entero que especifica la ubicación final del rango de texto desde el cuadro delimitador que está midiendo.

Valor devuelto

Rectangle — El cuadro delimitador del rango de texto especificado o null si uno o ambos índices no son válidos. Este método devuelve el mismo valor si startIndex es mayor o menor que endIndex. El mismo valor debe ser devuelto independientemente de si startIndex es mayor o menor que endIndex.

getTextInRange

()

método

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

Versión del lenguaje:

ActionScript 3.0

Versiones de motor de ejecución:

Flash Player 10.1, AIR 2

Obtiene el rango de texto especificado del componente. Se llama a este método durante la reconversión IME.

Parámetros

	`startIndex:int` — un entero que especifica la ubicación inicial del rango de texto que se va a recuperar.

	`endIndex:int` — un entero que especifica la ubicación final del rango de texto que se va a recuperar.

Valor devuelto

String — El texto solicitado, o null si no hay texto disponible en el rango o solicitado si uno o ambos índices no son válidos. El mismo valor debe ser devuelto independientemente de si startIndex es mayor o menor que endIndex.

selectRange

()

método

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

Versión del lenguaje:

ActionScript 3.0

Versiones de motor de ejecución:

Flash Player 10.1, AIR 2

Establece el rango de texto seleccionado en el componente. Si alguno de los argumentos queda fuera de los límites la selección no se deben modificar.

Parámetros

	`anchorIndex:int` — El valor de índice basado en cero del carácter en el final del anclaje de la selección

	`activeIndex:int` — El valor de índice basado en cero del carácter en el final activo de la selección.

updateComposition

()

método

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

Versión del lenguaje:

ActionScript 3.0

Versiones de motor de ejecución:

Flash Player 10.1, AIR 2

La función callback para actualizar el contenido de la sesión de edición en línea. Se llama a este método cada vez que cambia el texto que se editando con el IME y su contenido lo utiliza el cliente para redibujar toda la sesión de edición en línea.

Parámetros

	`text:String` — Contiene el texto de la sesión de edición en línea del IME.

	`attributes:Vector.<CompositionAttributeRange>` — Contiene un conjunto de cláusulas de composición con información de ornamentación.

	`compositionStartIndex:int` — Inicio de la sesión en línea con relación al inicio del objeto de texto.

	`compositionEndIndex:int` — Final de la sesión en línea con relación al inicio del objeto de texto.

Información sobre eventos

imeStartComposition

Evento

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

Versión del lenguaje:

ActionScript 3.0

Versiones de motor de ejecución:

Flash Player 10.1, AIR 2

Se distribuye cuando el usuario comienza a utilizar un IME (editor de método de entrada).

Para gestionar entrada de texto IME, el receptor debe definir el campo imeClient del evento en un objeto que implemente la interfaz IIMEClient. Si imeClient se desactiva, el motor de ejecución utiliza la composición de IME sin conexión y envía la composición final TEXT_INPUT como un evento.

Este evento tiene las propiedades siguientes:

Propiedad	Valor
`bubbles`	`false`
`cancelable`	`false`; no hay ningún comportamiento predeterminado que cancelar.
`currentTarget`	Objeto que procesa de forma activa el objeto de evento con un detector de eventos.
`target`	El objeto IME.

textInput

Evento

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

Versión del lenguaje:

ActionScript 3.0

Versiones de motor de ejecución:

Flash Player 10.1, AIR 2

Se distribuye cuando el usuario introduce texto. Para clientes IME (editor de método de entrada), el receptor debe insertar la cadena incluida en la propiedad text del objeto de evento en el punto de inserción actual.

Define el valor de la propiedad type de un objeto de evento textInput.

Nota: este evento no se distribuye para las teclas Supr o Retroceso.

Este evento tiene las propiedades siguientes:

Propiedad	Valor
`bubbles`	`true`
`cancelable`	`true`; llama al método `preventDefault()` para cancelar el comportamiento predeterminado.
`currentTarget`	Objeto que procesa de forma activa el objeto de evento con un detector de eventos.
`target`	Campo de texto en el que se introducen los caracteres. El destino no siempre es el objeto de la lista de visualización que registró el detector de eventos. Utilice la propiedad `currentTarget` para acceder al objeto de la lista de visualización que está procesando el evento actualmente.
`text`	Carácter o secuencia de caracteres introducidos por el usuario.

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

IIMEClient - AS3

Clases x

compositionEndIndex

compositionStartIndex

selectionActiveIndex

selectionAnchorIndex

verticalTextLayout

confirmComposition

getTextBounds

getTextInRange

selectRange

updateComposition

imeStartComposition

textInput