Codelab SystemUIOverlayWindow

Esta página explica como criar uma visualização no SystemUIOverlayWindow .

Antes que você comece

O conteúdo fornecido abaixo pressupõe que você leu estes artigos da UI do sistema:

Este artigo:

  • Presume-se que você esteja familiarizado com os casos de uso do sistema operacional Android Automotive e de seu SystemUIOverlayWindow .
  • Fornece exemplos de determinadas subclasses do OverlayViewController .
  • Não aborda subclasses do OverlayViewController .
  • Não explica como configurar o Android para desenvolvimento.
  • Não descreve cada opção que pode ser substituída nas classes base. Em vez disso, descreve apenas aqueles necessários para configurar uma visão básica.

Conclua o codelab

Etapa 1: crie um layout para o OverlayViewController

Crie um arquivo chamado frameworks/base/packages/CarSystemUI/res/layout/codelab_layout.xml para conter o seguinte:

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

Esse layout cria a seguinte visualização:

OverlayViewController
Figura 1. OverlayViewController

Etapa 2: adicionar um ViewStub ao SysUIOverlayWindow

Adicione a visualização à sua janela adicionando um ViewStub ao SystemUIOverlayWindow .

Adicione o seguinte código a frameworks/base/packages/CarSystemUI/res/layout/sysui_overlay_window.xml na raiz FrameLayout :

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

A ordem em que ViewStubs são definidos no FrameLayout raiz define a ordem Z das visualizações na janela. Como este codelab não envolve visualizações em camadas, você pode adicionar o snippet de código em qualquer lugar da raiz FrameLayout .

Etapa 3: crie um OverlayViewController

Para ser mostrado e ocultado, o novo layout deve estar vinculado a um OverlayViewController .

Para criar um OverlayViewController injetável denominado frameworks/base/packages/CarSystemUI/src/com/android/systemui/car/codelab/CodeLabViewController.java com o seguinte conteúdo:

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

Etapa 4: crie um OverlayViewMediator

É necessário um OverlayViewMediator para ser acionado quando uma nova visualização é mostrada ou ocultada.

Crie um novo OverlayViewMediator injetável chamado frameworks/base/packages/CarSystemUI/src/com/android/systemui/car/codelab/CodeLabViewMediator.java com o seguinte conteúdo:
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
    }
}

Etapa 5: mostrar a visualização

Para facilitar a compreensão e acionar a nossa visualização, use o Bluetooth quando o status estiver desativado.

Substitua // no-op em CodeLabViewMediator#registerListeners pelo seguinte:

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

Etapa 6: ocultar a visualização

A visualização ficará oculta quando a opção "Ocultar!" botão é clicado. Como esta ação ocorre apenas no botão da visualização inflada, adicione-a diretamente a você OverlayViewController .

Adicione o seguinte método ao CodeLabViewController :

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

Etapa 7: configurar o novo OverlayViewMediator

  1. Para adicionar o novo OverlayViewMediator ao OverlayWindowModule, adicione o seguinte código ao OverlayWindowModule :
    /** Injects CodeLabViewMediator. */
    @Binds
    @IntoMap
    @ClassKey(CodeLabViewMediator.class)
    public abstract OverlayViewMediator bindCodeLabViewMediator(
                CodeLabViewMediator overlayViewsMediator);
  2. Para adicionar o novo OverlayViewMediator a config_carSystemUIOverlayViewsMediators, adicione a seguinte linha a config_carSystemUIOverlayViewsMediators em frameworks/base/packages/CarSystemUI/res/values/config.xml :
    <item>com.android.systemui.car.codelab.CodeLabViewMediator</item>

Resultado

Parabéns! Você criou uma visualização no SystemUIOverlayWindow :

Janela de sobreposição SystemUIOverlay
Figura 2. Janela SystemUIOverlay

Recursos adicionais

Para saber mais, consulte os recursos fornecidos abaixo.

Exemplo de OverlayViewController

Veja o alternador de usuário em tela cheia como uma aplicação direta de SystemUIOverlayWindow: :

Outros OverlayViewControllers

OverlayPanelViewController

Um OverlayPanelViewController é usado para fornecer animação básica de arrastar ao mostrar e ocultar visualizações dentro de SystemUIOverlayWindow . Consulte o painel de notificação para saber mais: