chrome.input.ime

Wichtig: Diese API funktioniert nur unter ChromeOS.

Beschreibung

Mit der chrome.input.ime API kannst du einen benutzerdefinierten IME für Chrome OS implementieren. Dadurch kann Ihre Erweiterung Tastenanschläge verarbeiten, die Anordnung festlegen und das Kandidatenfenster verwalten.

Berechtigungen

input

Sie müssen „input“ deklarieren im Erweiterungsmanifest, um die input.ime API zu verwenden. Beispiel:

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

Verfügbarkeit

<ph type="x-smartling-placeholder"></ph> Nur ChromeOS

Beispiele

Mit dem folgenden Code wird ein IME erstellt, der eingegebene Buchstaben in Großbuchstaben umwandelt.

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;
    }
  }
);

Typen

AssistiveWindowButton

Chrome (ab Version 85)

ID von Schaltflächen im Hilfsfenster.

Enum

"Rückgängig machen"

"addToDictionary"

AssistiveWindowProperties

Chrome (ab Version 85)

Eigenschaften des unterstützenden Fensters

Attribute

• announceString

  String optional

  Zeichenfolgen für die Ansage von ChromeVox.

• Typ

  "Rückgängig machen"
  

• sichtbar

  boolean

  Legt fest, dass AssistiveWindow angezeigt wird, und "false", um ausgeblendet zu werden.

AssistiveWindowType

Chrome (ab Version 85)

Art des Hilfsfensters.

Wert

"Rückgängig machen"

AutoCapitalizeType

Chrome 69 und höher

Der Typ des Textfelds mit automatischer Groß-/Kleinschreibung.

Enum

"characters"

"Wörter"

"Sätze"

InputContext

Beschreibt einen Eingabekontext

Attribute

• autoCapitalize

  AutoCapitalizeType

  Chrome 69 und höher

  Der Typ des Textfelds mit automatischer Groß-/Kleinschreibung.

• autoComplete

  boolean

  Gibt an, ob das Textfeld automatisch vervollständigt werden soll.

• autoCorrect

  boolean

  Gibt an, ob für das Textfeld eine Autokorrektur erfolgen soll.

• contextID

  Zahl

  Wird verwendet, um Ziele von Textfeldvorgängen anzugeben. Diese ID wird ungültig, sobald onBlur aufgerufen wird.

• shouldDoLearning

  boolean

  Chrome (ab Version 68)

  Gibt an, ob in das Textfeld eingegebener Text zur Verbesserung der Eingabevorschläge für den Nutzer verwendet werden soll.

• spellCheck

  boolean

  Gibt an, ob im Textfeld eine Rechtschreibprüfung erfolgen soll.

• Typ

  InputContextType

  Typ des Werts, den das Textfeld bearbeitet (Text, Zahl, URL usw.)

InputContextType

Chrome (ab Version 44)

Typ des Werts, den das Textfeld bearbeitet (Text, Zahl, URL usw.)

Enum

"Text"

"Suche"

"tel"

"url"

"E-Mail"

"Zahl"

„Passwort“

"null"

KeyboardEvent

Siehe http://www.w3.org/TR/DOM-Level-3-Events/#events-KeyboardEvent

Attribute

• altKey

  Boolescher Wert optional

  Gibt an, ob die ALT-Taste gedrückt wird.

• altgrKey

  Boolescher Wert optional

  Chrome 79 oder höher

  Gibt an, ob die ALTGR-Taste gedrückt wird.

• capsLock

  Boolescher Wert optional

  Gibt an, ob die Funktion CAPS_LOCK aktiviert ist.

• Code

  String

  Wert der gedrückten physischen Taste. Der Wert wird nicht vom aktuellen Tastaturlayout oder Modifikatorstatus beeinflusst.

• ctrlKey

  Boolescher Wert optional

  Gibt an, ob die Strg-Taste gedrückt wird.

• extensionId

  String optional

  Die Erweiterungs-ID des Absenders dieses Schlüsselereignisses.

• Schlüssel

  String

  Wert der gedrückten Taste

• keyCode

  Zahl optional

  Der veraltete HTML-KeyCode, bei dem es sich um einen system- und implementierungsabhängigen numerischen Code handelt, der die unveränderte Kennung angibt, die der gedrückten Taste zugeordnet ist.

