IIMEClient - Guida di riferimento alle API Adobe ActionScript® 3 (AS3 )

Pacchetto	flash.text.ime
Interfaccia	public interface IIMEClient

Versione linguaggio:

ActionScript 3.0

Versioni runtime:

Flash Player 10.1, AIR 2

Interfaccia per i client IME (Input Method Editor). I componenti basati sul pacchetto flash.text.engine devono supportare la modifica di testo inline tramite un IME. Questa interfaccia non viene utilizzata con gli oggetti TextField. TextLayoutFramework (TLF) utilizza questa interfaccia per supportare l'IME inline, pertanto i client che utilizzano TLF non hanno l'esigenza di implementare tale interfaccia.

Per supportare l'IME inline, impostate la proprietà imeClient di un evento ImeEvent.IME_START_COMPOSITION su un oggetto che implementa questa interfaccia.

Di seguito sono riportati i termini che vengono spesso utilizzati nell'API correlata all'IME:

Una conversazione è lo scambio tra l'IME e l'applicazione. Durante una conversazione, una composizione viene aggiornata una o più volte e quindi confermata dall'utente.
Una composizione identifica il testo immesso dall'utente tramite l'IME; sono incluse le informazioni sullo stato di input associate, ad esempio l'intervallo selezionato e l'estensione delle eventuali clausole.
Una clausola è un intervallo della composizione che può condividere informazioni semantiche, ad esempio l'indicazione dello stato dell'input, ovvero selezionato o convertito. Una composizione contiene zero o più clausole.

Elementi API correlati

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

Proprietà pubbliche

	Proprietà		Definito da
		compositionEndIndex : int [sola lettura] Il valore dell'indice a base zero della fine del testo della sessione di modifica corrente (ad esempio, tutto il testo nella sessione inline che non è confermato nel documento).	IIMEClient
		compositionStartIndex : int [sola lettura] Il valore dell'indice a base zero dell'inizio del testo della sessione di modifica corrente (ad esempio, tutto il testo nella sessione inline che non è confermato nel documento).	IIMEClient
		selectionActiveIndex : int [sola lettura] Il valore dell'indice a base zero dell'ultimo carattere nella selezione corrente.	IIMEClient
		selectionAnchorIndex : int [sola lettura] Il valore dell'indice a base zero del primo carattere nella selezione corrente.	IIMEClient
		verticalTextLayout : Boolean [sola lettura] Indica se il testo nel componente è verticale o meno.	IIMEClient

Metodi pubblici

	Metodo		Definito da
		confirmComposition(text:String = null, preserveSelection:Boolean = false):void Utilizzate questo metodo di callback per terminare la sessione di modifica inline e confermare il testo.	IIMEClient
		getTextBounds(startIndex:int, endIndex:int):Rectangle L'IME utilizza questo metodo per inviare una query al riquadro di delimitazione del testo attualmente modificato con il client IME.	IIMEClient
		getTextInRange(startIndex:int, endIndex:int):String Ottiene l'intervallo di testo specificato dal componente.	IIMEClient
		selectRange(anchorIndex:int, activeIndex:int):void Imposta l'intervallo del testo selezionato nel componente.	IIMEClient
		updateComposition(text:String, attributes:Vector.<CompositionAttributeRange>, compositionStartIndex:int, compositionEndIndex:int):void Callback per l'aggiornamento del contenuto della sessione di modifica inline.	IIMEClient

Eventi

Fate clic per visualizzare altre informazioni sugli eventi

	Evento		Riepilogo	Definito da
		imeStartComposition	Inviato quando l'utente inizia a utilizzare un IME (Input Method Editor).	IIMEClient
		textInput	Inviato quando l'utente immette un testo.	IIMEClient

Descrizione delle proprietà

compositionEndIndex

proprietà

compositionEndIndex:int [sola lettura]

Versione linguaggio:

ActionScript 3.0

Versioni runtime:

Flash Player 10.1, AIR 2

Il valore dell'indice a base zero della fine del testo della sessione di modifica corrente (ad esempio, tutto il testo nella sessione inline che non è confermato nel documento).

