chrome/browser/android/tab_android.h

   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
   5 #ifndef CHROME_BROWSER_ANDROID_TAB_ANDROID_H_
   6 #define CHROME_BROWSER_ANDROID_TAB_ANDROID_H_
   7
   8 #include <jni.h>
   9
  10 #include "base/android/jni_weak_ref.h"
  11 #include "base/callback_forward.h"
  12 #include "base/memory/scoped_ptr.h"
  13 #include "base/strings/string16.h"
  14 #include "chrome/browser/search/instant_service_observer.h"
  15 #include "chrome/browser/sync/glue/synced_tab_delegate_android.h"
  16 #include "chrome/browser/ui/search/search_tab_helper_delegate.h"
  17 #include "chrome/browser/ui/tab_contents/core_tab_helper_delegate.h"
  18 #include "components/favicon/core/favicon_driver_observer.h"
  19 #include "components/sessions/session_id.h"
  20 #include "components/toolbar/toolbar_model.h"
  21 #include "content/public/browser/notification_observer.h"
  22 #include "content/public/browser/notification_registrar.h"
  23
  24 class GURL;
  25 class Profile;
  26 class SkBitmap;
  27
  28 namespace cc {
  29 class Layer;
  30 }
  31
  32 namespace chrome {
  33 struct NavigateParams;
  34 }
  35
  36 namespace chrome {
  37 namespace android {
  38 class ChromeWebContentsDelegateAndroid;
  39 class TabContentManager;
  40 }
  41 }
  42
  43 namespace content {
  44 class ContentViewCore;
  45 class WebContents;
  46 }
  47
  48 namespace offline_pages {
  49 struct OfflinePageItem;
  50 }
  51
  52 namespace prerender {
  53 class PrerenderManager;
  54 }
  55
  56 class TabAndroid : public CoreTabHelperDelegate,
  57                    public InstantServiceObserver,
  58                    public SearchTabHelperDelegate,
  59                    public content::NotificationObserver,
  60                    public favicon::FaviconDriverObserver {
  61  public:
  62   // A Java counterpart will be generated for this enum.
  63   // GENERATED_JAVA_ENUM_PACKAGE: org.chromium.chrome.browser
  64   enum TabLoadStatus {
  65     PAGE_LOAD_FAILED = 0,
  66     DEFAULT_PAGE_LOAD = 1,
  67     PARTIAL_PRERENDERED_PAGE_LOAD = 2,
  68     FULL_PRERENDERED_PAGE_LOAD = 3,
  69   };
  70
  71   // Convenience method to retrieve the Tab associated with the passed
  72   // WebContents.  Can return NULL.
  73   static TabAndroid* FromWebContents(content::WebContents* web_contents);
  74
  75   // Returns the native TabAndroid stored in the Java Tab represented by
  76   // |obj|.
  77   static TabAndroid* GetNativeTab(JNIEnv* env, jobject obj);
  78
  79   // Function to attach helpers to the contentView.
  80   static void AttachTabHelpers(content::WebContents* web_contents);
  81
  82   TabAndroid(JNIEnv* env, jobject obj);
  83   ~TabAndroid() override;
  84
  85   base::android::ScopedJavaLocalRef<jobject> GetJavaObject();
  86
  87   // Return the WebContents, if any, currently owned by this TabAndroid.
  88   content::WebContents* web_contents() const { return web_contents_.get(); }
  89
  90   // Return the cc::Layer that represents the content for this TabAndroid.
  91   scoped_refptr<cc::Layer> GetContentLayer() const;
  92
  93   // Return specific id information regarding this TabAndroid.
  94   const SessionID& session_id() const { return session_tab_id_; }
  95   int GetAndroidId() const;
  96   int GetSyncId() const;
  97
  98   // Return the tab title.
  99   base::string16 GetTitle() const;
 100
 101   // Return the tab url.
 102   GURL GetURL() const;
 103
 104   // Load the tab if it was unloaded from memory.
 105   bool LoadIfNeeded();
 106
 107   // Helper methods to make it easier to access objects from the associated
 108   // WebContents.  Can return NULL.
 109   content::ContentViewCore* GetContentViewCore() const;
 110   Profile* GetProfile() const;
 111   browser_sync::SyncedTabDelegate* GetSyncedTabDelegate() const;
 112
 113   void SetWindowSessionID(SessionID::id_type window_id);
 114   void SetSyncId(int sync_id);
 115
 116   void HandlePopupNavigation(chrome::NavigateParams* params);
 117
 118   bool HasPrerenderedUrl(GURL gurl);
 119
 120   void MakeLoadURLParams(
 121       chrome::NavigateParams* params,
 122       content::NavigationController::LoadURLParams* load_url_params);
 123
 124   // CoreTabHelperDelegate ----------------------------------------------------
 125
 126   void SwapTabContents(content::WebContents* old_contents,
 127                        content::WebContents* new_contents,
 128                        bool did_start_load,
 129                        bool did_finish_load) override;
 130
 131   // Overridden from InstantServiceObserver:
 132   void DefaultSearchProviderChanged(
 133       bool google_base_url_domain_changed) override;
 134
 135   // Overridden from SearchTabHelperDelegate:
 136   void OnWebContentsInstantSupportDisabled(
 137       const content::WebContents* web_contents) override;
 138
 139   // NotificationObserver -----------------------------------------------------
 140   void Observe(int type,
 141                const content::NotificationSource& source,
 142                const content::NotificationDetails& details) override;
 143
 144   // favicon::FaviconDriverObserver -------------------------------------------
 145   void OnFaviconAvailable(const gfx::Image& image) override;
 146   void OnFaviconUpdated(favicon::FaviconDriver* favicon_driver,
 147                         bool icon_url_changed) override;
 148
 149   // Methods called from Java via JNI -----------------------------------------
 150
 151   void Destroy(JNIEnv* env, jobject obj);
 152   void InitWebContents(JNIEnv* env,
 153                        jobject obj,
 154                        jboolean incognito,
 155                        jobject jcontent_view_core,
 156                        jobject jweb_contents_delegate,
 157                        jobject jcontext_menu_populator);
 158   void DestroyWebContents(JNIEnv* env, jobject obj, jboolean delete_native);
 159   base::android::ScopedJavaLocalRef<jobject> GetProfileAndroid(JNIEnv* env,
 160                                                                jobject obj);
 161   TabLoadStatus LoadUrl(JNIEnv* env,
 162                         jobject obj,
 163                         jstring url,
 164                         jstring j_extra_headers,
 165                         jbyteArray j_post_data,
 166                         jint page_transition,
 167                         jstring j_referrer_url,
 168                         jint referrer_policy,
 169                         jboolean is_renderer_initiated,
 170                         jboolean should_replace_current_entry,
 171                         jlong intent_received_timestamp,
 172                         jboolean has_user_gesture);
 173   void SetActiveNavigationEntryTitleForUrl(JNIEnv* env,
 174                                            jobject obj,
 175                                            jstring jurl,
 176                                            jstring jtitle);
 177   bool Print(JNIEnv* env, jobject obj);
 178
 179   // Sets the tab as content to be printed through JNI.
 180   void SetPendingPrint();
 181
 182   // Called to get default favicon of current tab, return null if no
 183   // favicon is avaliable for current tab.
 184   base::android::ScopedJavaLocalRef<jobject> GetFavicon(JNIEnv* env,
 185                                                         jobject obj);
 186
 187   void CreateHistoricalTab(JNIEnv* env, jobject obj);
 188
 189   static void CreateHistoricalTabFromContents(
 190       content::WebContents* web_contents);
 191
 192   void UpdateTopControlsState(JNIEnv* env,
 193                               jobject obj,
 194                               jint constraints,
 195                               jint current,
 196                               jboolean animate);
 197
 198   void LoadOriginalImage(JNIEnv* env, jobject obj);
 199
 200   void SearchByImageInNewTabAsync(JNIEnv* env, jobject obj);
 201
 202   jlong GetBookmarkId(JNIEnv* env, jobject obj, jboolean only_editable);
 203
 204   jboolean IsOfflinePage(JNIEnv* env, jobject obj);
 205
 206   base::android::ScopedJavaLocalRef<jstring> GetOfflinePageOriginalUrl(
 207       JNIEnv* env,
 208       jobject obj);
 209
 210   void SetInterceptNavigationDelegate(JNIEnv* env,
 211                                       jobject obj,
 212                                       jobject delegate);
 213
 214   // TODO(dtrainor): Remove this, pull content_layer() on demand.
 215   void AttachToTabContentManager(JNIEnv* env,
 216                                  jobject obj,
 217                                  jobject jtab_content_manager);
 218
 219   void AttachOverlayContentViewCore(JNIEnv* env,
 220                                     jobject obj,
 221                                     jobject jcontent_view_core,
 222                                     jboolean visible);
 223
 224   void DetachOverlayContentViewCore(JNIEnv* env,
 225                                     jobject obj,
 226                                     jobject jcontent_view_core);
 227
 228   bool HasPrerenderedUrl(JNIEnv* env, jobject obj, jstring url);
 229
 230   // Register the Tab's native methods through JNI.
 231   static bool RegisterTabAndroid(JNIEnv* env);
 232
 233  private:
 234   prerender::PrerenderManager* GetPrerenderManager() const;
 235
 236   const offline_pages::OfflinePageItem* GetOfflinePage(const GURL& url) const;
 237
 238   JavaObjectWeakGlobalRef weak_java_tab_;
 239
 240   // The identifier used by session restore for this tab.
 241   SessionID session_tab_id_;
 242
 243   // Identifier of the window the tab is in.
 244   SessionID session_window_id_;
 245
 246   content::NotificationRegistrar notification_registrar_;
 247
 248   scoped_refptr<cc::Layer> content_layer_;
 249   chrome::android::TabContentManager* tab_content_manager_;
 250
 251   scoped_ptr<content::WebContents> web_contents_;
 252   scoped_ptr<chrome::android::ChromeWebContentsDelegateAndroid>
 253       web_contents_delegate_;
 254
 255   scoped_ptr<browser_sync::SyncedTabDelegateAndroid> synced_tab_delegate_;
 256
 257   DISALLOW_COPY_AND_ASSIGN(TabAndroid);
 258 };
 259
 260 #endif  // CHROME_BROWSER_ANDROID_TAB_ANDROID_H_