Package org.mozilla.geckoview

Class GeckoView

Object

android.view.View

android.view.ViewGroup

android.widget.FrameLayout

org.mozilla.geckoview.GeckoView

All Implemented Interfaces:

Drawable.Callback, AccessibilityEventSource, KeyEvent.Callback, ViewManager, ViewParent, GeckoDisplay.NewSurfaceProvider

@UiThread
public class GeckoView
extends FrameLayout
implements GeckoDisplay.NewSurfaceProvider

A view container that hosts Gecko rendering, manages its surface, and dispatches input/events.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GeckoView.ActivityContextDelegate	This delegate is used to provide the GeckoView an Activity context for certain operations such as retrieving a PrintManager, which requires an Activity context.
static @interface	GeckoView.ViewBackend	View backend type definitions for GeckoView display backends.

Nested classes/interfaces inherited from class android.widget.FrameLayout

FrameLayout.LayoutParams

Nested classes/interfaces inherited from class android.view.ViewGroup

ViewGroup.MarginLayoutParams, ViewGroup.OnHierarchyChangeListener

Nested classes/interfaces inherited from class android.view.View

View.AccessibilityDelegate, View.BaseSavedState, View.DragShadowBuilder, View.MeasureSpec, View.OnApplyWindowInsetsListener, View.OnAttachStateChangeListener, View.OnCapturedPointerListener, View.OnClickListener, View.OnContextClickListener, View.OnCreateContextMenuListener, View.OnDragListener, View.OnFocusChangeListener, View.OnGenericMotionListener, View.OnHoverListener, View.OnKeyListener, View.OnLayoutChangeListener, View.OnLongClickListener, View.OnScrollChangeListener, View.OnSystemUiVisibilityChangeListener, View.OnTouchListener, View.OnUnhandledKeyEventListener

Field Summary

Fields

Modifier and Type	Field	Description
static final int	BACKEND_SURFACE_VIEW	This GeckoView instance will be backed by a SurfaceView.
static final int	BACKEND_TEXTURE_VIEW	This GeckoView instance will be backed by a TextureView.
protected final org.mozilla.geckoview.GeckoView.Display	mDisplay	Manages the underlying GeckoDisplay surface lifecycle and layout.
protected GeckoSession	mSession	The currently attached GeckoSession, or null if none is set.

Fields inherited from class android.view.ViewGroup

CLIP_TO_PADDING_MASK, FOCUS_AFTER_DESCENDANTS, FOCUS_BEFORE_DESCENDANTS, FOCUS_BLOCK_DESCENDANTS, LAYOUT_MODE_CLIP_BOUNDS, LAYOUT_MODE_OPTICAL_BOUNDS, PERSISTENT_ALL_CACHES, PERSISTENT_ANIMATION_CACHE, PERSISTENT_NO_CACHE, PERSISTENT_SCROLLING_CACHE

Fields inherited from class android.view.View

ACCESSIBILITY_DATA_SENSITIVE_AUTO, ACCESSIBILITY_DATA_SENSITIVE_NO, ACCESSIBILITY_DATA_SENSITIVE_YES, ACCESSIBILITY_LIVE_REGION_ASSERTIVE, ACCESSIBILITY_LIVE_REGION_NONE, ACCESSIBILITY_LIVE_REGION_POLITE, ALPHA, AUTOFILL_FLAG_INCLUDE_NOT_IMPORTANT_VIEWS, AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_DATE, AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_DAY, AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_MONTH, AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_YEAR, AUTOFILL_HINT_CREDIT_CARD_NUMBER, AUTOFILL_HINT_CREDIT_CARD_SECURITY_CODE, AUTOFILL_HINT_EMAIL_ADDRESS, AUTOFILL_HINT_NAME, AUTOFILL_HINT_PASSWORD, AUTOFILL_HINT_PHONE, AUTOFILL_HINT_POSTAL_ADDRESS, AUTOFILL_HINT_POSTAL_CODE, AUTOFILL_HINT_USERNAME, AUTOFILL_TYPE_DATE, AUTOFILL_TYPE_LIST, AUTOFILL_TYPE_NONE, AUTOFILL_TYPE_TEXT, AUTOFILL_TYPE_TOGGLE, CONTENT_SENSITIVITY_AUTO, CONTENT_SENSITIVITY_NOT_SENSITIVE, CONTENT_SENSITIVITY_SENSITIVE, DRAG_FLAG_ACCESSIBILITY_ACTION, DRAG_FLAG_GLOBAL, DRAG_FLAG_GLOBAL_PERSISTABLE_URI_PERMISSION, DRAG_FLAG_GLOBAL_PREFIX_URI_PERMISSION, DRAG_FLAG_GLOBAL_SAME_APPLICATION, DRAG_FLAG_GLOBAL_URI_READ, DRAG_FLAG_GLOBAL_URI_WRITE, DRAG_FLAG_HIDE_CALLING_TASK_ON_DRAG_START, DRAG_FLAG_OPAQUE, DRAG_FLAG_START_INTENT_SENDER_ON_UNHANDLED_DRAG, DRAWING_CACHE_QUALITY_AUTO, DRAWING_CACHE_QUALITY_HIGH, DRAWING_CACHE_QUALITY_LOW, EMPTY_STATE_SET, ENABLED_FOCUSED_SELECTED_STATE_SET, ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET, ENABLED_FOCUSED_STATE_SET, ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET, ENABLED_SELECTED_STATE_SET, ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET, ENABLED_STATE_SET, ENABLED_WINDOW_FOCUSED_STATE_SET, FIND_VIEWS_WITH_CONTENT_DESCRIPTION, FIND_VIEWS_WITH_TEXT, FOCUS_BACKWARD, FOCUS_DOWN, FOCUS_FORWARD, FOCUS_LEFT, FOCUS_RIGHT, FOCUS_UP, FOCUSABLE, FOCUSABLE_AUTO, FOCUSABLES_ALL, FOCUSABLES_TOUCH_MODE, FOCUSED_SELECTED_STATE_SET, FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET, FOCUSED_STATE_SET, FOCUSED_WINDOW_FOCUSED_STATE_SET, GONE, HAPTIC_FEEDBACK_ENABLED, IMPORTANT_FOR_ACCESSIBILITY_AUTO, IMPORTANT_FOR_ACCESSIBILITY_NO, IMPORTANT_FOR_ACCESSIBILITY_NO_HIDE_DESCENDANTS, IMPORTANT_FOR_ACCESSIBILITY_YES, IMPORTANT_FOR_AUTOFILL_AUTO, IMPORTANT_FOR_AUTOFILL_NO, IMPORTANT_FOR_AUTOFILL_NO_EXCLUDE_DESCENDANTS, IMPORTANT_FOR_AUTOFILL_YES, IMPORTANT_FOR_AUTOFILL_YES_EXCLUDE_DESCENDANTS, IMPORTANT_FOR_CONTENT_CAPTURE_AUTO, IMPORTANT_FOR_CONTENT_CAPTURE_NO, IMPORTANT_FOR_CONTENT_CAPTURE_NO_EXCLUDE_DESCENDANTS, IMPORTANT_FOR_CONTENT_CAPTURE_YES, IMPORTANT_FOR_CONTENT_CAPTURE_YES_EXCLUDE_DESCENDANTS, INVISIBLE, KEEP_SCREEN_ON, LAYER_TYPE_HARDWARE, LAYER_TYPE_NONE, LAYER_TYPE_SOFTWARE, LAYOUT_DIRECTION_INHERIT, LAYOUT_DIRECTION_LOCALE, LAYOUT_DIRECTION_LTR, LAYOUT_DIRECTION_RTL, MEASURED_HEIGHT_STATE_SHIFT, MEASURED_SIZE_MASK, MEASURED_STATE_MASK, MEASURED_STATE_TOO_SMALL, NO_ID, NOT_FOCUSABLE, OVER_SCROLL_ALWAYS, OVER_SCROLL_IF_CONTENT_SCROLLS, OVER_SCROLL_NEVER, PRESSED_ENABLED_FOCUSED_SELECTED_STATE_SET, PRESSED_ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET, PRESSED_ENABLED_FOCUSED_STATE_SET, PRESSED_ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET, PRESSED_ENABLED_SELECTED_STATE_SET, PRESSED_ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET, PRESSED_ENABLED_STATE_SET, PRESSED_ENABLED_WINDOW_FOCUSED_STATE_SET, PRESSED_FOCUSED_SELECTED_STATE_SET, PRESSED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET, PRESSED_FOCUSED_STATE_SET, PRESSED_FOCUSED_WINDOW_FOCUSED_STATE_SET, PRESSED_SELECTED_STATE_SET, PRESSED_SELECTED_WINDOW_FOCUSED_STATE_SET, PRESSED_STATE_SET, PRESSED_WINDOW_FOCUSED_STATE_SET, RECTANGLE_ON_SCREEN_REQUEST_SOURCE_INPUT_FOCUS, RECTANGLE_ON_SCREEN_REQUEST_SOURCE_SCROLL_ONLY, RECTANGLE_ON_SCREEN_REQUEST_SOURCE_TEXT_CURSOR, RECTANGLE_ON_SCREEN_REQUEST_SOURCE_UNDEFINED, REQUESTED_FRAME_RATE_CATEGORY_DEFAULT, REQUESTED_FRAME_RATE_CATEGORY_HIGH, REQUESTED_FRAME_RATE_CATEGORY_LOW, REQUESTED_FRAME_RATE_CATEGORY_NO_PREFERENCE, REQUESTED_FRAME_RATE_CATEGORY_NORMAL, ROTATION, ROTATION_X, ROTATION_Y, SCALE_X, SCALE_Y, SCREEN_STATE_OFF, SCREEN_STATE_ON, SCROLL_AXIS_HORIZONTAL, SCROLL_AXIS_NONE, SCROLL_AXIS_VERTICAL, SCROLL_CAPTURE_HINT_AUTO, SCROLL_CAPTURE_HINT_EXCLUDE, SCROLL_CAPTURE_HINT_EXCLUDE_DESCENDANTS, SCROLL_CAPTURE_HINT_INCLUDE, SCROLL_INDICATOR_BOTTOM, SCROLL_INDICATOR_END, SCROLL_INDICATOR_LEFT, SCROLL_INDICATOR_RIGHT, SCROLL_INDICATOR_START, SCROLL_INDICATOR_TOP, SCROLLBAR_POSITION_DEFAULT, SCROLLBAR_POSITION_LEFT, SCROLLBAR_POSITION_RIGHT, SCROLLBARS_INSIDE_INSET, SCROLLBARS_INSIDE_OVERLAY, SCROLLBARS_OUTSIDE_INSET, SCROLLBARS_OUTSIDE_OVERLAY, SELECTED_STATE_SET, SELECTED_WINDOW_FOCUSED_STATE_SET, SOUND_EFFECTS_ENABLED, STATUS_BAR_HIDDEN, STATUS_BAR_VISIBLE, SYSTEM_UI_FLAG_FULLSCREEN, SYSTEM_UI_FLAG_HIDE_NAVIGATION, SYSTEM_UI_FLAG_IMMERSIVE, SYSTEM_UI_FLAG_IMMERSIVE_STICKY, SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN, SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION, SYSTEM_UI_FLAG_LAYOUT_STABLE, SYSTEM_UI_FLAG_LIGHT_NAVIGATION_BAR, SYSTEM_UI_FLAG_LIGHT_STATUS_BAR, SYSTEM_UI_FLAG_LOW_PROFILE, SYSTEM_UI_FLAG_VISIBLE, SYSTEM_UI_LAYOUT_FLAGS, TEXT_ALIGNMENT_CENTER, TEXT_ALIGNMENT_GRAVITY, TEXT_ALIGNMENT_INHERIT, TEXT_ALIGNMENT_TEXT_END, TEXT_ALIGNMENT_TEXT_START, TEXT_ALIGNMENT_VIEW_END, TEXT_ALIGNMENT_VIEW_START, TEXT_DIRECTION_ANY_RTL, TEXT_DIRECTION_FIRST_STRONG, TEXT_DIRECTION_FIRST_STRONG_LTR, TEXT_DIRECTION_FIRST_STRONG_RTL, TEXT_DIRECTION_INHERIT, TEXT_DIRECTION_LOCALE, TEXT_DIRECTION_LTR, TEXT_DIRECTION_RTL, TRANSLATION_X, TRANSLATION_Y, TRANSLATION_Z, VIEW_LOG_TAG, VISIBLE, WINDOW_FOCUSED_STATE_SET, X, Y, Z

