Codelab SystemUIOverlayWindow

Halaman ini menjelaskan cara membuat tampilan di SystemUIOverlayWindow.

Sebelum memulai

Konten yang disediakan di bawah menganggap Anda telah membaca artikel UI Sistem ini:

Artikel ini:

  • Menganggap Anda sudah memahami kasus penggunaan Android Automotive OS dan SystemUIOverlayWindow.
  • Memberikan contoh subclass OverlayViewController tertentu.
  • Tidak menangani subclass dari OverlayViewController.
  • Tidak menjelaskan cara menyiapkan Android untuk pengembangan.
  • Tidak menjelaskan setiap opsi yang dapat diganti di class dasar. Melainkan mendeskripsikan yang dibutuhkan untuk menyiapkan tampilan dasar.

Menyelesaikan codelab

Langkah 1: Buat tata letak untuk OverlayViewController

Membuat file bernama frameworks/base/packages/CarSystemUI/res/layout/codelab_layout.xml untuk memuat hal-hal berikut: 

<?xml version="1.0" encoding="utf-8"?>
<FrameLayout
    xmlns:android="http://schemas.android.com/apk/res/android"
    android:id="@+id/codelab_container"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    android:background="@android:color/black">
    <LinearLayout
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        android:orientation="vertical">
        <TextView
            android:layout_width="match_parent"
            android:layout_height="0dp"
            android:layout_weight="1"
            android:gravity="center"
            android:text="Code Lab View!"
            android:color="@*android:color/car_accent"
            android:textStyle="italic"
            android:textSize="34sp"/>
        <Button
            android:id="@+id/codelab_button"
            android:layout_width="match_parent"
            android:layout_height="wrap_content"
            android:layout_weight="0"
            android:text="Hide!"
            android:background="@*android:color/car_accent"/>
    </LinearLayout>
</FrameLayout>

Tata letak ini membuat tampilan berikut:

OverlayViewController
Gambar 1. OverlayViewController

Langkah 2: Menambahkan ViewStub ke SysUIOverlayWindow

Tambahkan tampilan ke jendela Anda dengan menambahkan sebuah ViewStub ke SystemUIOverlayWindow.

Tambahkan kode berikut ke frameworks/base/packages/CarSystemUI/res/layout/sysui_overlay_window.xml di FrameLayout root: 

<ViewStub android:id="@+id/codelab_stub"
          android:layout_width="match_parent"
          android:layout_height="match_parent"
          android:layout="@layout/codelab_layout"/>

Urutan ViewStubs didefinisikan dalam FrameLayout root akan menentukan Pengurutan Z tampilan di jendela. Karena codelab ini tidak melibatkan tampilan pelapisan, Anda dapat tambahkan cuplikan kode di mana saja di root FrameLayout.

Langkah 3: Buat OverlayViewController

Agar ditampilkan dan disembunyikan, tata letak baru harus ditautkan ke OverlayViewController.

Untuk membuat OverlayViewController yang dapat dimasukkan bernama frameworks/base/packages/CarSystemUI/src/com/android/systemui/car/codelab/CodeLabViewController.java dengan konten berikut:

package com.android.systemui.car.codelab;

import com.android.systemui.R;
import com.android.systemui.car.window.OverlayViewController;
import com.android.systemui.car.window.OverlayViewGlobalStateController;
import com.android.systemui.dagger.SysUISingleton;

import javax.inject.Singleton;

@SysUISingleton
public class CodeLabViewController extends OverlayViewController {

    @Inject
    public CodeLabViewController(
            OverlayViewGlobalStateController overlayViewGlobalStateController) {
        super(R.id.codelab_stub, overlayViewGlobalStateController);
    }
}

Langkah 4: Buat OverlayViewMediator

Channel OverlayViewMediator yang akan dipicu saat tampilan baru ditampilkan atau disembunyikan diperlukan.

Buat OverlayViewMediator baru yang dapat dimasukkan bernama frameworks/base/packages/CarSystemUI/src/com/android/systemui/car/codelab/CodeLabViewMediator.java dengan konten berikut: 
package com.android.systemui.car.codelab;


import android.bluetooth.BluetoothAdapter;
import android.content.BroadcastReceiver;
import android.content.Context;
import android.content.Intent;
import android.content.IntentFilter;


import com.android.systemui.car.window.OverlayViewMediator;
import com.android.systemui.dagger.SysUISingleton;


import javax.inject.Inject;


@SysUISingleton
public class CodeLabViewMediator implements OverlayViewMediator {
    Context mContext;
    CodeLabViewController mCodeLabViewController;


    @Inject
    public CodeLabViewMediator(Context context, CodeLabViewController codeLabViewController) {
        mContext = context;
        mCodeLabViewController = codeLabViewController;
    }


    @Override
    public void registerListeners() {
        // no-op
    }


    @Override
    public void setupOverlayContentViewControllers() {
        // no-op
    }
}

Langkah 5: Tampilkan tampilan

Untuk memudahkan pemahaman dan memicu tampilan, gunakan Bluetooth saat status nonaktif.

Ganti // no-op di CodeLabViewMediator#registerListeners dengan hal berikut:

// Register Show Listener
mContext.registerReceiver(new BroadcastReceiver() {
    @Override
    public void onReceive(Context context, Intent intent) {
        final String action = intent.getAction();


        if (action.equals(BluetoothAdapter.ACTION_STATE_CHANGED)) {
            final int state = intent.getIntExtra(BluetoothAdapter.EXTRA_STATE,
                    BluetoothAdapter.ERROR);
            switch (state) {
                case BluetoothAdapter.STATE_OFF:
                    // Show OverlayViewController
                    mCodeLabViewController.start();
                    break;
            }
        }
    }
}, new IntentFilter(BluetoothAdapter.ACTION_STATE_CHANGED));

Langkah 6: Sembunyikan tampilan

Tampilan akan disembunyikan ketika tanda "Sembunyikan!" diklik. Karena tindakan ini hanya pada tombol tampilan yang di-inflate, tambahkan langsung kepada Anda OverlayViewController.

Tambahkan metode berikut ke CodeLabViewController:

@Override
protected void onFinishInflate() {
    getLayout().findViewById(R.id.codelab_button).setOnClickListener(v -> {
        stop();
    });
}

Langkah 7: Konfigurasikan OverlayViewMediator baru

  1. Untuk menambahkan OverlayViewMediator baru ke OverlayWindowModule, tambahkan kode berikut ke OverlayWindowModule: 
    /** Injects CodeLabViewMediator. */
@Binds
@IntoMap
@ClassKey(CodeLabViewMediator.class)
public abstract OverlayViewMediator bindCodeLabViewMediator(
        CodeLabViewMediator overlayViewsMediator);
  2. Untuk menambahkan OverlayViewMediator baru ke config_carSystemUIOverlayViewsMediators, tambahkan baris berikut ke config_carSystemUIOverlayViewsMediators dalam frameworks/base/packages/CarSystemUI/res/values/config.xml: 
    <item>com.android.systemui.car.codelab.CodeLabViewMediator</item>

Hasil

Selamat! Anda membuat tampilan di SystemUIOverlayWindow:

SistemUIOverlayWindow
Gambar 2. SystemUIOverlayWindow

Referensi lainnya

Untuk mempelajari lebih lanjut, lihat referensi yang disediakan di bawah.

Contoh OverlayViewController

Lihat pengalih pengguna layar penuh sebagai aplikasi langsung dari SystemUIOverlayWindow::

OverlayViewController Lainnya

OverlayPanelViewController

Channel OverlayPanelViewController digunakan untuk menyediakan animasi penarikan dasar saat menampilkan dan menyembunyikan tampilan di dalam SystemUIOverlayWindow. Lihat panel Notifikasi untuk mempelajari lebih lanjut: