El sistema de administración de SystemUIOverlayWindow te permite mostrar y
administrar vistas en SystemUIOverlayWindow. Actualmente, esta ventana se utiliza para las vistas
incluidos el selector de usuario en pantalla completa, el panel de notificaciones y el bloqueo del teclado. En esta página, no se incluye lo siguiente:
- Crea restricciones en torno a lo que el OEM puede agregar a la ventana.
- Obligarte a adoptar las abstracciones descritas en esta página
Descripción general
Puedes usar el sistema de administración de SystemUIOverlayWindow para mostrar vistas como la
aviso legal, selector de usuario en pantalla completa, cámara de retroceso, controles de HVAC y bloqueo de teclado. Esta
se encuentra fuera del espacio de la app y te permite controlar el orden en Z de la vista,
mostrar/ocultar activadores y personalizaciones generales, como la ubicación de la vista, el tamaño, la transparencia
y color. Al mismo tiempo, no debes preocuparte por el estado de las barras del sistema u otras
Objetos de la IU del sistema que deben ocultarse o mostrarse cuando su vista respectiva está oculta o se muestra.
Para aprovechar SystemUIOverlayWindow, crea controladores de vista
mediadores. Los mediadores se pasan al controlador de estado global de la ventana. Estos ven mediadores:
- Coordenada entre los controladores de vistas.
- Aloja la lógica empresarial para los controladores de vistas.
Controladores de vista (coordinados por mediadores de vista):
- Aprópiate de su vista.
- Crea métodos set a través de los cuales
OverlayViewsMediatorpueda conectar la lógica empresarial. - Crea las animaciones de revelación y ocultamiento de su vista.
SystemUIOverlayWindowManager, un componente SystemUI,funciona como punto de entrada para
inicializan y registran mediadores con el controlador de estado global mientras el controlador de estado global
se vincula con los controladores de vista de manera que los mediadores puedan llamar directamente a los controladores de vista.
para mostrar y ocultar vistas en la ventana.
OverlayViewController
OverlayViewController
es responsable de la vista que se muestra en SystemUIOverlayWindow y controla cómo se
revelados y ocultos. También permite adjuntar objetos de escucha necesarios para poder vincularlos
a la lógica empresarial.
Firmas de métodos 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
El controlador OverlayPanelViewController extiende OverlayViewController y proporciona capacidades adicionales de animación de arrastre a su superclase.
OverlayViewMediator
OverlayViewMediator contiene lógica empresarial que oculta o revela
varias instancias OverlayViewController; por lo tanto, también administra el
y la coordinación entre los controladores de vista.
/** * 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
es responsable de ser el objeto SystemUI que funciona como punto de entrada para el
Sistema de administración de SystemUIOverlayWindow para inicializar y registrar
OverlayViewMediator instancias con OverlayViewGlobalStateController.
OverlayViewGlobalStateController
OverlayViewGlobalStateController recibe llamadas de
OverlayViewController instancias para revelar u ocultarse. Por lo tanto, también
Contiene el estado de lo que se oculta o se muestra en SystemUIOverlayWindow.
A continuación, se ilustra el flujo de la vista de programa:
Ocultar flujo de vistas
A continuación, se ilustra el flujo de ocultamiento de la vista:
Firmas de métodos públicos
Las firmas de métodos públicos se codifican de la siguiente manera:
/**
* 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);
}
Cómo agregar una vista a SysUIOverlayWindow
Para obtener más información, consulta el Codelab.
Paso 1: Agrega un ViewStub a SysUIOverlayWindow
Agregar ViewStub
al
diseño de ventana.
Paso 2: Crea un objeto OverlayViewController
Usa el nuevo ViewStub para crear un nuevo inyectable.
OverlayViewController
Paso 3: OverlayViewMediator
Crear un inyectable nuevo
OverlayViewMediator
o usa uno existente (omite el paso 4) y registra objetos de escucha para ocultar o mostrar el nuevo
OverlayViewController
Paso 4: Configura el nuevo OverlayViewMediator
Agrega tu nueva OverlayViewMediator a
OverlayWindowModule
y para
config_carSystemUIOverlayViewsMediator
Advertencias
Cuando SysUIPrimaryWindow cubre toda la pantalla, cualquier elemento debajo de la ventana
no registran eventos táctiles. Por lo tanto, cuando la ventana cubra toda la pantalla, pero su contenido
dejar un espacio negativo, puedes difuminar el espacio negativo y adjuntar objetos de escucha a
ese espacio para descartar contenido en la ventana.