Constructor Summary

Constructors

Constructor	Description
GeckoView(Context context)	Construct a new GeckoView instance.
GeckoView(Context context, AttributeSet attrs)	Construct a new GeckoView with layout attributes.

Method Summary

Modifier and Type	Method	Description
void	addWindowInsetsListener(String key, androidx.core.view.OnApplyWindowInsetsListener listener)	Add an OnApplyWindowInsetsListener to observe the root view WindowInsets changes.
void	autofill(SparseArray<AutofillValue> values)
GeckoResult<Bitmap>	capturePixels()	Request a Bitmap of the visible portion of the web page currently being rendered.
void	coverUntilFirstPaint(int color)	Set a color to cover the display surface while a document is being shown.
void	dispatchDraw(Canvas canvas)
boolean	gatherTransparentRegion(Region region)
GeckoView.ActivityContextDelegate	getActivityContextDelegate()	Gets the delegate from the GeckoView.
boolean	getAutofillEnabled()
Handler	getHandler()
PanZoomController	getPanZoomController()	Retrieves the controller responsible for panning and zooming gestures.
GeckoSession.PrintDelegate	getPrintDelegate()	Retrieves the GeckoView's print delegate.
void	getPrintDelegate(GeckoSession.PrintDelegate delegate)	Sets the GeckoView's print delegate.
GeckoSession	getSession()	Returns the current GeckoSession attached to this view.
boolean	isVisibleToUserForAutofill(int virtualId)
void	onAttachedToWindow()
protected void	onConfigurationChanged(Configuration newConfig)
InputConnection	onCreateInputConnection(EditorInfo outAttrs)
void	onDetachedFromWindow()
boolean	onDragEvent(DragEvent event)	Handle drag and drop event
protected void	onFocusChanged(boolean gainFocus, int direction, Rect previouslyFocusedRect)
boolean	onGenericMotionEvent(MotionEvent event)
boolean	onKeyDown(int keyCode, KeyEvent event)
boolean	onKeyLongPress(int keyCode, KeyEvent event)
boolean	onKeyMultiple(int keyCode, int repeatCount, KeyEvent event)
boolean	onKeyPreIme(int keyCode, KeyEvent event)
boolean	onKeyUp(int keyCode, KeyEvent event)
void	onProvideAutofillVirtualStructure(ViewStructure structure, int flags)
boolean	onTouchEvent(MotionEvent event)
GeckoResult<PanZoomController.InputResultDetail>	onTouchEventForDetailResult(MotionEvent event)	Dispatches a MotionEvent to the PanZoomController.
void	onWindowFocusChanged(boolean hasWindowFocus)
protected void	onWindowVisibilityChanged(int visibility)
GeckoSession	releaseSession()	Unsets the current session from this instance and returns it, if any.
void	removeWindowInsetsListener(String key)	Remove the OnApplyWindowInsetsListener to stop observing WindowInsets changed.
void	requestNewSurface()	Called by Gecko to request a new Surface from the application.
void	setActivityContextDelegate(GeckoView.ActivityContextDelegate delegate)	Sets the delegate for the GeckoView.
void	setAutofillEnabled(boolean enabled)	Sets whether or not this View participates in Android autofill.
void	setDynamicToolbarMaxHeight(int height)	Set the maximum height of the dynamic toolbar(s).
void	setSession(GeckoSession session)	Attach a session to this view.
void	setVerticalClipping(int clippingHeight)	Update the amount of vertical space that is clipped or visibly obscured in the bottom portion of the view.
void	setViewBackend(int backend)	Set which view should be used by this GeckoView instance to display content.
boolean	shouldPinOnScreen()	Return whether the view should be pinned on the screen.

Methods inherited from class android.widget.FrameLayout

checkLayoutParams, generateDefaultLayoutParams, generateLayoutParams, generateLayoutParams, getAccessibilityClassName, getConsiderGoneChildrenWhenMeasuring, getMeasureAllChildren, onLayout, onMeasure, setForegroundGravity, setMeasureAllChildren, shouldDelayChildPressedState

Methods inherited from class android.view.ViewGroup

