SystemUIOverlayWindow sistema di gestione

Il sistema di gestione di SystemUIOverlayWindow consente di visualizzare e gestisci le visualizzazioni in SystemUIOverlayWindow. Attualmente, questa finestra viene utilizzata per le visualizzazioni inclusi il selettore utente a schermo intero, il riquadro delle notifiche e il blocco tastiera. Questa pagina non:

  • Crea limitazioni su ciò che l'OEM può aggiungere alla finestra.
  • Ti costringono ad adottare le astrazioni descritte in questa pagina.

Panoramica

Puoi utilizzare il sistema di gestione di SystemUIOverlayWindow per mostrare viste come avviso legale, selettore utente a schermo intero, videocamera di retrovisione, controlli dell'impianto di climatizzazione e blocco tastiera. Questo che si trova fuori dallo spazio dell'app e ti consente di controllare l'ordinamento Z della visualizzazione, per rivelare/nascondere attivatori e personalizzazioni generali, tra cui posizionamento della visualizzazione, dimensioni, trasparenza e il colore. Allo stesso tempo, non è necessario preoccuparsi dello stato delle barre di sistema o di altre Oggetti UI di sistema che devono essere nascosti o mostrati quando la rispettiva visualizzazione è nascosta o mostrata.

Per utilizzare SystemUIOverlayWindow, devi creare dei controller di visualizzazione per te mediatori. I mediatori vengono passati al controller di stato globale della finestra. Questi mediatori di visualizzazione:

  • Coordinata tra i controller di visualizzazione.
  • Logica di business autopromozionale per i controller di visualizzazione.

Visualizza controller (coordinati dai mediatori della visualizzazione):

  • Possedere il suo punto di vista.
  • Crea setter tramite i quali OverlayViewsMediator può collegare la logica di business.
  • Creare le animazioni di rivelazione e nascondere della visualizzazione.

SystemUIOverlayWindowManager, un componente SystemUI,funge da punto di ingresso inizializza e registra i mediatori con il controller di stato globale mentre il controller di stato globale si collega ai controller di visualizzazione in modo tale che i mediatori possano chiamare direttamente i controller di visualizzazione per mostrare e nascondere le visualizzazioni nella finestra.

OverlayViewController

OverlayViewController è responsabile della vista mostrata in SystemUIOverlayWindow e ne determina il funzionamento rivelati e nascosti. Consente inoltre di collegare i listener richiesti in modo che possano alla logica di business.

Firme dei metodi importanti

/**
 * 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

Il controller OverlayPanelViewController estende OverlayViewController e fornisce ulteriori funzionalità di animazione di trascinamento alla sua superclasse.

OverlayViewMediator

OverlayViewMediator ospita una logica di business che rivela o nasconde più istanze di OverlayViewController; in questo modo, in modo da gestire anche il coordinamento tra i controller di visualizzazione.

/**
 * 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();
}

SistemaUIOverlayWindowManager

SystemUIOverlayWindowManager è responsabile di essere l'oggetto SystemUI che funge da punto di ingresso per SystemUIOverlayWindow Sistema di gestione per inizializzare e registrare OverlayViewMediator istanze con OverlayViewGlobalStateController.

Mostra flusso di visualizzazione
Figura 1. SystemUIOverlayWindowManager
.

OverlayViewGlobalStateController

OverlayViewGlobalStateController riceve chiamate da OverlayViewController di istanze per rivelare o nascondersi. Pertanto, contiene lo stato di ciò che viene mostrato o nascosto in SystemUIOverlayWindow.

Il flusso di visualizzazione del programma è illustrato di seguito:

Mostra flusso di visualizzazione
Figura 2. Mostra flusso di visualizzazione
.

Nascondi flusso di visualizzazione

Il flusso per nascondere la visualizzazione è illustrato di seguito:

Nascondi flusso di visualizzazione
Figura 3. Nascondi flusso di visualizzazione
.

Firme del metodo pubblico

Le firme dei metodi pubblici sono codificate come segue:

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

Come aggiungere una visualizzazione a SysUIOverlayWindow

Per maggiori dettagli, consulta il Codelab.

Passaggio 1: aggiungi un ViewStub a SysUIOverlayWindow

Aggiungi ViewStub alle layout della finestra.

Passaggio 2: crea un OverlayViewController

Usa il nuovo ViewStub per creare un nuovo iniettabile OverlayViewController.

Passaggio 3: OverlayViewMediator

Crea un nuovo iniettabile OverlayViewMediator oppure utilizzane uno esistente (salta il Passaggio 4) e registra gli ascoltatori per nascondere o mostrare il nuovo OverlayViewController.

Passaggio 4: configura il nuovo OverlayViewMediator

Aggiungi il tuo nuovo OverlayViewMediator a OverlayWindowModule e per config_carSystemUIOverlayViewsMediator.

Precisazioni

Quando SysUIPrimaryWindow copre l'intero schermo, tutti gli elementi sotto la finestra Non registrare eventi touch. Pertanto, quando la finestra copre l'intero schermo, ma i suoi contenuti lascia dello spazio negativo, puoi scegliere di sfocare quello negativo e assegnare agli ascoltatori in quell'area per chiudere i contenuti nella finestra.