android api (83) —— InputMethodSession [輸入法]

前言

　　本章內容是android.view.inputmethod.InputMethodSession，為輸入法相關章節，版本為Android 2.3 r1  

正文

　　一、結構

public interface InputMethodSession

        

android.view.inputmethod. InputMethodSession

間接子類

AbstractInputMethodService.AbstractInputMethodSessionImpl,InputMethodService.InputMethodSessionImpl

 

　　二、概述

　　InputMethodSession接口提供給每個客戶端的InputMethod可安全地暴露在應用程序中。

　　應用程序通常不自己使用本接口，而是依靠TextView和EditText提供的標准交互。

 

　　三、內部類

　　　　 interface          InputMethodSession.EventCallback

 

 

　　四、公共方法

           public abstract void appPrivateCommand (String action, Bundle data)

　　執行由應用程序發往輸入法的私有命令。它可用於提供專屬域功能，僅專屬於特定的輸入法及其客戶端

           　　參數

　　action      執行命名的名稱。它必須是一個域名稱，如前綴你自己的包名稱，這樣不同的開發者就不產生命令沖突。

　　data         隨命令包括的任何數據。

 

　　public abstract void dispatchKeyEvent (int seq, KeyEvent event, InputMethodSession.EventCallback callback)

　　當按鍵按下時調用此方法。完成事件時，本方法的實現方法必須調用callback回調函數並返回結果。

　　如果輸入法處理此事件返回true，否則返回false，調用者（如應用程序）將處理事件。

           　　參數

　　event       按鍵事件

　　返回值

　　輸入法是否處理本事件。

　　參見

                       ERROR(/#dispatchKeyUp)

                       KeyEvent

 

　　public abstract void dispatchTrackballEvent (int seq, MotionEvent event, InputMethodSession.EventCallback callback)

　　發生軌跡球事件時調用此方法。

　　如果輸入法處理此事件返回true，否則返回false，調用者（如應用程序）將處理事件。

           　　參數

　　event       移動事件

　　返回值

　　輸入法是否處理本事件。

　　參見

                       MotionEvent

 

　　public abstract void displayCompletions (CompletionInfo[] completions)

　　由文本編輯器調用自動補全，完成後通知輸入法補全有效。可被用於輸入法向用戶顯示備選文本以備插入。

           　　參數

　　completions    補充文本數組有效，並以最佳結果開頭。如果數組為空，存在的補充將被移除。

 

　　public abstract void finishInput ()

　　當應用程序要停止接收文字輸入時調用此方法。

 

　　public abstract void toggleSoftInput (int showFlags, int hideFlags)

　　切換軟鍵盤(soft input)窗口。應用程序能切換軟鍵盤(soft input)窗口

            　  參數

　　showFlags       提供附加的操作標志。可能為0或設置SHOW_IMPLICIT, SHOW_FORCED位。

　　hideFlags         提供附加的操作標志。可能為0或設置HIDE_IMPLICIT_ONLY, HIDE_NOT_ALWAYS位。

 

　　public abstract void updateCursor (Rect newCursor)

　　當目標輸入域的光標位置在自身窗口內移動時調用此方法。本方法通常不被調用，但輸入法要求更新時可被調用。

           　　參數

　　newCursor      當前輸入區域窗口坐標系下光標顯示的矩陣區域。

 

　　public abstract void updateExtractedText (int token, ExtractedText text)

　　當內容變化時文本編輯器調用此方法，通知其新提取文本。本方法僅在輸入法調用InputConnection.getExtractedText()並帶有通報更新選項時才被調用。

           　　參數

　　token       輸入法提供了分辨要求的令牌。

　　text          新的提取文本。

 

　　public abstract void updateSelection (int oldSelStart, int oldSelEnd, int newSelStart, int newSelEnd, int candidatesStart, int candidatesEnd)

　　當目標輸入域的光標或選定變化時，調用此方法。

           　　參數

　　oldSelStart      之前的選擇開始位置相對於光標的文本偏移。

　　oldSelEnd         之前的選擇結束位置相對於光標的文本偏移。

　　newSelStart    新的選擇初始位置相對於光標的文本偏移。

　　newSelEnd      新的選擇結束位置相對於光標的文本偏移。

　　candidatesStart      當前坐標系下文本文本開始位置的文本偏移。

　　　　　　　　candidatesEnd        當前坐標系下文本文本結束位置的文本偏移。

 

　　五、補充
 

文章鏈接

android 鍵盤的啟動關閉、顯示、隱藏及其 bug