addChildrenForAccessibility, addExtraDataToAccessibilityNodeInfo, addFocusables, addKeyboardNavigationClusters, addStatesFromChildren, addTouchables, addView, addView, addView, addView, addView, addViewInLayout, addViewInLayout, attachLayoutAnimationParameters, attachViewToParent, bringChildToFront, canAnimate, childDrawableStateChanged, childHasTransientStateChanged, cleanupLayoutState, clearChildFocus, clearDisappearingChildren, clearFocus, debug, detachAllViewsFromParent, detachViewFromParent, detachViewFromParent, detachViewsFromParent, dispatchApplyWindowInsets, dispatchCapturedPointerEvent, dispatchConfigurationChanged, dispatchCreateViewTranslationRequest, dispatchDisplayHint, dispatchDragEvent, dispatchDrawableHotspotChanged, dispatchFinishTemporaryDetach, dispatchFreezeSelfOnly, dispatchGenericFocusedEvent, dispatchGenericPointerEvent, dispatchHoverEvent, dispatchKeyEvent, dispatchKeyEventPreIme, dispatchKeyShortcutEvent, dispatchPointerCaptureChanged, dispatchProvideAutofillStructure, dispatchProvideStructure, dispatchRestoreInstanceState, dispatchSaveInstanceState, dispatchScrollCaptureSearch, dispatchSetActivated, dispatchSetPressed, dispatchSetSelected, dispatchStartTemporaryDetach, dispatchSystemUiVisibilityChanged, dispatchThawSelfOnly, dispatchTouchEvent, dispatchTrackballEvent, dispatchUnhandledMove, dispatchVisibilityChanged, dispatchWindowFocusChanged, dispatchWindowInsetsAnimationEnd, dispatchWindowInsetsAnimationPrepare, dispatchWindowInsetsAnimationProgress, dispatchWindowInsetsAnimationStart, dispatchWindowSystemUiVisiblityChanged, dispatchWindowVisibilityChanged, drawableStateChanged, drawChild, endViewTransition, findFocus, findOnBackInvokedDispatcherForChild, findViewsWithText, focusableViewAvailable, focusSearch, getChildAt, getChildCount, getChildDrawingOrder, getChildDrawingOrder, getChildMeasureSpec, getChildStaticTransformation, getChildVisibleRect, getClipChildren, getClipToPadding, getDescendantFocusability, getFocusedChild, getLayoutAnimation, getLayoutAnimationListener, getLayoutMode, getLayoutTransition, getNestedScrollAxes, getOverlay, getPersistentDrawingCache, getTouchscreenBlocksFocus, hasFocus, hasTransientState, indexOfChild, invalidateChild, invalidateChildInParent, isAlwaysDrawnWithCacheEnabled, isAnimationCacheEnabled, isChildrenDrawingOrderEnabled, isChildrenDrawnWithCacheEnabled, isLayoutSuppressed, isMotionEventSplittingEnabled, isTransitionGroup, jumpDrawablesToCurrentState, layout, measureChild, measureChildren, measureChildWithMargins, notifySubtreeAccessibilityStateChanged, offsetDescendantRectToMyCoords, offsetRectIntoDescendantCoords, onCreateDrawableState, onDescendantInvalidated, onInterceptHoverEvent, onInterceptTouchEvent, onNestedFling, onNestedPreFling, onNestedPrePerformAccessibilityAction, onNestedPreScroll, onNestedScroll, onNestedScrollAccepted, onRequestFocusInDescendants, onRequestSendAccessibilityEvent, onResolvePointerIcon, onStartNestedScroll, onStopNestedScroll, onViewAdded, onViewRemoved, propagateRequestedFrameRate, recomputeViewAttributes, removeAllViews, removeAllViewsInLayout, removeDetachedView, removeView, removeViewAt, removeViewInLayout, removeViews, removeViewsInLayout, requestChildFocus, requestChildRectangleOnScreen, requestDisallowInterceptTouchEvent, requestFocus, requestSendAccessibilityEvent, requestTransparentRegion, restoreDefaultFocus, scheduleLayoutAnimation, setAddStatesFromChildren, setAlwaysDrawnWithCacheEnabled, setAnimationCacheEnabled, setChildrenDrawingCacheEnabled, setChildrenDrawingOrderEnabled, setChildrenDrawnWithCacheEnabled, setClipChildren, setClipToPadding, setDescendantFocusability, setLayoutAnimation, setLayoutAnimationListener, setLayoutMode, setLayoutTransition, setMotionEventSplittingEnabled, setOnHierarchyChangeListener, setPersistentDrawingCache, setRequestedFrameRate, setStaticTransformationsEnabled, setTouchscreenBlocksFocus, setTransitionGroup, setWindowInsetsAnimationCallback, showContextMenuForChild, showContextMenuForChild, startActionModeForChild, startActionModeForChild, startLayoutAnimation, startViewTransition, suppressLayout, updateViewLayout

Methods inherited from class android.view.View