• requestId

  String optional

  (Eingestellt) Die ID der Anfrage. Verwenden Sie stattdessen den Parameter requestId aus dem Ereignis onKeyEvent.

• shiftKey

  Boolescher Wert optional

  Gibt an, ob die Umschalttaste gedrückt wird.

• Typ

  KeyboardEventType

  Entweder Keyup oder Keydown.

KeyboardEventType

Chrome (ab Version 44)

Enum

"keyup"

"keydown"

MenuItem

Menüpunkt, der von einer Eingabemethode für die Interaktion mit dem Nutzer über das Sprachmenü verwendet wird.

Attribute

• ausgewählt

  Boolescher Wert optional

  Gibt an, dass dieses Element mit einem Häkchen gezeichnet werden soll.

• aktiviert

  Boolescher Wert optional

  Gibt an, dass dieses Element aktiviert ist.

• id

  String

  String, der an Callbacks übergeben wird, die auf dieses MenuItem verweisen.

• Label

  String optional

  Der im Menü für diesen Artikel angezeigte Text.

• Stil

  MenuItemStyle optional

  Die Art des Menüelements.

• sichtbar

  Boolescher Wert optional

  Gibt an, dass dieses Element sichtbar ist.

MenuItemStyle

Chrome (ab Version 44)

Die Art des Menüelements. Optionsfelder zwischen Trennzeichen werden als gruppiert betrachtet.

Enum

"check"

"Radio"

"Trennzeichen"

MenuParameters

Chrome (ab Version 88)

Attribute

• engineID

  String

  ID der zu verwendenden Suchmaschine.

• Elemente

  MenuItem[]

  MenuItems, die hinzugefügt oder aktualisiert werden sollen. Sie werden in der Reihenfolge hinzugefügt, in der sie im Array vorhanden sind.

MouseButton

Chrome (ab Version 44)

Auf welche Maustasten geklickt wurde.

Enum

"links"

"Mitte"

"rechts"

ScreenType

Chrome (ab Version 44)

Der Bildschirmtyp, unter dem der IME aktiviert ist.

Enum

"normal"

"login"

"lock"

"secondary-login"

UnderlineStyle

Chrome (ab Version 44)

Der Typ der Unterstreichung, mit der dieses Segment geändert werden soll.

Enum

"Unterstrich"

"doubleUnderline"

"noUnderline"

WindowPosition

Chrome (ab Version 44)

Hier wird das Kandidatenfenster angezeigt. Bei Einstellung auf 'Cursor' folgt das Fenster dem Cursor. Bei Einstellung auf "Zusammensetzung" wird das Fenster auf den Anfang der Komposition fixiert.

Enum

"cursor"

"Zusammensetzung"

Methoden

clearComposition()

<ph type="x-smartling-placeholder"></ph> Versprechen

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

Aktuelle Komposition löschen. Wenn dieser Erweiterung nicht der aktive IME gehört, schlägt der Vorgang fehl.

Parameter

• Parameter

  Objekt

  • contextID

    Zahl

    ID des Kontexts, in dem die Komposition gelöscht wird

• callback

  Funktion optional

  Der Parameter callback sieht so aus:

  (success: boolean) => void

  • Erfolg

    boolean

Returns

• Promise&lt;boolean&gt;

  Chrome 111 oder höher

  Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks sind jedoch für Abwärtskompatibilität. Sie können nicht beide in demselben Funktionsaufruf verwenden. Die Promise wird mit demselben Typ aufgelöst, der an das Callback übergeben wird.

commitText()

<ph type="x-smartling-placeholder"></ph> Versprechen

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

Überschreibt den bereitgestellten Text an die aktuelle Eingabe.

Parameter

• Parameter

  Objekt

  • contextID

    Zahl

    ID des Kontexts, in dem ein Commit für den Text durchgeführt wird

  • Text

    String

    Der zu übergebende Text

• callback

  Funktion optional

  Der Parameter callback sieht so aus:

  (success: boolean) => void

  • Erfolg

    boolean

Returns

• Promise&lt;boolean&gt;

  Chrome 111 oder höher

  Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks sind jedoch für Abwärtskompatibilität. Sie können nicht beide in demselben Funktionsaufruf verwenden. Die Promise wird mit demselben Typ aufgelöst, der an das Callback übergeben wird.

deleteSurroundingText()

<ph type="x-smartling-placeholder"></ph> Versprechen

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

