ChromeInputIme class

Properties

hashCode int
The hash code for this object.
no setterinherited
isAvailable bool
no setter
onActivate EventStream<OnActivateEvent>
This event is sent when an IME is activated. It signals that the IME will be receiving onKeyPress events.
no setter
onAssistiveWindowButtonClicked EventStream<OnAssistiveWindowButtonClickedDetails>
This event is sent when a button in an assistive window is clicked.
no setter
onBlur EventStream<int>
This event is sent when focus leaves a text box. It is sent to all extensions that are listening to this event, and enabled by the user.
no setter
onCandidateClicked EventStream<OnCandidateClickedEvent>
This event is sent if this extension owns the active IME.
no setter
onDeactivated EventStream<String>
This event is sent when an IME is deactivated. It signals that the IME will no longer be receiving onKeyPress events.
no setter
onFocus EventStream<InputContext>
This event is sent when focus enters a text box. It is sent to all extensions that are listening to this event, and enabled by the user.
no setter
onInputContextUpdate EventStream<InputContext>
This event is sent when the properties of the current InputContext change, such as the the type. It is sent to all extensions that are listening to this event, and enabled by the user.
no setter
onKeyEvent EventStream<OnKeyEventEvent>
Fired when a key event is sent from the operating system. The event will be sent to the extension if this extension owns the active IME. The listener function should return true if the event was handled false if it was not. If the event will be evaluated asynchronously, this function must return undefined and the IME must later call keyEventHandled() with the result.
no setter
onMenuItemActivated EventStream<OnMenuItemActivatedEvent>
Called when the user selects a menu item
no setter
onReset EventStream<String>
This event is sent when chrome terminates ongoing text input session.
no setter
onSurroundingTextChanged EventStream<OnSurroundingTextChangedEvent>
Called when the editable string around caret is changed or when the caret position is moved. The text length is limited to 100 characters for each back and forth direction.
no setter
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

clearComposition(ClearCompositionParameters parameters) Future<bool>
Clear the current composition. If this extension does not own the active IME, this fails. returns Called when the operation completes with a boolean indicating if the text was accepted or not. On failure, runtime.lastError is set.
commitText(CommitTextParameters parameters) Future<bool>
Commits the provided text to the current input. returns Called when the operation completes with a boolean indicating if the text was accepted or not. On failure, runtime.lastError is set.
deleteSurroundingText(DeleteSurroundingTextParameters parameters) Future<void>
Deletes the text around the caret. returns Called when the operation completes.
hideInputView() → void
Hides the input view window, which is popped up automatically by system. If the input view window is already hidden, this function will do nothing.
keyEventHandled(String requestId, bool response) → void
Indicates that the key event received by onKeyEvent is handled. This should only be called if the onKeyEvent listener is asynchronous. requestId Request id of the event that was handled. This should come from keyEvent.requestId response True if the keystroke was handled, false if not
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
sendKeyEvents(SendKeyEventsParameters parameters) Future<void>
Sends the key events. This function is expected to be used by virtual keyboards. When key(s) on a virtual keyboard is pressed by a user, this function is used to propagate that event to the system. returns Called when the operation completes.
setAssistiveWindowButtonHighlighted(SetAssistiveWindowButtonHighlightedParameters parameters) Future<void>
Highlights/Unhighlights a button in an assistive window. returns Called when the operation completes. On failure, runtime.lastError is set.
setAssistiveWindowProperties(SetAssistiveWindowPropertiesParameters parameters) Future<bool>
Shows/Hides an assistive window with the given properties. returns Called when the operation completes.
setCandidates(SetCandidatesParameters parameters) Future<bool>
Sets the current candidate list. This fails if this extension doesn't own the active IME returns Called when the operation completes.
setCandidateWindowProperties(SetCandidateWindowPropertiesParameters parameters) Future<bool>
Sets the properties of the candidate window. This fails if the extension doesn't own the active IME returns Called when the operation completes.
setComposition(SetCompositionParameters parameters) Future<bool>
Set the current composition. If this extension does not own the active IME, this fails. returns Called when the operation completes with a boolean indicating if the text was accepted or not. On failure, runtime.lastError is set.
setCursorPosition(SetCursorPositionParameters parameters) Future<bool>
Set the position of the cursor in the candidate window. This is a no-op if this extension does not own the active IME. returns Called when the operation completes
setMenuItems(MenuParameters parameters) Future<void>
Adds the provided menu items to the language menu when this IME is active.
toString() String
A string representation of this object.
inherited
updateMenuItems(MenuParameters parameters) Future<void>
Updates the state of the MenuItems specified returns Called when the operation completes

Operators

operator ==(Object other) bool
The equality operator.
inherited