chrome.input.ime

Opis

Za pomocą interfejsu API chrome.input.ime możesz zaimplementować niestandardowy edytor IME dla systemu operacyjnego Chrome. 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 display.ime, musisz zadeklarować uprawnienie „input” w pliku manifestu rozszerzenia. Przykład:

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

Przykłady

Poniższy kod tworzy edytor IME, który konwertuje wpisane litery na wielkie.

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 i nowsze wersje

Identyfikator przycisków w oknie pomocniczym.

Enum

"addToDictionary"

AssistiveWindowProperties

Chrome 85 i nowsze wersje

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

Właściwości

  • announceString

    ciąg znaków opcjonalny

    Ciągi znaków do ogłoszenia przez ChromeVoksa.

  • typ

  • widoczna

    boolean

    Ustawia wartość „prawda”, by pokazać element AssistiveWindow, a ustawia „fałsz”, by ukryć.

AssistiveWindowType

Chrome 85 i nowsze wersje

Typ okna wspomagającego.

Wartość

AutoCapitalizeType

Chrome 69 i nowsze wersje

Typ automatycznego wstawiania wielkich liter w polu tekstowym.

Enum

"characters"

InputContext

Opisuje kontekst wejściowy

Właściwości

  • autoCapitalize

    AutoCapitalizeType

    Chrome 69 i nowsze wersje

    Typ automatycznego wstawiania wielkich liter w polu tekstowym.

  • autoComplete

    boolean

    Określa, czy pole tekstowe ma wymagać autouzupełniania.

  • autoCorrect

    boolean

    Określa, czy pole tekstowe wymaga autokorekty.

  • 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 onBlur.

  • shouldDoLearning

    boolean

    Chrome 68 i nowsze wersje

    Określa, czy tekst wpisany w polu tekstowym ma być używany do ulepszania sugestii podczas wpisywania.

  • spellCheck

    boolean

    Określa, czy w polu tekstowym ma być wymagane sprawdzanie pisowni.

  • Typ wartości edytowanej w tym polu tekstowym (Tekst, Liczba, URL itp.)

InputContextType

Chrome 44 i nowsze wersje

Typ wartości edytowanej w tym polu tekstowym (Tekst, Liczba, URL itp.)

Enum

"text"

"url"

"number"

"null"

KeyboardEvent

Więcej informacji: http://www.w3.org/TR/DOM-Level-3-Events/#events-KeyboardEvent

Właściwości

  • altKey

    wartość logiczna opcjonalna

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

  • altgrKey

    wartość logiczna opcjonalna

    Chrome 79 i nowsze

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

  • capsLock

    wartość logiczna opcjonalna

    Określa, czy funkcja CAPS_LOCK jest włączona.

  • kod

    string,

    Wartość naciśniętego klawisza fizycznego. Bieżący układ klawiatury ani modyfikator nie mają wpływu na tę wartość.

  • ctrlKey

    wartość logiczna opcjonalna

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

  • extensionId

    ciąg znaków opcjonalny

    Identyfikator rozszerzenia nadawcy tego zdarzenia kluczowego.

  • klucz

    string,

    Wartość naciskanego klawisza

  • keyCode

    Liczba opcjonalnie

    Wycofany kod HTML KeyCode, czyli zależny od systemu i implementacji kod numeryczny, który oznacza 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.

  • Jeden z klawiszy typu key-up lub keydown.

KeyboardEventType

Chrome 44 i nowsze wersje

Enum

"keyup"

"keydown"

MenuItem

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

Właściwości

  • zaznaczono

    wartość logiczna opcjonalna

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

  • włączone

    wartość logiczna opcjonalna

    Wskazuje, że element jest włączony.

  • id

    string,

    Ciąg znaków, który będzie przekazywany do wywołań zwrotnych odwołujących się do tego elementu MenuItem.

  • label

    ciąg znaków opcjonalny

    Tekst wyświetlany w menu tego elementu.

  • styl

    MenuItemStyle opcjonalnie

    Typ pozycji menu.

  • widoczna

    wartość logiczna opcjonalna

    Wskazuje, że ten element jest widoczny.

MenuItemStyle

Chrome 44 i nowsze wersje

Typ pozycji menu. Opcje między separatorami są uznawane za zgrupowane.

Enum

"check"

"radio"

"separator"

MenuParameters

Chrome 88 i nowsze wersje

Właściwości

  • engineID

    string,

    Identyfikator wyszukiwarki, która ma zostać użyta.

  • items

    MenuItem[]

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

MouseButton

Chrome 44 i nowsze wersje

które przyciski myszy.

