chrome.input.ime

תיאור

השתמשו ב-API של chrome.input.ime כדי להטמיע IME בהתאמה אישית עבור Chrome OS. כך התוסף יכול לטפל בהקשות, להגדיר את הקומפוזיציה ולנהל את חלון המועמד.

הרשאות

input

כדי להשתמש ב-input.ime API, יש להצהיר על ההרשאה 'קלט' במניפסט של התוסף. לדוגמה:

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

דוגמאות

הקוד הבא יוצר IME שממיר אותיות מוקלדות לאותיות רישיות.

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

סוגים

AssistiveWindowButton

Chrome 85 ומעלה

מזהה של לחצנים בחלון מסייע.

טיפוסים בני מנייה (enum)

"addToDictionary"

AssistiveWindowProperties

Chrome 85 ומעלה

תכונות החלון המסייע.

תכונות

• announceString

  מחרוזת אופציונלי

  מחרוזות להקראה של ChromeVox.

• סוג

• גלוי

  boolean

  הגדרת True כדי להציג את AssistiveWindow, ומגדירה false כדי להסתיר.

AssistiveWindowType

Chrome 85 ומעלה

סוג חלון המסייע.

Value

AutoCapitalizeType

Chrome מגרסה 69 ואילך

הסוג של שימוש באותיות רישיות בשדה הטקסט.

טיפוסים בני מנייה (enum)

InputContext

תיאור של הקשר הקלט

תכונות

• autoCapitalize

  AutoCapitalizeType

  Chrome מגרסה 69 ואילך

  הסוג של שימוש באותיות רישיות בשדה הטקסט.

• autoComplete

  boolean

  אם בשדה הטקסט נדרשת השלמה אוטומטית.

• autoCorrect

  boolean

  אם בשדה הטקסט דרוש תיקון אוטומטי.

• contextID

  מספר

  משמש לציון יעדים של פעולות בשדה הטקסט. המזהה הזה הופך ללא חוקי ברגע שמפעילים את onBlur.

• shouldDoLearning

  boolean

  Chrome 68 ומעלה

  האם צריך להשתמש בטקסט שמזינים בשדה הטקסט כדי לשפר את הצעות ההקלדה עבור המשתמש.

• spellCheck

  boolean

  אם בשדה הטקסט נדרשת בדיקת איות.

