SystemUIOverlayWindow Management System

SystemUIOverlayWindow Management System umożliwia wyświetlanie widoków w SystemUIOverlayWindow i zarządzanie nimi. Obecnie to okno jest używane do widoków, w tym do przełączania użytkowników na pełnym ekranie, panelu powiadomień i blokady klawiatury. Ten artykuł nie zawiera:

  • Utwórz ograniczenia dotyczące tego, co OEM może dodać do okna.
  • Zmusza do przyjęcia abstrakcji opisanych w tym dokumencie.

Przegląd

Możesz użyć SystemUIOverlayWindow Management System, aby wyświetlić widoki, takie jak informacja prawna, pełnoekranowy przełącznik użytkownika, kamera cofania, elementy sterujące HVAC i blokada klawiatury. To okno znajduje się poza obszarem aplikacji i zapewnia kontrolę nad kolejnością Z widoku, wyzwalaczami odsłaniania/ukrywania oraz ogólnymi dostosowaniami, w tym rozmieszczeniem widoku, rozmiarem, przezroczystością i kolorem). Jednocześnie nie musisz martwić się stanem pasków systemowych lub innych obiektów interfejsu systemu, które muszą być ukryte lub pokazane, gdy ich odpowiedni widok jest ukryty lub pokazany.

Aby skorzystać z SystemUIOverlayWindow , należy utworzyć kontrolery widoku umożliwiające wyświetlanie mediatorów. Mediatory są przekazywane do globalnego kontrolera stanu okna. Te poglądy mediatorów:

  • Współrzędne między kontrolerami widoku.
  • Domowa logika biznesowa dla kontrolerów widoku.

Kontrolery widoku (koordynowane przez mediatorów widoku):

  • Posiadaj swój pogląd.
  • Twórz setery, za pomocą których OverlayViewsMediator może dołączać logikę biznesową.
  • Twórz animacje odsłaniania i ukrywania widoku.

SystemUIOverlayWindow Manager, składnik SystemUI, służy jako punkt wejścia do inicjowania i rejestrowania mediatorów z globalnym kontrolerem stanu, podczas gdy globalny kontroler stanu łączy się z kontrolerami widoku w taki sposób, że mediatorzy mogą bezpośrednio wywoływać kontrolery widoku, aby pokazać i ukryć widoki w okno.

Kontroler widoku nakładki

OverlayViewController odpowiada za widok wyświetlany w SystemUIOverlayWindow i kontroluje sposób odsłaniania i ukrywania widoku. Umożliwia również dołączenie wymaganych detektorów, dzięki czemu można je powiązać z logiką biznesową.

Ważne podpisy metod

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

Kontroler OverlayPanelViewController rozszerza OverlayViewController i zapewnia dodatkowe możliwości animacji przeciągania do swojej superklasy.

NakładkaViewMediator

OverlayViewMediator zawiera logikę biznesową, która ujawnia lub ukrywa wiele OverlayViewController (s), stąd w pewien sposób zarządza również koordynacją między kontrolerami widoku.

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

SystemUIOverlay Menedżer okien

SystemUIOverlayWindowManager jest odpowiedzialny za bycie obiektem SystemUI, który służy jako punkt wejścia dla SystemUIOverlayWindow Management System do inicjowania i rejestrowania OverlayViewMediator (s) za pomocą OverlayViewGlobalStateController .

Pokaż przepływ widoku
Rysunek 1. SystemUIOverlayWindowManager

OverlayViewGlobalStateController

OverlayViewGlobalStateController odbiera wywołania z OverlayViewController (s) w celu ujawnienia lub ukrycia się. W związku z tym zawiera również stan tego, co jest wyświetlane lub ukryte w SystemUIOverlayWindow .

Przebieg widoku pokazu zilustrowano poniżej:

Pokaż przepływ widoku
Rysunek 2. Pokaż przepływ widoku

Ukryj widok widoku

Schemat ukrywania widoku zilustrowano poniżej:

Ukryj widok widoku
Rysunek 3. Ukryj widok widoku

Podpisy metod publicznych

Sygnatury metod publicznych są zakodowane w następujący sposób:

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

Jak dodać widok do SysUIOverlayWindow

Aby uzyskać szczegółowe informacje, zobacz Ćwiczenie z programowania .

Krok 1: Dodaj ViewStub do SysUIOverlayWindow

Dodaj ViewStub do układu okna .

Krok 2: Utwórz OverlayViewController

Użyj nowego ViewStub , aby utworzyć nowy wstrzykiwany OverlayViewController .

Krok 3: OverlayViewMediator

Utwórz nowy OverlayViewMediator do wstrzykiwania lub użyj istniejącego (pomiń krok 4) i zarejestruj detektory, aby ukryć lub pokazać nowy OverlayViewController .

Krok 4: Skonfiguruj nowy OverlayViewMediator

Dodaj nowy OverlayViewMediator do OverlayWindowModule i do config_carSystemUIOverlayViewsMediator .

Zastrzeżenia

Należy pamiętać, że gdy SysUIPrimaryWindow obejmuje cały ekran, żadne elementy pod oknem nie rejestrują zdarzeń dotyku. Dlatego, gdy okno obejmuje cały ekran, ale jego zawartość pozostawia pewną negatywną przestrzeń, możesz zamazać negatywną przestrzeń i dołączyć słuchaczy do tej przestrzeni, aby odrzucić zawartość w oknie.