chrome.input.ime

Ważne: ten interfejs API działa tylko w ChromeOS.

Opis

Implementacja niestandardowego edytora IME dla ChromeOS przy użyciu interfejsu API chrome.input.ime. Dzięki temu rozszerzenie może obsługiwać naciśnięcia klawiszy, ustawiać kompozycję i zarządzać oknem propozycji.

Uprawnienia

input

Aby korzystać z interfejsu APIinput.ime, musisz zadeklarować uprawnienia „input” w pliku manifestu rozszerzenia. Przykład:

{
  "name": "My extension",
  ...
  "permissions": [
    "input"
  ],
  ...
}

Dostępność

Tylko w ChromeOS

Przykłady

Ten kod tworzy edytor IME, który konwertuje wpisane litery na wielkie litery.

var context_id = -1;

chrome.input.ime.onFocus.addListener(function(context) {
  context_id = context.contextID;
});

chrome.input.ime.onKeyEvent.addListener(
  function(engineID, keyData) {
    if (keyData.type == "keydown" && keyData.key.match(/^[a-z]$/)) {
      chrome.input.ime.commitText({"contextID": context_id,
                                    "text": keyData.key.toUpperCase()});
      return true;
    } else {
      return false;
    }
  }
);

Typy

AssistiveWindowButton

Chrome 85 lub nowszy

Identyfikator przycisków w oknie wspomagającym.

Typ wyliczeniowy

"addToDictionary"

AssistiveWindowProperties

Chrome 85 lub nowszy

Właściwości okna wspomagającego.

Właściwości

• announceString

  ciąg znaków opcjonalny

  Ciągi tekstowe, które ChromeVox ma przeczytać na głos.

• Niestandardowy typ treści

• widoczna

  boolean

  Ustawia wartość „true” (prawda), aby wyświetlić okno AssistiveWindow, lub na wartość „false”, aby ją ukryć.

AssistiveWindowType

Chrome 85 lub nowszy

Typ okna wspomagającego.

Wartość

AutoCapitalizeType

Chrome w wersji 69 lub nowszej

Typ automatycznego wstawiania wielkich liter w polu tekstowym.

Typ wyliczeniowy

"characters"

"words"

InputContext

Opisuje kontekst danych wejściowych

Właściwości

• autoCapitalize

  AutoCapitalizeType

  Chrome w wersji 69 lub nowszej

  Typ automatycznego wstawiania wielkich liter w polu tekstowym.

• autoComplete

  boolean

  Określa, czy pole tekstowe ma być uzupełnione automatycznie.

• autoCorrect

  boolean

  Określa, czy pole tekstowe ma obsługiwać autokorektę.

• contextID

  Liczba

  Służy do określania celów operacji na polach tekstowych. Ten identyfikator staje się nieprawidłowy od razu po wywołaniu funkcji onBlur.

• shouldDoLearning

  boolean

  Chrome w wersji 68 lub nowszej

  Określa, czy tekst wpisany w polu tekstowym ma być używany do poprawy podpowiedzi podczas pisania.

• spellCheck

  boolean

  Określa, czy pole tekstowe ma być sprawdzane przez sprawdzanie pisowni.

• Niestandardowy typ treści

  InputContextType

  Typ wartości edytowanej w tym polu tekstowym (tekst, liczba, adres URL itp.)

InputContextType

Chrome 44 lub nowszy

Typ wartości edytowanej w tym polu tekstowym (tekst, liczba, adres URL itp.)

Typ wyliczeniowy

"text"

"search"

"tel"

"url"

"email"

"number"

"password"

"null"

KeyboardEvent

Zobacz http://www.w3.org/TR/DOM-Level-3-Events/#events-KlawiaturaEvent

Właściwości

• altKey

  Wartość logiczna opcjonalna

  Określa, czy został naciśnięty klawisz ALT.

• altgrKey

  Wartość logiczna opcjonalna

  Chrome 79 lub nowszy

  Określa, czy został naciśnięty klawisz ALTGR.

• capsLock

  Wartość logiczna opcjonalna

  Wskazuje, czy jest włączony CAPS_LOCK.

• kod

  string,

  Wartość wciśniętego klawisza fizycznego. Bieżący układ klawiatury ani stan modyfikatora nie ma wpływu na tę wartość.

