IIMEClient - Adobe ActionScript® 3 (AS3 ) — dokumentacja interfejsu API

Pakiet	flash.text.ime
Interfejs	public interface IIMEClient

Wersja języka:

ActionScript 3.0

Wersje środowiska wykonawczego:

Flash Player 10.1, AIR 2

Interfejs dla klientów edytora IME (Input Method Editor). Składniki realizowane w oparciu o pakiet flash.text.engine muszą implementować ten interfejs, aby obsługiwana była lokalna edycja tekstu za pomocą edytora IME. Ten interfejs nie jest używany z obiektami TextField. W architekturze TextLayoutFramework (TLF) interfejs ten jest wykorzystywany do obsługi edytora IME, a zatem w klientach korzystających z architektury TLF nie trzeba go implementować.

Aby umożliwić korzystanie z lokalnego edytora IME, należy przypisać właściwości imeClient zdarzenia ImeEvent.IME_START_COMPOSITION obiekt implementujący ten interfejs.

W opisach elementów interfejsu API związanych z edytorem IME używane są często następujące terminy:

Konwersacja jest to wymiana informacji między edytorem IME a aplikacją. W trakcie konwersacji następuje jedna lub wiele aktualizacji kompozycji, a następnie użytkownik potwierdza kompozycję.
Kompozycja jest to tekst wprowadzony przez użytkownika za pośrednictwem edytora IME; elementami kompozycji są także związane z tekstem informacje o stanie wprowadzania, takie jak zaznaczony zakres i granice klauzul.
Klauzula jest to zakres kompozycji, zwykle o wspólnych informacjach semantycznych, np. informacji o tym, czy dany zakres jest w stanie zaznaczonym lub przekonwertowanym. Kompozycja zawiera zero lub więcej klauzul.

Powiązane elementy interfejsu API

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

Właściwości publiczne

	Właściwość		Zdefiniowane przez
		compositionEndIndex : int [tylko do odczytu] Liczony od zera indeks znaku końca bieżącej sesji edycji lokalnej (np. całego tekstu w sesji edycji lokalnej, który nie został potwierdzony w dokumencie).	IIMEClient
		compositionStartIndex : int [tylko do odczytu] Liczony od zera indeks znaku początku bieżącej sesji edycji lokalnej (np. całego tekstu w sesji edycji lokalnej, który nie został potwierdzony w dokumencie).	IIMEClient
		selectionActiveIndex : int [tylko do odczytu] Indeks ostatniego znaku w bieżącym zaznaczeniu, liczony od 0.	IIMEClient
		selectionAnchorIndex : int [tylko do odczytu] Indeks pierwszego znaku w bieżącym zaznaczeniu, liczony od 0.	IIMEClient
		verticalTextLayout : Boolean [tylko do odczytu] Wskazuje, czy tekst w składniku jest pionowy, czy nie.	IIMEClient

Metody publiczne

	Metoda		Zdefiniowane przez
		confirmComposition(text:String = null, preserveSelection:Boolean = false):void Ta funkcja wywołania zwrotnego służy do zakończenia sesji edycji lokalnej i potwierdzenia tekstu.	IIMEClient
		getTextBounds(startIndex:int, endIndex:int):Rectangle Edytor IME używa tej metody do odczytywania wymiarów prostokąta ograniczającego tekst edytowany obecnie w kliencie edytora IME.	IIMEClient
		getTextInRange(startIndex:int, endIndex:int):String Pobiera określony zakres tekstu ze składnika.	IIMEClient
		selectRange(anchorIndex:int, activeIndex:int):void Ustawia zakres zaznaczonego tekstu w komponencie.	IIMEClient
		updateComposition(text:String, attributes:Vector.<CompositionAttributeRange>, compositionStartIndex:int, compositionEndIndex:int):void Funkcja wywołania zwrotnego służąca do aktualizacji zawartości sesji edycji lokalnej.	IIMEClient

Zdarzenia

Kliknij, aby uzyskać więcej informacji o zdarzeniach

	Zdarzenie		Podsumowanie	Zdefiniowane przez
		imeStartComposition	Wywoływane, gdy użytkownik zacznie używać edytora IME (Input Method Editor).	IIMEClient
		textInput	Wywoływane, gdy użytkownik wprowadzi tekst.	IIMEClient

Szczegół właściwości

compositionEndIndex

właściwość

compositionEndIndex:int [tylko do odczytu]

Wersja języka:

ActionScript 3.0

Wersje środowiska wykonawczego:

Flash Player 10.1, AIR 2

