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
17package android.webkit;
18
19import android.content.res.Configuration;
20import android.graphics.Bitmap;
21import android.graphics.Canvas;
22import android.graphics.Paint;
23import android.graphics.Picture;
24import android.graphics.Rect;
25import android.graphics.drawable.Drawable;
26import android.net.http.SslCertificate;
27import android.os.Bundle;
28import android.os.Message;
29import android.view.KeyEvent;
30import android.view.MotionEvent;
31import android.view.View;
32import android.view.ViewGroup.LayoutParams;
33import android.view.accessibility.AccessibilityEvent;
34import android.view.accessibility.AccessibilityNodeInfo;
35import android.view.inputmethod.EditorInfo;
36import android.view.inputmethod.InputConnection;
37import android.webkit.WebView.HitTestResult;
38import android.webkit.WebView.PictureListener;
39
40import java.io.File;
41import java.util.Map;
42
43/**
44 * WebView backend provider interface: this interface is the abstract backend to a WebView
45 * instance; each WebView object is bound to exactly one WebViewProvider object which implements
46 * the runtime behavior of that WebView.
47 *
48 * All methods must behave as per their namesake in {@link WebView}, unless otherwise noted.
49 *
50 * @hide Not part of the public API; only required by system implementors.
51 */
52public interface WebViewProvider {
53    //-------------------------------------------------------------------------
54    // Main interface for backend provider of the WebView class.
55    //-------------------------------------------------------------------------
56    /**
57     * Initialize this WebViewProvider instance. Called after the WebView has fully constructed.
58     * @param javaScriptInterfaces is a Map of interface names, as keys, and
59     * object implementing those interfaces, as values.
60     * @param privateBrowsing If true the web view will be initialized in private / incognito mode.
61     */
62    public void init(Map<String, Object> javaScriptInterfaces,
63            boolean privateBrowsing);
64
65    public void setHorizontalScrollbarOverlay(boolean overlay);
66
67    public void setVerticalScrollbarOverlay(boolean overlay);
68
69    public boolean overlayHorizontalScrollbar();
70
71    public boolean overlayVerticalScrollbar();
72
73    public int getVisibleTitleHeight();
74
75    public SslCertificate getCertificate();
76
77    public void setCertificate(SslCertificate certificate);
78
79    public void savePassword(String host, String username, String password);
80
81    public void setHttpAuthUsernamePassword(String host, String realm,
82            String username, String password);
83
84    public String[] getHttpAuthUsernamePassword(String host, String realm);
85
86    /**
87     * See {@link WebView#destroy()}.
88     * As well as releasing the internal state and resources held by the implementation,
89     * the provider should null all references it holds on the WebView proxy class, and ensure
90     * no further method calls are made to it.
91     */
92    public void destroy();
93
94    public void setNetworkAvailable(boolean networkUp);
95
96    public WebBackForwardList saveState(Bundle outState);
97
98    public boolean savePicture(Bundle b, final File dest);
99
100    public boolean restorePicture(Bundle b, File src);
101
102    public WebBackForwardList restoreState(Bundle inState);
103
104    public void loadUrl(String url, Map<String, String> additionalHttpHeaders);
105
106    public void loadUrl(String url);
107
108    public void postUrl(String url, byte[] postData);
109
110    public void loadData(String data, String mimeType, String encoding);
111
112    public void loadDataWithBaseURL(String baseUrl, String data,
113            String mimeType, String encoding, String historyUrl);
114
115    public void saveWebArchive(String filename);
116
117    public void saveWebArchive(String basename, boolean autoname, ValueCallback<String> callback);
118
119    public void stopLoading();
120
121    public void reload();
122
123    public boolean canGoBack();
124
125    public void goBack();
126
127    public boolean canGoForward();
128
129    public void goForward();
130
131    public boolean canGoBackOrForward(int steps);
132
133    public void goBackOrForward(int steps);
134
135    public boolean isPrivateBrowsingEnabled();
136
137    public boolean pageUp(boolean top);
138
139    public boolean pageDown(boolean bottom);
140
141    public void clearView();
142
143    public Picture capturePicture();
144
145    public float getScale();
146
147    public void setInitialScale(int scaleInPercent);
148
149    public void invokeZoomPicker();
150
151    public HitTestResult getHitTestResult();
152
153    public void requestFocusNodeHref(Message hrefMsg);
154
155    public void requestImageRef(Message msg);
156
157    public String getUrl();
158
159    public String getOriginalUrl();
160
161    public String getTitle();
162
163    public Bitmap getFavicon();
164
165    public String getTouchIconUrl();
166
167    public int getProgress();
168
169    public int getContentHeight();
170
171    public int getContentWidth();
172
173    public void pauseTimers();
174
175    public void resumeTimers();
176
177    public void onPause();
178
179    public void onResume();
180
181    public boolean isPaused();
182
183    public void freeMemory();
184
185    public void clearCache(boolean includeDiskFiles);
186
187    public void clearFormData();
188
189    public void clearHistory();
190
191    public void clearSslPreferences();
192
193    public WebBackForwardList copyBackForwardList();
194
195    public void setFindListener(WebView.FindListener listener);
196
197    public void findNext(boolean forward);
198
199    public int findAll(String find);
200
201    public void findAllAsync(String find);
202
203    public boolean showFindDialog(String text, boolean showIme);
204
205    public void clearMatches();
206
207    public void documentHasImages(Message response);
208
209    public void setWebViewClient(WebViewClient client);
210
211    public void setDownloadListener(DownloadListener listener);
212
213    public void setWebChromeClient(WebChromeClient client);
214
215    public void setPictureListener(PictureListener listener);
216
217    public void addJavascriptInterface(Object obj, String interfaceName);
218
219    public void removeJavascriptInterface(String interfaceName);
220
221    public WebSettings getSettings();
222
223    public void emulateShiftHeld();
224
225    public void setMapTrackballToArrowKeys(boolean setMap);
226
227    public void flingScroll(int vx, int vy);
228
229    public View getZoomControls();
230
231    public boolean canZoomIn();
232
233    public boolean canZoomOut();
234
235    public boolean zoomIn();
236
237    public boolean zoomOut();
238
239    public void debugDump();
240
241    //-------------------------------------------------------------------------
242    // Provider glue methods
243    //-------------------------------------------------------------------------
244
245    /**
246     * @return the ViewDelegate implementation. This provides the functionality to back all of
247     * the name-sake functions from the View and ViewGroup base classes of WebView.
248     */
249    /* package */ ViewDelegate getViewDelegate();
250
251    /**
252     * @return a ScrollDelegate implementation. Normally this would be same object as is
253     * returned by getViewDelegate().
254     */
255    /* package */ ScrollDelegate getScrollDelegate();
256
257    //-------------------------------------------------------------------------
258    // View / ViewGroup delegation methods
259    //-------------------------------------------------------------------------
260
261    /**
262     * Provides mechanism for the name-sake methods declared in View and ViewGroup to be delegated
263     * into the WebViewProvider instance.
264     * NOTE For many of these methods, the WebView will provide a super.Foo() call before or after
265     * making the call into the provider instance. This is done for convenience in the common case
266     * of maintaining backward compatibility. For remaining super class calls (e.g. where the
267     * provider may need to only conditionally make the call based on some internal state) see the
268     * {@link WebView.PrivateAccess} callback class.
269     */
270    // TODO: See if the pattern of the super-class calls can be rationalized at all, and document
271    // the remainder on the methods below.
272    interface ViewDelegate {
273        public boolean shouldDelayChildPressedState();
274
275        public void onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo info);
276
277        public void onInitializeAccessibilityEvent(AccessibilityEvent event);
278
279        public boolean performAccessibilityAction(int action, Bundle arguments);
280
281        public void setOverScrollMode(int mode);
282
283        public void setScrollBarStyle(int style);
284
285        public void onDrawVerticalScrollBar(Canvas canvas, Drawable scrollBar, int l, int t,
286                int r, int b);
287
288        public void onOverScrolled(int scrollX, int scrollY, boolean clampedX, boolean clampedY);
289
290        public void onWindowVisibilityChanged(int visibility);
291
292        public void onDraw(Canvas canvas);
293
294        public void setLayoutParams(LayoutParams layoutParams);
295
296        public boolean performLongClick();
297
298        public void onConfigurationChanged(Configuration newConfig);
299
300        public InputConnection onCreateInputConnection(EditorInfo outAttrs);
301
302        public boolean onKeyMultiple(int keyCode, int repeatCount, KeyEvent event);
303
304        public boolean onKeyDown(int keyCode, KeyEvent event);
305
306        public boolean onKeyUp(int keyCode, KeyEvent event);
307
308        public void onAttachedToWindow();
309
310        public void onDetachedFromWindow();
311
312        public void onVisibilityChanged(View changedView, int visibility);
313
314        public void onWindowFocusChanged(boolean hasWindowFocus);
315
316        public void onFocusChanged(boolean focused, int direction, Rect previouslyFocusedRect);
317
318        public boolean setFrame(int left, int top, int right, int bottom);
319
320        public void onSizeChanged(int w, int h, int ow, int oh);
321
322        public void onScrollChanged(int l, int t, int oldl, int oldt);
323
324        public boolean dispatchKeyEvent(KeyEvent event);
325
326        public boolean onTouchEvent(MotionEvent ev);
327
328        public boolean onHoverEvent(MotionEvent event);
329
330        public boolean onGenericMotionEvent(MotionEvent event);
331
332        public boolean onTrackballEvent(MotionEvent ev);
333
334        public boolean requestFocus(int direction, Rect previouslyFocusedRect);
335
336        public void onMeasure(int widthMeasureSpec, int heightMeasureSpec);
337
338        public boolean requestChildRectangleOnScreen(View child, Rect rect, boolean immediate);
339
340        public void setBackgroundColor(int color);
341
342        public void setLayerType(int layerType, Paint paint);
343    }
344
345    interface ScrollDelegate {
346        // These methods are declared protected in the ViewGroup base class. This interface
347        // exists to promote them to public so they may be called by the WebView proxy class.
348        // TODO: Combine into ViewDelegate?
349        /**
350         * See {@link android.webkit.WebView#computeHorizontalScrollRange}
351         */
352        public int computeHorizontalScrollRange();
353
354        /**
355         * See {@link android.webkit.WebView#computeHorizontalScrollOffset}
356         */
357        public int computeHorizontalScrollOffset();
358
359        /**
360         * See {@link android.webkit.WebView#computeVerticalScrollRange}
361         */
362        public int computeVerticalScrollRange();
363
364        /**
365         * See {@link android.webkit.WebView#computeVerticalScrollOffset}
366         */
367        public int computeVerticalScrollOffset();
368
369        /**
370         * See {@link android.webkit.WebView#computeVerticalScrollExtent}
371         */
372        public int computeVerticalScrollExtent();
373
374        /**
375         * See {@link android.webkit.WebView#computeScroll}
376         */
377        public void computeScroll();
378    }
379}
380