• סוג

  InputContextType

  סוג הערך ששדה הטקסט הזה נערך, (טקסט, מספר, כתובת URL וכו')

InputContextType

Chrome 44 ואילך

סוג הערך ששדה הטקסט הזה נערך, (טקסט, מספר, כתובת URL וכו')

טיפוסים בני מנייה (enum)

"url"

"email"

"number"

"password"

"null"

KeyboardEvent

למידע נוסף: http://www.w3.org/TR/DOM-Level-3-Events/#events-KeyboardEvent

תכונות

• altKey

  בוליאני אופציונלי

  האם בוצעה לחיצה על מקש ALT.

• altgrKey

  בוליאני אופציונלי

  Chrome 79 ומעלה

  האם בוצעה לחיצה על מקש ALTGR.

• capsLock

  בוליאני אופציונלי

  האם CAPS_LOCK מופעל או לא.

• קוד

  מחרוזת

  הערך של המפתח הפיזי שעליו לוחצים. הערך לא מושפע מפריסת המקלדת הנוכחית או ממצב הצירוף.

• ctrlKey

  בוליאני אופציונלי

  מציין אם בוצעה לחיצה על מקש CTRL.

• extensionId

  מחרוזת אופציונלי

  מזהה התוסף של השולח של האירוע המרכזי הזה.

• key

  מחרוזת

  הערך של המקש שעליו לוחצים

• keyCode

  מספר אופציונלי

  קוד מפתח HTML שהוצא משימוש, שהוא קוד מספרי תלוי מערכת והטמעה, שמסמן את המזהה שלא השתנה המשויך למפתח שעליו לחצת.

• requestId

  מחרוזת אופציונלי

  (הוצאה משימוש) מזהה הבקשה. במקום זאת, צריך להשתמש בפרמטר requestId מהאירוע onKeyEvent.

• shiftKey

  בוליאני אופציונלי

  האם בוצעה לחיצה על מקש SHIFT.

• סוג

  KeyboardEventType

  הקשה על אחת מהמקשים או על המקשים.

KeyboardEventType

Chrome 44 ואילך

טיפוסים בני מנייה (enum)

"keyup"

"keydown"

MenuItem

פריט בתפריט שמשמש שיטת קלט לאינטראקציה עם המשתמש מתפריט השפה.

תכונות

• בוצע סימון

  בוליאני אופציונלי

  מציין שיש לצייר פריט זה באמצעות המחאה.

• פעיל

  בוליאני אופציונלי

  מסמן שהפריט הזה מופעל.

• id

  מחרוזת

  מחרוזת שתועבר לקריאות חוזרות שמפנות לפריט התפריט הזה.

• label

  מחרוזת אופציונלי

  טקסט שמוצג בתפריט של הפריט הזה.

• style

  MenuItemStyle אופציונלי

  הסוג של האפשרות בתפריט.

• גלוי

  בוליאני אופציונלי

  מסמן שהפריט הזה גלוי.

MenuItemStyle

Chrome 44 ואילך

הסוג של האפשרות בתפריט. לחצני בחירה בין תווי הפרדה נחשבים כלחצני בחירה.

טיפוסים בני מנייה (enum)

MenuParameters

Chrome 88 ומעלה

תכונות

• engineID

  מחרוזת

  המזהה של המנוע לשימוש.

• items

  MenuItem[]

  פריטים בתפריט להוספה או לעדכון הן יתווספו לפי הסדר שבו הן קיימות במערך.

MouseButton

Chrome 44 ואילך

על אילו לחצני עכבר לחצו.

טיפוסים בני מנייה (enum)

ScreenType

Chrome 44 ואילך

סוג המסך שבו מופעל ה-IME.

טיפוסים בני מנייה (enum)

UnderlineStyle

Chrome 44 ואילך

סוג הקו התחתון שצריך לשנות את המקטע הזה.

טיפוסים בני מנייה (enum)

WindowPosition

Chrome 44 ואילך

איפה להציג את חלון האפשרויות. אם המדיניות מוגדרת כ 'סמן', החלון עוקב אחר הסמן. אם הוא מוגדר ל 'קומפוזיציה', החלון נעול לתחילת היצירה.

טיפוסים בני מנייה (enum)

שיטות

clearComposition()

הבטחה

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

ניקוי היצירה הנוכחית. אם התוסף הזה אינו הבעלים של ה-IME הפעיל, הפעולה תיכשל.

פרמטרים

• פרמטרים

  אובייקט

  • contextID

    מספר

    מזהה של ההקשר שבו היצירה תימחק

• קריאה חוזרת (callback)

  פונקציה אופציונלי

  הפרמטר callback נראה כך:

  (success: boolean)=>void

  • הצלחה

    boolean

החזרות

• Promise<boolean>

  Chrome 111 ומעלה

  יש תמיכה בהבטחות במניפסט מגרסה V3 ואילך, אבל אפשר לבצע קריאה חוזרת (callback) לצורך תאימות לאחור. אי אפשר להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה מסתיימת עם אותו הסוג שמועבר לקריאה החוזרת.

commitText()

הבטחה

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

הפונקציה מחייבת את הטקסט שצוין לקלט הנוכחי.

פרמטרים

• פרמטרים

  אובייקט

  • contextID

    מספר

    המזהה של ההקשר שבו הטקסט יחויב

  • טקסט

    מחרוזת

    הטקסט שיש לבצע

• קריאה חוזרת (callback)

  פונקציה אופציונלי

  הפרמטר callback נראה כך:

  (success: boolean)=>void

  • הצלחה

    boolean

החזרות

• Promise<boolean>

  Chrome 111 ומעלה

  יש תמיכה בהבטחות במניפסט מגרסה V3 ואילך, אבל אפשר לבצע קריאה חוזרת (callback) לצורך תאימות לאחור. אי אפשר להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה מסתיימת עם אותו הסוג שמועבר לקריאה החוזרת.

deleteSurroundingText()

הבטחה

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

מחיקת הטקסט שמסביב לסימן הקארה.

פרמטרים

• פרמטרים

  אובייקט

  • contextID

    מספר

    המזהה של ההקשר שבו הטקסט שמקיף אותו יימחק.

  • engineID

    מחרוזת

    המזהה של המנוע שמקבל את האירוע.

  • length

    מספר

    מספר התווים למחיקה

  • היסט

    מספר

    ההיסט ממצב סמן הטקסט שבו תתחיל המחיקה. הערך הזה יכול להיות שלילי.

• קריאה חוזרת (callback)

  פונקציה אופציונלי

  הפרמטר callback נראה כך:

  ()=>void

החזרות

• Promise<void>

  Chrome 111 ומעלה

  יש תמיכה בהבטחות במניפסט מגרסה V3 ואילך, אבל אפשר לבצע קריאה חוזרת (callback) לצורך תאימות לאחור. אי אפשר להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה מסתיימת עם אותו הסוג שמועבר לקריאה החוזרת.

hideInputView()

chrome.input.ime.hideInputView()

הסתרת חלון תצוגת הקלט, שקופץ אוטומטית על ידי המערכת. אם חלון תצוגת הקלט כבר מוסתר, הפונקציה הזו לא תגרום לשום פעולה.

keyEventHandled()

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

מציין שהאירוע המרכזי שהתקבל על ידי onKeyEvent מטופל. יש לקרוא לפעולה הזו רק אם ה-onKeyEvent listener הוא אסינכרוני.

פרמטרים

• requestId

  מחרוזת

  מזהה הבקשה של האירוע שטופל. הוא צריך להגיע מ-keyEvent.requestId

• תשובה

  boolean

  True אם הקשה טופלה, FALSE אם לא

sendKeyEvents()

הבטחה

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

האירועים המרכזיים יישלחו. הפונקציה הזו צפויה לשמש מקלדות וירטואליות. כשמשתמש לוחץ על מקשים במקלדת וירטואלית, הפונקציה הזו משמשת להפצת האירוע הזה במערכת.

פרמטרים

• פרמטרים

  אובייקט

  • contextID

    מספר

    המזהה של ההקשר שאליו יישלחו האירועים המרכזיים, או אפס כדי לשלוח אירועים מרכזיים לשדה שאינו קלט.

  • keyData

    KeyboardEvent[]

    נתונים באירוע המרכזי.

• קריאה חוזרת (callback)

  פונקציה אופציונלי

  הפרמטר callback נראה כך:

  ()=>void

החזרות

• Promise<void>

  Chrome 111 ומעלה

  יש תמיכה בהבטחות במניפסט מגרסה V3 ואילך, אבל אפשר לבצע קריאה חוזרת (callback) לצורך תאימות לאחור. אי אפשר להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה מסתיימת עם אותו הסוג שמועבר לקריאה החוזרת.

setAssistiveWindowButtonHighlighted()

Promise Chrome 86 ואילך

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

הדגשה/ביטול הדגשה של לחצן בחלון מסייע.

פרמטרים

• פרמטרים

  אובייקט

  • announceString

    מחרוזת אופציונלי

    הטקסט שקורא המסך יקריא.

  • buttonID

    AssistiveWindowButton

    המזהה של הלחצן

  • contextID

    מספר

    המזהה של ההקשר שהוא הבעלים של חלון הסיוע.

  • מודגש

    boolean

    אם הלחצן צריך להיות מודגש.

  • windowType

    סוג החלון שאליו שייך הלחצן.

• קריאה חוזרת (callback)

  פונקציה אופציונלי

  הפרמטר callback נראה כך:

  ()=>void

החזרות

• Promise<void>

  Chrome 111 ומעלה

  יש תמיכה בהבטחות במניפסט מגרסה V3 ואילך, אבל אפשר לבצע קריאה חוזרת (callback) לצורך תאימות לאחור. אי אפשר להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה מסתיימת עם אותו הסוג שמועבר לקריאה החוזרת.

setAssistiveWindowProperties()

Promise Chrome 85 ומעלה

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

הצגה/הסתרה של חלון מסייע עם המאפיינים הנתונים.

פרמטרים

• פרמטרים

  אובייקט

  • contextID

    מספר

    המזהה של ההקשר שהוא הבעלים של חלון הסיוע.

  • נכסים

    AssistiveWindowProperties

    תכונות החלון המסייע.

• קריאה חוזרת (callback)

  פונקציה אופציונלי

  הפרמטר callback נראה כך:

  (success: boolean)=>void

  • הצלחה

    boolean

החזרות

• Promise<boolean>

  Chrome 111 ומעלה

  יש תמיכה בהבטחות במניפסט מגרסה V3 ואילך, אבל אפשר לבצע קריאה חוזרת (callback) לצורך תאימות לאחור. אי אפשר להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה מסתיימת עם אותו הסוג שמועבר לקריאה החוזרת.

setCandidates()

הבטחה

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

מגדיר את רשימת ההצעות הנוכחית. הפעולה תיכשל אם תוסף זה אינו הבעלים של ה-IME הפעיל

פרמטרים

• פרמטרים

  אובייקט

  • מועמדים

    אובייקט[]

    רשימת מועמדים שיוצגו בחלון האפשרויות

    • אנוטציה

      מחרוזת אופציונלי

      טקסט נוסף שמתאר את המועמד

    • שילוב אפשרי למיקוד

      מחרוזת

      המועמד

    • id

      מספר

      מזהה המועמד

    • label

      מחרוזת אופציונלי

      מחרוזת קצרה מוצגת לצד האפשרות שנבחרה, לעיתים קרובות מקש הקיצור או האינדקס

    • parentId

      מספר אופציונלי

      המזהה שבו יש להוסיף את המועמדים האלה

    • שימוש

      אובייקט אופציונלי

      תיאור השימוש או הפרטים של מילה.

      • body

        מחרוזת

        מחרוזת הגוף של תיאור הפרטים.

      • title

        מחרוזת

        מחרוזת הכותרת של תיאור הפרטים.

  • contextID

    מספר

    המזהה של ההקשר שחלון המועמד מוגדר לו.

• קריאה חוזרת (callback)

  פונקציה אופציונלי

  הפרמטר callback נראה כך:

  (success: boolean)=>void

  • הצלחה

    boolean

החזרות

• Promise<boolean>

  Chrome 111 ומעלה

  יש תמיכה בהבטחות במניפסט מגרסה V3 ואילך, אבל אפשר לבצע קריאה חוזרת (callback) לצורך תאימות לאחור. אי אפשר להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה מסתיימת עם אותו הסוג שמועבר לקריאה החוזרת.

setCandidateWindowProperties()

הבטחה

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

מגדיר את המאפיינים של חלון האפשרויות. הפעולה הזו תיכשל אם התוסף אינו הבעלים של ה-IME הפעיל

פרמטרים

• פרמטרים

  אובייקט

  • engineID

    מחרוזת

    המזהה של המנוע שבו רוצים להגדיר מאפיינים.

  • נכסים

    אובייקט

    • auxiliaryText

      מחרוזת אופציונלי

      טקסט שמוצג בתחתית חלון האפשרויות.

    • auxiliaryTextVisible

      בוליאני אופציונלי

      יש לציין את הערך True כדי להציג את טקסט העזר, ואת הערך false כדי להסתיר אותו.

    • currentCandidateIndex

      מספר אופציונלי

      Chrome 84 ומעלה

      האינדקס של המועמד הנוכחי שנבחר מתוך סך כל המועמדים.

    • cursorVisible

      בוליאני אופציונלי

      יש לציין True כדי להציג את הסמן, או FALSE כדי להסתיר אותו.

    • pageSize

      מספר אופציונלי

      מספר המועמדים שיוצגו בכל דף.

    • totalCandidates

      מספר אופציונלי

      Chrome 84 ומעלה

      המספר הכולל של המועמדים לחלון ההצעות.

    • לאורך

      בוליאני אופציונלי

      יש לציין את הערך True אם יש לעבד את החלון האפשרי לאורך, ואת הערך false כדי להפוך אותו לרוחב.

    • גלוי

      בוליאני אופציונלי

      יש לציין True כדי להציג את החלון 'מועמד', או 'FALSE' כדי להסתיר אותו.

    • windowPosition

      WindowPosition אופציונלי

      איפה להציג את חלון האפשרויות.

• קריאה חוזרת (callback)

  פונקציה אופציונלי

  הפרמטר callback נראה כך:

  (success: boolean)=>void

  • הצלחה

    boolean

החזרות

• Promise<boolean>

  Chrome 111 ומעלה

  יש תמיכה בהבטחות במניפסט מגרסה V3 ואילך, אבל אפשר לבצע קריאה חוזרת (callback) לצורך תאימות לאחור. אי אפשר להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה מסתיימת עם אותו הסוג שמועבר לקריאה החוזרת.

setComposition()

הבטחה

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

מגדירים את היצירה הנוכחית. אם התוסף הזה אינו הבעלים של ה-IME הפעיל, הפעולה תיכשל.

פרמטרים

• פרמטרים

  אובייקט

  • contextID

    מספר

    המזהה של ההקשר שבו יוגדר הטקסט המוקלט

  • סמן

    מספר

    מיקום בטקסט של הסמן.

  • בפלחים דומים

    אובייקט[] אופציונלי

    רשימת פלחים והסוגים המשויכים להם.

    • סיום

      מספר

      אינדקס הדמות שצריך לסיים אחריה את הקטע הזה.

    • התחלה

      מספר

      האינדקס של התו שבו צריך להתחיל את הקטע הזה

    • style

      UnderlineStyle

      סוג הקו התחתון שצריך לשנות את המקטע הזה.

  • selectionEnd

    מספר אופציונלי

    מיקום בטקסט שבו מסתיימת הבחירה.

  • selectionStart

    מספר אופציונלי

    מיקום בטקסט שבו מתחילה הבחירה.

  • טקסט

    מחרוזת

    טקסט להגדרה

• קריאה חוזרת (callback)

  פונקציה אופציונלי

  הפרמטר callback נראה כך:

  (success: boolean)=>void

  • הצלחה

    boolean

החזרות

• Promise<boolean>

  Chrome 111 ומעלה

  יש תמיכה בהבטחות במניפסט מגרסה V3 ואילך, אבל אפשר לבצע קריאה חוזרת (callback) לצורך תאימות לאחור. אי אפשר להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה מסתיימת עם אותו הסוג שמועבר לקריאה החוזרת.

setCursorPosition()

הבטחה

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

הגדרת מיקום הסמן בחלון המועמד. אין אפשרות לבצע פעולה אם התוסף הזה לא הבעלים של ה-IME הפעיל.

פרמטרים

• פרמטרים

  אובייקט

  • candidateID

    מספר

    המזהה של המועמד לבחירה.

  • contextID

    מספר

    המזהה של ההקשר שחלון המועמד מוגדר לו.

• קריאה חוזרת (callback)

  פונקציה אופציונלי

  הפרמטר callback נראה כך:

  (success: boolean)=>void

  • הצלחה

    boolean

החזרות

• Promise<boolean>

  Chrome 111 ומעלה

  יש תמיכה בהבטחות במניפסט מגרסה V3 ואילך, אבל אפשר לבצע קריאה חוזרת (callback) לצורך תאימות לאחור. אי אפשר להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה מסתיימת עם אותו הסוג שמועבר לקריאה החוזרת.

setMenuItems()

הבטחה

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

הוספת אפשרויות התפריט שצוינו לתפריט השפה כשה-IME הזה פעיל.

פרמטרים

• פרמטרים

  MenuParameters

• קריאה חוזרת (callback)

  פונקציה אופציונלי

  הפרמטר callback נראה כך:

  ()=>void

החזרות

• Promise<void>

  Chrome 111 ומעלה

  יש תמיכה בהבטחות במניפסט מגרסה V3 ואילך, אבל אפשר לבצע קריאה חוזרת (callback) לצורך תאימות לאחור. אי אפשר להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה מסתיימת עם אותו הסוג שמועבר לקריאה החוזרת.

updateMenuItems()

הבטחה

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

עדכון המצב של פריטי התפריט שצוינו

פרמטרים

• פרמטרים

  MenuParameters

• קריאה חוזרת (callback)

  פונקציה אופציונלי

  הפרמטר callback נראה כך:

  ()=>void

החזרות

• Promise<void>

  Chrome 111 ומעלה

  יש תמיכה בהבטחות במניפסט מגרסה V3 ואילך, אבל אפשר לבצע קריאה חוזרת (callback) לצורך תאימות לאחור. אי אפשר להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה מסתיימת עם אותו הסוג שמועבר לקריאה החוזרת.

אירועים

onActivate

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

האירוע הזה נשלח כאשר IME מופעל. הוא מסמן שה-IME יקבל אירועי onKeyPress.

פרמטרים

• קריאה חוזרת (callback)

  פונקציה

  הפרמטר callback נראה כך:

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

  • engineID

    מחרוזת

  • סינון שיחות

    ScreenType

onAssistiveWindowButtonClicked

Chrome 85 ומעלה

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

האירוע הזה נשלח כשלוחצים על לחצן בחלון מסייע.

פרמטרים

• קריאה חוזרת (callback)

  פונקציה

  הפרמטר callback נראה כך:

  (details: object)=>void

  • פרטים

    אובייקט

    • buttonID

      AssistiveWindowButton

      המזהה של הלחצן שעליו לחצת.

    • windowType

      AssistiveWindowType

      סוג החלון המסייע.

onBlur

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

האירוע הזה נשלח כשהמיקוד יוצא מתיבת טקסט. הוא נשלח לכל התוספים שמאזינים לאירוע הזה, והוא מופעל על ידי המשתמש.

פרמטרים

• קריאה חוזרת (callback)

  פונקציה

  הפרמטר callback נראה כך:

  (contextID: number)=>void

  • contextID

    מספר

onCandidateClicked

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

האירוע הזה נשלח אם ה-IME הפעיל הוא בבעלות התוסף הזה.

פרמטרים

• קריאה חוזרת (callback)

  פונקציה

  הפרמטר callback נראה כך:

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

  • engineID

    מחרוזת

  • candidateID

    מספר

  • לחצן

    MouseButton

onDeactivated

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

האירוע הזה נשלח כאשר IME מושבת. הוא מסמן שה-IME כבר לא יקבל יותר אירועי onKeyPress.

פרמטרים

• קריאה חוזרת (callback)

  פונקציה

  הפרמטר callback נראה כך:

  (engineID: string)=>void

  • engineID

    מחרוזת

onFocus

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

האירוע הזה נשלח כשהמיקוד נכנס לתיבת טקסט. הוא נשלח לכל התוספים שמאזינים לאירוע הזה, והוא מופעל על ידי המשתמש.

פרמטרים

• קריאה חוזרת (callback)

  פונקציה

  הפרמטר callback נראה כך:

  (context: InputContext)=>void

  • context

    InputContext

onInputContextUpdate

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

האירוע הזה נשלח כאשר המאפיינים של ה-inputContext הנוכחי משתנים, למשל הסוג. הוא נשלח לכל התוספים שמאזינים לאירוע הזה, והוא מופעל על ידי המשתמש.

פרמטרים

• קריאה חוזרת (callback)

  פונקציה

  הפרמטר callback נראה כך:

  (context: InputContext)=>void

  • context

    InputContext

onKeyEvent

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

מופעל כאשר אירוע מרכזי נשלח ממערכת ההפעלה. האירוע יישלח לתוסף אם ה-IME הפעיל הוא בבעלותו של תוסף זה. פונקציית ההאזנה צריכה להחזיר את הערך True אם האירוע טופל כ-FALSE אם לא. אם האירוע ייבדק באופן אסינכרוני, הפונקציה הזו חייבת להחזיר ערך לא מוגדר וה-IME חייב לקרוא ל-keyEventHandld() עם התוצאה מאוחר יותר.

פרמטרים

• קריאה חוזרת (callback)

  פונקציה

  הפרמטר callback נראה כך:

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

  • engineID

    מחרוזת

  • keyData

    KeyboardEvent

  • requestId

    מחרוזת

  • החזרות

    boolean|undefined

onMenuItemActivated

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

מתבצעת שיחה כשהמשתמש בוחר אפשרות בתפריט

פרמטרים

• קריאה חוזרת (callback)

  פונקציה

  הפרמטר callback נראה כך:

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

  • engineID

    מחרוזת

  • name

    מחרוזת

onReset

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

האירוע הזה נשלח כש-Chrome מסיים פעילות מתמשכת של קלט טקסט.

פרמטרים

• קריאה חוזרת (callback)

  פונקציה

  הפרמטר callback נראה כך:

  (engineID: string)=>void

  • engineID

    מחרוזת

onSurroundingTextChanged

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

תכונה זו נקראת כאשר המחרוזת שניתנת לעריכה סביב סמן הטקסט משתנה או כשמיקום סמן הטקסט זז. אורך הטקסט מוגבל ל-100 תווים לכל כיוון שהוא.

פרמטרים

• קריאה חוזרת (callback)

  פונקציה

  הפרמטר callback נראה כך:

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

  • engineID

    מחרוזת

  • surroundingInfo

    אובייקט

    • עוגן

      מספר

      המיקום ההתחלתי של הבחירה. הערך הזה מציין את מיקום סמן הטקסט אם לא נבחרה אפשרות.

    • מיקוד

      מספר

      מיקום הסיום של הבחירה. הערך הזה מציין את מיקום סמן הטקסט אם לא נבחרה אפשרות.

    • היסט

      מספר

      Chrome 46 ואילך

      מיקום ההיסט של text. מכיוון ש-text כולל רק קבוצת משנה של טקסט סביב הסמן, ההיסט מציין את המיקום המוחלט של התו הראשון של text.

    • טקסט

      מחרוזת

      הטקסט שמסביב לסמן. זוהי רק קבוצת משנה של כל הטקסט בשדה הקלט.