Classes
class	Configuration

class	InputType

enum	TextCapitalization

class	TextEditState

interface	TextInputMethodHandler

enum	TextInputType

Public Member Functions
	TextInputChannel (@NonNull DartExecutor dartExecutor)

void	requestExistingInputState ()

void	updateEditingState (int inputClientId, @NonNull String text, int selectionStart, int selectionEnd, int composingStart, int composingEnd)

void	updateEditingStateWithDeltas (int inputClientId, @NonNull ArrayList< TextEditingDelta > batchDeltas)

void	updateEditingStateWithTag (int inputClientId, @NonNull HashMap< String, TextEditState > editStates)

void	newline (int inputClientId)

void	go (int inputClientId)

void	search (int inputClientId)

void	send (int inputClientId)

void	done (int inputClientId)

void	next (int inputClientId)

void	previous (int inputClientId)

void	unspecifiedAction (int inputClientId)

void	commitContent (int inputClientId, Map< String, Object > content)

void	performPrivateCommand (int inputClientId, @NonNull String action, @NonNull Bundle data)

void	setTextInputMethodHandler (@Nullable TextInputMethodHandler textInputMethodHandler)

Public Attributes
final MethodChannel	channel

Package Attributes
final MethodChannel.MethodCallHandler	parsingMethodHandler

Detailed Description

TextInputChannel is a platform channel between Android and Flutter that is used to communicate information about the user's text input.

When the user presses an action button like "done" or "next", that action is sent from Android to Flutter through this TextInputChannel.

When an input system in the Flutter app wants to show the keyboard, or hide it, or configure editing state, etc. a message is sent from Flutter to Android through this TextInputChannel.

TextInputChannel comes with a default io.flutter.plugin.common.MethodChannel.MethodCallHandler that parses incoming messages from Flutter. Register a TextInputMethodHandler to respond to standard Flutter text input messages.

Definition at line 44 of file TextInputChannel.java.

Constructor & Destructor Documentation

◆ TextInputChannel()

io.flutter.embedding.engine.systemchannels.TextInputChannel.TextInputChannel ( @NonNull DartExecutor dartExecutor )

inline

Constructs a TextInputChannel that connects Android to the Dart code running in dartExecutor.

The given dartExecutor is permitted to be idle or executing code.

See DartExecutor.

Definition at line 168 of file TextInputChannel.java.

                                                              {
    this.channel = new MethodChannel(dartExecutor, "flutter/textinput", JSONMethodCodec.INSTANCE);
    channel.setMethodCallHandler(parsingMethodHandler);
  }

Member Function Documentation

◆ commitContent()

void io.flutter.embedding.engine.systemchannels.TextInputChannel.commitContent	(	int	inputClientId,
		Map< String, Object >	content
	)

inline

Instructs Flutter to commit inserted content back to the text channel.

Definition at line 332 of file TextInputChannel.java.

                                                                            {
    Log.v(TAG, "Sending 'commitContent' message.");
    channel.invokeMethod(
        "TextInputClient.performAction",
        Arrays.asList(inputClientId, "TextInputAction.commitContent", content));
  }

◆ done()

void io.flutter.embedding.engine.systemchannels.TextInputChannel.done ( int inputClientId )

inline

Instructs Flutter to execute a "done" action.

Definition at line 303 of file TextInputChannel.java.

                                      {
    Log.v(TAG, "Sending 'done' message.");
    channel.invokeMethod(
        "TextInputClient.performAction", Arrays.asList(inputClientId, "TextInputAction.done"));
  }

◆ go()

void io.flutter.embedding.engine.systemchannels.TextInputChannel.go ( int inputClientId )

inline

Instructs Flutter to execute a "go" action.

Definition at line 282 of file TextInputChannel.java.

                                    {
    Log.v(TAG, "Sending 'go' message.");
    channel.invokeMethod(
        "TextInputClient.performAction", Arrays.asList(inputClientId, "TextInputAction.go"));
  }

◆ newline()

void io.flutter.embedding.engine.systemchannels.TextInputChannel.newline ( int inputClientId )

inline

Instructs Flutter to execute a "newline" action.

Definition at line 275 of file TextInputChannel.java.

                                         {
    Log.v(TAG, "Sending 'newline' message.");
    channel.invokeMethod(
        "TextInputClient.performAction", Arrays.asList(inputClientId, "TextInputAction.newline"));
  }

◆ next()

void io.flutter.embedding.engine.systemchannels.TextInputChannel.next ( int inputClientId )

inline

Instructs Flutter to execute a "next" action.

Definition at line 310 of file TextInputChannel.java.

                                      {
    Log.v(TAG, "Sending 'next' message.");
    channel.invokeMethod(
        "TextInputClient.performAction", Arrays.asList(inputClientId, "TextInputAction.next"));
  }

◆ performPrivateCommand()

void io.flutter.embedding.engine.systemchannels.TextInputChannel.performPrivateCommand	(	int	inputClientId,
		@NonNull String	action,
		@NonNull Bundle	data
	)

inline

Definition at line 339 of file TextInputChannel.java.

                                                                       {
    HashMap<Object, Object> json = new HashMap<>();
    json.put("action", action);
    if (data != null) {
      HashMap<String, Object> dataMap = new HashMap<>();
      Set<String> keySet = data.keySet();
      for (String key : keySet) {
        Object value = data.get(key);
        if (value instanceof byte[]) {
          dataMap.put(key, data.getByteArray(key));
        } else if (value instanceof Byte) {
          dataMap.put(key, data.getByte(key));
        } else if (value instanceof char[]) {
          dataMap.put(key, data.getCharArray(key));
        } else if (value instanceof Character) {
          dataMap.put(key, data.getChar(key));
        } else if (value instanceof CharSequence[]) {
          dataMap.put(key, data.getCharSequenceArray(key));
        } else if (value instanceof CharSequence) {
          dataMap.put(key, data.getCharSequence(key));
        } else if (value instanceof float[]) {
          dataMap.put(key, data.getFloatArray(key));
        } else if (value instanceof Float) {
          dataMap.put(key, data.getFloat(key));
        }
      }
      json.put("data", dataMap);
    }
    channel.invokeMethod(
        "TextInputClient.performPrivateCommand", Arrays.asList(inputClientId, json));
  }

◆ previous()

void io.flutter.embedding.engine.systemchannels.TextInputChannel.previous ( int inputClientId )

inline

Instructs Flutter to execute a "previous" action.

Definition at line 317 of file TextInputChannel.java.

                                          {
    Log.v(TAG, "Sending 'previous' message.");
    channel.invokeMethod(
        "TextInputClient.performAction", Arrays.asList(inputClientId, "TextInputAction.previous"));
  }

◆ requestExistingInputState()

void io.flutter.embedding.engine.systemchannels.TextInputChannel.requestExistingInputState ( )

inline

Instructs Flutter to reattach the last active text input client, if any.

This is necessary when the view hierarchy has been detached and reattached to a io.flutter.embedding.engine.FlutterEngine, as the engine may have kept alive a text editing client on the Dart side.

Definition at line 180 of file TextInputChannel.java.

                                          {
    channel.invokeMethod("TextInputClient.requestExistingInputState", null);
  }

◆ search()

void io.flutter.embedding.engine.systemchannels.TextInputChannel.search ( int inputClientId )

inline

Instructs Flutter to execute a "search" action.

Definition at line 289 of file TextInputChannel.java.

                                        {
    Log.v(TAG, "Sending 'search' message.");
    channel.invokeMethod(
        "TextInputClient.performAction", Arrays.asList(inputClientId, "TextInputAction.search"));
  }

◆ send()

void io.flutter.embedding.engine.systemchannels.TextInputChannel.send ( int inputClientId )

inline

Instructs Flutter to execute a "send" action.

Definition at line 296 of file TextInputChannel.java.

                                      {
    Log.v(TAG, "Sending 'send' message.");
    channel.invokeMethod(
        "TextInputClient.performAction", Arrays.asList(inputClientId, "TextInputAction.send"));
  }

◆ setTextInputMethodHandler()

void io.flutter.embedding.engine.systemchannels.TextInputChannel.setTextInputMethodHandler ( @Nullable TextInputMethodHandler textInputMethodHandler )