Löscht den Text um das Caret-Zeichen.

Parameter

• Parameter

  Objekt

  • contextID

    Zahl

    ID des Kontexts, in dem der umgebende Text gelöscht wird.

  • engineID

    String

    ID der Suchmaschine, die das Ereignis empfängt.

  • Länge

    Zahl

    Die Anzahl der zu löschenden Zeichen

  • kompensiert

    Zahl

    Der Versatz von der Caret-Position, an der das Löschen beginnt. Dieser Wert kann negativ sein.

• callback

  Funktion optional

  Der Parameter callback sieht so aus:

  () => void

Returns

• Versprechen<void>

  Chrome 111 oder höher

  Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks sind jedoch für Abwärtskompatibilität. Sie können nicht beide in demselben Funktionsaufruf verwenden. Die Promise wird mit demselben Typ aufgelöst, der an das Callback übergeben wird.

hideInputView()

chrome.input.ime.hideInputView()

Blendet das Eingabeansichtsfenster aus, das vom System automatisch geöffnet wird. Wenn das Eingabeansichtsfenster bereits ausgeblendet ist, wird diese Funktion nichts tun.

keyEventHandled()

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

Gibt an, dass das von onKeyEvent empfangene Schlüsselereignis verarbeitet wird. Dies sollte nur aufgerufen werden, wenn der onKeyEvent-Listener asynchron ist.

Parameter

• requestId

  String

  Anfrage-ID des verarbeiteten Ereignisses Diese sollte aus „keyEvent.requestId“ stammen.

• Antwort

  boolean

  „True“, wenn der Tastenanschlag ausgeführt wurde, „False“, wenn nicht

sendKeyEvents()

<ph type="x-smartling-placeholder"></ph> Versprechen

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

Sendet die Schlüsselereignisse. Diese Funktion wird für Bildschirmtastaturen erwartet. Wenn Tasten auf einer Bildschirmtastatur von einem Nutzer gedrückt werden, wird dieses Ereignis mit dieser Funktion an das System weitergeleitet.

Parameter

• Parameter

  Objekt

  • contextID

    Zahl

    ID des Kontexts, an den die Schlüsselereignisse gesendet werden, oder null, um Schlüsselereignisse an ein Nicht-Eingabefeld zu senden.

  • keyData

    KeyboardEvent[]

    Daten zum Schlüsselereignis.

• callback

  Funktion optional

  Der Parameter callback sieht so aus:

  () => void

Returns

• Versprechen<void>

  Chrome 111 oder höher

  Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks sind jedoch für Abwärtskompatibilität. Sie können nicht beide in demselben Funktionsaufruf verwenden. Die Promise wird mit demselben Typ aufgelöst, der an das Callback übergeben wird.

setAssistiveWindowButtonHighlighted()

<ph type="x-smartling-placeholder"></ph> Versprechen Chrome 86 und höher

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

Hebt die Hervorhebung einer Schaltfläche in einem Hilfsfenster hervor bzw. hebt die Hervorhebung auf.

Parameter

• Parameter

  Objekt

  • announceString

    String optional

    Der Text, der vom Screenreader angesagt werden soll.

  • buttonID

    AssistiveWindowButton

    ID der Schaltfläche

  • contextID

    Zahl

    ID des Kontexts, zu dem das unterstützende Fenster gehört.

  • hervorgehoben

    boolean

    Legt fest, ob die Schaltfläche hervorgehoben werden soll.

  • windowType

    "Rückgängig machen"
    

    Der Fenstertyp, zu dem die Schaltfläche gehört.

• callback

  Funktion optional

  Der Parameter callback sieht so aus:

  () => void

Returns

• Versprechen<void>

  Chrome 111 oder höher

  Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks sind jedoch für Abwärtskompatibilität. Sie können nicht beide in demselben Funktionsaufruf verwenden. Die Promise wird mit demselben Typ aufgelöst, der an das Callback übergeben wird.

setAssistiveWindowProperties()

<ph type="x-smartling-placeholder"></ph> Versprechen Chrome (ab Version 85)

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

Blendet ein unterstützendes Fenster mit den angegebenen Eigenschaften ein bzw. aus.

Parameter

• Parameter

  Objekt

  • contextID

    Zahl

    ID des Kontexts, zu dem das unterstützende Fenster gehört.

  • Properties

    AssistiveWindowProperties

    Eigenschaften des unterstützenden Fensters

