io.flutter.embedding.android.KeyData Class Reference

Classes
enum	DeviceType
enum	Type

Public Member Functions
	KeyData ()
	KeyData (@NonNull ByteBuffer buffer)

Static Public Attributes
static final String	CHANNEL = "flutter/keydata"

Package Functions
ByteBuffer	toBytes ()

Package Attributes
long	timestamp
Type	type
long	physicalKey
long	logicalKey
boolean	synthesized
DeviceType	deviceType
String	character

Detailed Description

The resulting Flutter key events generated by KeyEmbedderResponder, and are sent through the messenger after being marshalled with toBytes().

This class is the Java adaption of KeyData and KeyDataPacket in the C engine. Changes made to either side must also be made to the other.

Each KeyData corresponds to a ui.KeyData in the framework.

Definition at line 22 of file KeyData.java.

Constructor & Destructor Documentation

KeyData() [1/2]

io.flutter.embedding.android.KeyData.KeyData ( )

inline

Creates an empty KeyData.

Definition at line 107 of file KeyData.java.

{}

KeyData() [2/2]

io.flutter.embedding.android.KeyData.KeyData ( @NonNull ByteBuffer  buffer )

inline

Unmarshal fields from a buffer.

For the binary format, see lib/ui/window/key_data_packet.h.

Definition at line 114 of file KeyData.java.

                                             {
    final long charSize = buffer.getLong();
    this.timestamp = buffer.getLong();
    this.type = Type.fromLong(buffer.getLong());
    this.physicalKey = buffer.getLong();
    this.logicalKey = buffer.getLong();
    this.synthesized = buffer.getLong() != 0;
    this.deviceType = DeviceType.fromLong(buffer.getLong());
 
    if (buffer.remaining() != charSize) {
      throw new AssertionError(
          String.format(
              "Unexpected char length: charSize is %d while buffer has position %d, capacity %d, limit %d",
              charSize, buffer.position(), buffer.capacity(), buffer.limit()));
    }
    this.character = null;
    if (charSize != 0) {
      final byte[] strBytes = new byte[(int) charSize];
      buffer.get(strBytes, 0, (int) charSize);
      try {
        this.character = new String(strBytes, "UTF-8");
      } catch (UnsupportedEncodingException e) {
        throw new AssertionError("UTF-8 unsupported");
      }
    }
  }

Member Function Documentation

toBytes()

ByteBuffer io.flutter.embedding.android.KeyData.toBytes ( )

inlinepackage

Marshal the key data to a new byte buffer.

For the binary format, see lib/ui/window/key_data_packet.h.

Returns

the marshalled bytes.

Definition at line 158 of file KeyData.java.

                       {
    byte[] charBytes;
    try {
      charBytes = character == null ? null : character.getBytes("UTF-8");
    } catch (UnsupportedEncodingException e) {
      throw new AssertionError("UTF-8 not supported");
    }
    final int charSize = charBytes == null ? 0 : charBytes.length;
    final ByteBuffer packet =
        ByteBuffer.allocateDirect((1 + FIELD_COUNT) * BYTES_PER_FIELD + charSize);
    packet.order(ByteOrder.LITTLE_ENDIAN);
 
    packet.putLong(charSize);
    packet.putLong(timestamp);
    packet.putLong(type.getValue());
    packet.putLong(physicalKey);
    packet.putLong(logicalKey);
    packet.putLong(synthesized ? 1L : 0L);
    packet.putLong(deviceType.getValue());
    if (charBytes != null) {
      packet.put(charBytes);
    }
 
    return packet;
  }

Member Data Documentation

CHANNEL

final String io.flutter.embedding.android.KeyData.CHANNEL = "flutter/keydata"

static

The channel that key data should be sent through.

Must be kept in sync with kFlutterKeyDataChannel in embedder.cc

Definition at line 30 of file KeyData.java.

character

String io.flutter.embedding.android.KeyData.character

package

The character of this key data encoded in UTF-8.

Definition at line 149 of file KeyData.java.

deviceType

DeviceType io.flutter.embedding.android.KeyData.deviceType

package

Definition at line 146 of file KeyData.java.

logicalKey

long io.flutter.embedding.android.KeyData.logicalKey

package

Definition at line 144 of file KeyData.java.

physicalKey

long io.flutter.embedding.android.KeyData.physicalKey

package

Definition at line 143 of file KeyData.java.

synthesized

boolean io.flutter.embedding.android.KeyData.synthesized

package

Definition at line 145 of file KeyData.java.

timestamp

long io.flutter.embedding.android.KeyData.timestamp

package

Definition at line 141 of file KeyData.java.

type

Type io.flutter.embedding.android.KeyData.type

package

Definition at line 142 of file KeyData.java.

---

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

• shell/platform/android/io/flutter/embedding/android/KeyData.java