inline

Sets the TextInputMethodHandler which receives all events and requests that are parsed from the underlying platform channel.

Definition at line 376 of file TextInputChannel.java.

                                                                                                 {
    this.textInputMethodHandler = textInputMethodHandler;
  }

◆ unspecifiedAction()

void io.flutter.embedding.engine.systemchannels.TextInputChannel.unspecifiedAction ( int inputClientId )

inline

Instructs Flutter to execute an "unspecified" action.

Definition at line 324 of file TextInputChannel.java.

                                                   {
    Log.v(TAG, "Sending 'unspecified' message.");
    channel.invokeMethod(
        "TextInputClient.performAction",
        Arrays.asList(inputClientId, "TextInputAction.unspecified"));
  }

◆ updateEditingState()

void io.flutter.embedding.engine.systemchannels.TextInputChannel.updateEditingState	(	int	inputClientId,
		@NonNull String	text,
		int	selectionStart,
		int	selectionEnd,
		int	composingStart,
		int	composingEnd
	)

inline

Instructs Flutter to update its text input editing state to reflect the given configuration.

Definition at line 209 of file TextInputChannel.java.

                        {
    Log.v(
        TAG,
        "Sending message to update editing state: \n"
            + "Text: "
            + text
            + "\n"
            + "Selection start: "
            + selectionStart
            + "\n"
            + "Selection end: "
            + selectionEnd
            + "\n"
            + "Composing start: "
            + composingStart
            + "\n"
            + "Composing end: "
            + composingEnd);
 
    final HashMap<Object, Object> state =
        createEditingStateJSON(text, selectionStart, selectionEnd, composingStart, composingEnd);
 
    channel.invokeMethod("TextInputClient.updateEditingState", Arrays.asList(inputClientId, state));
  }

◆ updateEditingStateWithDeltas()

void io.flutter.embedding.engine.systemchannels.TextInputChannel.updateEditingStateWithDeltas	(	int	inputClientId,
		@NonNull ArrayList< TextEditingDelta >	batchDeltas
	)

inline

Definition at line 240 of file TextInputChannel.java.

                                                                           {
 
    Log.v(
        TAG,
        "Sending message to update editing state with deltas: \n"
            + "Number of deltas: "
            + batchDeltas.size());
 
    final HashMap<Object, Object> state = createEditingDeltaJSON(batchDeltas);
 
    channel.invokeMethod(
        "TextInputClient.updateEditingStateWithDeltas", Arrays.asList(inputClientId, state));
  }

◆ updateEditingStateWithTag()

void io.flutter.embedding.engine.systemchannels.TextInputChannel.updateEditingStateWithTag	(	int	inputClientId,
		@NonNull HashMap< String, TextEditState >	editStates
	)

inline

Definition at line 255 of file TextInputChannel.java.

                                                                             {
    Log.v(
        TAG,
        "Sending message to update editing state for "
            + String.valueOf(editStates.size())
            + " field(s).");
 
    final HashMap<String, HashMap<Object, Object>> json = new HashMap<>();
    for (Map.Entry<String, TextEditState> element : editStates.entrySet()) {
      final TextEditState state = element.getValue();
      json.put(
          element.getKey(),
          createEditingStateJSON(state.text, state.selectionStart, state.selectionEnd, -1, -1));
    }
    channel.invokeMethod(
        "TextInputClient.updateEditingStateWithTag", Arrays.asList(inputClientId, json));
  }

Member Data Documentation

◆ channel

final MethodChannel io.flutter.embedding.engine.systemchannels.TextInputChannel.channel

Definition at line 47 of file TextInputChannel.java.

◆ parsingMethodHandler

final MethodChannel.MethodCallHandler io.flutter.embedding.engine.systemchannels.TextInputChannel.parsingMethodHandler

package