• ctrlKey

  Wartość logiczna opcjonalna

  Określa, czy został naciśnięty klawisz CTRL.

• extensionId

  ciąg znaków opcjonalny

  Identyfikator rozszerzenia nadawcy tego kluczowego zdarzenia.

• klucz

  string,

  Wartość naciśniętego klawisza

• keyCode

  liczba opcjonalnie

  Wycofany kod klucza HTML, który jest zależny od systemu i implementacji kod numeryczny określający niezmodyfikowany identyfikator powiązany z naciśniętym klawiszem.

• requestId

  ciąg znaków opcjonalny

  (Wycofano) Identyfikator żądania. Zamiast tego użyj parametru requestId ze zdarzenia onKeyEvent.

• shiftKey

  Wartość logiczna opcjonalna

  Określa, czy został naciśnięty klawisz SHIFT.

• Niestandardowy typ treści

  KeyboardEventType

  Jeden z klawiszy Keyup lub Keydown.

KeyboardEventType

Chrome 44 lub nowszy

Typ wyliczeniowy

"keyup"

"keydown"

MenuItem

Pozycja menu używana przez metodę wprowadzania tekstu do interakcji z użytkownikiem za pomocą menu języka.

Właściwości

• zaznaczono

  Wartość logiczna opcjonalna

  Wskazuje, że ten element powinien być rysowany ze znacznikiem wyboru.

• włączone

  Wartość logiczna opcjonalna

  Wskazuje, że ten element jest włączony.

• id

  string,

  Ciąg, który zostanie przekazany do wywołań zwrotnych odwołujących się do tego elementu MenuItem.

• etykieta

  ciąg znaków opcjonalny

  Tekst wyświetlany w menu tego elementu.

• styl

  Opcjonalny MenuItemStyle

  Typ elementu menu.

• widoczna

  Wartość logiczna opcjonalna

  Wskazuje, że element jest widoczny.

MenuItemStyle

Chrome 44 lub nowszy

Typ elementu menu. Przyciski opcji między separatorami są uważane za zgrupowane.

Typ wyliczeniowy

"check"

"radio"

"separator"

MenuParameters

Chrome 88 lub nowszy

Właściwości

• engineID

  string,

  Identyfikator wyszukiwarki, której chcesz użyć.

• items

  MenuItem[]

  Elementy MenuItem do dodania lub zaktualizowania. Zostaną one dodane w kolejności, w jakiej występują w tablicy.

MouseButton

Chrome 44 lub nowszy

które przyciski myszy zostały kliknięte;

Typ wyliczeniowy

"left"

"middle"

"right"

ScreenType

Chrome 44 lub nowszy

Typ ekranu, w którym edytor IME został aktywowany.

Typ wyliczeniowy

"normal"

"login"

"lock"

"secondary-login"

UnderlineStyle

Chrome 44 lub nowszy

Typ podkreślenia modyfikującego ten segment.

Typ wyliczeniowy

"underline"

"doubleUnderline"

"noUnderline"

WindowPosition

Chrome 44 lub nowszy

Gdzie wyświetlać okno z propozycjami. Jeśli ustawisz wartość „kursor”, okno będzie podążać za kursorem. Jeśli zasada jest ustawiona na „kompozycję”, okno jest zablokowane na początku kompozycji.

Typ wyliczeniowy

"composition"

Metody

clearComposition()

Obiecujemy

chrome.input.ime.clearComposition(
  parameters: object,
  callback?: function,
)

Wyczyść bieżącą kompozycję. Jeśli to rozszerzenie nie jest właścicielem aktywnego IME, zakończy się niepowodzeniem.

Parametry

• Parametry

  obiekt

  • contextID

    Liczba

    Identyfikator kontekstu, w którym kompozycja zostanie wyczyszczona

• wywołanie zwrotne

  funkcja optional

  Parametr callback wygląda tak:

  (success: boolean) => void

  • sukces

    boolean

Zwroty

• Promise<boolean>

  Chrome 111 lub nowszy

  Obietnice są obsługiwane w platformie Manifest V3 i nowszych, ale wywołania zwrotne są obsługiwane na potrzeby zgodności wstecznej. Nie można użyć obu w tym samym wywołaniu funkcji. Obietnica jest realizowana z tym samym typem, który jest przekazywany do wywołania zwrotnego.

commitText()

Obiecujemy

chrome.input.ime.commitText(
  parameters: object,
  callback?: function,
)

Zatwierdź podany tekst na bieżące dane wejściowe.

Parametry

• Parametry

  obiekt

  • contextID

    Liczba

    Identyfikator kontekstu, w którym zostanie zatwierdzony tekst

  • tekst

    string,

    Tekst do zatwierdzenia

• wywołanie zwrotne

  funkcja optional

  Parametr callback wygląda tak:

  (success: boolean) => void

  • sukces

    boolean

Zwroty

• Promise<boolean>

  Chrome 111 lub nowszy

  Obietnice są obsługiwane w platformie Manifest V3 i nowszych, ale wywołania zwrotne są obsługiwane na potrzeby zgodności wstecznej. Nie można użyć obu w tym samym wywołaniu funkcji. Obietnica jest realizowana z tym samym typem, który jest przekazywany do wywołania zwrotnego.

deleteSurroundingText()

Obiecujemy

chrome.input.ime.deleteSurroundingText(
  parameters: object,
  callback?: function,
)

Usuwa tekst wokół kursora.

Parametry

• Parametry

  obiekt

  • contextID

    Liczba

    Identyfikator kontekstu, w którym zostanie usunięty otaczający go tekst.

  • engineID

    string,

    Identyfikator wyszukiwarki, która odbiera zdarzenie.

  • length

    Liczba

    Liczba znaków do usunięcia

  • odliczyć

    Liczba

    Przesunięcie od pozycji kursora od miejsca, w którym rozpocznie się usuwanie. Ta wartość może być ujemna.

• wywołanie zwrotne

  funkcja optional

  Parametr callback wygląda tak:

  () => void

Zwroty

• Promise<void>

  Chrome 111 lub nowszy

  Obietnice są obsługiwane w platformie Manifest V3 i nowszych, ale wywołania zwrotne są obsługiwane na potrzeby zgodności wstecznej. Nie można użyć obu w tym samym wywołaniu funkcji. Obietnica jest realizowana z tym samym typem, który jest przekazywany do wywołania zwrotnego.

hideInputView()

chrome.input.ime.hideInputView()

Ukrywa okno widoku danych wejściowych, które jest automatycznie wyświetlane przez system. Jeśli okno widoku danych wejściowych jest już ukryte, ta funkcja nie będzie wykonywać żadnych działań.

keyEventHandled()

chrome.input.ime.keyEventHandled(
  requestId: string,
  response: boolean,
)

Wskazuje, że kluczowe zdarzenie odebrane przez onKeyEvent jest obsługiwane. Tę metodę należy wywoływać tylko wtedy, gdy detektor onKeyEvent jest asynchroniczny.

Parametry

• requestId

  string,

  Identyfikator żądania obsługiwanego zdarzenia. Powinien on pochodzić z klucza keyEvent.requestId

• odpowiedź

  boolean

  Prawda, jeśli po naciśnięciu klawisza zostało obsłużone, fałsz, jeśli nie

sendKeyEvents()

Obiecujemy

chrome.input.ime.sendKeyEvents(
  parameters: object,
  callback?: function,
)

Wysyła kluczowe zdarzenia. Ta funkcja powinna być używana na klawiaturach wirtualnych. Gdy użytkownik naciśnie klawisze na klawiaturze wirtualnej, ta funkcja służy do rozpowszechniania zdarzenia w systemie.

Parametry

• Parametry

  obiekt

  • contextID

    Liczba

    Identyfikator kontekstu, w którym będą wysyłane kluczowe zdarzenia, lub wartość 0 w przypadku wysyłania kluczowych zdarzeń do pola, które nie służy do wprowadzania danych.

  • keyData

    KeyboardEvent[]

    Dane o kluczowym zdarzeniu.

• wywołanie zwrotne

  funkcja optional

  Parametr callback wygląda tak:

  () => void

Zwroty

• Promise<void>

  Chrome 111 lub nowszy

  Obietnice są obsługiwane w platformie Manifest V3 i nowszych, ale wywołania zwrotne są obsługiwane na potrzeby zgodności wstecznej. Nie można użyć obu w tym samym wywołaniu funkcji. Obietnica jest realizowana z tym samym typem, który jest przekazywany do wywołania zwrotnego.

setAssistiveWindowButtonHighlighted()

Obiecujemy Chrome 86 lub nowszy

chrome.input.ime.setAssistiveWindowButtonHighlighted(
  parameters: object,
  callback?: function,
)

Podświetla lub odznacza przycisk w oknie, które pomaga.

Parametry

• Parametry

  obiekt

  • announceString

    ciąg znaków opcjonalny

    Tekst do odczytania przez czytnik ekranu.

  • buttonID

    AssistiveWindowButton

    Identyfikator przycisku.

  • contextID

    Liczba

    Identyfikator kontekstu będący właścicielem okna wspomagającego.

  • wyróżniona

    boolean

    Określa, czy przycisk ma być wyróżniony.

  • windowType

    Typ okna, do którego należy przycisk.

• wywołanie zwrotne

  funkcja optional

  Parametr callback wygląda tak:

  () => void

Zwroty

• Promise<void>

  Chrome 111 lub nowszy

  Obietnice są obsługiwane w platformie Manifest V3 i nowszych, ale wywołania zwrotne są obsługiwane na potrzeby zgodności wstecznej. Nie można użyć obu w tym samym wywołaniu funkcji. Obietnica jest realizowana z tym samym typem, który jest przekazywany do wywołania zwrotnego.

setAssistiveWindowProperties()

Obiecujemy Chrome 85 lub nowszy

chrome.input.ime.setAssistiveWindowProperties(
  parameters: object,
  callback?: function,
)

Pokazuje/ukrywa pomocne okno z podanymi właściwościami.

Parametry

• Parametry

  obiekt

  • contextID

    Liczba

    Identyfikator kontekstu będący właścicielem okna wspomagającego.

  • usługi

    AssistiveWindowProperties

    Właściwości okna wspomagającego.

• wywołanie zwrotne

  funkcja optional

  Parametr callback wygląda tak:

  (success: boolean) => void

  • sukces

    boolean

Zwroty

• Promise<boolean>

  Chrome 111 lub nowszy

  Obietnice są obsługiwane w platformie Manifest V3 i nowszych, ale wywołania zwrotne są obsługiwane na potrzeby zgodności wstecznej. Nie można użyć obu w tym samym wywołaniu funkcji. Obietnica jest realizowana z tym samym typem, który jest przekazywany do wywołania zwrotnego.

setCandidates()

Obiecujemy

chrome.input.ime.setCandidates(
  parameters: object,
  callback?: function,
)

Ustawia bieżącą listę kandydatów. Ten błąd występuje, jeśli to rozszerzenie nie jest właścicielem aktywnego edytora IME

Parametry

• Parametry

  obiekt

  • kandydaci

    obiekt[]

    Lista kandydatów do wyświetlenia w oknie z sugestiami

    • adnotacja

      ciąg znaków opcjonalny

      Dodatkowy tekst opisujący kandydata

    • kandydat

      string,

      Kandydat

    • id

      Liczba

      Identyfikator kandydata

    • etykieta

      ciąg znaków opcjonalny

      Krótki ciąg znaków wyświetlany obok kandydata, często klawisz skrótu lub indeks.

    • parentId

      liczba opcjonalnie

      Identyfikator, do którego należy dodać tych kandydatów

    • wykorzystanie

      obiekt opcjonalny

      Użycie lub szczegółowy opis słowa.

      • body

        string,

        Ciąg tekstowy opisu szczegółów.

      • title

        string,

        Tytuł i opis szczegółów.

  • contextID

    Liczba

    Identyfikator kontekstu, do którego należy okno z kandydatami.

• wywołanie zwrotne

  funkcja optional

  Parametr callback wygląda tak:

  (success: boolean) => void

  • sukces

    boolean

Zwroty

• Promise<boolean>

  Chrome 111 lub nowszy

  Obietnice są obsługiwane w platformie Manifest V3 i nowszych, ale wywołania zwrotne są obsługiwane na potrzeby zgodności wstecznej. Nie można użyć obu w tym samym wywołaniu funkcji. Obietnica jest realizowana z tym samym typem, który jest przekazywany do wywołania zwrotnego.

setCandidateWindowProperties()

Obiecujemy

chrome.input.ime.setCandidateWindowProperties(
  parameters: object,
  callback?: function,
)

Ustawia właściwości okna propozycji. Ten błąd występuje, jeśli rozszerzenie nie jest właścicielem aktywnego edytora IME

Parametry

• Parametry

  obiekt

  • engineID

    string,

    Identyfikator wyszukiwarki, w której chcesz ustawić właściwości.

  • usługi

    obiekt

    • auxiliaryText

      ciąg znaków opcjonalny

      Tekst wyświetlany na dole okna z propozycjami zmian.

    • auxiliaryTextVisible

      Wartość logiczna opcjonalna

      Ustaw wartość True, aby wyświetlić tekst pomocniczy, a false, aby go ukryć.

    • currentCandidateIndex

      liczba opcjonalnie

      Chrome 84 lub nowszy

      Indeks aktualnie wybranego kandydata w stosunku do łącznej liczby kandydatów.

    • cursorVisible

      Wartość logiczna opcjonalna

      Wartość Prawda, aby pokazywać kursor, albo fałsz, żeby go ukryć.

    • pageSize

      liczba opcjonalnie

      Liczba propozycji wyświetlanych na stronie.

    • totalCandidates

      liczba opcjonalnie

      Chrome 84 lub nowszy

      Łączna liczba kandydatów w oknie kandydatów.

    • kategoria

      Wartość logiczna opcjonalna

      Wartość „prawda”, jeśli okno kandydujące ma być renderowane w pionie, lub „fałsz”, jeśli chcesz ustawić je w poziomie.

    • widoczna

      Wartość logiczna opcjonalna

      Wartość True (prawda), by wyświetlić okno z informacjami o kandydatach, albo false, aby je ukryć.

    • windowPosition

      Opcja WindowPosition

      Gdzie wyświetlać okno z propozycjami.

• wywołanie zwrotne

  funkcja optional

  Parametr callback wygląda tak:

  (success: boolean) => void

  • sukces

    boolean

Zwroty

• Promise<boolean>

  Chrome 111 lub nowszy

  Obietnice są obsługiwane w platformie Manifest V3 i nowszych, ale wywołania zwrotne są obsługiwane na potrzeby zgodności wstecznej. Nie można użyć obu w tym samym wywołaniu funkcji. Obietnica jest realizowana z tym samym typem, który jest przekazywany do wywołania zwrotnego.

setComposition()

Obiecujemy

chrome.input.ime.setComposition(
  parameters: object,
  callback?: function,
)

Ustaw bieżącą kompozycję. Jeśli to rozszerzenie nie jest właścicielem aktywnego IME, zakończy się niepowodzeniem.

Parametry

• Parametry

  obiekt

  • contextID

    Liczba

    Identyfikator kontekstu, w którym zostanie ustawiony tekst kompozycji

  • kursor

    Liczba

    Pozycja w tekście kursora.

  • segmentów

    obiekt[] opcjonalny

    Lista segmentów i powiązanych z nimi typów.

    • end

      Liczba

      Indeks znaku, po którym ma się kończyć ten segment.

    • start

      Liczba

      Indeks znaku, od którego ma się zaczynać ten segment

    • styl

      UnderlineStyle

      Typ podkreślenia modyfikującego ten segment.

  • selectionEnd

    liczba opcjonalnie

    Pozycja w tekście, na której kończy się zaznaczenie.

  • selectionStart

    liczba opcjonalnie

    Pozycja w tekście, od której zaczyna się zaznaczenie.

  • tekst

    string,

    Tekst do ustawienia

• wywołanie zwrotne

  funkcja optional

  Parametr callback wygląda tak:

  (success: boolean) => void

  • sukces

    boolean

Zwroty

• Promise<boolean>

  Chrome 111 lub nowszy

  Obietnice są obsługiwane w platformie Manifest V3 i nowszych, ale wywołania zwrotne są obsługiwane na potrzeby zgodności wstecznej. Nie można użyć obu w tym samym wywołaniu funkcji. Obietnica jest realizowana z tym samym typem, który jest przekazywany do wywołania zwrotnego.

setCursorPosition()

Obiecujemy

chrome.input.ime.setCursorPosition(
  parameters: object,
  callback?: function,
)

Ustaw pozycję kursora w oknie propozycji. Jeśli to rozszerzenie nie jest właścicielem aktywnego edytora IME, jest to prawidłowe działanie.

Parametry