Implementazione
public function get compositionEndIndex():int

compositionStartIndex

proprietà

compositionStartIndex:int [sola lettura]

Versione linguaggio:

ActionScript 3.0

Versioni runtime:

Flash Player 10.1, AIR 2

Il valore dell'indice a base zero dell'inizio del testo della sessione di modifica corrente (ad esempio, tutto il testo nella sessione inline che non è confermato nel documento).

Implementazione
public function get compositionStartIndex():int

selectionActiveIndex

proprietà

selectionActiveIndex:int [sola lettura]

Versione linguaggio:

ActionScript 3.0

Versioni runtime:

Flash Player 10.1, AIR 2

Il valore dell'indice a base zero dell'ultimo carattere nella selezione corrente.

Implementazione
public function get selectionActiveIndex():int

selectionAnchorIndex

proprietà

selectionAnchorIndex:int [sola lettura]

Versione linguaggio:

ActionScript 3.0

Versioni runtime:

Flash Player 10.1, AIR 2

Il valore dell'indice a base zero del primo carattere nella selezione corrente.

Implementazione
public function get selectionAnchorIndex():int

verticalTextLayout

proprietà

verticalTextLayout:Boolean [sola lettura]

Versione linguaggio:

ActionScript 3.0

Versioni runtime:

Flash Player 10.1, AIR 2

Indica se il testo nel componente è verticale o meno. Questa proprietà indica il posizionamento della finestra candidata (ad esempio accanto al testo verticale o sotto il testo orizzontale).

Implementazione
public function get verticalTextLayout():Boolean

Descrizione dei metodi

confirmComposition

()

metodo

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

Versione linguaggio:

ActionScript 3.0

Versioni runtime:

Flash Player 10.1, AIR 2

Utilizzate questo metodo di callback per terminare la sessione di modifica inline e confermare il testo.

Parametri

	`text:String` (default = `null`) — Lo stato finale del testo nella sessione inline (il testo confermato).

	`preserveSelection:Boolean` (default = `false`) — Se true, non reimpostate la selezione corrente alla fine del testo confermato.

getTextBounds

()

metodo

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

Versione linguaggio:

ActionScript 3.0

Versioni runtime:

Flash Player 10.1, AIR 2

L'IME utilizza questo metodo per inviare una query al riquadro di delimitazione del testo attualmente modificato con il client IME. Utilizzate questo metodo per inserire la finestra candidata e impostare il cursore del mouse nel client IME quando il mouse si trova sopra il campo di testo o un altro componente che supporta IME.

Parametri

	`startIndex:int` — Un numero intero che specifica la posizione iniziale dell'intervallo di testo dal riquadro di delimitazione che state misurando.

	`endIndex:int` — Opzionale; un numero intero che specifica la posizione finale dell'intervallo di testo dal riquadro di delimitazione che state misurando.

Restituisce

Rectangle — Il riquadro di delimitazione dell'intervallo di testo specificato oppure null se uno o entrambi gli indici non sono validi. Questo metodo restituisce lo stesso valore se startIndex è maggiore o minore di endIndex. Dovrà essere restituito lo stesso valore indipendentemente dal fatto che startIndex sia maggiore o minore di endIndex.

getTextInRange

()

metodo

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

Versione linguaggio:

ActionScript 3.0

Versioni runtime:

Flash Player 10.1, AIR 2

Ottiene l'intervallo di testo specificato dal componente. Questo metodo viene chiamato durante la riconversione dell'IME.

Parametri

	`startIndex:int` — Un numero intero che specifica la posizione iniziale dell'intervallo di testo da recuperare.

	`endIndex:int` — Un numero intero che specifica la posizione finale dell'intervallo di testo da recuperare.

Restituisce

String — Il testo richiesto oppure null se nell'intervallo richiesto non è presente del testo o se entrambi gli indici non sono validi. Dovrà essere restituito lo stesso valore indipendentemente dal fatto che startIndex sia maggiore o minore di endIndex.

selectRange

()

metodo

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

Versione linguaggio:

ActionScript 3.0

