SystemUIOverlayWindow-Verwaltungssystem

Das SystemUIOverlayWindow Verwaltungssystem bietet Ihnen die Möglichkeit, Ansichten im SystemUIOverlayWindow anzuzeigen und zu verwalten. Derzeit wird dieses Fenster für Ansichten einschließlich des Vollbild-Benutzerwechsels, des Benachrichtigungsfelds und der Tastensperre verwendet. Diese Seite funktioniert nicht:

  • Erstellen Sie Einschränkungen hinsichtlich dessen, was der OEM dem Fenster hinzufügen kann.
  • Zwingen Sie dazu, die auf dieser Seite beschriebenen Abstraktionen zu übernehmen.

Überblick

Sie können das SystemUIOverlayWindow Verwaltungssystem verwenden, um Ansichten wie den rechtlichen Hinweis, den Vollbild-Benutzerumschalter, die Rückfahrkamera, die HVAC-Steuerung und den Tastenschutz anzuzeigen. Dieses Fenster liegt außerhalb des App-Bereichs und gibt Ihnen die Kontrolle über die Z-Reihenfolge der Ansicht, Auslöser für das Anzeigen/Verbergen und allgemeine Anpassungen, einschließlich Ansichtsplatzierung, Größe, Transparenz und Farbe. Gleichzeitig müssen Sie sich nicht um den Status von Systemleisten oder anderen System-UI-Objekten kümmern, die ausgeblendet oder angezeigt werden müssen, wenn ihre jeweilige Ansicht ausgeblendet oder angezeigt wird.

Um SystemUIOverlayWindow zu nutzen, erstellen Sie Ansichtscontroller für Ihre Ansichtsvermittler. Die Mediatoren werden an den globalen Statuscontroller des Fensters übergeben. Diese Ansichtsvermittler:

  • Koordination zwischen Ansichtscontrollern.
  • Hausgeschäftslogik für View-Controller.

View-Controller (koordiniert durch View-Mediatoren):

  • Besitze seine Ansicht.
  • Erstellen Sie Setter, über die OverlayViewsMediator Geschäftslogik anhängen kann.
  • Erstellen Sie die Animationen zum Offenlegen und Verbergen ihrer Ansicht.

SystemUIOverlayWindow Manager, eine SystemUI-Komponente, dient als Einstiegspunkt zum Initialisieren und Registrieren von Mediatoren beim globalen Statuscontroller, während der globale Statuscontroller so mit den Ansichtscontrollern verknüpft ist, dass Mediatoren die Ansichtscontroller direkt aufrufen können, um Ansichten anzuzeigen und auszublenden das Fenster.

OverlayViewController

OverlayViewController ist für die in SystemUIOverlayWindow angezeigte Ansicht verantwortlich und steuert, wie die Ansicht angezeigt und ausgeblendet wird. Es ermöglicht auch das Anhängen erforderlicher Listener, sodass es an die Geschäftslogik gebunden werden kann.

Wichtige Methodensignaturen

/**
 * Owns a {@link View} that is present in SystemUIOverlayWindow.
 */
public class OverlayViewController {

    /**
     * Shows content of {@link OverlayViewController}.
     *
     * Should be used to show view externally and in particular by {@link OverlayViewMediator}.
     */
    public final void start();

    /**
     * Hides content of {@link OverlayViewController}.
     *
     * Should be used to hide view externally and in particular by {@link OverlayViewMediator}.
     */
    public final void stop();

    /**
     * Inflate layout owned by controller.
     */
    public final void inflate(ViewGroup baseLayout);

    /**
     * Called once inflate finishes.
     */
    protected void onFinishInflate();

    /**
     * Returns {@code true} if layout owned by controller has been inflated.
     */
    public final boolean isInflated();

    /**
     * Subclasses should override this method to implement reveal animations and implement logic
     * specific to when the layout owned by the controller is shown.
     *
     * Should only be overridden by Superclass but not called by any {@link OverlayViewMediator}.
     */
    protected void showInternal();

    /**
     * Subclasses should override this method to implement conceal animations and implement logic
     * specific to when the layout owned by the controller is hidden.
     *
     * Should only be overridden by Superclass but not called by any {@link OverlayViewMediator}.
     */
    protected void hideInternal();

    /**
     * Provides access to layout owned by controller.
     */
    protected final View getLayout();

    /** Returns the {@link OverlayViewGlobalStateController}. */
    protected final OverlayViewGlobalStateController getOverlayViewGlobalStateController();

    /** Returns whether the view controlled by this controller is visible. */
    public final boolean isVisible();

    /**
     * Returns the ID of the focus area that should receive focus when this view is the
     * topmost view or {@link View#NO_ID} if there is no focus area.
     */
    @IdRes
    protected int getFocusAreaViewId();