• Parametry

  obiekt

  • candidateID

    Liczba

    Identyfikator kandydata, którego chcesz użyć.

  • contextID

    Liczba

    Identyfikator kontekstu, do którego należy okno z kandydatami.

• wywołanie zwrotne

  funkcja optional

  Parametr callback wygląda tak:

  (success: boolean) => void

  • sukces

    boolean

Zwroty

• Promise<boolean>

  Chrome 111 lub nowszy

  Obietnice są obsługiwane w platformie Manifest V3 i nowszych, ale wywołania zwrotne są obsługiwane na potrzeby zgodności wstecznej. Nie można użyć obu w tym samym wywołaniu funkcji. Obietnica jest realizowana z tym samym typem, który jest przekazywany do wywołania zwrotnego.

setMenuItems()

Obiecujemy

chrome.input.ime.setMenuItems(
  parameters: MenuParameters,
  callback?: function,
)

Dodaje podane pozycje menu do menu języka, gdy ten edytor IME jest aktywny.

Parametry

• Parametry

  MenuParameters

• wywołanie zwrotne

  funkcja optional

  Parametr callback wygląda tak:

  () => void

Zwroty

• Promise<void>

  Chrome 111 lub nowszy

  Obietnice są obsługiwane w platformie Manifest V3 i nowszych, ale wywołania zwrotne są obsługiwane na potrzeby zgodności wstecznej. Nie można użyć obu w tym samym wywołaniu funkcji. Obietnica jest realizowana z tym samym typem, który jest przekazywany do wywołania zwrotnego.

updateMenuItems()

Obiecujemy

chrome.input.ime.updateMenuItems(
  parameters: MenuParameters,
  callback?: function,
)

Aktualizuje stan określonych elementów MenuItems

Parametry

• Parametry

  MenuParameters

• wywołanie zwrotne

  funkcja optional

  Parametr callback wygląda tak:

  () => void

Zwroty

• Promise<void>

  Chrome 111 lub nowszy

  Obietnice są obsługiwane w platformie Manifest V3 i nowszych, ale wywołania zwrotne są obsługiwane na potrzeby zgodności wstecznej. Nie można użyć obu w tym samym wywołaniu funkcji. Obietnica jest realizowana z tym samym typem, który jest przekazywany do wywołania zwrotnego.

Wydarzenia

onActivate

chrome.input.ime.onActivate.addListener(
  callback: function,
)

To zdarzenie jest wysyłane po aktywacji IME. Wskazuje, że edytor IME będzie otrzymywać zdarzenia onKeyPress.

Parametry

• wywołanie zwrotne

  funkcja

  Parametr callback wygląda tak:

  (engineID: string, screen: ScreenType) => void

  • engineID

    string,

  • Ekran

    ScreenType

onAssistiveWindowButtonClicked

Chrome 85 lub nowszy

chrome.input.ime.onAssistiveWindowButtonClicked.addListener(
  callback: function,
)

To zdarzenie jest wysyłane po kliknięciu przycisku w oknie pomocniczym.

Parametry

• wywołanie zwrotne

  funkcja

  Parametr callback wygląda tak:

  (details: object) => void

  • szczegóły

    obiekt

    • buttonID

      AssistiveWindowButton

      Identyfikator klikniętego przycisku.

    • windowType

      AssistiveWindowType

      Typ okna wspomagającego.

onBlur

chrome.input.ime.onBlur.addListener(
  callback: function,
)

To zdarzenie jest wysyłane, gdy zaznaczenie opuści pole tekstowe. Jest on wysyłany do wszystkich rozszerzeń, które nasłuchują tego zdarzenia, i włączony przez użytkownika.

Parametry

• wywołanie zwrotne

  funkcja

  Parametr callback wygląda tak:

  (contextID: number) => void

  • contextID

    Liczba

onCandidateClicked

chrome.input.ime.onCandidateClicked.addListener(
  callback: function,
)

To zdarzenie jest wysyłane, jeśli to rozszerzenie jest właścicielem aktywnego edytora IME.

Parametry

• wywołanie zwrotne

  funkcja

  Parametr callback wygląda tak:

  (engineID: string, candidateID: number, button: MouseButton) => void

  • engineID

    string,

  • candidateID

    Liczba

  • przycisk

    MouseButton

onDeactivated

