Mengontrol dan menganimasikan keyboard virtual

Dengan menggunakan WindowInsetsCompat, aplikasi Anda dapat mengkueri dan mengontrol keyboard virtual (juga disebut IME) mirip dengan caranya berinteraksi dengan kolom sistem. Aplikasi juga dapat menggunakan WindowInsetsAnimationCompat untuk membuat transisi yang lancar saat keyboard virtual dibuka atau ditutup.

Gambar 1. Dua contoh transisi terbuka-tertutup keyboard virtual.

Prasyarat

Sebelum menyiapkan kontrol dan animasi untuk keyboard virtual, konfigurasikan aplikasi Anda untuk menampilkan layar penuh. Hal ini memungkinkannya menangani inset jendela sistem seperti kolom sistem dan keyboard virtual.

Periksa visibilitas software keyboard

Gunakan WindowInsets untuk memeriksa visibilitas keyboard software.

Kotlin

val insets = ViewCompat.getRootWindowInsets(view) ?: return
val imeVisible = insets.isVisible(WindowInsetsCompat.Type.ime())
val imeHeight = insets.getInsets(WindowInsetsCompat.Type.ime()).bottom

Java

WindowInsetsCompat insets = ViewCompat.getRootWindowInsets(view);
boolean imeVisible = insets.isVisible(WindowInsetsCompat.Type.ime());
int imeHeight = insets.getInsets(WindowInsetsCompat.Type.ime()).bottom;

Atau, Anda dapat menggunakan ViewCompat.setOnApplyWindowInsetsListener untuk mengamati perubahan pada visibilitas keyboard software.

Kotlin

ViewCompat.setOnApplyWindowInsetsListener(view) { _, insets ->
  val imeVisible = insets.isVisible(WindowInsetsCompat.Type.ime())
  val imeHeight = insets.getInsets(WindowInsetsCompat.Type.ime()).bottom
  insets
}

Java

ViewCompat.setOnApplyWindowInsetsListener(view, (v, insets) -> {
  boolean imeVisible = insets.isVisible(WindowInsetsCompat.Type.ime());
  int imeHeight = insets.getInsets(WindowInsetsCompat.Type.ime()).bottom;
  return insets;
});

Menyinkronkan animasi dengan keyboard virtual

Pengguna mengetuk kolom input teks akan menyebabkan keyboard bergeser ke tempatnya dari bagian bawah layar, seperti yang ditunjukkan dalam contoh berikut:

Gambar 2. Animasi keyboard yang disinkronkan.

  • Contoh berlabel "Tidak disinkronkan" pada gambar 2 menunjukkan perilaku default di Android 10 (level API 29), yaitu kolom teks dan konten aplikasi masuk ke tempatnya, bukan menyinkronkan dengan animasi keyboard—perilaku yang dapat terlihat janggal secara visual.

  • Di Android 11 (level API 30) dan yang lebih tinggi, Anda dapat menggunakan WindowInsetsAnimationCompat untuk menyinkronkan transisi aplikasi dengan keyboard yang bergeser ke atas dan ke bawah dari bagian bawah layar. Tampilannya terlihat lebih lancar, seperti ditunjukkan dalam contoh berlabel "Disinkronkan" dalam gambar 2.

Konfigurasi WindowInsetsAnimationCompat.Callback dengan tampilan yang akan disinkronkan dengan animasi keyboard.

Kotlin

ViewCompat.setWindowInsetsAnimationCallback(
  view,
  object : WindowInsetsAnimationCompat.Callback(DISPATCH_MODE_STOP) {
    // Override methods.
  }
)

Java

ViewCompat.setWindowInsetsAnimationCallback(
    view,
    new WindowInsetsAnimationCompat.Callback(
        WindowInsetsAnimationCompat.Callback.DISPATCH_MODE_STOP
    ) {
      // Override methods.
    });

Ada beberapa metode yang dapat diganti di WindowInsetsAnimationCompat.Callback, yaitu onPrepare(), onStart(), onProgress(), dan onEnd(). Mulailah dengan memanggil onPrepare() sebelum tata letak berubah.

onPrepare dipanggil saat animasi inset dimulai dan sebelum tampilan ditata ulang karena animasi. Anda dapat menggunakannya untuk menyimpan status awal, yang dalam hal ini adalah koordinat bawah tampilan.

Gambar yang menunjukkan koordinat bawah status awal dari tampilan root.
Gambar 3. Menggunakan onPrepare() untuk merekam status awal.

Cuplikan berikut menunjukkan contoh panggilan ke onPrepare:

Kotlin

var startBottom = 0f

override fun onPrepare(
  animation: WindowInsetsAnimationCompat
) {
  startBottom = view.bottom.toFloat()
}

Java

float startBottom;

@Override
public void onPrepare(
    @NonNull WindowInsetsAnimationCompat animation
) {
  startBottom = view.getBottom();
}

onStart dipanggil saat animasi inset dimulai. Anda dapat menggunakannya untuk menyetel semua properti tampilan ke status akhir perubahan tata letak. Jika Anda memiliki callback OnApplyWindowInsetsListener yang disetel ke salah satu tampilan, callback tersebut sudah dipanggil pada tahap ini. Ini adalah waktu yang tepat untuk menyimpan status akhir properti tampilan.

Gambar yang menunjukkan koordinat bawah status akhir tampilan
Gambar 4. Menggunakan onStart() untuk merekam status akhir.

Cuplikan berikut menunjukkan contoh panggilan ke onStart:

Kotlin

var endBottom = 0f

override fun onStart(
  animation: WindowInsetsAnimationCompat,
  bounds: WindowInsetsAnimationCompat.BoundsCompat
): WindowInsetsAnimationCompat.BoundsCompat {
  // Record the position of the view after the IME transition.
  endBottom = view.bottom.toFloat()

  return bounds
}

Java

float endBottom;

@NonNull
@Override
public WindowInsetsAnimationCompat.BoundsCompat onStart(
    @NonNull WindowInsetsAnimationCompat animation,
    @NonNull WindowInsetsAnimationCompat.BoundsCompat bounds
) {
  endBottom = view.getBottom();
  return bounds;
}

onProgress dipanggil saat inset berubah sebagai bagian dari menjalankan animasi, sehingga Anda dapat menggantinya dan diberi tahu di setiap frame selama animasi keyboard. Update properti tampilan agar tampilan beranimasi dengan keyboard.

Semua perubahan tata letak sudah selesai di tahap ini. Misalnya, jika Anda menggunakan View.translationY untuk menggeser tampilan, nilai akan menurun secara bertahap untuk setiap panggilan metode ini dan pada akhirnya mencapai 0 ke posisi tata letak asal.

Gambar 5. Menggunakan onProgress() untuk menyinkronkan animasi.

Cuplikan berikut menunjukkan contoh panggilan ke onProgress:

Kotlin

override fun onProgress(
  insets: WindowInsetsCompat,
  runningAnimations: MutableList<WindowInsetsAnimationCompat>
): WindowInsetsCompat {
  // Find an IME animation.
  val imeAnimation = runningAnimations.find {
    it.typeMask and WindowInsetsCompat.Type.ime() != 0
  } ?: return insets

  // Offset the view based on the interpolated fraction of the IME animation.
  view.translationY =
    (startBottom - endBottom) * (1 - imeAnimation.interpolatedFraction)

  return insets
}

Java

@NonNull
@Override
public WindowInsetsCompat onProgress(
    @NonNull WindowInsetsCompat insets,
    @NonNull List<WindowInsetsAnimationCompat> runningAnimations
) {
  // Find an IME animation.
  WindowInsetsAnimationCompat imeAnimation = null;
  for (WindowInsetsAnimationCompat animation : runningAnimations) {
    if ((animation.getTypeMask() & WindowInsetsCompat.Type.ime()) != 0) {
      imeAnimation = animation;
      break;
    }
  }
  if (imeAnimation != null) {
    // Offset the view based on the interpolated fraction of the IME animation.
    view.setTranslationY((startBottom - endBottom)

        *   (1 - imeAnimation.getInterpolatedFraction()));
  }
  return insets;
}

Secara opsional, Anda dapat mengganti onEnd. Metode ini dipanggil setelah animasi selesai. Ini adalah saat yang tepat untuk membersihkan perubahan sementara.

Referensi lainnya