/*
* Copyright 2018 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package androidx.webkit;
import android.annotation.SuppressLint;
import android.webkit.WebSettings;
import androidx.annotation.IntDef;
import androidx.annotation.RequiresFeature;
import androidx.annotation.RestrictTo;
import androidx.webkit.internal.WebSettingsAdapter;
import androidx.webkit.internal.WebViewFeatureInternal;
import androidx.webkit.internal.WebViewGlueCommunicator;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* Compatibility version of {@link android.webkit.WebSettings}
*/
public class WebSettingsCompat {
private WebSettingsCompat() {}
/**
* Sets whether this WebView should raster tiles when it is
* offscreen but attached to a window. Turning this on can avoid
* rendering artifacts when animating an offscreen WebView on-screen.
* Offscreen WebViews in this mode use more memory. The default value is
* false.
* Please follow these guidelines to limit memory usage:
*
* Safe Browsing can be disabled for all WebViews using a manifest tag (read general Safe Browsing info). The * manifest tag has a lower precedence than this API. * *
* Safe Browsing is enabled by default for devices which support it. * * @param enabled Whether Safe Browsing is enabled. */ @SuppressLint("NewApi") @RequiresFeature(name = WebViewFeature.SAFE_BROWSING_ENABLE, enforcement = "androidx.webkit.WebViewFeature#isFeatureSupported") public static void setSafeBrowsingEnabled(WebSettings webSettings, boolean enabled) { WebViewFeatureInternal webviewFeature = WebViewFeatureInternal.getFeature(WebViewFeature.SAFE_BROWSING_ENABLE); if (webviewFeature.isSupportedByFramework()) { webSettings.setSafeBrowsingEnabled(enabled); } else if (webviewFeature.isSupportedByWebView()) { getAdapter(webSettings).setSafeBrowsingEnabled(enabled); } else { throw WebViewFeatureInternal.getUnsupportedOperationException(); } } /** * Gets whether Safe Browsing is enabled. * See {@link #setSafeBrowsingEnabled}. * * @return {@code true} if Safe Browsing is enabled and {@code false} otherwise. */ @SuppressLint("NewApi") @RequiresFeature(name = WebViewFeature.SAFE_BROWSING_ENABLE, enforcement = "androidx.webkit.WebViewFeature#isFeatureSupported") public static boolean getSafeBrowsingEnabled(WebSettings webSettings) { WebViewFeatureInternal webviewFeature = WebViewFeatureInternal.getFeature(WebViewFeature.SAFE_BROWSING_ENABLE); if (webviewFeature.isSupportedByFramework()) { return webSettings.getSafeBrowsingEnabled(); } else if (webviewFeature.isSupportedByWebView()) { return getAdapter(webSettings).getSafeBrowsingEnabled(); } else { throw WebViewFeatureInternal.getUnsupportedOperationException(); } } /** * @hide */ @RestrictTo(RestrictTo.Scope.LIBRARY_GROUP) @IntDef(flag = true, value = { WebSettings.MENU_ITEM_NONE, WebSettings.MENU_ITEM_SHARE, WebSettings.MENU_ITEM_WEB_SEARCH, WebSettings.MENU_ITEM_PROCESS_TEXT }) @Retention(RetentionPolicy.SOURCE) @Target({ElementType.PARAMETER, ElementType.METHOD}) public @interface MenuItemFlags {} /** * Disables the action mode menu items according to {@code menuItems} flag. * @param menuItems an integer field flag for the menu items to be disabled. */ @SuppressLint("NewApi") @RequiresFeature(name = WebViewFeature.DISABLED_ACTION_MODE_MENU_ITEMS, enforcement = "androidx.webkit.WebViewFeature#isFeatureSupported") public static void setDisabledActionModeMenuItems(WebSettings webSettings, @MenuItemFlags int menuItems) { WebViewFeatureInternal webviewFeature = WebViewFeatureInternal.getFeature(WebViewFeature.DISABLED_ACTION_MODE_MENU_ITEMS); if (webviewFeature.isSupportedByFramework()) { webSettings.setDisabledActionModeMenuItems(menuItems); } else if (webviewFeature.isSupportedByWebView()) { getAdapter(webSettings).setDisabledActionModeMenuItems(menuItems); } else { throw WebViewFeatureInternal.getUnsupportedOperationException(); } } /** * Gets the action mode menu items that are disabled, expressed in an integer field flag. * The default value is {@link WebSettings#MENU_ITEM_NONE} * * @return all the disabled menu item flags combined with bitwise OR. */ @SuppressLint("NewApi") @RequiresFeature(name = WebViewFeature.DISABLED_ACTION_MODE_MENU_ITEMS, enforcement = "androidx.webkit.WebViewFeature#isFeatureSupported") public static @MenuItemFlags int getDisabledActionModeMenuItems(WebSettings webSettings) { WebViewFeatureInternal webviewFeature = WebViewFeatureInternal.getFeature(WebViewFeature.DISABLED_ACTION_MODE_MENU_ITEMS); if (webviewFeature.isSupportedByFramework()) { return webSettings.getDisabledActionModeMenuItems(); } else if (webviewFeature.isSupportedByWebView()) { return getAdapter(webSettings).getDisabledActionModeMenuItems(); } else { throw WebViewFeatureInternal.getUnsupportedOperationException(); } } private static WebSettingsAdapter getAdapter(WebSettings webSettings) { return WebViewGlueCommunicator.getCompatConverter().convertSettings(webSettings); } }