Definition at line 51 of file TextInputChannel.java.

                                            {
        @Override
        public void onMethodCall(@NonNull MethodCall call, @NonNull MethodChannel.Result result) {
          if (textInputMethodHandler == null) {
            // If no explicit TextInputMethodHandler has been registered then we don't
            // need to forward this call to an API. Return.
            return;
          }
 
          String method = call.method;
          Object args = call.arguments;
          Log.v(TAG, "Received '" + method + "' message.");
          switch (method) {
            case "TextInput.show":
              textInputMethodHandler.show();
              result.success(null);
              break;
            case "TextInput.hide":
              textInputMethodHandler.hide();
              result.success(null);
              break;
            case "TextInput.setClient":
              try {
                final JSONArray argumentList = (JSONArray) args;
                final int textInputClientId = argumentList.getInt(0);
                final JSONObject jsonConfiguration = argumentList.getJSONObject(1);
                textInputMethodHandler.setClient(
                    textInputClientId, Configuration.fromJson(jsonConfiguration));
                result.success(null);
              } catch (JSONException | NoSuchFieldException exception) {
                // JSONException: missing keys or bad value types.
                // NoSuchFieldException: one or more values were invalid.
                result.error("error", exception.getMessage(), null);
              }
              break;
            case "TextInput.requestAutofill":
              textInputMethodHandler.requestAutofill();
              result.success(null);
              break;
            case "TextInput.setPlatformViewClient":
              try {
                final JSONObject arguments = (JSONObject) args;
                final int platformViewId = arguments.getInt("platformViewId");
                final boolean usesVirtualDisplay =
                    arguments.optBoolean("usesVirtualDisplay", false);
                textInputMethodHandler.setPlatformViewClient(platformViewId, usesVirtualDisplay);
                result.success(null);
              } catch (JSONException exception) {
                result.error("error", exception.getMessage(), null);
              }
              break;
            case "TextInput.setEditingState":
              try {
                final JSONObject editingState = (JSONObject) args;
                textInputMethodHandler.setEditingState(TextEditState.fromJson(editingState));
                result.success(null);
              } catch (JSONException exception) {
                result.error("error", exception.getMessage(), null);
              }
              break;
            case "TextInput.setEditableSizeAndTransform":
              try {
                final JSONObject arguments = (JSONObject) args;
                final double width = arguments.getDouble("width");
                final double height = arguments.getDouble("height");
                final JSONArray jsonMatrix = arguments.getJSONArray("transform");
                final double[] matrix = new double[16];
                for (int i = 0; i < 16; i++) {
                  matrix[i] = jsonMatrix.getDouble(i);
                }
 
                textInputMethodHandler.setEditableSizeAndTransform(width, height, matrix);
                result.success(null);
              } catch (JSONException exception) {
                result.error("error", exception.getMessage(), null);
              }
              break;
            case "TextInput.clearClient":
              textInputMethodHandler.clearClient();
              result.success(null);
              break;
            case "TextInput.sendAppPrivateCommand":
              try {
                final JSONObject arguments = (JSONObject) args;
                final String action = arguments.getString("action");
                final String data = arguments.getString("data");
                Bundle bundle = null;
                if (data != null && !data.isEmpty()) {
                  bundle = new Bundle();
                  bundle.putString("data", data);
                }
                textInputMethodHandler.sendAppPrivateCommand(action, bundle);
                result.success(null);
              } catch (JSONException exception) {
                result.error("error", exception.getMessage(), null);
              }
              break;
            case "TextInput.finishAutofillContext":
              textInputMethodHandler.finishAutofillContext((boolean) args);
              result.success(null);
              break;
            default:
              result.notImplemented();
              break;
          }
        }
      };

The documentation for this class was generated from the following file:

shell/platform/android/io/flutter/embedding/engine/systemchannels/TextInputChannel.java

Classes

Public Member Functions

Public Attributes

Package Attributes

Detailed Description

Constructor & Destructor Documentation

◆ TextInputChannel()

Member Function Documentation

◆ commitContent()

◆ done()

◆ go()

◆ newline()

◆ next()

◆ performPrivateCommand()

◆ previous()

◆ requestExistingInputState()

◆ search()

◆ send()

◆ setTextInputMethodHandler()

◆ unspecifiedAction()

◆ updateEditingState()

◆ updateEditingStateWithDeltas()

◆ updateEditingStateWithTag()

Member Data Documentation

◆ channel

◆ parsingMethodHandler