IIMEClient - Adobe ActionScript® 3 (AS3 ) API-Referenz

Paket	flash.text.ime
Schnittstelle	public interface IIMEClient

Sprachversion:

ActionScript 3.0

Laufzeitversionen:

Flash Player 10.1, AIR 2

Schnittstelle für IME-Clients (IME = Input Method Editor). Komponenten, die auf dem flash.text.engine-Paket basieren, müssen diese Schnittstelle implementieren, um die Bearbeitung von Text in der Zeile („inline“) mit einem IME zu unterstützen. Diese Schnittstelle wird nicht mit TextField-Objekten verwendet. TextLayoutFramework (TLF) verwendet diese Schnittstelle, um Inline-IME zu unterstützen; Clients, die TLF einsetzen, brauchen diese Schnittstelle also nicht zu implementieren.

Um Inline-IME zu unterstützen, stellen Sie die imeClient-Eigenschaft eines ImeEvent.IME_START_COMPOSITION-Ereignisses auf ein Objekt ein, dass diese Schnittstelle implementiert.

Die folgenden Begriffe werden häufig in der IME-bezogenen API verwendet:

Eine Konversation ist der Austausch zwischen dem IME und der Anwendung. Während einer Konversation wird ein Satz ein oder mehrere Male aktualisiert und dann vom Benutzer bestätigt.
Ein Satz identifiziert den Text, der vom Benutzer über den IME eingegeben wird; dazu gehören auch zugehörige Eingabestatusinformationen wie der ausgewählte Bereich und der Umfang etwaiger vorhandener Klauseln.
Eine Klausel ist ein Bereich des Satzes mit möglicherweise gemeinsamen semantischen Informationen, zum Beispiel die Anzeige, ob es sich bei der Eingabe um einen ausgewählten oder konvertierten Zustand handelt. Ein Satz enthält null oder mehrere Klauseln.

Verwandte API-Elemente

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

Öffentliche Eigenschaften

	Eigenschaft		Definiert von
		compositionEndIndex : int [schreibgeschützt] Der auf null basierende Zeichenindexwert des Endes des aktuellen Bearbeitungssitzungstexts (zum Beispiel der gesamte Text in der Inline-Sitzung, der noch nicht für das Dokument bestätigt wurde).	IIMEClient
		compositionStartIndex : int [schreibgeschützt] Der auf null basierende Zeichenindexwert des Anfangs des aktuellen Bearbeitungssitzungstexts (zum Beispiel der gesamte Text in der Inline-Sitzung, der noch nicht für das Dokument bestätigt wurde).	IIMEClient
		selectionActiveIndex : int [schreibgeschützt] Der auf null basierende Indexwert des letzten Zeichens in der aktuellen Auswahl.	IIMEClient
		selectionAnchorIndex : int [schreibgeschützt] Der auf null basierende Zeichenindexwert des ersten Zeichens in der aktuellen Auswahl.	IIMEClient
		verticalTextLayout : Boolean [schreibgeschützt] Gibt an, ob der Text in der Komponente vertikal ist oder nicht.	IIMEClient

Öffentliche Methoden

	Methode		Definiert von
		confirmComposition(text:String = null, preserveSelection:Boolean = false):void Verwenden Sie diesen Rückruf, um die Inline-Bearbeitungssitzung zu beenden und den Text zu bestätigen.	IIMEClient
		getTextBounds(startIndex:int, endIndex:int):Rectangle Der IME verwendet diese Methode, um den Begrenzungsrahmen des Texts, der zurzeit mit dem IME-Client bearbeitet wird, abzufragen.	IIMEClient
		getTextInRange(startIndex:int, endIndex:int):String Ruft den angegebenen Textbereich von der Komponente ab.	IIMEClient
		selectRange(anchorIndex:int, activeIndex:int):void Legt den Bereich des ausgewählten Texts in der Komponente fest.	IIMEClient
		updateComposition(text:String, attributes:Vector.<CompositionAttributeRange>, compositionStartIndex:int, compositionEndIndex:int):void Rückruf zum Aktualisieren des Inhalts der Inline-Bearbeitungssitzung.	IIMEClient

Ereignisse

Klicken Sie, um weitere Informationen zu Ereignissen zu erhalten.

	Ereignis		Übersicht	Definiert von
		imeStartComposition	Wird abgesetzt, wenn der Benutzer mit der Verwendung eines IME (Input Method Editor) beginnt.	IIMEClient
		textInput	Wird ausgelöst, wenn der Benutzer Text eingibt.	IIMEClient

Eigenschaftendetails

compositionEndIndex

Eigenschaft

compositionEndIndex:int [schreibgeschützt]

Sprachversion:

ActionScript 3.0

Laufzeitversionen:

Flash Player 10.1, AIR 2

Der auf null basierende Zeichenindexwert des Endes des aktuellen Bearbeitungssitzungstexts (zum Beispiel der gesamte Text in der Inline-Sitzung, der noch nicht für das Dokument bestätigt wurde).

Implementierung
public function get compositionEndIndex():int

compositionStartIndex

Eigenschaft

compositionStartIndex:int [schreibgeschützt]

Sprachversion:

ActionScript 3.0

Laufzeitversionen:

Flash Player 10.1, AIR 2

Der auf null basierende Zeichenindexwert des Anfangs des aktuellen Bearbeitungssitzungstexts (zum Beispiel der gesamte Text in der Inline-Sitzung, der noch nicht für das Dokument bestätigt wurde).

Implementierung
public function get compositionStartIndex():int

selectionActiveIndex

Eigenschaft

selectionActiveIndex:int [schreibgeschützt]

Sprachversion:

ActionScript 3.0

Laufzeitversionen:

Flash Player 10.1, AIR 2

Der auf null basierende Indexwert des letzten Zeichens in der aktuellen Auswahl.

Implementierung
public function get selectionActiveIndex():int

selectionAnchorIndex

Eigenschaft

selectionAnchorIndex:int [schreibgeschützt]

Sprachversion:

ActionScript 3.0

Laufzeitversionen:

Flash Player 10.1, AIR 2

Der auf null basierende Zeichenindexwert des ersten Zeichens in der aktuellen Auswahl.

Implementierung
public function get selectionAnchorIndex():int

verticalTextLayout

Eigenschaft

verticalTextLayout:Boolean [schreibgeschützt]

Sprachversion:

ActionScript 3.0

Laufzeitversionen:

Flash Player 10.1, AIR 2

Gibt an, ob der Text in der Komponente vertikal ist oder nicht. Diese Eigenschaft steuert die Positionierung des Kandidatenfenster (zum Beispiel neben vertikalem Text oder unter horizontalem Text).

Implementierung
public function get verticalTextLayout():Boolean

Methodendetails

confirmComposition

()

Methode

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

Sprachversion:

ActionScript 3.0

Laufzeitversionen:

Flash Player 10.1, AIR 2

Verwenden Sie diesen Rückruf, um die Inline-Bearbeitungssitzung zu beenden und den Text zu bestätigen.

Parameter

	`text:String` (default = `null`) — der endgültige Zustand des Texts in der Inline-Sitzung (der bestätigte Text).

	`preserveSelection:Boolean` (default = `false`) — bei der Einstellung „true“ sollten Sie die aktuelle Textauswahl nicht auf das Ende des bestätigten Texts zurücksetzen.

getTextBounds

()

Methode

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

Sprachversion:

ActionScript 3.0

Laufzeitversionen:

Flash Player 10.1, AIR 2

Der IME verwendet diese Methode, um den Begrenzungsrahmen des Texts, der zurzeit mit dem IME-Client bearbeitet wird, abzufragen. Verwenden Sie diese Methode, um das Kandidatenfenster zu platzieren und den Mauscursor in den IME-Client zu setzen, wenn sich die Maus über dem Textfeld oder der Komponente, die IME unterstützt, befindet.

Parameter

	`startIndex:int` — Eine Ganzzahl, die die Startposition des Textbereichs vom Begrenzungsrahmen, den Sie messen, angibt.

	`endIndex:int` — Optional, eine Ganzzahl, die die Endposition des Textbereichs vom Begrenzungsrahmen, den Sie messen, angibt.

Rückgabewerte

Rectangle — Der Begrenzungsrahmen des angegebenen Textbereichs oder null, wenn mindestens einer der Indizes ungültig ist. Diese Methode gibt denselben Wert zurück, wenn startIndex größer oder kleiner als endIndex ist. Unabhängig davon, ob startIndex größer oder kleiner als endIndex ist, sollte der gleiche Wert wiedergegeben werden.

getTextInRange

()

Methode

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

Sprachversion:

ActionScript 3.0

Laufzeitversionen:

Flash Player 10.1, AIR 2

Ruft den angegebenen Textbereich von der Komponente ab. Diese Methode wird während der IME-Neukonvertierung aufgerufen.

Parameter

	`startIndex:int` — eine Ganzzahl, die die Startposition des abzurufenden Textbereichs angibt.

	`endIndex:int` — eine Ganzzahl, die die Endposition des abzurufenden Textbereichs angibt.

Rückgabewerte

String — Der angeforderte Text oder null, wenn im angeforderten Bereich kein Text verfügbar ist, oder wenn mindestens einer der Indizes ungültig ist. Es sollte derselbe Wert zurückgegeben werden, unabhängig davon, ob startIndex größer oder kleiner als endIndex ist.