• callback

  Funktion optional

  Der Parameter callback sieht so aus:

  (success: boolean) => void

  • Erfolg

    boolean

Returns

• Promise&lt;boolean&gt;

  Chrome 111 oder höher

  Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks sind jedoch für Abwärtskompatibilität. Sie können nicht beide in demselben Funktionsaufruf verwenden. Die Promise wird mit demselben Typ aufgelöst, der an das Callback übergeben wird.

setCandidates()

<ph type="x-smartling-placeholder"></ph> Versprechen

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

Legt die aktuelle Kandidatenliste fest. Dieser Vorgang schlägt fehl, wenn dieser Erweiterung nicht der aktive IME gehört

Parameter

• Parameter

  Objekt

  • Kandidaten

    object[]

    Liste der Kandidaten, die im Kandidatenfenster angezeigt werden sollen

    • Annotation

      String optional

      Zusätzliche Beschreibung des Kandidaten

    • Variante

      String

      Der Kandidat

    • id

      Zahl

      Die ID des Kandidaten

    • Label

      String optional

      Kurzer String, der neben dem Vorschlag angezeigt wird, oft die Tastenkombination oder den Index

    • parentId

      Zahl optional

      Die ID, unter der diese Kandidaten hinzugefügt werden sollen

    • Nutzung

      Objekt (optional)

      Die Verwendung oder detaillierte Beschreibung des Wortes.

      • body

        String

        Der Textstring der Detailbeschreibung.

      • Titel

        String

        Der Titelstring der Detailbeschreibung.

  • contextID

    Zahl

    ID des Kontexts, zu dem das Kandidatenfenster gehört.

• callback

  Funktion optional

  Der Parameter callback sieht so aus:

  (success: boolean) => void

  • Erfolg

    boolean

Returns

• Promise&lt;boolean&gt;

  Chrome 111 oder höher

  Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks sind jedoch für Abwärtskompatibilität. Sie können nicht beide in demselben Funktionsaufruf verwenden. Die Promise wird mit demselben Typ aufgelöst, der an das Callback übergeben wird.

setCandidateWindowProperties()

<ph type="x-smartling-placeholder"></ph> Versprechen

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

Legt die Eigenschaften des Kandidatenfensters fest. Dieser Vorgang schlägt fehl, wenn die Erweiterung nicht über den aktiven IME verfügt.

Parameter

• Parameter

  Objekt

  • engineID

    String

    ID der Suchmaschine, für die Eigenschaften festgelegt werden sollen.

  • Properties

    Objekt

    • auxiliaryText

      String optional

      Text, der unten im Kandidatenfenster angezeigt wird.

    • auxiliaryTextVisible

      Boolescher Wert optional

      "True", um den Zusatztext anzuzeigen, "false", um ihn auszublenden.

    • currentCandidateIndex

      Zahl optional

      Chrome (ab Version 84)

      Der Index des aktuell ausgewählten Kandidaten aus der Gesamtzahl der Kandidaten.

    • cursorVisible

      Boolescher Wert optional

      "True", um den Cursor anzuzeigen, "false", um ihn auszublenden.

    • pageSize

      Zahl optional

      Die Anzahl der Vorschläge, die pro Seite angezeigt werden sollen.

    • totalCandidates

      Zahl optional

      Chrome (ab Version 84)

      Die Gesamtzahl der Kandidaten für das Kandidatenfenster.

    • Branche

      Boolescher Wert optional

      Der Wert "True", wenn das mögliche Fenster vertikal gerendert werden soll, und "false", um es horizontal zu machen.

    • sichtbar

      Boolescher Wert optional

      Einstellung "True", um das Kandidatenfenster anzuzeigen, "false", um es auszublenden.

    • windowPosition

      WindowPosition – optional

      Hier wird das Kandidatenfenster angezeigt.

• callback

  Funktion optional

  Der Parameter callback sieht so aus:

  (success: boolean) => void

  • Erfolg

    boolean

Returns

• Promise&lt;boolean&gt;

  Chrome 111 oder höher

  Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks sind jedoch für Abwärtskompatibilität. Sie können nicht beide in demselben Funktionsaufruf verwenden. Die Promise wird mit demselben Typ aufgelöst, der an das Callback übergeben wird.

setComposition()

