IT. Expert System.

All Known Implementing Classes:

AbstractInputMethodService.AbstractInputMethodSessionImpl, InputMethodService.InputMethodSessionImpl

public interface InputMethodSession

• Nested Class Summary

  Nested Classes

  Modifier and Type	Interface and Description
  static interface	InputMethodSession.EventCallback

• Method Summary

  Methods

  Modifier and Type	Method and Description
  void	appPrivateCommand(String action, Bundle data) Process a private command sent from the application to the input method.
  void	dispatchGenericMotionEvent(int seq, MotionEvent event, InputMethodSession.EventCallback callback) This method is called when there is a generic motion event.
  void	dispatchKeyEvent(int seq, KeyEvent event, InputMethodSession.EventCallback callback) This method is called when a key is pressed.
  void	dispatchTrackballEvent(int seq, MotionEvent event, InputMethodSession.EventCallback callback) This method is called when there is a track ball event.
  void	displayCompletions(CompletionInfo[] completions) Called by a text editor that performs auto completion, to tell the input method about the completions it has available.
  void	finishInput() This method is called when the application would like to stop receiving text input.
  void	toggleSoftInput(int showFlags, int hideFlags) Toggle the soft input window.
  void	updateCursor(Rect newCursor) This method is called when cursor location of the target input field has changed within its window.
  void	updateExtractedText(int token, ExtractedText text) Called by a text editor to report its new extracted text when its contents change.
  void	updateSelection(int oldSelStart, int oldSelEnd, int newSelStart, int newSelEnd, int candidatesStart, int candidatesEnd) This method is called when the selection or cursor in the current target input field has changed.
  void	viewClicked(boolean focusChanged) This method is called when the user tapped a text view.

• Method Detail

  • finishInput

    void finishInput()

    This method is called when the application would like to stop receiving text input.

  • updateSelection

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

    This method is called when the selection or cursor in the current target input field has changed.

    Parameters:

    oldSelStart - The previous text offset of the cursor selection start position.

    oldSelEnd - The previous text offset of the cursor selection end position.

    newSelStart - The new text offset of the cursor selection start position.

    newSelEnd - The new text offset of the cursor selection end position.

    candidatesStart - The text offset of the current candidate text start position.

    candidatesEnd - The text offset of the current candidate text end position.

  • viewClicked

    void viewClicked(boolean focusChanged)

    This method is called when the user tapped a text view. IMEs can't rely on this method being called because this was not part of the original IME protocol, so applications with custom text editing written before this method appeared will not call to inform the IME of this interaction.

    Parameters:

    focusChanged - true if the user changed the focused view by this click.

  • updateCursor

    void updateCursor(Rect newCursor)

    This method is called when cursor location of the target input field has changed within its window. This is not normally called, but will only be reported if requested by the input method.

    Parameters:

    newCursor - The rectangle of the cursor currently being shown in the input field's window coordinates.

  • displayCompletions

    void displayCompletions(CompletionInfo[] completions)

    Called by a text editor that performs auto completion, to tell the input method about the completions it has available. This can be used by the input method to display them to the user to select the text to be inserted.

    Parameters:

    completions - Array of text completions that are available, starting with the best. If this array is null, any existing completions will be removed.

  • updateExtractedText

    void updateExtractedText(int token,
                           ExtractedText text)

    Called by a text editor to report its new extracted text when its contents change. This will only be called if the input method calls InputConnection.getExtractedText() with the option to report updates.

    Parameters:

    token - The input method supplied token for identifying its request.

    text - The new extracted text.

  • dispatchKeyEvent

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

    This method is called when a key is pressed. When done with the event, the implementation must call back on callback with its result.

    If the input method wants to handle this event, return true, otherwise return false and the caller (i.e. the application) will handle the event.

    Parameters:

    event - The key event.

    See Also:

    #dispatchKeyUp, KeyEvent

  • dispatchTrackballEvent

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

    This method is called when there is a track ball event.

    If the input method wants to handle this event, return true, otherwise return false and the caller (i.e. the application) will handle the event.

    Parameters:

    event - The motion event.

    See Also:

    MotionEvent

  • dispatchGenericMotionEvent

    void dispatchGenericMotionEvent(int seq,
                                  MotionEvent event,
                                  InputMethodSession.EventCallback callback)

    This method is called when there is a generic motion event.

    If the input method wants to handle this event, return true, otherwise return false and the caller (i.e. the application) will handle the event.

    Parameters:

    event - The motion event.

    See Also:

    MotionEvent

  • appPrivateCommand

    void appPrivateCommand(String action,
                         Bundle data)

    Process a private command sent from the application to the input method. This can be used to provide domain-specific features that are only known between certain input methods and their clients.

    Parameters:

    action - 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 - Any data to include with the command.

  • toggleSoftInput

    void toggleSoftInput(int showFlags,
                       int hideFlags)

    Toggle the soft input window. Applications can toggle the state of the soft input window.

    Parameters:

    showFlags - Provides additional operating flags. May be 0 or have the InputMethodManager.SHOW_IMPLICIT, InputMethodManager.SHOW_FORCED bit set.

    hideFlags - Provides additional operating flags. May be 0 or have the InputMethodManager.HIDE_IMPLICIT_ONLY, InputMethodManager.HIDE_NOT_ALWAYS bit set.