Hệ thống quản lý SystemUIOverlayWindow cung cấp cho bạn cách hiển thị và quản lý các chế độ xem trong SystemUIOverlayWindow . Hiện tại, cửa sổ này được sử dụng cho các chế độ xem bao gồm trình chuyển đổi người dùng toàn màn hình, bảng thông báo và bàn phím. Trang này không:
- Tạo các hạn chế xung quanh những gì OEM có thể thêm vào cửa sổ.
- Buộc bạn phải chấp nhận những điều trừu tượng được mô tả trên trang này.
Tổng quan
Bạn có thể sử dụng Hệ thống quản lý SystemUIOverlayWindow để hiển thị các chế độ xem như thông báo pháp lý, trình chuyển đổi người dùng toàn màn hình, camera chiếu hậu, điều khiển HVAC và bàn phím. Cửa sổ này nằm bên ngoài không gian ứng dụng và cung cấp cho bạn quyền kiểm soát thứ tự Z của chế độ xem, trình kích hoạt hiển thị/ẩn và các tùy chỉnh tổng thể bao gồm vị trí, kích thước, độ trong suốt và màu sắc của chế độ xem. Đồng thời, bạn không cần phải quan tâm đến trạng thái của thanh hệ thống hoặc các đối tượng Giao diện người dùng hệ thống khác cần được ẩn hoặc hiển thị khi chế độ xem tương ứng của chúng bị ẩn hoặc hiển thị.
Để tận dụng SystemUIOverlayWindow , bạn tạo bộ điều khiển chế độ xem cho các bộ điều khiển chế độ xem. Các bộ hòa giải được chuyển tới bộ điều khiển trạng thái toàn cầu của cửa sổ. Những quan điểm trung gian này:
- Phối hợp giữa các bộ điều khiển xem.
- Logic nghiệp vụ nội bộ cho bộ điều khiển chế độ xem.
Xem bộ điều khiển (được điều phối bởi các bộ hòa giải xem):
- Sở hữu quan điểm của nó.
- Tạo các setter mà qua đó
OverlayViewsMediatorcó thể đính kèm logic nghiệp vụ. - Tạo hoạt ảnh hiển thị và che giấu chế độ xem của họ.
SystemUIOverlayWindow Manager, một thành phần SystemUI, đóng vai trò là điểm đầu vào để khởi tạo và đăng ký các bộ hòa giải với bộ điều khiển trạng thái toàn cầu trong khi bộ điều khiển trạng thái toàn cầu liên kết với các bộ điều khiển chế độ xem theo cách mà các bộ hòa giải có thể gọi trực tiếp các bộ điều khiển chế độ xem để hiển thị và ẩn các chế độ xem trong cửa sổ.
Lớp phủViewController
OverlayViewController chịu trách nhiệm về chế độ xem được hiển thị trong SystemUIOverlayWindow và kiểm soát cách hiển thị và ẩn chế độ xem. Nó cũng cho phép các trình nghe được yêu cầu được đính kèm để có thể gắn với logic nghiệp vụ.
Chữ ký phương thức quan trọng
/**
* 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
Bộ điều khiển OverlayPanelViewController mở rộng OverlayViewController và cung cấp thêm khả năng kéo hoạt ảnh vào siêu lớp của nó.
OverlayViewMeditor
OverlayViewMediator chứa logic nghiệp vụ hiển thị hoặc ẩn nhiều phiên bản OverlayViewController , do đó, theo một cách nào đó, nó cũng quản lý sự phối hợp giữa các bộ điều khiển chế độ xem.
/**
* 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 chịu trách nhiệm là đối tượng SystemUI phục vụ điểm vào cho Hệ thống quản lý SystemUIOverlayWindow để khởi tạo và đăng ký các phiên bản OverlayViewMediator với OverlayViewGlobalStateController .
OverlayViewGlobalStateController
OverlayViewGlobalStateController nhận lệnh gọi từ các phiên bản OverlayViewController để tiết lộ hoặc che giấu bản thân. Do đó, nó cũng giữ trạng thái của những gì được hiển thị hoặc ẩn trong SystemUIOverlayWindow .
Luồng xem chương trình được minh họa dưới đây:
Ẩn luồng chế độ xem
Luồng ẩn chế độ xem được minh họa bên dưới:
Chữ ký phương thức công khai
Chữ ký phương thức công khai được mã hóa như sau:
/**
* 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ách thêm chế độ xem vào SysUIOverlayWindow
Để biết chi tiết, hãy xem Codelab .
Bước 1: Thêm ViewStub vào SysUIOverlayWindow
Thêm ViewStub vào bố cục cửa sổ .
Bước 2: Tạo OverlayViewController
Sử dụng ViewStub mới để tạo OverlayViewController có thể tiêm mới.
Bước 3: OverlayViewMediator
Tạo OverlayViewMediator có thể tiêm mới hoặc sử dụng OverlayViewMediator hiện có (bỏ qua Bước 4) và đăng ký trình nghe để ẩn hoặc hiển thị OverlayViewController mới.
Bước 4: Định cấu hình OverlayViewMediator mới
Thêm OverlayViewMediator mới của bạn vào OverlayWindowModule và config_carSystemUIOverlayViewsMediator .
Hãy cẩn thận
Khi SysUIPrimaryWindow bao phủ toàn bộ màn hình, mọi phần tử bên dưới cửa sổ sẽ không đăng ký các sự kiện chạm. Do đó, khi cửa sổ che toàn bộ màn hình nhưng nội dung của nó để lại một khoảng trống nào đó, bạn có thể chọn làm mờ không gian âm và gắn người nghe vào không gian đó để loại bỏ nội dung trong cửa sổ.