Système de gestion SystemUIOverlayWindow

Le système de gestion SystemUIOverlayWindow vous permet d'afficher et de gérer les vues dans SystemUIOverlayWindow . Actuellement, cette fenêtre est utilisée pour les vues comprenant le sélecteur d'utilisateur plein écran, le panneau de notification et le protège-clavier. Cette page ne :

  • Créez des restrictions sur ce que l'OEM peut ajouter à la fenêtre.
  • Vous oblige à adopter les abstractions décrites sur cette page.

Aperçu

Vous pouvez utiliser le système de gestion SystemUIOverlayWindow pour afficher des vues telles que les mentions légales, le sélecteur d'utilisateur plein écran, la caméra de recul, les commandes CVC et le protège-clavier. Cette fenêtre se trouve en dehors de l'espace de l'application et vous permet de contrôler l'ordre Z de la vue, les déclencheurs de révélation/masquage et les personnalisations globales, notamment le placement, la taille, la transparence et la couleur de la vue. Dans le même temps, vous n'avez pas besoin de vous soucier de l'état des barres système ou des autres objets de l'interface utilisateur système qui doivent être masqués ou affichés lorsque leur vue respective est masquée ou affichée.

Pour profiter de SystemUIOverlayWindow , vous créez des contrôleurs de vue pour vos médiateurs de vue. Les médiateurs sont transmis au contrôleur d'état global de la fenêtre. Ceux-ci voient les médiateurs :

  • Coordonner entre les contrôleurs de vue.
  • Logique métier interne pour les contrôleurs de vue.

Contrôleurs de vue (coordonnés par des médiateurs de vue) :

  • Posséder son point de vue.
  • Créez des setters grâce auxquels OverlayViewsMediator peut attacher une logique métier.
  • Créez les animations de révélation et de dissimulation de leur vue.

SystemUIOverlayWindow Manager, un composant SystemUI, sert de point d'entrée pour initialiser et enregistrer les médiateurs auprès du contrôleur d'état global tandis que le contrôleur d'état global est lié aux contrôleurs de vue de telle manière que les médiateurs peuvent appeler directement les contrôleurs de vue pour afficher et masquer les vues dans la fenêtre.

OverlayViewController

OverlayViewController est responsable de la vue affichée dans SystemUIOverlayWindow et contrôle la façon dont la vue est révélée et masquée. Il permet également d'attacher les écouteurs requis afin de pouvoir les lier à la logique métier.

Signatures de méthode importantes

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

Le contrôleur OverlayPanelViewController étend OverlayViewController et fournit des capacités d'animation par glissement supplémentaires à sa superclasse.

OverlayViewMediator

OverlayViewMediator héberge une logique métier qui révèle ou masque plusieurs instances OverlayViewController . Ainsi, d'une certaine manière, il gère également la coordination entre les contrôleurs de vue.

/**
 * 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 est responsable d'être l'objet SystemUI qui sert de point d'entrée au système de gestion SystemUIOverlayWindow pour initialiser et enregistrer les instances OverlayViewMediator avec OverlayViewGlobalStateController .

Afficher le flux de vue
Figure 1. SystemUIOverlayWindowManager

OverlayViewGlobalStateController

OverlayViewGlobalStateController reçoit des appels d'instances OverlayViewController pour se révéler ou se cacher. Par conséquent, il contient également l’état de ce qui est affiché ou masqué dans SystemUIOverlayWindow .

Le flux de la vue Afficher est illustré ci-dessous :

Afficher le flux de la vue
Figure 2. Afficher le flux de vue

Masquer le flux de la vue

Le flux de masquage de la vue est illustré ci-dessous :

Masquer le flux de la vue
Figure 3. Masquer le flux de la vue

Signatures de méthode publique

Les signatures de méthode publique sont codées comme suit :

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

Comment ajouter une vue à SysUIOverlayWindow

Pour plus de détails, consultez l' atelier de programmation .

Étape 1 : ajouter un ViewStub à SysUIOverlayWindow

Ajoutez ViewStub à la disposition des fenêtres .

Étape 2 : créer un OverlayViewController

Utilisez le nouveau ViewStub pour créer un nouveau OverlayViewController injectable.

Étape 3 : OverlayViewMediator

Créez un nouveau OverlayViewMediator injectable ou utilisez-en un existant (ignorez l'étape 4) et enregistrez les écouteurs pour masquer ou afficher le nouveau OverlayViewController .

Étape 4 : Configurez le nouveau OverlayViewMediator

Ajoutez votre nouveau OverlayViewMediator à OverlayWindowModule et à config_carSystemUIOverlayViewsMediator .

Mises en garde

Lorsque SysUIPrimaryWindow couvre tout l'écran, les éléments sous la fenêtre n'enregistrent pas les événements tactiles. Par conséquent, lorsque la fenêtre couvre tout l'écran mais que son contenu laisse un espace négatif, vous pouvez choisir de flouter l'espace négatif et d'attacher des écouteurs à cet espace pour ignorer le contenu de la fenêtre.

Précédent
Implémenter l'interface utilisateur du système