<ph type="x-smartling-placeholder"></ph> Versprechen

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

Legen Sie die aktuelle Zusammensetzung fest. Wenn dieser Erweiterung nicht der aktive IME gehört, schlägt der Vorgang fehl.

Parameter

• Parameter

  Objekt

  • contextID

    Zahl

    ID des Kontexts, in dem der Kompositionstext festgelegt wird

  • cursor

    Zahl

    Position im Text des Cursors.

  • Segmente

    Objekt[] optional

    Liste der Segmente und der zugehörigen Typen.

    • Ende

      Zahl

      Index des Zeichens, nach dem dieses Segment enden soll.

    • start

      Zahl

      Index des Zeichens, bei dem dieses Segment beginnen soll

    • Stil

      UnderlineStyle

      Der Typ der Unterstreichung, mit der dieses Segment geändert werden soll.

  • selectionEnd

    Zahl optional

    Position im Text, an der die Auswahl endet.

  • selectionStart

    Zahl optional

    Position im Text, bei der die Auswahl beginnt.

  • Text

    String

    Festzulegender Text

• callback

  Funktion optional

  Der Parameter callback sieht so aus:

  (success: boolean) => void

  • Erfolg

    boolean

Returns

• Promise&lt;boolean&gt;

  Chrome 111 oder höher

  Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks sind jedoch für Abwärtskompatibilität. Sie können nicht beide in demselben Funktionsaufruf verwenden. Die Promise wird mit demselben Typ aufgelöst, der an das Callback übergeben wird.

setCursorPosition()

<ph type="x-smartling-placeholder"></ph> Versprechen

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

Legt die Position des Cursors im Kandidatenfenster fest. Dies ist ein Leerbefehl, wenn dieser Erweiterung nicht der aktive IME gehört.

Parameter

• Parameter

  Objekt

  • candidateID

    Zahl

    ID des Kandidaten, der ausgewählt werden soll.

  • contextID

    Zahl

    ID des Kontexts, zu dem das Kandidatenfenster gehört.

• callback

  Funktion optional

  Der Parameter callback sieht so aus:

  (success: boolean) => void

  • Erfolg

    boolean

Returns

• Promise&lt;boolean&gt;

  Chrome 111 oder höher

  Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks sind jedoch für Abwärtskompatibilität. Sie können nicht beide in demselben Funktionsaufruf verwenden. Die Promise wird mit demselben Typ aufgelöst, der an das Callback übergeben wird.

setMenuItems()

<ph type="x-smartling-placeholder"></ph> Versprechen

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

Fügt dem Sprachmenü die bereitgestellten Menüpunkte hinzu, wenn dieser IME aktiv ist.

Parameter

• Parameter

  MenuParameters

• callback

  Funktion optional

  Der Parameter callback sieht so aus:

  () => void

Returns

• Versprechen<void>

  Chrome 111 oder höher

  Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks sind jedoch für Abwärtskompatibilität. Sie können nicht beide in demselben Funktionsaufruf verwenden. Die Promise wird mit demselben Typ aufgelöst, der an das Callback übergeben wird.

updateMenuItems()

<ph type="x-smartling-placeholder"></ph> Versprechen

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

Aktualisiert den Status der angegebenen MenuItems

Parameter

• Parameter

  MenuParameters

• callback

  Funktion optional

  Der Parameter callback sieht so aus:

  () => void

Returns

• Versprechen<void>

  Chrome 111 oder höher

  Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks sind jedoch für Abwärtskompatibilität. Sie können nicht beide in demselben Funktionsaufruf verwenden. Die Promise wird mit demselben Typ aufgelöst, der an das Callback übergeben wird.

Ereignisse

onActivate

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

Dieses Ereignis wird gesendet, wenn ein IME aktiviert wird. Damit wird signalisiert, dass der IME onKeyPress-Ereignisse empfangen wird.

Parameter

• callback

  Funktion

  Der Parameter callback sieht so aus:

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

  • engineID

    String

  • Bildschirm

    ScreenType

onAssistiveWindowButtonClicked

Chrome (ab Version 85)

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

Dieses Ereignis wird gesendet, wenn auf eine Schaltfläche in einem unterstützenden Fenster geklickt wird.

Parameter

