SystemUIOverlayWindow Codelab

このページでは、 SystemUIOverlayWindowでビューを作成する方法を説明します。

始める前に

以下に提供されるコンテンツは、次のシステム UI 記事を読んでいることを前提としています。

• システムUIの実装
• SystemUIOverlayWindow 管理システム

この記事：

• Android Automotive OS とそのSystemUIOverlayWindowの使用例に精通していることを前提としています。
• OverlayViewControllerの特定のサブクラスの例を提供します。
• OverlayViewControllerのサブクラスには対応しません。
• 開発用に Android をセットアップする方法については説明しません。
• 基本クラスでオーバーライドできる各オプションについては説明しません。むしろ、基本的なビューを設定するために必要なものだけを説明します。

コードラボを完了する

ステップ 1: OverlayViewController のレイアウトを作成する

以下を含むframeworks/base/packages/CarSystemUI/res/layout/codelab_layout.xmlという名前のファイルを作成します。

<?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>

このレイアウトでは次のビューが作成されます。

ステップ 2: ViewStub を SysUIOverlayWindow に追加する

ViewStubをSystemUIOverlayWindowに追加して、ビューをウィンドウに追加します。

次のコードをルートFrameLayout frameworks/base/packages/CarSystemUI/res/layout/sysui_overlay_window.xmlに追加します:

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

ルートFrameLayoutで ViewStub が定義される順序によって、ウィンドウ内のビューの Z 順序が定義されます。このコードラボにはビューの階層化が含まれないため、ルートFrameLayoutのどこにでもコード スニペットを追加できます。

ステップ 3: OverlayViewController を作成する

表示および非表示を切り替えるには、新しいレイアウトをOverlayViewControllerにリンクする必要があります。

次の内容を含むframeworks/base/packages/CarSystemUI/src/com/android/systemui/car/codelab/CodeLabViewController.java名前の注入可能なOverlayViewControllerを作成するには、次の手順を実行します。

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);
    }
}

ステップ 4: OverlayViewMediator を作成する

新しいビューが表示または非表示になったときにトリガーするOverlayViewMediatorが必要です。

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
    }
}

ステップ 5: ビューを表示する

理解を容易にし、ビューをトリガーするには、ステータスがオフのときに Bluetooth を使用します。

CodeLabViewMediator#registerListenersの// no-op次のように置き換えます。

// 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));

ステップ 6: ビューを非表示にする

「Hide!」ボタンを押すとビューが非表示になります。ボタンがクリックされました。このアクションはインフレートされたビューのボタン上でのみ行われるため、これをOverlayViewControllerに直接追加します。

次のメソッドをCodeLabViewControllerに追加します。

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

ステップ 7: 新しい OverlayViewMediator を構成する

1. 新しい OverlayViewMediator を OverlayWindowModule に追加するには、次のコードをOverlayWindowModuleに追加します。

   /** Injects CodeLabViewMediator. */
   @Binds
   @IntoMap
   @ClassKey(CodeLabViewMediator.class)
   public abstract OverlayViewMediator bindCodeLabViewMediator(
           CodeLabViewMediator overlayViewsMediator);
   

2. 新しい OverlayViewMediator を config_carSystemUIOverlayViewsMediators に追加するには、 frameworks/base/packages/CarSystemUI/res/values/config.xmlのconfig_carSystemUIOverlayViewsMediatorsに次の行を追加します。

   <item>com.android.systemui.car.codelab.CodeLabViewMediator</item>
   

結果

おめでとう！ SystemUIOverlayWindowにビューを作成しました。

追加のリソース

詳細については、以下のリソースを参照してください。

OverlayViewController のサンプル

SystemUIOverlayWindow:の直接的なアプリケーションとしての全画面ユーザー スイッチャーを参照してください。

• フルスクリーンユーザースイッチャービューコントローラー
• フルスクリーンユーザースイッチャービューメディエーター

その他の OverlayViewController

オーバーレイパネルビューコントローラー

OverlayPanelViewControllerは、 SystemUIOverlayWindow内でビューを表示または非表示にするときに、基本的なドラッグ アニメーションを提供するために使用されます。詳細については、通知パネルを参照してください。

• 通知パネルビューコントローラー
• 通知パネルビューメディエーター