addFocusables, addOnAttachStateChangeListener, addOnLayoutChangeListener, addOnUnhandledKeyEventListener, animate, announceForAccessibility, autofill, awakenScrollBars, awakenScrollBars, awakenScrollBars, bringToFront, buildDrawingCache, buildDrawingCache, buildLayer, callOnClick, cancelDragAndDrop, cancelLongPress, cancelPendingInputEvents, canResolveLayoutDirection, canResolveTextAlignment, canResolveTextDirection, canScrollHorizontally, canScrollVertically, checkInputConnectionProxy, clearAnimation, clearPendingCredentialRequest, clearViewTranslationCallback, combineMeasuredStates, computeHorizontalScrollExtent, computeHorizontalScrollOffset, computeHorizontalScrollRange, computeScroll, computeSystemWindowInsets, computeVerticalScrollExtent, computeVerticalScrollOffset, computeVerticalScrollRange, createAccessibilityNodeInfo, createContextMenu, destroyDrawingCache, dispatchGenericMotionEvent, dispatchNestedFling, dispatchNestedPreFling, dispatchNestedPrePerformAccessibilityAction, dispatchNestedPreScroll, dispatchNestedScroll, dispatchPopulateAccessibilityEvent, draw, drawableHotspotChanged, findOnBackInvokedDispatcher, findViewById, findViewWithTag, fitSystemWindows, focusSearch, forceHasOverlappingRendering, forceLayout, generateDisplayHash, generateViewId, getAccessibilityDelegate, getAccessibilityLiveRegion, getAccessibilityNodeProvider, getAccessibilityPaneTitle, getAccessibilityTraversalAfter, getAccessibilityTraversalBefore, getAllowedHandwritingDelegatePackageName, getAllowedHandwritingDelegatorPackageName, getAlpha, getAnimation, getAnimationMatrix, getApplicationWindowToken, getAttributeResolutionStack, getAttributeSourceResourceMap, getAutofillHints, getAutofillId, getAutofillType, getAutofillValue, getBackground, getBackgroundTintBlendMode, getBackgroundTintList, getBackgroundTintMode, getBaseline, getBottom, getBottomFadingEdgeStrength, getBottomPaddingOffset, getCameraDistance, getClipBounds, getClipBounds, getClipToOutline, getContentCaptureSession, getContentDescription, getContentSensitivity, getContext, getContextMenuInfo, getDefaultFocusHighlightEnabled, getDefaultSize, getDisplay, getDrawableState, getDrawingCache, getDrawingCache, getDrawingCacheBackgroundColor, getDrawingCacheQuality, getDrawingRect, getDrawingTime, getElevation, getExplicitStyle, getFilterTouchesWhenObscured, getFitsSystemWindows, getFocusable, getFocusables, getFocusedRect, getForeground, getForegroundGravity, getForegroundTintBlendMode, getForegroundTintList, getForegroundTintMode, getFrameContentVelocity, getGlobalVisibleRect, getGlobalVisibleRect, getHandwritingBoundsOffsetBottom, getHandwritingBoundsOffsetLeft, getHandwritingBoundsOffsetRight, getHandwritingBoundsOffsetTop, getHandwritingDelegateFlags, getHandwritingDelegatorCallback, getHasOverlappingRendering, getHeight, getHitRect, getHorizontalFadingEdgeLength, getHorizontalScrollbarHeight, getHorizontalScrollbarThumbDrawable, getHorizontalScrollbarTrackDrawable, getId, getImportantForAccessibility, getImportantForAutofill, getImportantForContentCapture, getKeepScreenOn, getKeyDispatcherState, getLabelFor, getLayerType, getLayoutDirection, getLayoutParams, getLeft, getLeftFadingEdgeStrength, getLeftPaddingOffset, getLocalVisibleRect, getLocationInSurface, getLocationInWindow, getLocationOnScreen, getMatrix, getMeasuredHeight, getMeasuredHeightAndState, getMeasuredState, getMeasuredWidth, getMeasuredWidthAndState, getMinimumHeight, getMinimumWidth, getNextClusterForwardId, getNextFocusDownId, getNextFocusForwardId, getNextFocusLeftId, getNextFocusRightId, getNextFocusUpId, getOnFocusChangeListener, getOutlineAmbientShadowColor, getOutlineProvider, getOutlineSpotShadowColor, getOverScrollMode, getPaddingBottom, getPaddingEnd, getPaddingLeft, getPaddingRight, getPaddingStart, getPaddingTop, getParent, getParentForAccessibility, getPendingCredentialCallback, getPendingCredentialRequest, getPivotX, getPivotY, getPointerIcon, getPreferKeepClearRects, getReceiveContentMimeTypes, getRequestedFrameRate, getResources, getRevealOnFocusHint, getRight, getRightFadingEdgeStrength, getRightPaddingOffset, getRootSurfaceControl, getRootView, getRootWindowInsets, getRotation, getRotationX, getRotationY, getScaleX, getScaleY, getScrollBarDefaultDelayBeforeFade, getScrollBarFadeDuration, getScrollBarSize, getScrollBarStyle, getScrollCaptureHint, getScrollIndicators, getScrollX, getScrollY, getSolidColor, getSourceLayoutResId, getStateDescription, getStateListAnimator, getSuggestedMinimumHeight, getSuggestedMinimumWidth, getSupplementalDescription, getSystemGestureExclusionRects, getSystemUiVisibility, getTag, getTag, getTextAlignment, getTextDirection, getTooltipText, getTop, getTopFadingEdgeStrength, getTopPaddingOffset, getTouchables, getTouchDelegate, getTransitionAlpha, getTransitionName, getTranslationX, getTranslationY, getTranslationZ, getUniqueDrawingId, getVerticalFadingEdgeLength, getVerticalScrollbarPosition, getVerticalScrollbarThumbDrawable, getVerticalScrollbarTrackDrawable, getVerticalScrollbarWidth, getViewTranslationResponse, getViewTreeObserver, getVisibility, getWidth, getWindowAttachCount, getWindowId, getWindowInsetsController, getWindowSystemUiVisibility, getWindowToken, getWindowVisibility, getWindowVisibleDisplayFrame, getX, getY, getZ, hasExplicitFocusable, hasFocusable, hasNestedScrollingParent, hasOnClickListeners, hasOnLongClickListeners, hasOverlappingRendering, hasPointerCapture, hasWindowFocus, inflate, invalidate, invalidate, invalidate, invalidateDrawable, invalidateOutline, isAccessibilityDataSensitive, isAccessibilityFocused, isAccessibilityHeading, isActivated, isAttachedToWindow, isAutoHandwritingEnabled, isClickable, isContentSensitive, isContextClickable, isCredential, isDirty, isDrawingCacheEnabled, isDuplicateParentStateEnabled, isEnabled, isFocusable, isFocusableInTouchMode, isFocused, isFocusedByDefault, isForceDarkAllowed, isHandwritingDelegate, isHapticFeedbackEnabled, isHardwareAccelerated, isHorizontalFadingEdgeEnabled, isHorizontalScrollBarEnabled, isHovered, isImportantForAccessibility, isImportantForAutofill, isImportantForContentCapture, isInEditMode, isInLayout, isInTouchMode, isKeyboardNavigationCluster, isLaidOut, isLayoutDirectionResolved, isLayoutRequested, isLongClickable, isNestedScrollingEnabled, isOpaque, isPaddingOffsetRequired, isPaddingRelative, isPivotSet, isPreferKeepClear, isPressed, isSaveEnabled, isSaveFromParentEnabled, isScreenReaderFocusable, isScrollbarFadingEnabled, isScrollContainer, isSelected, isShowingLayoutBounds, isShown, isSoundEffectsEnabled, isTemporarilyDetached, isTextAlignmentResolved, isTextDirectionResolved, isVerticalFadingEdgeEnabled, isVerticalScrollBarEnabled, keyboardNavigationClusterSearch, measure, mergeDrawableStates, offsetLeftAndRight, offsetTopAndBottom, onAnimationEnd, onAnimationStart, onApplyWindowInsets, onCancelPendingInputEvents, onCapturedPointerEvent, onCheckIsTextEditor, onCreateContextMenu, onCreateViewTranslationRequest, onCreateVirtualViewTranslationRequests, onDisplayHint, onDraw, onDrawForeground, onDrawScrollBars, onFilterTouchEventForSecurity, onFinishInflate, onFinishTemporaryDetach, onHoverChanged, onHoverEvent, onInitializeAccessibilityEvent, onInitializeAccessibilityNodeInfo, onKeyShortcut, onOverScrolled, onPointerCaptureChange, onPopulateAccessibilityEvent, onProvideAutofillStructure, onProvideContentCaptureStructure, onProvideStructure, onProvideVirtualStructure, onReceiveContent, onRestoreInstanceState, onRtlPropertiesChanged, onSaveInstanceState, onScreenStateChanged, onScrollCaptureSearch, onScrollChanged, onSetAlpha, onSizeChanged, onStartTemporaryDetach, onTrackballEvent, onViewTranslationResponse, onVirtualViewTranslationResponses, onVisibilityAggregated, onVisibilityChanged, onWindowSystemUiVisibilityChanged, overScrollBy, performAccessibilityAction, performClick, performContextClick, performContextClick, performHapticFeedback, performHapticFeedback, performHapticFeedback, performLongClick, performLongClick, performReceiveContent, playSoundEffect, post, postDelayed, postInvalidate, postInvalidate, postInvalidateDelayed, postInvalidateDelayed, postInvalidateOnAnimation, postInvalidateOnAnimation, postOnAnimation, postOnAnimationDelayed, refreshDrawableState, releasePointerCapture, removeCallbacks, removeOnAttachStateChangeListener, removeOnLayoutChangeListener, removeOnUnhandledKeyEventListener, reportAppJankStats, requestApplyInsets, requestFitSystemWindows, requestFocus, requestFocus, requestFocusFromTouch, requestLayout, requestPointerCapture, requestRectangleOnScreen, requestRectangleOnScreen, requestRectangleOnScreen, requestUnbufferedDispatch, requestUnbufferedDispatch, requireViewById, resetPivot, resolveSize, resolveSizeAndState, restoreHierarchyState, saveAttributeDataForStyleable, saveHierarchyState, scheduleDrawable, scrollBy, scrollTo, sendAccessibilityEvent, sendAccessibilityEventUnchecked, setAccessibilityDataSensitive, setAccessibilityDelegate, setAccessibilityHeading, setAccessibilityLiveRegion, setAccessibilityPaneTitle, setAccessibilityTraversalAfter, setAccessibilityTraversalBefore, setActivated, setAllowClickWhenDisabled, setAllowedHandwritingDelegatePackage, setAllowedHandwritingDelegatorPackage, setAlpha, setAnimation, setAnimationMatrix, setAutofillHints, setAutofillId, setAutoHandwritingEnabled, setBackground, setBackgroundColor, setBackgroundDrawable, setBackgroundResource, setBackgroundTintBlendMode, setBackgroundTintList, setBackgroundTintMode, setBottom, setCameraDistance, setClickable, setClipBounds, setClipToOutline, setContentCaptureSession, setContentDescription, setContentSensitivity, setContextClickable, setDefaultFocusHighlightEnabled, setDrawingCacheBackgroundColor, setDrawingCacheEnabled, setDrawingCacheQuality, setDuplicateParentStateEnabled, setElevation, setEnabled, setFadingEdgeLength, setFilterTouchesWhenObscured, setFitsSystemWindows, setFocusable, setFocusable, setFocusableInTouchMode, setFocusedByDefault, setForceDarkAllowed, setForeground, setForegroundTintBlendMode, setForegroundTintList, setForegroundTintMode, setFrameContentVelocity, setHandwritingBoundsOffsets, setHandwritingDelegateFlags, setHandwritingDelegatorCallback, setHapticFeedbackEnabled, setHasTransientState, setHorizontalFadingEdgeEnabled, setHorizontalScrollBarEnabled, setHorizontalScrollbarThumbDrawable, setHorizontalScrollbarTrackDrawable, setHovered, setId, setImportantForAccessibility, setImportantForAutofill, setImportantForContentCapture, setIsCredential, setIsHandwritingDelegate, setKeepScreenOn, setKeyboardNavigationCluster, setLabelFor, setLayerPaint, setLayerType, setLayoutDirection, setLayoutParams, setLeft, setLeftTopRightBottom, setLongClickable, setMeasuredDimension, setMinimumHeight, setMinimumWidth, setNestedScrollingEnabled, setNextClusterForwardId, setNextFocusDownId, setNextFocusForwardId, setNextFocusLeftId, setNextFocusRightId, setNextFocusUpId, setOnApplyWindowInsetsListener, setOnCapturedPointerListener, setOnClickListener, setOnContextClickListener, setOnCreateContextMenuListener, setOnDragListener, setOnFocusChangeListener, setOnGenericMotionListener, setOnHoverListener, setOnKeyListener, setOnLongClickListener, setOnReceiveContentListener, setOnScrollChangeListener, setOnSystemUiVisibilityChangeListener, setOnTouchListener, setOutlineAmbientShadowColor, setOutlineProvider, setOutlineSpotShadowColor, setOverScrollMode, setPadding, setPaddingRelative, setPendingCredentialRequest, setPivotX, setPivotY, setPointerIcon, setPreferKeepClear, setPreferKeepClearRects, setPressed, setRenderEffect, setRevealOnFocusHint, setRight, setRotation, setRotationX, setRotationY, setSaveEnabled, setSaveFromParentEnabled, setScaleX, setScaleY, setScreenReaderFocusable, setScrollBarDefaultDelayBeforeFade, setScrollBarFadeDuration, setScrollbarFadingEnabled, setScrollBarSize, setScrollBarStyle, setScrollCaptureCallback, setScrollCaptureHint, setScrollContainer, setScrollIndicators, setScrollIndicators, setScrollX, setScrollY, setSelected, setSoundEffectsEnabled, setStateDescription, setStateListAnimator, setSupplementalDescription, setSystemGestureExclusionRects, setSystemUiVisibility, setTag, setTag, setTextAlignment, setTextDirection, setTooltipText, setTop, setTouchDelegate, setTransitionAlpha, setTransitionName, setTransitionVisibility, setTranslationX, setTranslationY, setTranslationZ, setVerticalFadingEdgeEnabled, setVerticalScrollBarEnabled, setVerticalScrollbarPosition, setVerticalScrollbarThumbDrawable, setVerticalScrollbarTrackDrawable, setViewTranslationCallback, setVisibility, setWillNotCacheDrawing, setWillNotDraw, setX, setY, setZ, showContextMenu, showContextMenu, startActionMode, startActionMode, startAnimation, startDrag, startDragAndDrop, startNestedScroll, stopNestedScroll, toString, transformMatrixToGlobal, transformMatrixToLocal, unscheduleDrawable, unscheduleDrawable, updateDragShadow, verifyDrawable, willNotCacheDrawing, willNotDraw

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface android.view.ViewParent