Enum

"left"

ScreenType

Chrome 44 i nowsze wersje

Typ ekranu, na którym aktywowany jest edytor IME.

Enum

"login"

UnderlineStyle

Chrome 44 i nowsze wersje

Typ podkreślenia, którego użyto do modyfikacji tego segmentu.

Enum

WindowPosition

Chrome 44 i nowsze wersje

Gdzie wyświetlić okno kandydujące. Po ustawieniu opcji „kursor” okno podąża za kursorem. W przypadku ustawienia „Kompozycja” okno zostanie zablokowane na początku kompozycji.

Enum

Metody

clearComposition()

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

Wyczyść bieżącą kompozycję. Jeśli to rozszerzenie nie jest właścicielem aktywnego edytora IME, operacja się nie uda.

Parametry

  • Parametry

    obiekt

    • contextID

      Liczba

      Identyfikator kontekstu, w którym kompozycja zostanie wyczyszczona

  • wywołanie zwrotne

    funkcja opcjonalnie

    Parametr callback wygląda tak: 

    (success: boolean)=>void

    • sukces

      boolean

Akcje powrotne

  • Promise<boolean>

    Chrome 111 i nowsze wersje

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

commitText()

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

Stosuje podany tekst do bieżących danych wejściowych.

Parametry

  • Parametry

    obiekt

    • contextID

      Liczba

      Identyfikator kontekstu, w którym tekst zostanie zatwierdzony

    • plik tekstowy,

      string,

      Tekst do zatwierdzenia

  • wywołanie zwrotne

    funkcja opcjonalnie

    Parametr callback wygląda tak: 

    (success: boolean)=>void

    • sukces

      boolean

Akcje powrotne

  • Promise<boolean>

    Chrome 111 i nowsze wersje

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

deleteSurroundingText()

Obietnica 
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 odbierającej zdarzenie.

    • length

      Liczba

      Liczba znaków do usunięcia

    • przesunięcie

      Liczba

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

  • wywołanie zwrotne

    funkcja opcjonalnie

    Parametr callback wygląda tak: 

    ()=>void

Akcje powrotne

  • Promise<void>

    Chrome 111 i nowsze wersje

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

hideInputView()

chrome.input.ime.hideInputView()

Ukrywa okno widoku wprowadzania, które wyświetla się automatycznie przez system. Jeśli okno widoku wejściowego jest już ukryte, ta funkcja nie zadziała.

keyEventHandled()

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

Wskazuje, że kluczowe zdarzenie odebrane przez onKeyEvent jest obsługiwane. Należy to wywoływać tylko wtedy, gdy detektor onKeyEvent jest asynchroniczny.

Parametry

  • requestId

    string,

    Identyfikator żądania obsłużonego zdarzenia. Powinien pochodzić z keyEvent.requestId.

  • odpowiedź

    boolean

    Prawda, jeśli naciśnięto klawisze, lub fałsz, jeśli nie

sendKeyEvents()

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

Wysyła kluczowe zdarzenia. Ta funkcja ma być używana przez klawiatury wirtualne. Po naciśnięciu przez użytkownika klawiszy na klawiaturze wirtualnej ta funkcja służy do rozpowszechniania tego zdarzenia w systemie.

Parametry

  • Parametry

    obiekt

    • contextID

      Liczba

      Identyfikator kontekstu, w którym będą wysyłane kluczowe zdarzenia, lub zero, który powoduje wysyłanie kluczowych zdarzeń do pola innego niż dane wejściowe.

    • keyData

      KeyboardEvent[]

      Dane o kluczowym zdarzeniu.

  • wywołanie zwrotne

    funkcja opcjonalnie

    Parametr callback wygląda tak: 

    ()=>void

Akcje powrotne

  • Promise<void>

    Chrome 111 i nowsze wersje

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

setAssistiveWindowButtonHighlighted()

Obietnica Chrome w wersji 86 lub nowszej 
chrome.input.ime.setAssistiveWindowButtonHighlighted(
  parameters: object,
  callback?: function,
)

Wyróżnia lub cofa podświetlenie przycisku w oknie pomocniczym.

Parametry

  • Parametry

    obiekt

    • announceString

      ciąg znaków opcjonalny

      Tekst do ogłoszeń przez czytnik ekranu.

    • Identyfikator przycisku.

    • contextID

      Liczba

      Identyfikator kontekstu, do którego należy okno wspomagające.

    • wyróżniona

      boolean

      Określa, czy przycisk ma być podświetlony.

    • windowType

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

  • wywołanie zwrotne

    funkcja opcjonalnie

    Parametr callback wygląda tak: 

    ()=>void