Liczony od zera indeks znaku końca bieżącej sesji edycji lokalnej (np. całego tekstu w sesji edycji lokalnej, który nie został potwierdzony w dokumencie).

Implementacja
public function get compositionEndIndex():int

compositionStartIndex

właściwość

compositionStartIndex:int [tylko do odczytu]

Wersja języka:

ActionScript 3.0

Wersje środowiska wykonawczego:

Flash Player 10.1, AIR 2

Liczony od zera indeks znaku początku bieżącej sesji edycji lokalnej (np. całego tekstu w sesji edycji lokalnej, który nie został potwierdzony w dokumencie).

Implementacja
public function get compositionStartIndex():int

selectionActiveIndex

właściwość

selectionActiveIndex:int [tylko do odczytu]

Wersja języka:

ActionScript 3.0

Wersje środowiska wykonawczego:

Flash Player 10.1, AIR 2

Indeks ostatniego znaku w bieżącym zaznaczeniu, liczony od 0.

Implementacja
public function get selectionActiveIndex():int

selectionAnchorIndex

właściwość

selectionAnchorIndex:int [tylko do odczytu]

Wersja języka:

ActionScript 3.0

Wersje środowiska wykonawczego:

Flash Player 10.1, AIR 2

Indeks pierwszego znaku w bieżącym zaznaczeniu, liczony od 0.

Implementacja
public function get selectionAnchorIndex():int

verticalTextLayout

właściwość

verticalTextLayout:Boolean [tylko do odczytu]

Wersja języka:

ActionScript 3.0

Wersje środowiska wykonawczego:

Flash Player 10.1, AIR 2

Wskazuje, czy tekst w składniku jest pionowy, czy nie. Ta właściwość steruje położeniem okna kandydatów (np. obok tekstu pionowego lub pod tekstem poziomym).

Implementacja
public function get verticalTextLayout():Boolean

Szczegół metody

confirmComposition

()

metoda

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

Wersja języka:

ActionScript 3.0

Wersje środowiska wykonawczego:

Flash Player 10.1, AIR 2

Ta funkcja wywołania zwrotnego służy do zakończenia sesji edycji lokalnej i potwierdzenia tekstu.

Parametry

	`text:String` (default = `null`) — Ostateczny stan tekstu w sesji edycji lokalnej (tekst potwierdzony).

	`preserveSelection:Boolean` (default = `false`) — gdy ma wartość true, nie należy ustawiać bieżącego zaznaczenia na koniec potwierdzonego tekstu.

getTextBounds

()

metoda

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

Wersja języka:

ActionScript 3.0

Wersje środowiska wykonawczego:

Flash Player 10.1, AIR 2

Edytor IME używa tej metody do odczytywania wymiarów prostokąta ograniczającego tekst edytowany obecnie w kliencie edytora IME. Ta metoda służy do umieszczania okna kandydatów i ustawiania kursora myszy w kliencie IME, gdy wskaźnik znajduje się nad polem tekstowym lub innym składnikiem obsługującym edytor IME.

Parametry

	`startIndex:int` — Liczba całkowita określająca położenie początkowe zakresu tekstu względem mierzonego prostokąta ograniczającego.

	`endIndex:int` — Opcjonalnie; liczba całkowita określająca położenie początkowe zakresu tekstu względem mierzonego prostokąta ograniczającego.

Zwraca

Rectangle — Prostokąt ograniczający określony zakres tekstu lub null, jeśli jeden lub oba indeksy są niepoprawne. Ta metoda zwraca tę samą wartość, niezależnie od tego, czy startIndex jest większy, czy mniejszy niż endIndex. Niezależnie od tego, czy startIndex jest większy, czy mniejszy niż endIndex, powinna być zwracana ta sama wartość.

getTextInRange

()

metoda

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

Wersja języka:

ActionScript 3.0

Wersje środowiska wykonawczego:

Flash Player 10.1, AIR 2

Pobiera określony zakres tekstu ze składnika. Ta metoda jest wywoływana podczas ponownej konwersji w edytorze IME.

Parametry

	`startIndex:int` — Liczba całkowita określająca początek zakresu tekstu do pobrania.

	`endIndex:int` — Liczba całkowita określająca koniec zakresu tekstu do pobrania.

Zwraca

String — Żądany tekst lub null, jeśli w żądanym zakresie nie jest dostępny żaden tekst lub jeśli jeden lub oba indeksy nie są poprawne. Niezależnie od tego, czy startIndex jest większy, czy mniejszy niż endIndex, powinna być zwracana ta sama wartość.

selectRange

()

metoda

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

Wersja języka:

ActionScript 3.0