• callback

  Funktion

  Der Parameter callback sieht so aus:

  (details: object) => void

  • Details

    Objekt

    • buttonID

      AssistiveWindowButton

      Die ID der angeklickten Schaltfläche.

    • windowType

      AssistiveWindowType

      Der Typ des unterstützenden Fensters.

onBlur

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

Dieses Ereignis wird gesendet, wenn der Fokus das Textfeld verlässt. Sie wird an alle Erweiterungen gesendet, die dieses Ereignis beobachten, und vom Nutzer aktiviert.

Parameter

• callback

  Funktion

  Der Parameter callback sieht so aus:

  (contextID: number) => void

  • contextID

    Zahl

onCandidateClicked

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

Dieses Ereignis wird gesendet, wenn dieser Erweiterung der aktive IME gehört.

Parameter

• callback

  Funktion

  Der Parameter callback sieht so aus:

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

  • engineID

    String

  • candidateID

    Zahl

  • Schaltfläche

    MouseButton

onDeactivated

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

Dieses Ereignis wird gesendet, wenn ein IME deaktiviert wird. Er signalisiert, dass der IME keine onKeyPress-Ereignisse mehr empfängt.

Parameter

• callback

  Funktion

  Der Parameter callback sieht so aus:

  (engineID: string) => void

  • engineID

    String

onFocus

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

Dieses Ereignis wird gesendet, wenn der Fokus auf einem Textfeld liegt. Sie wird an alle Erweiterungen gesendet, die dieses Ereignis beobachten, und vom Nutzer aktiviert.

Parameter

• callback

  Funktion

  Der Parameter callback sieht so aus:

  (context: InputContext) => void

  • context

    InputContext

onInputContextUpdate

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

Dieses Ereignis wird gesendet, wenn sich die Attribute des aktuellen InputContext ändern, z. B. der Typ. Sie wird an alle Erweiterungen gesendet, die dieses Ereignis beobachten, und vom Nutzer aktiviert.

Parameter

• callback

  Funktion

  Der Parameter callback sieht so aus:

  (context: InputContext) => void

  • context

    InputContext

onKeyEvent

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

Wird ausgelöst, wenn ein Schlüsselereignis vom Betriebssystem gesendet wird Das Ereignis wird an die Erweiterung gesendet, wenn diese Erweiterung über den aktiven IME verfügt. Die Listener-Funktion sollte "true" zurückgeben, wenn das Ereignis andernfalls mit "false" verarbeitet wurde. Wenn das Ereignis asynchron ausgewertet wird, muss diese Funktion undefiniert zurückgeben und der IME muss später keyEventHandled() mit dem Ergebnis aufrufen.

Parameter

• callback

  Funktion

  Der Parameter callback sieht so aus:

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

  • engineID

    String

  • keyData

    KeyboardEvent

  • requestId

    String

  • Gibt zurück

    boolean | nicht definiert

onMenuItemActivated

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

Wird aufgerufen, wenn der Nutzer einen Menüpunkt auswählt

Parameter

• callback

  Funktion

  Der Parameter callback sieht so aus:

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

  • engineID

    String

  • Name

    String

onReset

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

Dieses Ereignis wird gesendet, wenn Chrome die laufende Texteingabesitzung beendet.

Parameter

• callback

  Funktion

  Der Parameter callback sieht so aus:

  (engineID: string) => void

  • engineID

    String

onSurroundingTextChanged

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

Wird aufgerufen, wenn die bearbeitbare Zeichenfolge um das Caret-Zeichen geändert oder die Caret-Position verschoben wird. Die Textlänge ist auf 100 Zeichen für jede Richtung begrenzt.

Parameter

• callback

  Funktion

  Der Parameter callback sieht so aus:

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

  • engineID

    String

  • surroundingInfo

    Objekt

    • anchor

      Zahl

      Die Anfangsposition der Auswahl. Dieser Wert gibt die Caret-Position an, wenn keine Auswahl vorhanden ist.

    • Fokus

      Zahl

      Die Endposition der Auswahl. Dieser Wert gibt die Caret-Position an, wenn keine Auswahl vorhanden ist.

    • kompensiert

      Zahl

      Chrome (ab Version 46)

      Die Versatzposition von text. Da text nur einen Teil des Textes um den Cursor enthält, gibt „offset“ die absolute Position des ersten Zeichens von text an.

    • Text

      String

      Der Text um den Cursor Dies ist nur ein Teil des gesamten Textes im Eingabefeld.