canResolveLayoutDirection, canResolveTextAlignment, canResolveTextDirection, createContextMenu, getLayoutDirection, getParent, getParentForAccessibility, getTextAlignment, getTextDirection, isLayoutDirectionResolved, isLayoutRequested, isTextAlignmentResolved, isTextDirectionResolved, keyboardNavigationClusterSearch, requestChildRectangleOnScreen, requestFitSystemWindows, requestLayout

Field Details

mDisplay

@NonNull
protected final org.mozilla.geckoview.GeckoView.Display mDisplay

Manages the underlying GeckoDisplay surface lifecycle and layout.

mSession

@Nullable
protected GeckoSession mSession

The currently attached GeckoSession, or null if none is set.

BACKEND_SURFACE_VIEW

public static final int BACKEND_SURFACE_VIEW

This GeckoView instance will be backed by a SurfaceView.

This option offers the best performance at the price of not being able to animate GeckoView.

See Also:

• Constant Field Values

BACKEND_TEXTURE_VIEW

public static final int BACKEND_TEXTURE_VIEW

This GeckoView instance will be backed by a TextureView.

This option offers worse performance compared to BACKEND_SURFACE_VIEW but allows you to animate GeckoView or to paint a GeckoView on top of another GeckoView.

See Also:

• Constant Field Values