Versioni runtime:

Flash Player 10.1, AIR 2

Imposta l'intervallo del testo selezionato nel componente. Se uno degli argomenti è fuori dai limiti, evitate di modificare la selezione.

Parametri

	`anchorIndex:int` — Il valore dell'indice a base zero del carattere in corrispondenza dell'estremità di ancoraggio della selezione.

	`activeIndex:int` — Il valore dell'indice a base zero del carattere in corrispondenza dell'estremità attiva della selezione.

updateComposition

()

metodo

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

Versione linguaggio:

ActionScript 3.0

Versioni runtime:

Flash Player 10.1, AIR 2

Callback per l'aggiornamento del contenuto della sessione di modifica inline. Questo metodo viene chiamato ogni volta che il testo in corso di modifica tramite l'IME viene modificato e il relativo contenuto viene utilizzato dal client per ridisegnare l'intera sessione di modifica inline.

Parametri

	`text:String` — Contiene il testo della sessione di modifica inline dall'IME.

	`attributes:Vector.<CompositionAttributeRange>` — Contiene un array di clausole di composizione con informazioni sulla formattazione.

	`compositionStartIndex:int` — Inizio della sessione inline relativa all'inizio dell'oggetto di testo.

	`compositionEndIndex:int` — Fine della sessione inline relativa all'inizio dell'oggetto di testo.

Descrizione degli eventi

imeStartComposition

Evento

Tipo di oggetto evento: flash.events.IMEEvent
proprietà IMEEvent.type = flash.events.IMEEvent.IME_START_COMPOSITION

Versione linguaggio:

ActionScript 3.0

Versioni runtime:

Flash Player 10.1, AIR 2

Inviato quando l'utente inizia a utilizzare un IME (Input Method Editor).

Per gestire l'input di testo IME, il ricevente deve impostare il campo imeClient dell'evento su un oggetto che implementa l'interfaccia IIMEClient. Se imeClient non è impostato, il runtime utilizza la composizione IME "out-of-line" e invia la composizione finale come evento TEXT_INPUT.

Questo evento ha le seguenti proprietà:

Proprietà	Valore
`bubbles`	`false`
`cancelable`	`false`; non è presente alcun comportamento predefinito da annullare.
`currentTarget`	L'oggetto che elabora attivamente l'oggetto Event con un listener di eventi.
`target`	L'oggetto IME.

textInput

Evento

Tipo di oggetto evento: flash.events.TextEvent
proprietà TextEvent.type = flash.events.TextEvent.TEXT_INPUT

Versione linguaggio:

ActionScript 3.0

Versioni runtime:

Flash Player 10.1, AIR 2

Inviato quando l'utente immette un testo. Per i client IME (Input Method Editor), il ricevente deve inserire la stringa contenuta nella proprietà text dell'oggetto evento nel punto di inserimento corrente.

Definisce il valore della proprietà type di un oggetto evento textInput.

Nota: questo evento non viene inviato per il tasto Canc o Backspace.

Questo evento ha le seguenti proprietà:

Proprietà	Valore
`bubbles`	`true`
`cancelable`	`true`; chiama il metodo `preventDefault()` per annullare il comportamento predefinito.
`currentTarget`	L'oggetto che elabora attivamente l'oggetto Event con un listener di eventi.
`target`	Il campo di testo in cui vengono immessi i caratteri. Il target non è sempre l'oggetto contenuto nell'elenco di visualizzazione, che ha registrato il listener di eventi. Utilizzate la proprietà `currentTarget` per accedere all'oggetto dell'elenco di visualizzazione che sta elaborando l'evento.
`text`	Il carattere o la sequenza di caratteri immessi dall'utente.

Note legali | Informativa sulla privacy online

IIMEClient - AS3

Pacchettix

Elementi del linguaggio

Appendici

Pacchetto flash.text.ime

compositionEndIndex

compositionStartIndex

selectionActiveIndex

selectionAnchorIndex

verticalTextLayout

confirmComposition

getTextBounds

getTextInRange

selectRange

updateComposition

imeStartComposition

textInput