Home | History | Annotate | Download | only in webkit 
      1 /*
      2  * Copyright (C) 2012 The Android Open Source Project
      3  *
      4  * Licensed under the Apache License, Version 2.0 (the "License");
      5  * you may not use this file except in compliance with the License.
      6  * You may obtain a copy of the License at
      7  *
      8  *      http://www.apache.org/licenses/LICENSE-2.0
      9  *
     10  * Unless required by applicable law or agreed to in writing, software
     11  * distributed under the License is distributed on an "AS IS" BASIS,
     12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     13  * See the License for the specific language governing permissions and
     14  * limitations under the License.
     15  */
     16 
     17 package android.webkit;
     18 
     19 import android.content.Context;
     20 
     21 /**
     22  * This is the main entry-point into the WebView back end implementations, which the WebView
     23  * proxy class uses to instantiate all the other objects as needed. The backend must provide an
     24  * implementation of this interface, and make it available to the WebView via mechanism TBD.
     25  * @hide
     26  */
     27 public interface WebViewFactoryProvider {
     28     /**
     29      * This Interface provides glue for implementing the backend of WebView static methods which
     30      * cannot be implemented in-situ in the proxy class.
     31      */
     32     interface Statics {
     33         /**
     34          * Implements the API method:
     35          * {@link android.webkit.WebView#findAddress(String)}
     36          */
     37         String findAddress(String addr);
     38 
     39         /**
     40          * Implements the API methods:
     41          * {@link android.webkit.WebView#enablePlatformNotifications()}
     42          * {@link android.webkit.WebView#disablePlatformNotifications()}
     43          */
     44         void setPlatformNotificationsEnabled(boolean enable);
     45 
     46         /**
     47          * Implements the API method:
     48          * {@link android.webkit.WebSettings#getDefaultUserAgent(Context) }
     49          */
     50         String getDefaultUserAgent(Context context);
     51     }
     52 
     53     Statics getStatics();
     54 
     55     /**
     56      * Construct a new WebViewProvider.
     57      * @param webView the WebView instance bound to this implementation instance. Note it will not
     58      * necessarily be fully constructed at the point of this call: defer real initialization to
     59      * WebViewProvider.init().
     60      * @param privateAccess provides access into WebView internal methods.
     61      */
     62     WebViewProvider createWebView(WebView webView, WebView.PrivateAccess privateAccess);
     63 
     64     /**
     65      * Gets the singleton GeolocationPermissions instance for this WebView implementation. The
     66      * implementation must return the same instance on subsequent calls.
     67      * @return the single GeolocationPermissions instance.
     68      */
     69     GeolocationPermissions getGeolocationPermissions();
     70 
     71     /**
     72      * Gets the singleton CookieManager instance for this WebView implementation. The
     73      * implementation must return the same instance on subsequent calls.
     74      *
     75      * @return the singleton CookieManager instance
     76      */
     77     CookieManager getCookieManager();
     78 
     79     /**
     80      * Gets the singleton WebIconDatabase instance for this WebView implementation. The
     81      * implementation must return the same instance on subsequent calls.
     82      *
     83      * @return the singleton WebIconDatabase instance
     84      */
     85     WebIconDatabase getWebIconDatabase();
     86 
     87     /**
     88      * Gets the singleton WebStorage instance for this WebView implementation. The
     89      * implementation must return the same instance on subsequent calls.
     90      *
     91      * @return the singleton WebStorage instance
     92      */
     93     WebStorage getWebStorage();
     94 
     95     /**
     96      * Gets the singleton WebViewDatabase instance for this WebView implementation. The
     97      * implementation must return the same instance on subsequent calls.
     98      *
     99      * @return the singleton WebViewDatabase instance
    100      */
    101     WebViewDatabase getWebViewDatabase(Context context);
    102 }
    103