Wersje środowiska wykonawczego:

Flash Player 10.1, AIR 2

Ustawia zakres zaznaczonego tekstu w komponencie. Jeśli którykolwiek z argumentów wykracza poza zaznaczenie, zaznaczenie nie powinno ulec zmianie.

Parametry

	`anchorIndex:int` — Liczony od zera indeks znaku na końcu zaznaczenia będącym jego zakotwiczeniem.

	`activeIndex:int` — Liczony od zera indeks znaku na końcu aktywnym zaznaczenia.

updateComposition

()

metoda

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

Wersja języka:

ActionScript 3.0

Wersje środowiska wykonawczego:

Flash Player 10.1, AIR 2

Funkcja wywołania zwrotnego służąca do aktualizacji zawartości sesji edycji lokalnej. Ta metoda jest wywoływana za każdym razem, gdy tekst edytowany za pomocą edytora IME uległ zmianie, a jego zawartość jest używana przez klienta do ponownego narysowania całej sesji edycji lokalnej.

Parametry

	`text:String` — Zawiera tekst sesji edycji lokalnej z edytora IME.

	`attributes:Vector.<CompositionAttributeRange>` — Zawiera tablicę klauzul kompozycji z informacjami o upiększeniach.

	`compositionStartIndex:int` — Początek sesji edycji lokalnej względem początku obiektu tekstu.

	`compositionEndIndex:int` — Koniec sesji edycji lokalnej względem początku obiektu tekstu.

Szczegół zdarzenia

imeStartComposition

Zdarzenie

Typ obiektu zdarzenia: flash.events.IMEEvent
właściwość IMEEvent.type = flash.events.IMEEvent.IME_START_COMPOSITION

Wersja języka:

ActionScript 3.0

Wersje środowiska wykonawczego:

Flash Player 10.1, AIR 2

Wywoływane, gdy użytkownik zacznie używać edytora IME (Input Method Editor).

Aby obsługiwane było wprowadzanie tekstu za pomocą edytora IME, obiekt odbierający musi w polu imeClient zdarzenia określić obiekt implementujący interfejs IIMEClient. Jeśli wartość pola imeClient nie będzie ustawiona, środowisko wykonawcze będzie stosować kompozycję w edytorze IME poza wierszem (nielokalną) i wysyłać wyniki kompozycji jako zdarzenia TEXT_INPUT.

To zdarzenie ma następujące właściwości:

Właściwość	Wartość
`bubbles`	`false`
`cancelable`	`false`; nie ma domyślnego zachowania, które można byłoby anulować.
`currentTarget`	Obiekt przetwarzający aktywnie obiekt Event za pomocą detektora zdarzeń.
`target`	Obiekt IME.

textInput

Zdarzenie

Typ obiektu zdarzenia: flash.events.TextEvent
właściwość TextEvent.type = flash.events.TextEvent.TEXT_INPUT

Wersja języka:

ActionScript 3.0

Wersje środowiska wykonawczego:

Flash Player 10.1, AIR 2

Wywoływane, gdy użytkownik wprowadzi tekst. W przypadku klientów edytora IME (Input Method Editor) obiekt odbierający powinien wstawić w aktualnym punkcie wstawiania ciąg znaków zawarty we właściwości text obiektu zdarzenia.

Definiuje wartość właściwości type obiektu zdarzenia textInput.

Uwaga: To zdarzenie nie jest wywoływane dla klawiszy Delete ani Backspace.

To zdarzenie ma następujące właściwości:

Właściwość	Wartość
`bubbles`	`true`
`cancelable`	`true`; w celu anulowania zachowania domyślnego należy wywołać metodę `preventDefault()`.
`currentTarget`	Obiekt przetwarzający aktywnie obiekt Event za pomocą detektora zdarzeń.
`target`	Pole tekstowe, do którego wprowadzane są znaki. Obiekt target nie zawsze jest obiektem na liście wyświetlania, która zarejestrowała detektor zdarzeń. Właściwość `currentTarget` umożliwia uzyskanie dostępu do obiektu na liście wyświetlania, który obecnie przetwarza zdarzenie.
`text`	Znak lub sekwencja znaków wprowadzonych przez użytkownika.

Informacje prawne | Zasady prywatności online

IIMEClient - AS3

Pakietyx

Elementy językowe

Dodatki

Pakiet flash.text.ime

compositionEndIndex

compositionStartIndex

selectionActiveIndex

selectionAnchorIndex

verticalTextLayout

confirmComposition

getTextBounds

getTextInRange

selectRange

updateComposition

imeStartComposition

textInput