Added in API level 3

InputMethodSessionImpl


open class InputMethodSessionImpl : AbstractInputMethodService.AbstractInputMethodSessionImpl
kotlin.Any
   ↳ android.inputmethodservice.AbstractInputMethodService.AbstractInputMethodSessionImpl
   ↳ android.inputmethodservice.InputMethodService.InputMethodSessionImpl

Concrete implementation of AbstractInputMethodService.AbstractInputMethodSessionImpl that provides all of the standard behavior for an input method session.

Summary

Public constructors

Public methods
open Unit
appPrivateCommand(action: String!, data: Bundle!)

Call InputMethodService.onAppPrivateCommand().

open Unit

Call InputMethodService.onDisplayCompletions().

open Unit

open Unit
toggleSoftInput(showFlags: Int, hideFlags: Int)

Handles a request to toggle the IME visibility.

open Unit
updateCursor(newCursor: Rect!)

Call InputMethodService.onUpdateCursor().

open Unit

Call InputMethodService.onUpdateCursorAnchorInfo().

open Unit

Call InputMethodService.onUpdateExtractedText().

open Unit
updateSelection(oldSelStart: Int, oldSelEnd: Int, newSelStart: Int, newSelEnd: Int, candidatesStart: Int, candidatesEnd: Int)

Call InputMethodService.onUpdateSelection().

open Unit
viewClicked(focusChanged: Boolean)

Inherited functions

Public constructors

InputMethodSessionImpl

InputMethodSessionImpl()

Public methods

appPrivateCommand

Added in API level 3
open fun appPrivateCommand(
    action: String!,
    data: Bundle!
): Unit

Call InputMethodService.onAppPrivateCommand().

Parameters
action String!: Name of the command to be performed. This must be a scoped name, i.e. prefixed with a package name you own, so that different developers will not create conflicting commands.
data Bundle!: Any data to include with the command.

displayCompletions

Added in API level 3
open fun displayCompletions(completions: Array<CompletionInfo!>!): Unit

Call InputMethodService.onDisplayCompletions().

Parameters
completions Array<CompletionInfo!>!: Array of text completions that are available, starting with the best. If this array is null, any existing completions will be removed.

finishInput

Added in API level 3
open fun finishInput(): Unit

toggleSoftInput

Added in API level 3
open fun toggleSoftInput(
    showFlags: Int,
    hideFlags: Int
): Unit

Deprecated: Starting in Build.VERSION_CODES#S the system no longer invokes this method, instead it explicitly shows or hides the IME. An InputMethodService wishing to toggle its own visibility should instead invoke android.inputmethodservice.InputMethodService#requestShowSelf or InputMethodService#requestHideSelf

Handles a request to toggle the IME visibility.

Parameters
showFlags Int: Value is either 0 or a combination of android.view.inputmethod.InputMethodManager#SHOW_IMPLICIT, and android.view.inputmethod.InputMethodManager#SHOW_FORCED
hideFlags Int: Value is either 0 or a combination of android.view.inputmethod.InputMethodManager#HIDE_IMPLICIT_ONLY, and android.view.inputmethod.InputMethodManager#HIDE_NOT_ALWAYS

updateCursor

Added in API level 3
open fun updateCursor(newCursor: Rect!): Unit

Call InputMethodService.onUpdateCursor().

Parameters
newCursor Rect!: The rectangle of the cursor currently being shown in the input field's window coordinates.

updateCursorAnchorInfo

Added in API level 21
open fun updateCursorAnchorInfo(info: CursorAnchorInfo!): Unit

Call InputMethodService.onUpdateCursorAnchorInfo().

Parameters
cursorAnchorInfo Positional information relevant to text input, such as text insertion point and composition string.

updateExtractedText

Added in API level 3
open fun updateExtractedText(
    token: Int,
    text: ExtractedText!
): Unit

Call InputMethodService.onUpdateExtractedText().

Parameters
token Int: The input method supplied token for identifying its request.
text ExtractedText!: The new extracted text.

updateSelection

Added in API level 3
open fun updateSelection(
    oldSelStart: Int,
    oldSelEnd: Int,
    newSelStart: Int,
    newSelEnd: Int,
    candidatesStart: Int,
    candidatesEnd: Int
): Unit

Call InputMethodService.onUpdateSelection().

Parameters
oldSelStart Int: The previous text offset of the cursor selection start position.
oldSelEnd Int: The previous text offset of the cursor selection end position.
newSelStart Int: The new text offset of the cursor selection start position.
newSelEnd Int: The new text offset of the cursor selection end position.
candidatesStart Int: The text offset of the current candidate text start position.
candidatesEnd Int: The text offset of the current candidate text end position.

viewClicked

Added in API level 14
open fun viewClicked(focusChanged: Boolean): Unit
Parameters
focusChanged Boolean: true if the user changed the focused view by this click.