selectRange

()

Methode

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

Sprachversion:

ActionScript 3.0

Laufzeitversionen:

Flash Player 10.1, AIR 2

Legt den Bereich des ausgewählten Texts in der Komponente fest. Wenn eines der Argumente außerhalb des gültigen Bereichs liegt, sollte die Auswahl nicht geändert werden.

Parameter

	`anchorIndex:int` — Der auf null basierende Index des Zeichens beim Ankerende der Auswahl

	`activeIndex:int` — Der auf null basierende Index des Zeichens beim aktiven Ende der Auswahl.

updateComposition

()

Methode

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

Sprachversion:

ActionScript 3.0

Laufzeitversionen:

Flash Player 10.1, AIR 2

Rückruf zum Aktualisieren des Inhalts der Inline-Bearbeitungssitzung. Diese Methode wird aufgerufen, wenn der Text, der mit dem IME bearbeitet wird, geändert wurde und sein Inhalt vom Client verwendet wird, um die gesamte Inline-Bearbeitungssitzung neu zu zeichnen.

Parameter

	`text:String` — Enthält den Text der Inline-Bearbeitungssitzung vom IME.

	`attributes:Vector.<CompositionAttributeRange>` — Enthält ein Array von Satzklauseln mit Verzierungsinformationen.

	`compositionStartIndex:int` — Start der Inline-Sitzung relativ zum Start des Textobjekts.

	`compositionEndIndex:int` — Ende der Inline-Sitzung relativ zum Start des Textobjekts.

Ereignisdetails

imeStartComposition

Ereignis

Ereignisobjekttyp: flash.events.IMEEvent
Eigenschaft IMEEvent.type = flash.events.IMEEvent.IME_START_COMPOSITION

Sprachversion:

ActionScript 3.0

Laufzeitversionen:

Flash Player 10.1, AIR 2

Wird abgesetzt, wenn der Benutzer mit der Verwendung eines IME (Input Method Editor) beginnt.

Um IME-Texteingaben zu verarbeiten, muss der Empfänger das imeClient-Feld des Ereignisses auf ein Objekt einstellen, das die IIMEClient-Schnittstelle implementiert. Wenn imeClient nicht eingestellt wird, verwendet die Laufzeitumgebung stattdessen den Out-of-Line-IME-Satz und sendet den endgültigen Satz als TEXT_INPUT-Ereignis.

Dieses Ereignis verfügt über die folgenden Eigenschaften:

Eigenschaft	Wert
`bubbles`	`false`
`cancelable`	`false`. Es gibt kein Standardverhalten, das abgebrochen werden kann.
`currentTarget`	Das Objekt, welches das Ereignisobjekt aktiv mit einem Ereignis-Listener verarbeitet.
`target`	Das IME-Objekt.

textInput

Ereignis

Ereignisobjekttyp: flash.events.TextEvent
Eigenschaft TextEvent.type = flash.events.TextEvent.TEXT_INPUT

Sprachversion:

ActionScript 3.0

Laufzeitversionen:

Flash Player 10.1, AIR 2

Wird ausgelöst, wenn der Benutzer Text eingibt. Für IME-Clients (IME = Input Method Editor) sollte der Empfänger den String, der in der text-Eigenschaft des Ereignisobjekts enthalten ist, an der aktuellen Einfügemarke einfügen.

Definiert den Wert der Eigenschaft type eines textInput-Ereignisobjekts.

Hinweis: Dieses Ereignis wird für die Entf- und Rücktaste nicht ausgelöst.

Dieses Ereignis verfügt über die folgenden Eigenschaften:

Eigenschaft	Wert
`bubbles`	`true`
`cancelable`	`true`; rufen Sie die Methode `preventDefault()` auf, um das Standardverhalten abzubrechen.
`currentTarget`	Das Objekt, welches das Ereignisobjekt aktiv mit einem Ereignis-Listener verarbeitet.
`target`	Das Textfeld, in das die Zeichen eingegeben werden. Das Ziel ist nicht immer das Objekt in der Anzeigeliste, in der der Ereignis-Listener registriert wurde. Mit der Eigenschaft `currentTarget` können Sie auf das Objekt in der Anzeigeliste zugreifen, das das Ereignis derzeit verarbeitet.
`text`	Das bzw. die Zeichen wird/werden vom Benutzer eingegeben.

Rechtliche Hinweise | Onlinedatenschutzerklärung

IIMEClient - AS3

Paketex

Sprachelemente

Anhänge

Paket flash.text.ime

compositionEndIndex

compositionStartIndex

selectionActiveIndex

selectionAnchorIndex

verticalTextLayout

confirmComposition

getTextBounds

getTextInRange

selectRange

updateComposition

imeStartComposition

textInput