chrome.input.ime.onDeactivated.addListener(
  callback: function,
)

To zdarzenie jest wysyłane po dezaktywacji IME. Jest to sygnał, że edytor IME nie będzie już otrzymywać zdarzeń onKeyPress.

Parametry

• wywołanie zwrotne

  funkcja

  Parametr callback wygląda tak:

  (engineID: string) => void

  • engineID

    string,

onFocus

chrome.input.ime.onFocus.addListener(
  callback: function,
)

To zdarzenie jest wysyłane, gdy zaznaczenie przechodzi do pola tekstowego. Jest on wysyłany do wszystkich rozszerzeń, które nasłuchują tego zdarzenia, i włączony przez użytkownika.

Parametry

• wywołanie zwrotne

  funkcja

  Parametr callback wygląda tak:

  (context: InputContext) => void

  • sytuacja

    InputContext

onInputContextUpdate

chrome.input.ime.onInputContextUpdate.addListener(
  callback: function,
)

To zdarzenie jest wysyłane, gdy zmienią się właściwości bieżącego kontekstu wejściowego, takie jak typ. Jest on wysyłany do wszystkich rozszerzeń, które nasłuchują tego zdarzenia, i włączony przez użytkownika.

Parametry

• wywołanie zwrotne

  funkcja

  Parametr callback wygląda tak:

  (context: InputContext) => void

  • sytuacja

    InputContext

onKeyEvent

chrome.input.ime.onKeyEvent.addListener(
  callback: function,
)

Uruchamiane, gdy z systemu operacyjnego zostanie wysłane kluczowe zdarzenie. Zdarzenie zostanie wysłane do rozszerzenia, jeśli jest ono właścicielem aktywnego edytora IME. Jeśli zdarzenie nie zostało przetworzone jako fałsz, funkcja odbiornika powinna zwracać wartość „true” (prawda). Jeśli zdarzenie będzie oceniane asynchronicznie, funkcja musi zwrócić niezdefiniowany element, a IME musi później wywołać z wynikiem funkcję keyEventHandled().

Parametry

• wywołanie zwrotne

  funkcja

  Parametr callback wygląda tak:

  (engineID: string, keyData: KeyboardEvent, requestId: string) => boolean | undefined

  • engineID

    string,

  • keyData

    KeyboardEvent

  • requestId

    string,

  • returns

    wartość logiczna | niezdefiniowana

onMenuItemActivated

chrome.input.ime.onMenuItemActivated.addListener(
  callback: function,
)

Wywoływane, gdy użytkownik wybiera pozycję w menu

Parametry

• wywołanie zwrotne

  funkcja

  Parametr callback wygląda tak:

  (engineID: string, name: string) => void

  • engineID

    string,

  • nazwa

    string,

onReset

chrome.input.ime.onReset.addListener(
  callback: function,
)

To zdarzenie jest wysyłane, gdy Chrome zakończy trwającą sesję wprowadzania tekstu.

Parametry

• wywołanie zwrotne

  funkcja

  Parametr callback wygląda tak:

  (engineID: string) => void

  • engineID

    string,

onSurroundingTextChanged

chrome.input.ime.onSurroundingTextChanged.addListener(
  callback: function,
)

Wywoływana po zmianie edytowalnego ciągu wokół kursora lub przesunięcia kursora. Długość tekstu jest ograniczona do 100 znaków dla obu kierunku.

Parametry

• wywołanie zwrotne

  funkcja

  Parametr callback wygląda tak:

  (engineID: string, surroundingInfo: object) => void

  • engineID

    string,

  • surroundingInfo

    obiekt

    • anchor

      Liczba

      Pozycja początkowa zaznaczenia. Jeśli nie można dokonać wyboru, ta wartość wskazuje pozycję kursora.

    • ostrość

      Liczba

      Pozycja końcowa zaznaczenia. Jeśli nie można dokonać wyboru, ta wartość wskazuje pozycję kursora.

    • odliczyć

      Liczba

      Chrome 46 lub nowszy

      Pozycja przesunięcia text. Ponieważ text uwzględnia tylko podzbiór tekstu wokół kursora, przesunięcie wskazuje pozycję bezwzględną pierwszego znaku text.

    • tekst

      string,

      Tekst wokół kursora. Jest to tylko podzbiór całego tekstu w polu do wprowadzania danych.