    /** Returns whether the view controlled by this controller has rotary focus. */
    protected final boolean hasRotaryFocus();

    /**
     * Sets whether this view allows rotary focus. This should be set to {@code true} for the
     * topmost layer in the overlay window and {@code false} for the others.
     */
    public void setAllowRotaryFocus(boolean allowRotaryFocus);

    /**
     * Refreshes the rotary focus in this view if we are in rotary mode. If the view already has
     * rotary focus, it leaves the focus alone. Returns {@code true} if a new view was focused.
     */
    public boolean refreshRotaryFocusIfNeeded();

    /**
     * Returns {@code true} if heads up notifications should be displayed over this view.
     */
    protected boolean shouldShowHUN();

    /**
     * Returns {@code true} if navigation bar insets should be displayed over this view. Has no
     * effect if {@link #shouldFocusWindow} returns {@code false}.
     */
    protected boolean shouldShowNavigationBarInsets();

    /**
     * Returns {@code true} if status bar insets should be displayed over this view. Has no
     * effect if {@link #shouldFocusWindow} returns {@code false}.
     */
    protected boolean shouldShowStatusBarInsets();

    /**
     * Returns {@code true} if this view should be hidden during the occluded state.
     */
    protected boolean shouldShowWhenOccluded();

    /**
     * Returns {@code true} if the window should be focued when this view is visible. Note that
     * returning {@code false} here means that {@link #shouldShowStatusBarInsets} and
     * {@link #shouldShowNavigationBarInsets} will have no effect.
     */
    protected boolean shouldFocusWindow();

    /**
     * Returns {@code true} if the window should use stable insets. Using stable insets means that
     * even when system bars are temporarily not visible, inset from the system bars will still be
     * applied.
     *
     * NOTE: When system bars are hidden in transient mode, insets from them will not be applied
     * even when the system bars become visible. Setting the return value to {@true} here can
     * prevent the OverlayView from overlapping with the system bars when that happens.
     */
    protected boolean shouldUseStableInsets();

    /**
     * Returns the insets types to fit to the sysui overlay window when this
     * {@link OverlayViewController} is in the foreground.
     */
    @WindowInsets.Type.InsetsType
    protected int getInsetTypesToFit();

    /**
     * Optionally returns the sides of enabled system bar insets to fit to the sysui overlay window
     * when this {@link OverlayViewController} is in the foreground.
     *
     * For example, if the bottom and left system bars are enabled and this method returns
     * WindowInsets.Side.LEFT, then the inset from the bottom system bar will be ignored.
     *
     * NOTE: By default, this method returns {@link #INVALID_INSET_SIDE}, so insets to fit are
     * defined by {@link #getInsetTypesToFit()}, and not by this method, unless it is overridden
     * by subclasses.
     *
     * NOTE: {@link #NO_INSET_SIDE} signifies no insets from any system bars will be honored. Each
     * {@link OverlayViewController} can first take this value and add sides of the system bar
     * insets to honor to it.
     *
     * NOTE: If getInsetSidesToFit is overridden to return {@link WindowInsets.Side}, it always
     * takes precedence over {@link #getInsetTypesToFit()}. That is, the return value of {@link
     * #getInsetTypesToFit()} will be ignored.
     */
    @WindowInsets.Side.InsetsSide
    protected int getInsetSidesToFit();
}

OverlayPanelViewController

Der OverlayPanelViewController Controller erweitert OverlayViewController und bietet seiner Oberklasse zusätzliche Funktionen zum Ziehen von Animationen.

OverlayViewMediator

OverlayViewMediator beherbergt Geschäftslogik, die mehrere OverlayViewController Instanzen ein- oder ausblendet und so in gewisser Weise auch die Koordination zwischen View-Controllern verwaltet.

/**
 * Controls when to show and hide {@link OverlayViewController}(s).
 */
public interface OverlayViewMediator {

    /**
     * Register listeners that could use ContentVisibilityAdjuster to show/hide content.
     *
     * Note that we do not unregister listeners because SystemUI components are expected to live
     * for the lifecycle of the device.
     */
    void registerListeners();

    /**
     * Allows for post-inflation callbacks and listeners to be set inside required {@link
     * OverlayViewController}(s).
     */
    void setupOverlayContentViewControllers();
}

SystemUIOverlayWindowManager

SystemUIOverlayWindowManager ist dafür verantwortlich, das SystemUI-Objekt zu sein, das als Einstiegspunkt für das SystemUIOverlayWindow -Verwaltungssystem dient, um OverlayViewMediator Instanzen mit OverlayViewGlobalStateController zu initialisieren und zu registrieren.

Ansichtsfluss anzeigen
Abbildung 1. SystemUIOverlayWindowManager

OverlayViewGlobalStateController

