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