1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
content / shell / android / java / src / org / chromium / content_shell / Shell.java [blame]
// Copyright 2012 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
package org.chromium.content_shell;
import android.content.Context;
import android.content.Intent;
import android.graphics.Rect;
import android.graphics.drawable.ClipDrawable;
import android.text.TextUtils;
import android.util.AttributeSet;
import android.view.ActionMode;
import android.view.KeyEvent;
import android.view.Menu;
import android.view.MenuItem;
import android.view.View;
import android.view.inputmethod.EditorInfo;
import android.view.inputmethod.InputMethodManager;
import android.widget.EditText;
import android.widget.FrameLayout;
import android.widget.ImageButton;
import android.widget.LinearLayout;
import android.widget.TextView;
import android.widget.TextView.OnEditorActionListener;
import androidx.annotation.Nullable;
import org.jni_zero.CalledByNative;
import org.jni_zero.JNINamespace;
import org.jni_zero.NativeMethods;
import org.chromium.base.Callback;
import org.chromium.base.ResettersForTesting;
import org.chromium.components.embedder_support.view.ContentView;
import org.chromium.components.embedder_support.view.ContentViewRenderView;
import org.chromium.content_public.browser.ActionModeCallback;
import org.chromium.content_public.browser.ActionModeCallbackHelper;
import org.chromium.content_public.browser.LoadUrlParams;
import org.chromium.content_public.browser.NavigationController;
import org.chromium.content_public.browser.SelectionPopupController;
import org.chromium.content_public.browser.Visibility;
import org.chromium.content_public.browser.WebContents;
import org.chromium.ui.base.ViewAndroidDelegate;
import org.chromium.ui.base.WindowAndroid;
/** Container for the various UI components that make up a shell window. */
@JNINamespace("content")
public class Shell extends LinearLayout {
private static final long COMPLETED_PROGRESS_TIMEOUT_MS = 200;
// Stylus handwriting: Setting this ime option instructs stylus writing service to restrict
// capturing writing events slightly outside the Url bar area. This is needed to prevent stylus
// handwriting in inputs in web content area that are very close to url bar area, from being
// committed to Url bar's Edit text. Ex: google.com search field.
private static final String IME_OPTION_RESTRICT_STYLUS_WRITING_AREA =
"restrictDirectWritingArea=true";
private final Runnable mClearProgressRunnable =
new Runnable() {
@Override
public void run() {
mProgressDrawable.setLevel(0);
}
};
private WebContents mWebContents;
private NavigationController mNavigationController;
private EditText mUrlTextView;
private ImageButton mPrevButton;
private ImageButton mNextButton;
private ImageButton mStopReloadButton;
private ClipDrawable mProgressDrawable;
private long mNativeShell;
private ContentViewRenderView mContentViewRenderView;
private WindowAndroid mWindow;
private ShellViewAndroidDelegate mViewAndroidDelegate;
private boolean mLoading;
private boolean mIsFullscreen;
private Callback<Boolean> mOverlayModeChangedCallbackForTesting;
/** Constructor for inflating via XML. */
public Shell(Context context, AttributeSet attrs) {
super(context, attrs);
}
/** Set the SurfaceView being rendered to as soon as it is available. */
public void setContentViewRenderView(ContentViewRenderView contentViewRenderView) {
FrameLayout contentViewHolder = (FrameLayout) findViewById(R.id.contentview_holder);
if (contentViewRenderView == null) {
if (mContentViewRenderView != null) {
contentViewHolder.removeView(mContentViewRenderView);
}
} else {
contentViewHolder.addView(
contentViewRenderView,
new FrameLayout.LayoutParams(
FrameLayout.LayoutParams.MATCH_PARENT,
FrameLayout.LayoutParams.MATCH_PARENT));
}
mContentViewRenderView = contentViewRenderView;
}
/**
* Initializes the Shell for use.
*
* @param nativeShell The pointer to the native Shell object.
* @param window The owning window for this shell.
*/
public void initialize(long nativeShell, WindowAndroid window) {
mNativeShell = nativeShell;
mWindow = window;
}
/**
* Closes the shell and cleans up the native instance, which will handle destroying all
* dependencies.
*/
public void close() {
if (mNativeShell == 0) return;
ShellJni.get().closeShell(mNativeShell);
}
@CalledByNative
private void onNativeDestroyed() {
mWindow = null;
mNativeShell = 0;
mWebContents = null;
}
/**
* @return Whether the Shell has been destroyed.
* @see #onNativeDestroyed()
*/
public boolean isDestroyed() {
return mNativeShell == 0;
}
/**
* @return Whether or not the Shell is loading content.
*/
public boolean isLoading() {
return mLoading;
}
@Override
protected void onFinishInflate() {
super.onFinishInflate();
View toolbar = findViewById(R.id.toolbar);
mProgressDrawable = (ClipDrawable) toolbar.getBackground();
initializeUrlField();
initializeNavigationButtons();
}
private void initializeUrlField() {
mUrlTextView = (EditText) findViewById(R.id.url);
mUrlTextView.setOnEditorActionListener(
new OnEditorActionListener() {
@Override
public boolean onEditorAction(TextView v, int actionId, KeyEvent event) {
if ((actionId != EditorInfo.IME_ACTION_GO)
&& (event == null
|| event.getKeyCode() != KeyEvent.KEYCODE_ENTER
|| event.getAction() != KeyEvent.ACTION_DOWN)) {
return false;
}
loadUrl(mUrlTextView.getText().toString());
setKeyboardVisibilityForUrl(false);
getContentView().requestFocus();
return true;
}
});
mUrlTextView.setOnFocusChangeListener(
new OnFocusChangeListener() {
@Override
public void onFocusChange(View v, boolean hasFocus) {
setKeyboardVisibilityForUrl(hasFocus);
mNextButton.setVisibility(hasFocus ? GONE : VISIBLE);
mPrevButton.setVisibility(hasFocus ? GONE : VISIBLE);
mStopReloadButton.setVisibility(hasFocus ? GONE : VISIBLE);
if (!hasFocus) {
mUrlTextView.setText(mWebContents.getVisibleUrl().getSpec());
}
}
});
mUrlTextView.setOnKeyListener(
new OnKeyListener() {
@Override
public boolean onKey(View v, int keyCode, KeyEvent event) {
if (keyCode == KeyEvent.KEYCODE_BACK) {
getContentView().requestFocus();
return true;
}
return false;
}
});
mUrlTextView.setPrivateImeOptions(IME_OPTION_RESTRICT_STYLUS_WRITING_AREA);
}
/**
* Loads an URL. This will perform minimal amounts of sanitizing of the URL to attempt to
* make it valid.
*
* @param url The URL to be loaded by the shell.
*/
public void loadUrl(String url) {
if (url == null) return;
if (TextUtils.equals(url, mWebContents.getLastCommittedUrl().getSpec())) {
mNavigationController.reload(true);
} else {
mNavigationController.loadUrl(new LoadUrlParams(sanitizeUrl(url)));
}
mUrlTextView.clearFocus();
}
/**
* Given an URL, this performs minimal sanitizing to ensure it will be valid.
* @param url The url to be sanitized.
* @return The sanitized URL.
*/
public static String sanitizeUrl(String url) {
if (url == null) return null;
if (url.startsWith("www.") || url.indexOf(":") == -1) url = "http://" + url;
return url;
}
private void initializeNavigationButtons() {
mPrevButton = (ImageButton) findViewById(R.id.prev);
mPrevButton.setOnClickListener(
new OnClickListener() {
@Override
public void onClick(View v) {
if (mNavigationController.canGoBack()) mNavigationController.goBack();
}
});
mNextButton = (ImageButton) findViewById(R.id.next);
mNextButton.setOnClickListener(
new OnClickListener() {
@Override
public void onClick(View v) {
if (mNavigationController.canGoForward()) mNavigationController.goForward();
}
});
mStopReloadButton = (ImageButton) findViewById(R.id.stop_reload_button);
mStopReloadButton.setOnClickListener(
new OnClickListener() {
@Override
public void onClick(View v) {
if (mLoading) mWebContents.stop();
else mNavigationController.reload(true);
}
});
}
@SuppressWarnings("unused")
@CalledByNative
private void onUpdateUrl(String url) {
mUrlTextView.setText(url);
}
@SuppressWarnings("unused")
@CalledByNative
private void onLoadProgressChanged(double progress) {
removeCallbacks(mClearProgressRunnable);
mProgressDrawable.setLevel((int) (10000.0 * progress));
if (progress == 1.0) postDelayed(mClearProgressRunnable, COMPLETED_PROGRESS_TIMEOUT_MS);
}
@CalledByNative
private void toggleFullscreenModeForTab(boolean enterFullscreen) {
mIsFullscreen = enterFullscreen;
LinearLayout toolBar = (LinearLayout) findViewById(R.id.toolbar);
toolBar.setVisibility(enterFullscreen ? GONE : VISIBLE);
}
@CalledByNative
private boolean isFullscreenForTabOrPending() {
return mIsFullscreen;
}
@SuppressWarnings("unused")
@CalledByNative
private void setIsLoading(boolean loading) {
mLoading = loading;
if (mLoading) {
mStopReloadButton.setImageResource(android.R.drawable.ic_menu_close_clear_cancel);
} else {
mStopReloadButton.setImageResource(R.drawable.ic_refresh);
}
}
public ShellViewAndroidDelegate getViewAndroidDelegate() {
return mViewAndroidDelegate;
}
/**
* Initializes the ContentView based on the native tab contents pointer passed in.
*
* @param webContents A {@link WebContents} object.
*/
@SuppressWarnings("unused")
@CalledByNative
private void initFromNativeTabContents(WebContents webContents) {
Context context = getContext();
ContentView cv = ContentView.createContentView(context, webContents);
mViewAndroidDelegate = new ShellViewAndroidDelegate(cv);
assert (mWebContents != webContents);
if (mWebContents != null) mWebContents.clearNativeReference();
webContents.setDelegates(
"", mViewAndroidDelegate, cv, mWindow, WebContents.createDefaultInternalsHolder());
mWebContents = webContents;
SelectionPopupController.fromWebContents(webContents)
.setActionModeCallback(defaultActionCallback());
mNavigationController = mWebContents.getNavigationController();
if (getParent() != null) mWebContents.updateWebContentsVisibility(Visibility.VISIBLE);
mUrlTextView.setText(mWebContents.getVisibleUrl().getSpec());
((FrameLayout) findViewById(R.id.contentview_holder))
.addView(
cv,
new FrameLayout.LayoutParams(
FrameLayout.LayoutParams.MATCH_PARENT,
FrameLayout.LayoutParams.MATCH_PARENT));
cv.requestFocus();
mContentViewRenderView.setCurrentWebContents(mWebContents);
}
/**
* {@link ActionModeCallback} that uses the default implementation in
* {@link SelectionPopupController}.
*/
private ActionModeCallback defaultActionCallback() {
final ActionModeCallbackHelper helper =
SelectionPopupController.fromWebContents(mWebContents)
.getActionModeCallbackHelper();
return new ActionModeCallback() {
@Override
public boolean onCreateActionMode(ActionMode mode, Menu menu) {
helper.onCreateActionMode(mode, menu);
return true;
}
@Override
public boolean onPrepareActionMode(ActionMode mode, Menu menu) {
return helper.onPrepareActionMode(mode, menu);
}
@Override
public boolean onActionItemClicked(ActionMode mode, MenuItem item) {
return helper.onActionItemClicked(mode, item);
}
@Override
public boolean onDropdownItemClicked(
int groupId,
int id,
@Nullable Intent intent,
@Nullable OnClickListener clickListener) {
return helper.onDropdownItemClicked(groupId, id, intent, clickListener);
}
@Override
public void onDestroyActionMode(ActionMode mode) {
helper.onDestroyActionMode();
}
@Override
public void onGetContentRect(ActionMode mode, View view, Rect outRect) {
helper.onGetContentRect(mode, view, outRect);
}
};
}
@CalledByNative
public void setOverlayMode(boolean useOverlayMode) {
mContentViewRenderView.setOverlayVideoMode(useOverlayMode);
if (mOverlayModeChangedCallbackForTesting != null) {
mOverlayModeChangedCallbackForTesting.onResult(useOverlayMode);
}
}
public void setOverayModeChangedCallbackForTesting(Callback<Boolean> callback) {
mOverlayModeChangedCallbackForTesting = callback;
ResettersForTesting.register(() -> mOverlayModeChangedCallbackForTesting = null);
}
/**
* Enable/Disable navigation(Prev/Next) button if navigation is allowed/disallowed
* in respective direction.
* @param controlId Id of button to update
* @param enabled enable/disable value
*/
@CalledByNative
private void enableUiControl(int controlId, boolean enabled) {
if (controlId == 0) {
mPrevButton.setEnabled(enabled);
} else if (controlId == 1) {
mNextButton.setEnabled(enabled);
}
}
/**
* @return The {@link View} currently shown by this Shell.
*/
public View getContentView() {
ViewAndroidDelegate viewDelegate = mWebContents.getViewAndroidDelegate();
return viewDelegate != null ? viewDelegate.getContainerView() : null;
}
/**
* @return The {@link WebContents} currently managing the content shown by this Shell.
*/
public WebContents getWebContents() {
return mWebContents;
}
private void setKeyboardVisibilityForUrl(boolean visible) {
InputMethodManager imm =
(InputMethodManager) getContext().getSystemService(Context.INPUT_METHOD_SERVICE);
if (visible) {
imm.showSoftInput(mUrlTextView, InputMethodManager.SHOW_IMPLICIT);
} else {
imm.hideSoftInputFromWindow(mUrlTextView.getWindowToken(), 0);
}
}
@NativeMethods
interface Natives {
void closeShell(long shellPtr);
}
}