OverlayViewGlobalStateController empfängt Aufrufe von OverlayViewController Instanzen, um sich selbst anzuzeigen oder zu verbergen. Daher enthält es auch den Status dessen, was in SystemUIOverlayWindow angezeigt oder ausgeblendet wird.

Der Ablauf der Showansicht ist unten dargestellt:

Ansichtsfluss anzeigen
Abbildung 2. Ansichtsfluss anzeigen

Ansichtsfluss ausblenden

Der Ablauf zum Ausblenden der Ansicht ist unten dargestellt:

Ansichtsfluss ausblenden
Abbildung 3. Ansichtsfluss ausblenden

Öffentliche Methodensignaturen

Signaturen öffentlicher Methoden werden wie folgt codiert:

​/**
 * This controller is responsible for the following:
 * <p><ul>
 * <li>Holds the global state for SystemUIOverlayWindow.
 * <li>Allows {@link SystemUIOverlayWindowManager} to register {@link OverlayViewMediator}(s).
 * <li>Enables {@link OverlayViewController)(s) to reveal/conceal themselves while respecting the
 * global state of SystemUIOverlayWindow.
 * </ul>
 */
@SysUISingleton
public class OverlayViewGlobalStateController {
    /**
     * Register {@link OverlayViewMediator} to use in SystemUIOverlayWindow.
     */
    public void registerMediator(OverlayViewMediator overlayViewMediator);

    /**
     * Show content in Overlay Window using {@link OverlayPanelViewController}.
     *
     * This calls {@link OverlayViewGlobalStateController#showView(OverlayViewController, Runnable)}
     * where the runnable is nullified since the actual showing of the panel is handled by the
     * controller itself.
     */
    public void showView(OverlayPanelViewController panelViewController);

    /**
     * Show content in Overlay Window using {@link OverlayViewController}.
     */
    public void showView(OverlayViewController viewController, @Nullable Runnable show);

    /**
     * Hide content in Overlay Window using {@link OverlayPanelViewController}.
     *
     * This calls {@link OverlayViewGlobalStateController#hideView(OverlayViewController, Runnable)}
     * where the runnable is nullified since the actual hiding of the panel is handled by the
     * controller itself.
     */
    public void hideView(OverlayPanelViewController panelViewController);

    /**
     * Hide content in Overlay Window using {@link OverlayViewController}.
     */
    public void hideView(OverlayViewController viewController, @Nullable Runnable hide);

    /** Returns {@code true} is the window is visible. */
    public boolean isWindowVisible();

    /**
     * Sets the {@link android.view.WindowManager.LayoutParams#FLAG_ALT_FOCUSABLE_IM} flag of the
     * sysui overlay window.
     */
    public void setWindowNeedsInput(boolean needsInput);

    /** Returns {@code true} if the window is focusable. */
    public boolean isWindowFocusable();

    /** Sets the focusable flag of the sysui overlawy window. */
    public void setWindowFocusable(boolean focusable);

    /** Inflates the view controlled by the given view controller. */
    public void inflateView(OverlayViewController viewController);

    /**
     * Return {@code true} if OverlayWindow is in a state where HUNs should be displayed above it.
     */
    public boolean shouldShowHUN();

    /**
     * Set the OverlayViewWindow to be in occluded or unoccluded state. When OverlayViewWindow is
     * occluded, all views mounted to it that are not configured to be shown during occlusion will
     * be hidden.
     */
    public void setOccluded(boolean occluded);
}

So fügen Sie SysUIOverlayWindow eine Ansicht hinzu

Einzelheiten finden Sie im Codelab .

Schritt 1: Fügen Sie einen ViewStub zu SysUIOverlayWindow hinzu

Fügen Sie ViewStub zum Fensterlayout hinzu.

Schritt 2: Erstellen Sie einen OverlayViewController

Verwenden Sie den neuen ViewStub , um einen neuen injizierbaren OverlayViewController zu erstellen.

Schritt 3: OverlayViewMediator

Erstellen Sie einen neuen injizierbaren OverlayViewMediator oder verwenden Sie einen vorhandenen (überspringen Sie Schritt 4) und registrieren Sie Listener, um den neuen OverlayViewController auszublenden oder anzuzeigen.

Schritt 4: Konfigurieren Sie den neuen OverlayViewMediator

Fügen Sie Ihren neuen OverlayViewMediator zu OverlayWindowModule und zu config_carSystemUIOverlayViewsMediator hinzu.

Vorbehalte

Wenn SysUIPrimaryWindow den gesamten Bildschirm abdeckt, registrieren alle Elemente unter dem Fenster keine Berührungsereignisse. Wenn das Fenster also den gesamten Bildschirm abdeckt, sein Inhalt jedoch etwas negativen Raum lässt, können Sie den negativen Raum verwischen und Zuhörer an diesen Raum anhängen, um den Inhalt im Fenster zu verwerfen.

Zurück
Implementieren Sie die System-Benutzeroberfläche