SystemUIOverlayWindow نظام إدارة

يوفر لك نظام إدارة SystemUIOverlayWindow طريقة لعرض وإدارة طرق العرض في SystemUIOverlayWindow . حاليًا، يتم استخدام هذه النافذة للعروض بما في ذلك مبدل المستخدم بملء الشاشة ولوحة الإشعارات وحارس المفاتيح. هذه الصفحة لا:

• قم بإنشاء قيود حول ما يمكن أن يضيفه OEM إلى النافذة.
• تجبرك على تبني التجريدات الموضحة في هذه الصفحة.

ملخص

يمكنك استخدام نظام إدارة SystemUIOverlayWindow لإظهار طرق العرض مثل الإشعار القانوني، ومحول المستخدم بملء الشاشة، وكاميرا الرؤية الخلفية، وعناصر التحكم في HVAC، وحارس المفاتيح. تقع هذه النافذة خارج مساحة التطبيق وتمنحك التحكم في الترتيب Z للعرض ومشغلات الكشف/الإخفاء والتخصيصات الشاملة بما في ذلك موضع العرض والحجم والشفافية واللون. وفي الوقت نفسه، لا داعي للقلق بشأن حالة أشرطة النظام أو كائنات واجهة مستخدم النظام الأخرى التي يجب إخفاؤها أو إظهارها عندما يكون العرض الخاص بها مخفيًا أو معروضًا.

للاستفادة من SystemUIOverlayWindow ، يمكنك إنشاء وحدات تحكم في العرض لعرض الوسطاء. يتم تمرير الوسطاء إلى وحدة تحكم الحالة العامة للنافذة. هؤلاء وسطاء العرض:

• التنسيق بين وحدات التحكم في العرض.
• منطق الأعمال المنزلية لوحدات التحكم في العرض.

عرض وحدات التحكم (يتم تنسيقها بواسطة وسطاء العرض):

• تملك وجهة نظرها.
• قم بإنشاء أدوات ضبط يمكن من خلالها لـ OverlayViewsMediator إرفاق منطق الأعمال.
• إنشاء الرسوم المتحركة الخاصة بإظهار وإخفاء طريقة العرض الخاصة بهم.

يعمل SystemUIOverlayWindow Manager، أحد مكونات SystemUI، كنقطة دخول لتهيئة الوسطاء وتسجيلهم مع وحدة تحكم الحالة العالمية بينما ترتبط وحدة تحكم الحالة العالمية بوحدات تحكم العرض بطريقة يمكن للوسطاء من خلالها الاتصال مباشرة بوحدات تحكم العرض لإظهار وإخفاء طرق العرض في النافذة.

OverlayViewController

OverlayViewController هو المسؤول عن العرض المعروض في SystemUIOverlayWindow ويتحكم في كيفية كشف العرض وإخفائه. كما أنه يمكّن من إرفاق المستمعين المطلوبين بحيث يمكن ربطهم بمنطق الأعمال.

توقيعات الطريقة الهامة

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

تعمل وحدة التحكم OverlayPanelViewController على توسيع OverlayViewController وتوفر إمكانات سحب إضافية للرسوم المتحركة إلى فئتها الفائقة.

OverlayViewMediator

يتضمن OverlayViewMediator منطق الأعمال الذي يكشف أو يخفي مثيلات OverlayViewController المتعددة، وبالتالي، فهو يدير أيضًا التنسيق بين وحدات تحكم العرض بطريقة ما.

/**
 * 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 مسؤولاً عن كونه كائن SystemUI الذي يخدم نقطة إدخال لنظام إدارة SystemUIOverlayWindow لتهيئة وتسجيل مثيلات OverlayViewMediator باستخدام OverlayViewGlobalStateController .

OverlayViewGlobalStateController

يتلقى OverlayViewGlobalStateController مكالمات من مثيلات OverlayViewController للكشف عن نفسها أو إخفائها. لذلك، فإنه يحتفظ أيضًا بحالة ما يظهر أو يخفي في SystemUIOverlayWindow .

يتم توضيح تدفق عرض العرض أدناه:

إخفاء تدفق العرض

يتم توضيح تدفق عرض الإخفاء أدناه:

توقيعات الطريقة العامة

يتم تشفير توقيعات الطريقة العامة على النحو التالي:

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

كيفية إضافة طريقة عرض إلى SysUIOverlayWindow

للحصول على تفاصيل، راجع Codelab .

الخطوة 1: إضافة ViewStub إلى SysUIOverlayWindow

أضف ViewStub إلى تخطيط النافذة .

الخطوة 2: إنشاء OverlayViewController

استخدم ViewStub الجديد لإنشاء OverlayViewController جديد قابل للحقن.

الخطوة 3: OverlayViewMediator

قم بإنشاء OverlayViewMediator جديد قابل للحقن أو استخدم واحدًا موجودًا (تخطي الخطوة 4) وقم بتسجيل المستمعين لإخفاء أو إظهار OverlayViewController الجديد.

الخطوة 4: قم بتكوين OverlayViewMediator الجديد

أضف OverlayViewMediator الجديد إلى OverlayWindowModule وإلى config_carSystemUIOverlayViewsMediator .

تحفظات

عندما يغطي SysUIPrimaryWindow الشاشة بأكملها، فإن أي عناصر موجودة أسفل النافذة لا تسجل أحداث اللمس. لذلك، عندما تغطي النافذة الشاشة بأكملها ولكن محتوياتها تترك بعض المساحة السلبية، يمكنك اختيار طمس المساحة السلبية وإرفاق المستمعين بتلك المساحة لتجاهل المحتوى في النافذة.