Akcje powrotne

  • Promise<void>

    Chrome 111 i nowsze wersje

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

setAssistiveWindowProperties()

Obietnica Chrome w wersji 85 lub nowszej 
chrome.input.ime.setAssistiveWindowProperties(
  parameters: object,
  callback?: function,
)

Pokazuje lub ukrywa okno wspomagające z podanymi właściwościami.

Parametry

  • Parametry

    obiekt

    • contextID

      Liczba

      Identyfikator kontekstu, do którego należy okno wspomagające.

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

  • wywołanie zwrotne

    funkcja opcjonalnie

    Parametr callback wygląda tak: 

    (success: boolean)=>void

    • sukces

      boolean

Akcje powrotne

  • Promise<boolean>

    Chrome 111 i nowsze wersje

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

setCandidates()

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

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

Parametry

  • Parametry

    obiekt

    • kandydaci

      obiekt[]

      Lista kandydatów do wyświetlania w oknie propozycji

      • adnotacja

        ciąg znaków opcjonalny

        Dodatkowy tekst opisujący kandydata

      • kandydat

        string,

        Kandydat

      • id

        Liczba

        Identyfikator kandydata

      • label

        ciąg znaków opcjonalny

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

      • parentId

        Liczba opcjonalnie

        Identyfikator, pod którym należy dodać tych kandydatów

      • wykorzystanie

        obiekt opcjonalnie

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

        • body

          string,

          Ciąg tekstowy opisu szczegółowego.

        • title

          string,

          Ciąg tytułu zawierający opis szczegółów.

    • contextID

      Liczba

      Identyfikator kontekstu, do którego należy okno kandydujące.

  • wywołanie zwrotne

    funkcja opcjonalnie

    Parametr callback wygląda tak: 

    (success: boolean)=>void

    • sukces

      boolean

Akcje powrotne

  • Promise<boolean>

    Chrome 111 i nowsze wersje

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

setCandidateWindowProperties()

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

Ustawia właściwości okna z listą kandydatów. Ta czynność się nie uda, jeśli rozszerzenie nie jest właścicielem aktywnego edytora IME

Parametry

  • Parametry

    obiekt

    • engineID

      string,

      Identyfikator wyszukiwarki, dla której chcesz ustawić usługi.

    • usługi

      obiekt

      • auxiliaryText

        ciąg znaków opcjonalny

        Tekst widoczny u dołu okna propozycji.

      • auxiliaryTextVisible

        wartość logiczna opcjonalna

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

      • currentCandidateIndex

        Liczba opcjonalnie

        Chrome 84 i nowsze wersje

        Indeks obecnie wybranego kandydata wśród wszystkich kandydatów.

      • cursorVisible

        wartość logiczna opcjonalna

        Ustaw wartość True, aby wyświetlić kursor, lub false, aby go ukryć.

      • pageSize

        Liczba opcjonalnie

        Liczba propozycji wyświetlanych na stronie.

      • totalCandidates

        Liczba opcjonalnie

        Chrome 84 i nowsze wersje

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

      • kategoria

        wartość logiczna opcjonalna

        Wartość prawda, jeśli okno kandydujące powinno zostać wyświetlone w pionie, a fałsz – jeśli ma być poziome.

      • widoczna

        wartość logiczna opcjonalna

        Ustaw True, by pokazać okno Kandydat, lub false, by je ukryć.

      • windowPosition

        WindowPosition opcjonalnie

        Gdzie wyświetlić okno kandydujące.

  • wywołanie zwrotne

    funkcja opcjonalnie

    Parametr callback wygląda tak: 

    (success: boolean)=>void

    • sukces

      boolean

Akcje powrotne

  • Promise<boolean>

    Chrome 111 i nowsze wersje

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

setComposition()

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

Ustaw bieżącą kompozycję. Jeśli to rozszerzenie nie jest właścicielem aktywnego edytora IME, operacja się nie uda.

Parametry

  • Parametry

    obiekt

    • contextID

      Liczba

      Identyfikator kontekstu, w którym zostanie ustawiony tekst kompozycji

    • kursor

      Liczba

      Pozycja kursora w tekście.

    • segmentów

      obiekt[] opcjonalny

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

      • end

        Liczba

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

      • start

        Liczba

        Indeks znaku, od którego rozpoczyna się ten segment

      • Typ podkreślenia, którego użyto do modyfikacji tego segmentu.

    • selectionEnd

      Liczba opcjonalnie

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

    • selectionStart

      Liczba opcjonalnie

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

    • plik tekstowy,

      string,

      Tekst do ustawienia

  • wywołanie zwrotne

    funkcja opcjonalnie

    Parametr callback wygląda tak: 

    (success: boolean)=>void

    • sukces

      boolean

