1// Copyright (c) 2012 The Chromium Authors. All rights reserved. 2// Use of this source code is governed by a BSD-style license that can be 3// found in the LICENSE file. 4 5package org.chromium.content.browser; 6 7import android.app.Activity; 8import android.content.Context; 9import android.content.res.Configuration; 10import android.graphics.Bitmap; 11import android.graphics.Canvas; 12import android.graphics.Rect; 13import android.os.Build; 14import android.util.AttributeSet; 15import android.view.KeyEvent; 16import android.view.MotionEvent; 17import android.view.View; 18import android.view.accessibility.AccessibilityEvent; 19import android.view.accessibility.AccessibilityNodeInfo; 20import android.view.inputmethod.EditorInfo; 21import android.view.inputmethod.InputConnection; 22import android.widget.FrameLayout; 23 24import com.google.common.annotations.VisibleForTesting; 25 26import org.chromium.content.common.TraceEvent; 27import org.chromium.ui.WindowAndroid; 28 29/** 30 * The containing view for {@link ContentViewCore} that exists in the Android UI hierarchy and 31 * exposes the various {@link View} functionality to it. 32 * 33 * TODO(joth): Remove any methods overrides from this class that were added for WebView 34 * compatibility. 35 */ 36public class ContentView extends FrameLayout 37 implements ContentViewCore.InternalAccessDelegate, PageInfo { 38 39 private final ContentViewCore mContentViewCore; 40 41 private float mCurrentTouchOffsetX; 42 private float mCurrentTouchOffsetY; 43 44 /** 45 * Creates an instance of a ContentView. 46 * @param context The Context the view is running in, through which it can 47 * access the current theme, resources, etc. 48 * @param nativeWebContents A pointer to the native web contents. 49 * @param windowAndroid An instance of the WindowAndroid. 50 * @return A ContentView instance. 51 */ 52 public static ContentView newInstance(Context context, int nativeWebContents, 53 WindowAndroid windowAndroid) { 54 return newInstance(context, nativeWebContents, windowAndroid, null, 55 android.R.attr.webViewStyle); 56 } 57 58 /** 59 * Creates an instance of a ContentView. 60 * @param context The Context the view is running in, through which it can 61 * access the current theme, resources, etc. 62 * @param nativeWebContents A pointer to the native web contents. 63 * @param windowAndroid An instance of the WindowAndroid. 64 * @param attrs The attributes of the XML tag that is inflating the view. 65 * @return A ContentView instance. 66 */ 67 public static ContentView newInstance(Context context, int nativeWebContents, 68 WindowAndroid windowAndroid, AttributeSet attrs) { 69 // TODO(klobag): use the WebViewStyle as the default style for now. It enables scrollbar. 70 // When ContentView is moved to framework, we can define its own style in the res. 71 return newInstance(context, nativeWebContents, windowAndroid, attrs, 72 android.R.attr.webViewStyle); 73 } 74 75 /** 76 * Creates an instance of a ContentView. 77 * @param context The Context the view is running in, through which it can 78 * access the current theme, resources, etc. 79 * @param nativeWebContents A pointer to the native web contents. 80 * @param windowAndroid An instance of the WindowAndroid. 81 * @param attrs The attributes of the XML tag that is inflating the view. 82 * @param defStyle The default style to apply to this view. 83 * @return A ContentView instance. 84 */ 85 public static ContentView newInstance(Context context, int nativeWebContents, 86 WindowAndroid windowAndroid, AttributeSet attrs, int defStyle) { 87 if (Build.VERSION.SDK_INT < Build.VERSION_CODES.JELLY_BEAN) { 88 return new ContentView(context, nativeWebContents, windowAndroid, attrs, defStyle); 89 } else { 90 return new JellyBeanContentView(context, nativeWebContents, windowAndroid, attrs, 91 defStyle); 92 } 93 } 94 95 protected ContentView(Context context, int nativeWebContents, WindowAndroid windowAndroid, 96 AttributeSet attrs, int defStyle) { 97 super(context, attrs, defStyle); 98 99 if (getScrollBarStyle() == View.SCROLLBARS_INSIDE_OVERLAY) { 100 setHorizontalScrollBarEnabled(false); 101 setVerticalScrollBarEnabled(false); 102 } 103 104 setFocusable(true); 105 setFocusableInTouchMode(true); 106 107 mContentViewCore = new ContentViewCore(context); 108 mContentViewCore.initialize(this, this, nativeWebContents, windowAndroid, 109 Build.VERSION.SDK_INT >= Build.VERSION_CODES.JELLY_BEAN ? 110 ContentViewCore.INPUT_EVENTS_DELIVERED_AT_VSYNC : 111 ContentViewCore.INPUT_EVENTS_DELIVERED_IMMEDIATELY); 112 } 113 114 // PageInfo implementation. 115 116 @Override 117 public String getUrl() { 118 return mContentViewCore.getUrl(); 119 } 120 121 @Override 122 public String getTitle() { 123 return mContentViewCore.getTitle(); 124 } 125 126 @Override 127 public boolean isReadyForSnapshot() { 128 return !isCrashed() && isReady(); 129 } 130 131 @Override 132 public Bitmap getBitmap() { 133 return getBitmap(getWidth(), getHeight()); 134 } 135 136 @Override 137 public Bitmap getBitmap(int width, int height) { 138 return mContentViewCore.getBitmap(width, height); 139 } 140 141 @Override 142 public int getBackgroundColor() { 143 return mContentViewCore.getBackgroundColor(); 144 } 145 146 @Override 147 public View getView() { 148 return this; 149 } 150 151 /** 152 * @return The core component of the ContentView that handles JNI communication. Should only be 153 * used for passing to native. 154 */ 155 public ContentViewCore getContentViewCore() { 156 return mContentViewCore; 157 } 158 159 /** 160 * @return The cache of scales and positions used to convert coordinates from/to CSS. 161 */ 162 public RenderCoordinates getRenderCoordinates() { 163 return mContentViewCore.getRenderCoordinates(); 164 } 165 166 /** 167 * Returns true if the given Activity has hardware acceleration enabled 168 * in its manifest, or in its foreground window. 169 * 170 * TODO(husky): Remove when ContentViewCore.initialize() is refactored (see TODO there) 171 * TODO(dtrainor) This is still used by other classes. Make sure to pull some version of this 172 * out before removing it. 173 */ 174 public static boolean hasHardwareAcceleration(Activity activity) { 175 return ContentViewCore.hasHardwareAcceleration(activity); 176 } 177 178 /** 179 * Destroy the internal state of the WebView. This method may only be called 180 * after the WebView has been removed from the view system. No other methods 181 * may be called on this WebView after this method has been called. 182 */ 183 public void destroy() { 184 mContentViewCore.destroy(); 185 } 186 187 /** 188 * Returns true initially, false after destroy() has been called. 189 * It is illegal to call any other public method after destroy(). 190 */ 191 public boolean isAlive() { 192 return mContentViewCore.isAlive(); 193 } 194 195 /** 196 * For internal use. Throws IllegalStateException if mNativeContentView is 0. 197 * Use this to ensure we get a useful Java stack trace, rather than a native 198 * crash dump, from use-after-destroy bugs in Java code. 199 */ 200 void checkIsAlive() throws IllegalStateException { 201 mContentViewCore.checkIsAlive(); 202 } 203 204 public void setContentViewClient(ContentViewClient client) { 205 mContentViewCore.setContentViewClient(client); 206 } 207 208 @VisibleForTesting 209 public ContentViewClient getContentViewClient() { 210 return mContentViewCore.getContentViewClient(); 211 } 212 213 /** 214 * Load url without fixing up the url string. Consumers of ContentView are responsible for 215 * ensuring the URL passed in is properly formatted (i.e. the scheme has been added if left 216 * off during user input). 217 * 218 * @param params Parameters for this load. 219 */ 220 public void loadUrl(LoadUrlParams params) { 221 mContentViewCore.loadUrl(params); 222 } 223 224 /** 225 * Stops loading the current web contents. 226 */ 227 public void stopLoading() { 228 mContentViewCore.stopLoading(); 229 } 230 231 /** 232 * @return Whether the current WebContents has a previous navigation entry. 233 */ 234 public boolean canGoBack() { 235 return mContentViewCore.canGoBack(); 236 } 237 238 /** 239 * @return Whether the current WebContents has a navigation entry after the current one. 240 */ 241 public boolean canGoForward() { 242 return mContentViewCore.canGoForward(); 243 } 244 245 /** 246 * @param offset The offset into the navigation history. 247 * @return Whether we can move in history by given offset 248 */ 249 public boolean canGoToOffset(int offset) { 250 return mContentViewCore.canGoToOffset(offset); 251 } 252 253 /** 254 * Navigates to the specified offset from the "current entry". Does nothing if the offset is out 255 * of bounds. 256 * @param offset The offset into the navigation history. 257 */ 258 public void goToOffset(int offset) { 259 mContentViewCore.goToOffset(offset); 260 } 261 262 /** 263 * Goes to the navigation entry before the current one. 264 */ 265 public void goBack() { 266 mContentViewCore.goBack(); 267 } 268 269 /** 270 * Goes to the navigation entry following the current one. 271 */ 272 public void goForward() { 273 mContentViewCore.goForward(); 274 } 275 276 /** 277 * Reload the current page. 278 */ 279 public void reload() { 280 mContentViewCore.reload(); 281 } 282 283 /** 284 * Clears the WebView's page history in both the backwards and forwards 285 * directions. 286 */ 287 public void clearHistory() { 288 mContentViewCore.clearHistory(); 289 } 290 291 /** 292 * Start profiling the update speed. You must call {@link #stopFpsProfiling} 293 * to stop profiling. 294 */ 295 @VisibleForTesting 296 public void startFpsProfiling() { 297 // TODO(nileshagrawal): Implement this. 298 } 299 300 /** 301 * Stop profiling the update speed. 302 */ 303 @VisibleForTesting 304 public float stopFpsProfiling() { 305 // TODO(nileshagrawal): Implement this. 306 return 0.0f; 307 } 308 309 /** 310 * Fling the ContentView from the current position. 311 * @param x Fling touch starting position 312 * @param y Fling touch starting position 313 * @param velocityX Initial velocity of the fling (X) measured in pixels per second. 314 * @param velocityY Initial velocity of the fling (Y) measured in pixels per second. 315 */ 316 @VisibleForTesting 317 public void fling(long timeMs, int x, int y, int velocityX, int velocityY) { 318 mContentViewCore.getContentViewGestureHandler().fling(timeMs, x, y, velocityX, velocityY); 319 } 320 321 /** 322 * Start pinch zoom. You must call {@link #pinchEnd} to stop. 323 */ 324 @VisibleForTesting 325 public void pinchBegin(long timeMs, int x, int y) { 326 mContentViewCore.getContentViewGestureHandler().pinchBegin(timeMs, x, y); 327 } 328 329 /** 330 * Stop pinch zoom. 331 */ 332 @VisibleForTesting 333 public void pinchEnd(long timeMs) { 334 mContentViewCore.getContentViewGestureHandler().pinchEnd(timeMs); 335 } 336 337 void setIgnoreSingleTap(boolean value) { 338 mContentViewCore.getContentViewGestureHandler().setIgnoreSingleTap(value); 339 } 340 341 /** 342 * Modify the ContentView magnification level. The effect of calling this 343 * method is exactly as after "pinch zoom". 344 * 345 * @param timeMs The event time in milliseconds. 346 * @param delta The ratio of the new magnification level over the current 347 * magnification level. 348 * @param anchorX The magnification anchor (X) in the current view 349 * coordinate. 350 * @param anchorY The magnification anchor (Y) in the current view 351 * coordinate. 352 */ 353 @VisibleForTesting 354 public void pinchBy(long timeMs, int anchorX, int anchorY, float delta) { 355 mContentViewCore.getContentViewGestureHandler().pinchBy(timeMs, anchorX, anchorY, delta); 356 } 357 358 /** 359 * Injects the passed JavaScript code in the current page and evaluates it. 360 * 361 * @throws IllegalStateException If the ContentView has been destroyed. 362 */ 363 public void evaluateJavaScript(String script) throws IllegalStateException { 364 mContentViewCore.evaluateJavaScript(script, null); 365 } 366 367 /** 368 * This method should be called when the containing activity is paused. 369 **/ 370 public void onActivityPause() { 371 mContentViewCore.onActivityPause(); 372 } 373 374 /** 375 * This method should be called when the containing activity is resumed. 376 **/ 377 public void onActivityResume() { 378 mContentViewCore.onActivityResume(); 379 } 380 381 /** 382 * To be called when the ContentView is shown. 383 **/ 384 public void onShow() { 385 mContentViewCore.onShow(); 386 } 387 388 /** 389 * To be called when the ContentView is hidden. 390 **/ 391 public void onHide() { 392 mContentViewCore.onHide(); 393 } 394 395 /** 396 * Return the ContentSettings object used to retrieve the settings for this 397 * ContentView. 398 * @return A ContentSettings object that can be used to retrieve this ContentView's 399 * settings. 400 */ 401 public ContentSettings getContentSettings() { 402 return mContentViewCore.getContentSettings(); 403 } 404 405 /** 406 * Hides the select action bar. 407 */ 408 public void hideSelectActionBar() { 409 mContentViewCore.hideSelectActionBar(); 410 } 411 412 // FrameLayout overrides. 413 414 // Needed by ContentViewCore.InternalAccessDelegate 415 @Override 416 public boolean drawChild(Canvas canvas, View child, long drawingTime) { 417 return super.drawChild(canvas, child, drawingTime); 418 } 419 420 @Override 421 protected void onSizeChanged(int w, int h, int ow, int oh) { 422 TraceEvent.begin(); 423 super.onSizeChanged(w, h, ow, oh); 424 mContentViewCore.onSizeChanged(w, h, ow, oh); 425 TraceEvent.end(); 426 } 427 428 @Override 429 public InputConnection onCreateInputConnection(EditorInfo outAttrs) { 430 return mContentViewCore.onCreateInputConnection(outAttrs); 431 } 432 433 @Override 434 public boolean onCheckIsTextEditor() { 435 return mContentViewCore.onCheckIsTextEditor(); 436 } 437 438 @Override 439 protected void onFocusChanged(boolean gainFocus, int direction, Rect previouslyFocusedRect) { 440 TraceEvent.begin(); 441 super.onFocusChanged(gainFocus, direction, previouslyFocusedRect); 442 mContentViewCore.onFocusChanged(gainFocus); 443 TraceEvent.end(); 444 } 445 446 @Override 447 public void onWindowFocusChanged(boolean hasWindowFocus) { 448 super.onWindowFocusChanged(hasWindowFocus); 449 mContentViewCore.onWindowFocusChanged(hasWindowFocus); 450 } 451 452 @Override 453 public boolean onKeyUp(int keyCode, KeyEvent event) { 454 return mContentViewCore.onKeyUp(keyCode, event); 455 } 456 457 @Override 458 public boolean dispatchKeyEventPreIme(KeyEvent event) { 459 return mContentViewCore.dispatchKeyEventPreIme(event); 460 } 461 462 @Override 463 public boolean dispatchKeyEvent(KeyEvent event) { 464 if (isFocused()) { 465 return mContentViewCore.dispatchKeyEvent(event); 466 } else { 467 return super.dispatchKeyEvent(event); 468 } 469 } 470 471 @Override 472 public boolean onTouchEvent(MotionEvent event) { 473 MotionEvent offset = createOffsetMotionEvent(event); 474 boolean consumed = mContentViewCore.onTouchEvent(offset); 475 offset.recycle(); 476 return consumed; 477 } 478 479 /** 480 * Mouse move events are sent on hover enter, hover move and hover exit. 481 * They are sent on hover exit because sometimes it acts as both a hover 482 * move and hover exit. 483 */ 484 @Override 485 public boolean onHoverEvent(MotionEvent event) { 486 MotionEvent offset = createOffsetMotionEvent(event); 487 boolean consumed = mContentViewCore.onHoverEvent(offset); 488 offset.recycle(); 489 return consumed; 490 } 491 492 @Override 493 public boolean onGenericMotionEvent(MotionEvent event) { 494 return mContentViewCore.onGenericMotionEvent(event); 495 } 496 497 @Override 498 public boolean performLongClick() { 499 return false; 500 } 501 502 /** 503 * Sets the current amount to offset incoming touch events by. This is used to handle content 504 * moving and not lining up properly with the android input system. 505 * @param dx The X offset in pixels to shift touch events. 506 * @param dy The Y offset in pixels to shift touch events. 507 */ 508 public void setCurrentMotionEventOffsets(float dx, float dy) { 509 mCurrentTouchOffsetX = dx; 510 mCurrentTouchOffsetY = dy; 511 } 512 513 private MotionEvent createOffsetMotionEvent(MotionEvent src) { 514 MotionEvent dst = MotionEvent.obtain(src); 515 dst.offsetLocation(mCurrentTouchOffsetX, mCurrentTouchOffsetY); 516 return dst; 517 } 518 519 @Override 520 protected void onConfigurationChanged(Configuration newConfig) { 521 mContentViewCore.onConfigurationChanged(newConfig); 522 } 523 524 /** 525 * Currently the ContentView scrolling happens in the native side. In 526 * the Java view system, it is always pinned at (0, 0). scrollBy() and scrollTo() 527 * are overridden, so that View's mScrollX and mScrollY will be unchanged at 528 * (0, 0). This is critical for drawing ContentView correctly. 529 */ 530 @Override 531 public void scrollBy(int x, int y) { 532 mContentViewCore.scrollBy(x, y); 533 } 534 535 @Override 536 public void scrollTo(int x, int y) { 537 mContentViewCore.scrollTo(x, y); 538 } 539 540 @Override 541 protected int computeHorizontalScrollExtent() { 542 // TODO (dtrainor): Need to expose scroll events properly to public. Either make getScroll* 543 // work or expose computeHorizontalScrollOffset()/computeVerticalScrollOffset as public. 544 return mContentViewCore.computeHorizontalScrollExtent(); 545 } 546 547 @Override 548 protected int computeHorizontalScrollOffset() { 549 return mContentViewCore.computeHorizontalScrollOffset(); 550 } 551 552 @Override 553 protected int computeHorizontalScrollRange() { 554 return mContentViewCore.computeHorizontalScrollRange(); 555 } 556 557 @Override 558 protected int computeVerticalScrollExtent() { 559 return mContentViewCore.computeVerticalScrollExtent(); 560 } 561 562 @Override 563 protected int computeVerticalScrollOffset() { 564 return mContentViewCore.computeVerticalScrollOffset(); 565 } 566 567 @Override 568 protected int computeVerticalScrollRange() { 569 return mContentViewCore.computeVerticalScrollRange(); 570 } 571 572 // End FrameLayout overrides. 573 574 @Override 575 public boolean awakenScrollBars(int startDelay, boolean invalidate) { 576 return mContentViewCore.awakenScrollBars(startDelay, invalidate); 577 } 578 579 @Override 580 public boolean awakenScrollBars() { 581 return super.awakenScrollBars(); 582 } 583 584 public int getSingleTapX() { 585 return mContentViewCore.getContentViewGestureHandler().getSingleTapX(); 586 } 587 588 public int getSingleTapY() { 589 return mContentViewCore.getContentViewGestureHandler().getSingleTapY(); 590 } 591 592 @Override 593 public void onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo info) { 594 super.onInitializeAccessibilityNodeInfo(info); 595 mContentViewCore.onInitializeAccessibilityNodeInfo(info); 596 } 597 598 /** 599 * Fills in scrolling values for AccessibilityEvents. 600 * @param event Event being fired. 601 */ 602 @Override 603 public void onInitializeAccessibilityEvent(AccessibilityEvent event) { 604 super.onInitializeAccessibilityEvent(event); 605 mContentViewCore.onInitializeAccessibilityEvent(event); 606 } 607 608 @Override 609 protected void onAttachedToWindow() { 610 super.onAttachedToWindow(); 611 mContentViewCore.onAttachedToWindow(); 612 } 613 614 @Override 615 protected void onDetachedFromWindow() { 616 super.onDetachedFromWindow(); 617 mContentViewCore.onDetachedFromWindow(); 618 } 619 620 @Override 621 protected void onVisibilityChanged(View changedView, int visibility) { 622 super.onVisibilityChanged(changedView, visibility); 623 mContentViewCore.onVisibilityChanged(changedView, visibility); 624 } 625 626 /** 627 * Register the delegate to be used when content can not be handled by 628 * the rendering engine, and should be downloaded instead. This will replace 629 * the current delegate. 630 * @param delegate An implementation of ContentViewDownloadDelegate. 631 */ 632 public void setDownloadDelegate(ContentViewDownloadDelegate delegate) { 633 mContentViewCore.setDownloadDelegate(delegate); 634 } 635 636 // Called by DownloadController. 637 ContentViewDownloadDelegate getDownloadDelegate() { 638 return mContentViewCore.getDownloadDelegate(); 639 } 640 641 public boolean getUseDesktopUserAgent() { 642 return mContentViewCore.getUseDesktopUserAgent(); 643 } 644 645 /** 646 * Set whether or not we're using a desktop user agent for the currently loaded page. 647 * @param override If true, use a desktop user agent. Use a mobile one otherwise. 648 * @param reloadOnChange Reload the page if the UA has changed. 649 */ 650 public void setUseDesktopUserAgent(boolean override, boolean reloadOnChange) { 651 mContentViewCore.setUseDesktopUserAgent(override, reloadOnChange); 652 } 653 654 /** 655 * @return Whether the native ContentView has crashed. 656 */ 657 public boolean isCrashed() { 658 return mContentViewCore.isCrashed(); 659 } 660 661 /** 662 * @return Whether a reload happens when this ContentView is activated. 663 */ 664 public boolean needsReload() { 665 return mContentViewCore.needsReload(); 666 } 667 668 /** 669 * Return the current scale. 670 * @return The current scale. 671 */ 672 public float getScale() { 673 return mContentViewCore.getScale(); 674 } 675 676 /** 677 * If the view is ready to draw contents to the screen. In hardware mode, 678 * the initialization of the surface texture may not occur until after the 679 * view has been added to the layout. This method will return {@code true} 680 * once the texture is actually ready. 681 */ 682 public boolean isReady() { 683 return mContentViewCore.isReady(); 684 } 685 686 /** 687 * Returns whether or not accessibility injection is being used. 688 */ 689 public boolean isInjectingAccessibilityScript() { 690 return mContentViewCore.isInjectingAccessibilityScript(); 691 } 692 693 /** 694 * Enable or disable accessibility features. 695 */ 696 public void setAccessibilityState(boolean state) { 697 mContentViewCore.setAccessibilityState(state); 698 } 699 700 /** 701 * Stop any TTS notifications that are currently going on. 702 */ 703 public void stopCurrentAccessibilityNotifications() { 704 mContentViewCore.stopCurrentAccessibilityNotifications(); 705 } 706 707 /** 708 * Inform WebKit that Fullscreen mode has been exited by the user. 709 */ 710 public void exitFullscreen() { 711 mContentViewCore.exitFullscreen(); 712 } 713 714 /** 715 * Return content scroll y. 716 * 717 * @return The vertical scroll position in pixels. 718 */ 719 public int getContentScrollY() { 720 return mContentViewCore.computeVerticalScrollOffset(); 721 } 722 723 /** 724 * Return content height. 725 * 726 * @return The height of the content in pixels. 727 */ 728 public int getContentHeight() { 729 return mContentViewCore.computeVerticalScrollRange(); 730 } 731 732 /////////////////////////////////////////////////////////////////////////////////////////////// 733 // Start Implementation of ContentViewCore.InternalAccessDelegate // 734 /////////////////////////////////////////////////////////////////////////////////////////////// 735 736 @Override 737 public boolean super_onKeyUp(int keyCode, KeyEvent event) { 738 return super.onKeyUp(keyCode, event); 739 } 740 741 @Override 742 public boolean super_dispatchKeyEventPreIme(KeyEvent event) { 743 return super.dispatchKeyEventPreIme(event); 744 } 745 746 @Override 747 public boolean super_dispatchKeyEvent(KeyEvent event) { 748 return super.dispatchKeyEvent(event); 749 } 750 751 @Override 752 public boolean super_onGenericMotionEvent(MotionEvent event) { 753 return super.onGenericMotionEvent(event); 754 } 755 756 @Override 757 public void super_onConfigurationChanged(Configuration newConfig) { 758 super.onConfigurationChanged(newConfig); 759 } 760 761 @Override 762 public boolean super_awakenScrollBars(int startDelay, boolean invalidate) { 763 return super.awakenScrollBars(startDelay, invalidate); 764 } 765 766 /////////////////////////////////////////////////////////////////////////////////////////////// 767 // End Implementation of ContentViewCore.InternalAccessDelegate // 768 /////////////////////////////////////////////////////////////////////////////////////////////// 769} 770