Constructor Details

GeckoView

public GeckoView(Context context)

Construct a new GeckoView instance.

Parameters:

context - The Context in which this view is running.

GeckoView

public GeckoView(Context context,
 AttributeSet attrs)

Construct a new GeckoView with layout attributes.

Parameters:

context - the Context in which this view is running

attrs - the set of view attributes to apply

Method Details

coverUntilFirstPaint

public void coverUntilFirstPaint(int color)

Set a color to cover the display surface while a document is being shown. The color is automatically cleared once the new document starts painting.

Parameters:

color - Cover color.

setViewBackend

public void setViewBackend(int backend)

Set which view should be used by this GeckoView instance to display content.

By default, GeckoView will use a SurfaceView.

Parameters:

backend - Any of BACKEND_*.

shouldPinOnScreen

public boolean shouldPinOnScreen()

Return whether the view should be pinned on the screen. When pinned, the view should not be moved on the screen due to animation, scrolling, etc. A common reason for the view being pinned is when the user is dragging a selection caret inside the view; normal user interaction would be disrupted in that case if the view was moved on screen.

Returns:

True if view should be pinned on the screen.

setVerticalClipping

public void setVerticalClipping(int clippingHeight)

Update the amount of vertical space that is clipped or visibly obscured in the bottom portion of the view. Tells gecko where to put bottom fixed elements so they are fully visible.

Optional call. The display's visible vertical space has changed. Must be called on the application main thread.

Parameters:

clippingHeight - The height of the bottom clipped space in screen pixels.

setDynamicToolbarMaxHeight

public void setDynamicToolbarMaxHeight(int height)

Set the maximum height of the dynamic toolbar(s).

If there are two or more dynamic toolbars, the height value should be the total amount of the height of each dynamic toolbar.

Parameters:

height - The the maximum height of the dynamic toolbar(s).

releaseSession

@UiThread
@Nullable
public GeckoSession releaseSession()

Unsets the current session from this instance and returns it, if any. You must call this before setSession(GeckoSession) if there is already an open session set for this instance.

Note: this method does not close the session and the session remains active. The caller is responsible for calling GeckoSession.close() when appropriate.

Returns:

The GeckoSession that was set for this instance. May be null.

setSession

@UiThread
public void setSession(@NonNull
 GeckoSession session)

Attach a session to this view. If this instance already has an open session, you must use releaseSession() first, otherwise IllegalStateException will be thrown. This is to avoid potentially leaking the currently opened session.

Parameters:

session - The session to be attached.

Throws:

IllegalArgumentException - if an existing open session is already set.

getSession

@AnyThread
@Nullable
public GeckoSession getSession()

Returns the current GeckoSession attached to this view.

Returns:

The GeckoSession instance, or null if none is set.

getPanZoomController

@NonNull
public PanZoomController getPanZoomController()

Retrieves the controller responsible for panning and zooming gestures.

Returns:

The non-null PanZoomController for this GeckoView.

addWindowInsetsListener

@UiThread
public void addWindowInsetsListener(@NonNull
 String key,
 @Nullable
 androidx.core.view.OnApplyWindowInsetsListener listener)

Add an OnApplyWindowInsetsListener to observe the root view WindowInsets changes.

Parameters:

key - The key associated to the listener.

listener - The OnApplyWindowInsetsListener to be invoked.

removeWindowInsetsListener

@UiThread
public void removeWindowInsetsListener(@NonNull
 String key)

Remove the OnApplyWindowInsetsListener to stop observing WindowInsets changed.

Parameters:

key - The key associated to the listener to remove.

onAttachedToWindow

public void onAttachedToWindow()