Akcje powrotne

  • Promise<boolean>

    Chrome 111 i nowsze wersje

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

setCursorPosition()

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

Ustaw pozycję kursora w oknie propozycji. Działanie jest niedostępne, jeśli to rozszerzenie nie jest właścicielem aktywnego edytora IME.

Parametry

  • Parametry

    obiekt

    • candidateID

      Liczba

      Identyfikator kandydata do wyboru.

    • contextID

      Liczba

      Identyfikator kontekstu, do którego należy okno kandydujące.

  • wywołanie zwrotne

    funkcja opcjonalnie

    Parametr callback wygląda tak: 

    (success: boolean)=>void

    • sukces

      boolean

Akcje powrotne

  • Promise<boolean>

    Chrome 111 i nowsze wersje

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

setMenuItems()

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

Gdy ten edytor IME jest aktywny, dodaje podane pozycje menu do menu języka.

Parametry

  • Parametry

    MenuParameters

  • wywołanie zwrotne

    funkcja opcjonalnie

    Parametr callback wygląda tak: 

    ()=>void

Akcje powrotne

  • Promise<void>

    Chrome 111 i nowsze wersje

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

updateMenuItems()

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

Aktualizuje stan określonych elementów MenuItems

Parametry

  • Parametry

    MenuParameters

  • wywołanie zwrotne

    funkcja opcjonalnie

    Parametr callback wygląda tak: 

    ()=>void

Akcje powrotne

  • Promise<void>

    Chrome 111 i nowsze wersje

    Obietnice są obsługiwane w platformie Manifest V3 i nowszych, ale wywołania zwrotne są dostępne na potrzeby zgodności wstecznej. Nie można użyć obu w tym samym wywołaniu funkcji. Obietnica znika 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 edytora IME. Wskazuje, że edytor IME będzie odbierać zdarzenia onKeyPress.

Parametry

  • wywołanie zwrotne

    funkcja

    Parametr callback wygląda tak: 

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

onAssistiveWindowButtonClicked

Chrome 85 i nowsze wersje 
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

onBlur

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

To wydarzenie jest wysyłane, gdy zaznaczenie opuści pole tekstowe. Jest ono wysyłane do wszystkich rozszerzeń, które nasłuchują tego zdarzenia, i włączone 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 wyłączeniu edytora IME. Wskazuje to, ż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 wydarzenie jest wysyłane, gdy zaznaczenie znajdzie się w polu tekstowym. Jest ono wysyłane do wszystkich rozszerzeń, które nasłuchują tego zdarzenia, i włączone przez użytkownika.

Parametry

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, np. typ. Jest ono wysyłane do wszystkich rozszerzeń, które nasłuchują tego zdarzenia, i włączone przez użytkownika.

Parametry

onKeyEvent

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

Uruchamiane, gdy z systemu operacyjnego wysyłane jest kluczowe zdarzenie. Zdarzenie będzie wysyłane do rozszerzenia, jeśli jest ono właścicielem aktywnego edytora IME. Funkcja detektora powinna zwracać wartość „prawda”, jeśli zdarzenie nie było obsługiwane (fałsz). Jeśli zdarzenie będzie oceniane asynchronicznie, funkcja ta musi zwrócić niezdefiniowane, a edytor IME musi później wywołać metodę keyEventHandled() z wynikiem.

Parametry

  • wywołanie zwrotne

    funkcja

    Parametr callback wygląda tak: 

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

    • returns

      boolean|undefined

onMenuItemActivated

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

Wywoływane, gdy użytkownik wybierze pozycję 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ływane, gdy edytowalny ciąg wokół kursora ulegnie zmianie lub gdy zostanie przesunięta pozycja kursora. Długość tekstu nie może przekraczać 100 znaków w każdym 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. Ta wartość wskazuje pozycję kursora, jeśli nie ma żadnego wyboru.

      • ostrość

        Liczba

        Pozycja końcowa zaznaczenia. Ta wartość wskazuje pozycję kursora, jeśli nie ma żadnego wyboru.

      • przesunięcie

        Liczba

        Chrome 46 i nowsze wersje

        Pozycja przesunięcia: text. Funkcja text zawiera tylko podzbiór tekstu wokół kursora, dlatego przesunięcie wskazuje bezwzględną pozycję pierwszego znaku w polu text.

      • plik tekstowy,

        string,

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