Overrides:

onAttachedToWindow in class ViewGroup

onDetachedFromWindow

public void onDetachedFromWindow()

Overrides:

onDetachedFromWindow in class ViewGroup

onConfigurationChanged

protected void onConfigurationChanged(Configuration newConfig)

Overrides:

onConfigurationChanged in class View

gatherTransparentRegion

public boolean gatherTransparentRegion(Region region)

Overrides:

gatherTransparentRegion in class ViewGroup

onWindowFocusChanged

public void onWindowFocusChanged(boolean hasWindowFocus)

Overrides:

onWindowFocusChanged in class View

onWindowVisibilityChanged

protected void onWindowVisibilityChanged(int visibility)

Overrides:

onWindowVisibilityChanged in class View

onFocusChanged

protected void onFocusChanged(boolean gainFocus,
 int direction,
 Rect previouslyFocusedRect)

Overrides:

onFocusChanged in class View

getHandler

public Handler getHandler()

Overrides:

getHandler in class View

onCreateInputConnection

public InputConnection onCreateInputConnection(EditorInfo outAttrs)

Overrides:

onCreateInputConnection in class View

onKeyPreIme

public boolean onKeyPreIme(int keyCode,
 KeyEvent event)

Overrides:

onKeyPreIme in class View

onKeyUp

public boolean onKeyUp(int keyCode,
 KeyEvent event)

Specified by:

onKeyUp in interface KeyEvent.Callback

Overrides:

onKeyUp in class View

onKeyDown

public boolean onKeyDown(int keyCode,
 KeyEvent event)

Specified by:

onKeyDown in interface KeyEvent.Callback

Overrides:

onKeyDown in class View

onKeyLongPress

public boolean onKeyLongPress(int keyCode,
 KeyEvent event)

Specified by:

onKeyLongPress in interface KeyEvent.Callback

Overrides:

onKeyLongPress in class View

onKeyMultiple

public boolean onKeyMultiple(int keyCode,
 int repeatCount,
 KeyEvent event)

Specified by:

onKeyMultiple in interface KeyEvent.Callback

Overrides:

onKeyMultiple in class View

dispatchDraw

public void dispatchDraw(@Nullable
 Canvas canvas)

Overrides:

dispatchDraw in class ViewGroup

onTouchEvent

public boolean onTouchEvent(MotionEvent event)

Overrides:

onTouchEvent in class View

onTouchEventForDetailResult

@NonNull
public GeckoResult<PanZoomController.InputResultDetail> onTouchEventForDetailResult(@NonNull
 MotionEvent event)

Dispatches a MotionEvent to the PanZoomController. This is the same as onTouchEvent(MotionEvent), but instead returns a PanZoomController.InputResult indicating how the event was handled.

NOTE: It is highly recommended to only call this with ACTION_DOWN or in otherwise limited capacity. Returning a GeckoResult for every touch event will generate a lot of allocations and unnecessary GC pressure.

Parameters:

event - A MotionEvent

Returns:

A GeckoResult resolving to PanZoomController.InputResultDetail.

onGenericMotionEvent

public boolean onGenericMotionEvent(MotionEvent event)

Overrides:

onGenericMotionEvent in class View

onProvideAutofillVirtualStructure

public void onProvideAutofillVirtualStructure(ViewStructure structure,
 int flags)

Overrides:

onProvideAutofillVirtualStructure in class View

autofill

public void autofill(@NonNull
 SparseArray<AutofillValue> values)

Overrides:

autofill in class View

isVisibleToUserForAutofill

public boolean isVisibleToUserForAutofill(int virtualId)

Overrides:

isVisibleToUserForAutofill in class View

capturePixels

@UiThread
@NonNull
public GeckoResult<Bitmap> capturePixels()

Request a Bitmap of the visible portion of the web page currently being rendered.

See GeckoDisplay.capturePixels() for more details.

Returns:

A GeckoResult that completes with a Bitmap containing the pixels and size information of the currently visible rendered web page.

setAutofillEnabled

public void setAutofillEnabled(boolean enabled)

Sets whether or not this View participates in Android autofill.

When enabled, this will set an Autofill.Delegate on the GeckoSession for this instance.

Parameters:

enabled - Whether or not Android autofill is enabled for this view.

getAutofillEnabled

public boolean getAutofillEnabled()

Returns:

Whether or not Android autofill is enabled for this view.

setActivityContextDelegate

public void setActivityContextDelegate(@Nullable
 GeckoView.ActivityContextDelegate delegate)

Sets the delegate for the GeckoView.

Parameters:

delegate - to provide activity context or null

getActivityContextDelegate

@Nullable
public GeckoView.ActivityContextDelegate getActivityContextDelegate()

Gets the delegate from the GeckoView.

Returns:

delegate, if set

getPrintDelegate

@Nullable
public GeckoSession.PrintDelegate getPrintDelegate()

Retrieves the GeckoView's print delegate.

Returns:

The GeckoView's print delegate.

getPrintDelegate

public void getPrintDelegate(@Nullable
 GeckoSession.PrintDelegate delegate)

Sets the GeckoView's print delegate.

Parameters:

delegate - for printing

requestNewSurface

public void requestNewSurface()

Description copied from interface: GeckoDisplay.NewSurfaceProvider

Called by Gecko to request a new Surface from the application.

Occasionally the Surface provided to Gecko via GeckoDisplay.surfaceChanged(SurfaceInfo) is invalid and Gecko is unable to render in to it. This function will be called in such circumstances. It is the implementation's responsibility to ensure that GeckoDisplay.surfaceChanged(SurfaceInfo) gets called soon afterwards with a new Surface, allowing Gecko to resume rendering.

Failure to implement this function may result in Gecko either crashing or not rendering correctly should it encounter an invalid Surface.

Specified by:

requestNewSurface in interface GeckoDisplay.NewSurfaceProvider

onDragEvent

public boolean onDragEvent(DragEvent event)

Handle drag and drop event

Overrides:

onDragEvent in class View