org.mozilla.geckoview

Class GeckoSession

Object

org.mozilla.geckoview.GeckoSession

All Implemented Interfaces:

Parcelable

public class GeckoSession
extends Object
implements Parcelable

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GeckoSession.ContentDelegate
static class	GeckoSession.FinderResult Represent the result of a find-in-page operation.
static interface	GeckoSession.HistoryDelegate An interface for recording new history visits and fetching the visited status for links.
static interface	GeckoSession.MediaDelegate GeckoSession applications implement this interface to handle media events.
static interface	GeckoSession.NavigationDelegate
static interface	GeckoSession.PermissionDelegate GeckoSession applications implement this interface to handle requests for permissions from content, such as geolocation and notifications.
static interface	GeckoSession.ProgressDelegate
static interface	GeckoSession.PromptDelegate GeckoSession applications implement this interface to handle prompts triggered by content in the GeckoSession, such as alerts, authentication dialogs, and select list pickers.
static interface	GeckoSession.ScrollDelegate GeckoSession applications implement this interface to handle content scroll events.
static interface	GeckoSession.SelectionActionDelegate
static class	GeckoSession.SessionState Class representing a saved session state.
static interface	GeckoSession.TextInputDelegate Interface that SessionTextInput uses for performing operations such as opening and closing the software keyboard.
static class	GeckoSession.WebResponseInfo WebResponseInfo contains information about a single web response.

Nested classes/interfaces inherited from interface android.os.Parcelable

Parcelable.ClassLoaderCreator<T>, Parcelable.Creator<T>

Field Summary

Fields

Modifier and Type	Field and Description
static Parcelable.Creator<GeckoSession>	CREATOR
static int	FINDER_DISPLAY_DIM_PAGE Dim the rest of the page when showing a find-in-page match.
static int	FINDER_DISPLAY_DRAW_LINK_OUTLINE Draw outlines around matching links.
static int	FINDER_DISPLAY_HIGHLIGHT_ALL Highlight all find-in-page matches.
static int	FINDER_FIND_BACKWARDS Go backwards when finding the next match.
static int	FINDER_FIND_LINKS_ONLY Limit matches to links on the page.
static int	FINDER_FIND_MATCH_CASE Perform case-sensitive match; default is to perform a case-insensitive match.
static int	FINDER_FIND_WHOLE_WORD Must match entire words; default is to allow matching partial words.
static int	LOAD_FLAGS_ALLOW_POPUPS Popup blocking will be disabled for this load
static int	LOAD_FLAGS_BYPASS_CACHE Bypass the cache.
static int	LOAD_FLAGS_BYPASS_CLASSIFIER Bypass the URI classifier (content blocking and Safe Browsing).
static int	LOAD_FLAGS_BYPASS_PROXY Bypass the proxy, if one has been configured.
static int	LOAD_FLAGS_EXTERNAL The load is coming from an external app.
static int	LOAD_FLAGS_FORCE_ALLOW_DATA_URI Allows a top-level data: navigation to occur.
static int	LOAD_FLAGS_NONE Default load flag, no special considerations.
static int	LOAD_FLAGS_REPLACE_HISTORY This flag specifies that any existing history entry should be replaced.
protected org.mozilla.geckoview.GeckoSession.Window	mWindow

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor and Description
GeckoSession()
GeckoSession(GeckoSessionSettings settings)

Method Summary

Modifier and Type	Method and Description
GeckoDisplay	acquireDisplay() Acquire the GeckoDisplay instance for providing the session with a drawing Surface.
void	autofill(SparseArray<CharSequence> values) Perform autofill using the specified values.
void	close() Closes the session.
static String	createDataUri(byte[] bytes, String mimeType) Creates a data URI of of the form "data:<mime type>,<base64-encoded data>"
static String	createDataUri(String data, String mimeType) Creates a data URI of of the form "data:<mime type>,<base64-encoded data>"
int	describeContents()
boolean	equals(Object obj)
void	exitFullScreen() Exits fullscreen mode
SessionAccessibility	getAccessibility() Get the SessionAccessibility instance for this session.
Autofill.Delegate	getAutofillDelegate()
Autofill.Session	getAutofillSession() Provides an autofill structure similar to View.onProvideAutofillVirtualStructure(ViewStructure, int) , but does not rely on ViewStructure to build the tree.
void	getClientBounds(RectF rect) Get the bounds of the client area in client coordinates.
void	getClientToScreenMatrix(Matrix matrix) Get a matrix for transforming from client coordinates to screen coordinates.
void	getClientToSurfaceMatrix(Matrix matrix) Get a matrix for transforming from client coordinates to surface coordinates.
CompositorController	getCompositorController() Get the CompositorController instance for this session.
ContentBlocking.Delegate	getContentBlockingDelegate() Get the content blocking callback handler.
GeckoSession.ContentDelegate	getContentDelegate() Get the content callback handler.
static String	getDefaultUserAgent() Get the default user agent for this GeckoView build.
DynamicToolbarAnimator	getDynamicToolbarAnimator() Get the DynamicToolbarAnimator instance for this session.
SessionFinder	getFinder() Get the SessionFinder instance for this session, to perform find-in-page operations.
GeckoSession.HistoryDelegate	getHistoryDelegate()
GeckoSession.MediaDelegate	getMediaDelegate() Get the Media callback handler.
WebExtension.MessageDelegate	getMessageDelegate(WebExtension webExtension, String nativeApp) Get the message delegate for nativeApp.
GeckoSession.NavigationDelegate	getNavigationDelegate() Get the navigation callback handler.
OverscrollEdgeEffect	getOverscrollEdgeEffect() Get the OverscrollEdgeEffect instance for this session.
void	getPageToScreenMatrix(Matrix matrix) Get a matrix for transforming from page coordinates to screen coordinates.
void	getPageToSurfaceMatrix(Matrix matrix) Get a matrix for transforming from page coordinates to surface coordinates.
PanZoomController	getPanZoomController() Get the PanZoomController instance for this session.
GeckoSession.PermissionDelegate	getPermissionDelegate() Get the current permission delegate for this GeckoSession.
GeckoSession.ProgressDelegate	getProgressDelegate() Get the progress callback handler.
GeckoSession.PromptDelegate	getPromptDelegate() Get the current prompt delegate for this GeckoSession.
GeckoSession.ScrollDelegate	getScrollDelegate()
GeckoSession.SelectionActionDelegate	getSelectionActionDelegate() Get the current selection action delegate for this GeckoSession.
GeckoSessionSettings	getSettings()
void	getSurfaceBounds(Rect rect) Get the bounds of the client area in surface coordinates.
SessionTextInput	getTextInput() Get the SessionTextInput instance for this session.
GeckoResult<String>	getUserAgent() Get the current user agent string for this GeckoSession.
WebExtension.ActionDelegate	getWebExtensionActionDelegate(WebExtension webExtension) Get the Action delegate for this session.
void	goBack() Go back in history.
void	goForward() Go forward in history.
void	gotoHistoryIndex(int index) Navigate to an index in browser history; the index of the currently viewed page can be retrieved from an up-to-date HistoryList by calling GeckoSession.HistoryDelegate.HistoryList.getCurrentIndex().
int	hashCode()
boolean	isOpen() Return whether this session is open.
void	loadData(byte[] bytes, String mimeType) Load the specified bytes.
void	loadString(String data, String mimeType) Load the specified String data.
void	loadUri(String uri) Load the given URI.
void	loadUri(String uri, GeckoSession referrer, int flags) Load the given URI with the specified referrer and load type.
void	loadUri(String uri, GeckoSession referrer, int flags, Map<String,String> additionalHeaders) Load the given URI with the specified referrer, load type and HTTP request headers.
void	loadUri(String uri, int flags) Load the given URI with the specified referrer and load type.
void	loadUri(String uri, Map<String,String> additionalHeaders) Load the given URI with specified HTTP request headers.
void	loadUri(String uri, String referrer, int flags) Load the given URI with the specified referrer and load type.
void	loadUri(String uri, String referrer, int flags, Map<String,String> additionalHeaders) Load the given URI with the specified referrer, load type and HTTP request headers.
void	loadUri(Uri uri) Load the given URI.
void	loadUri(Uri uri, int flags) Load the given URI with the specified referrer and load type.
void	loadUri(Uri uri, Map<String,String> additionalHeaders) Load the given URI with specified HTTP request headers.
void	loadUri(Uri uri, Uri referrer, int flags) Load the given URI with the specified referrer and load type.
void	loadUri(Uri uri, Uri referrer, int flags, Map<String,String> additionalHeaders) Load the given URI with the specified referrer, load type and HTTP request headers.
void	open(GeckoRuntime runtime) Opens the session.
void	purgeHistory() Purge history for the session.
void	readFromParcel(Parcel source)
void	releaseDisplay(GeckoDisplay display) Release an acquired GeckoDisplay instance.
void	reload() Reload the current URI.
void	restoreState(GeckoSession.SessionState state) Restore a saved state to this GeckoSession; only data that is saved (history, scroll position, zoom, and form data) will be restored.
void	setActive(boolean active) Set this GeckoSession as active or inactive, which represents if the session is currently visible or not.
void	setAutofillDelegate(Autofill.Delegate delegate) Sets the autofill delegate for this session.
void	setContentBlockingDelegate(ContentBlocking.Delegate delegate) Set the content blocking callback handler.
void	setContentDelegate(GeckoSession.ContentDelegate delegate) Set the content callback handler.
void	setFocused(boolean focused) Move focus to this session or away from this session.
void	setHistoryDelegate(GeckoSession.HistoryDelegate delegate) Set the history tracking delegate for this session, replacing the current delegate if one is set.
void	setMediaDelegate(GeckoSession.MediaDelegate delegate) Set the media callback handler.
void	setMessageDelegate(WebExtension webExtension, WebExtension.MessageDelegate delegate, String nativeApp) Defines a message delegate for a Native App.
void	setNavigationDelegate(GeckoSession.NavigationDelegate delegate) Set the navigation callback handler.
void	setPermissionDelegate(GeckoSession.PermissionDelegate delegate) Set the current permission delegate for this GeckoSession.
void	setProgressDelegate(GeckoSession.ProgressDelegate delegate) Set the progress callback handler.
void	setPromptDelegate(GeckoSession.PromptDelegate delegate) Set the current prompt delegate for this GeckoSession.
void	setScrollDelegate(GeckoSession.ScrollDelegate delegate) Set the content scroll callback handler.
void	setSelectionActionDelegate(GeckoSession.SelectionActionDelegate delegate) Set the current selection action delegate for this GeckoSession.
protected void	setShouldPinOnScreen(boolean pinned)
void	setWebExtensionActionDelegate(WebExtension webExtension, WebExtension.ActionDelegate delegate) Set the Action delegate for this session.
void	stop() Stop loading.
void	writeToParcel(Parcel out, int flags)

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

mWindow

@Nullable
protected org.mozilla.geckoview.GeckoSession.Window mWindow

CREATOR

public static final Parcelable.Creator<GeckoSession> CREATOR

LOAD_FLAGS_NONE

public static final int LOAD_FLAGS_NONE

Default load flag, no special considerations.

See Also:

Constant Field Values

LOAD_FLAGS_BYPASS_CACHE

public static final int LOAD_FLAGS_BYPASS_CACHE

Bypass the cache.

See Also:

Constant Field Values

LOAD_FLAGS_BYPASS_PROXY

public static final int LOAD_FLAGS_BYPASS_PROXY

Bypass the proxy, if one has been configured.

See Also:

Constant Field Values

LOAD_FLAGS_EXTERNAL

public static final int LOAD_FLAGS_EXTERNAL

The load is coming from an external app. Perform additional checks.

See Also:

Constant Field Values

LOAD_FLAGS_ALLOW_POPUPS

public static final int LOAD_FLAGS_ALLOW_POPUPS

Popup blocking will be disabled for this load

See Also:

Constant Field Values

LOAD_FLAGS_BYPASS_CLASSIFIER

public static final int LOAD_FLAGS_BYPASS_CLASSIFIER

Bypass the URI classifier (content blocking and Safe Browsing).

See Also:

Constant Field Values

LOAD_FLAGS_FORCE_ALLOW_DATA_URI

public static final int LOAD_FLAGS_FORCE_ALLOW_DATA_URI

Allows a top-level data: navigation to occur. E.g. view-image is an explicit user action which should be allowed.

See Also:

Constant Field Values

LOAD_FLAGS_REPLACE_HISTORY

public static final int LOAD_FLAGS_REPLACE_HISTORY

This flag specifies that any existing history entry should be replaced.

See Also:

Constant Field Values

FINDER_FIND_BACKWARDS

public static final int FINDER_FIND_BACKWARDS

Go backwards when finding the next match.

See Also:

Constant Field Values

FINDER_FIND_MATCH_CASE

public static final int FINDER_FIND_MATCH_CASE

Perform case-sensitive match; default is to perform a case-insensitive match.

See Also:

Constant Field Values

FINDER_FIND_WHOLE_WORD

public static final int FINDER_FIND_WHOLE_WORD

Must match entire words; default is to allow matching partial words.

See Also:

Constant Field Values

FINDER_FIND_LINKS_ONLY

public static final int FINDER_FIND_LINKS_ONLY

Limit matches to links on the page.

See Also:

Constant Field Values

FINDER_DISPLAY_HIGHLIGHT_ALL

public static final int FINDER_DISPLAY_HIGHLIGHT_ALL

Highlight all find-in-page matches.

See Also:

Constant Field Values

FINDER_DISPLAY_DIM_PAGE

public static final int FINDER_DISPLAY_DIM_PAGE

Dim the rest of the page when showing a find-in-page match.

See Also:

Constant Field Values

FINDER_DISPLAY_DRAW_LINK_OUTLINE

public static final int FINDER_DISPLAY_DRAW_LINK_OUTLINE

Draw outlines around matching links.

See Also:

Constant Field Values

Constructor Detail

GeckoSession

public GeckoSession()

GeckoSession

public GeckoSession(@Nullable
                    GeckoSessionSettings settings)

Method Detail

getMessageDelegate

@AnyThread
 @Nullable
public WebExtension.MessageDelegate getMessageDelegate(@NonNull
                                                                             WebExtension webExtension,
                                                                             @NonNull
                                                                             String nativeApp)

Get the message delegate for nativeApp.

Parameters:

webExtension - WebExtension that this delegate receives messages from.

nativeApp - identifier for the native app

Returns:

The WebExtension.MessageDelegate attached to the nativeApp. null if no delegate is present.

setMessageDelegate

@AnyThread
public void setMessageDelegate(@NonNull
                                          WebExtension webExtension,
                                          @Nullable
                                          WebExtension.MessageDelegate delegate,
                                          @NonNull
                                          String nativeApp)

Defines a message delegate for a Native App. If a delegate is already present, this delegate will replace the existing one. This message delegate will be responsible for handling messaging between a WebExtension content script running on the GeckoSession. Note: To receive messages from content scripts, the WebExtension needs to explicitely allow it in WebExtension.WebExtension(java.lang.String, org.mozilla.geckoview.WebExtensionController) by setting WebExtension.Flags.ALLOW_CONTENT_MESSAGING.

Parameters:

webExtension - WebExtension that this delegate receives messages from.

delegate - WebExtension.MessageDelegate that will receive messages from this session.

nativeApp - which native app id this message delegate will handle messaging for.

See Also:

WebExtension.setMessageDelegate(org.mozilla.geckoview.WebExtension.MessageDelegate, java.lang.String)

setWebExtensionActionDelegate

@AnyThread
public void setWebExtensionActionDelegate(@NonNull
                                                     WebExtension webExtension,
                                                     @Nullable
                                                     WebExtension.ActionDelegate delegate)

Set the Action delegate for this session. This delegate will receive page and browser action overrides specific to this session. The default Action will be received by the delegate set by WebExtension.setActionDelegate(org.mozilla.geckoview.WebExtension.ActionDelegate).

Parameters:

webExtension - the WebExtension object this delegate will receive updates for

delegate - the WebExtension.ActionDelegate that will receive updates.

See Also:

WebExtension.Action

getWebExtensionActionDelegate

@AnyThread
 @Nullable
public WebExtension.ActionDelegate getWebExtensionActionDelegate(@NonNull
                                                                                       WebExtension webExtension)

Get the Action delegate for this session.

Parameters:

webExtension - WebExtension that this delegates receive updates for.

Returns:

WebExtension.ActionDelegate for this session

getUserAgent

@AnyThread
 @NonNull
public GeckoResult<String> getUserAgent()

Get the current user agent string for this GeckoSession.

Returns:

a GeckoResult containing the UserAgent string

getDefaultUserAgent

@AnyThread
 @NonNull
public static String getDefaultUserAgent()

Get the default user agent for this GeckoView build. This method does not account for any override that might have been applied to the user agent string.

Returns:

the default user agent string

getPermissionDelegate

@UiThread
 @Nullable
public GeckoSession.PermissionDelegate getPermissionDelegate()

Get the current permission delegate for this GeckoSession.

Returns:

PermissionDelegate instance or null if using default delegate.

setPermissionDelegate

@UiThread
public void setPermissionDelegate(@Nullable
                                            GeckoSession.PermissionDelegate delegate)

Set the current permission delegate for this GeckoSession.

Parameters:

delegate - PermissionDelegate instance or null to use the default delegate.

describeContents

@AnyThread
public int describeContents()

Specified by:

describeContents in interface Parcelable

writeToParcel

@AnyThread
public void writeToParcel(Parcel out,
                                     int flags)

Specified by:

writeToParcel in interface Parcelable

readFromParcel

@AnyThread
public void readFromParcel(@NonNull
                                      Parcel source)

hashCode

@AnyThread
public int hashCode()

Overrides:

hashCode in class Object

equals

@AnyThread
public boolean equals(Object obj)

Overrides:

equals in class Object

isOpen

@AnyThread
public boolean isOpen()

Return whether this session is open.

Returns:

True if session is open.

See Also:

open(org.mozilla.geckoview.GeckoRuntime), close()

open

@UiThread
public void open(@NonNull
                           GeckoRuntime runtime)

Opens the session. Call this when you are ready to use a GeckoSession instance. The session is in a 'closed' state when first created. Opening it creates the underlying Gecko objects necessary to load a page, etc. Most GeckoSession methods only take affect on an open session, and are queued until the session is opened here. Opening a session is an asynchronous operation.

Parameters:

runtime - The Gecko runtime to attach this session to.

See Also:

close(), isOpen()

close

@UiThread
public void close()

Closes the session. This frees the underlying Gecko objects and unloads the current page. The session may be reopened later, but page state is not restored. Call this when you are finished using a GeckoSession instance.

See Also:

open(org.mozilla.geckoview.GeckoRuntime), isOpen()

getTextInput

@AnyThread
 @NonNull
public SessionTextInput getTextInput()

Get the SessionTextInput instance for this session. May be called on any thread.

Returns:

SessionTextInput instance.

getAccessibility

@UiThread
 @NonNull
public SessionAccessibility getAccessibility()

Get the SessionAccessibility instance for this session.

Returns:

SessionAccessibility instance.

loadUri

@AnyThread
public void loadUri(@NonNull
                               String uri)

Load the given URI.

Parameters:

uri - The URI of the resource to load.

loadUri

@AnyThread
public void loadUri(@NonNull
                               String uri,
                               @Nullable
                               Map<String,String> additionalHeaders)

Load the given URI with specified HTTP request headers.

Parameters:

uri - The URI of the resource to load.

additionalHeaders - any additional request headers used with the load

loadUri

@AnyThread
public void loadUri(@NonNull
                               String uri,
                               int flags)

Load the given URI with the specified referrer and load type.

Parameters:

uri - the URI to load

flags - the load flags to use, an OR-ed value of LOAD_FLAGS_*

loadUri

@AnyThread
public void loadUri(@NonNull
                               String uri,
                               @Nullable
                               String referrer,
                               int flags)

Load the given URI with the specified referrer and load type.

Parameters:

uri - the URI to load

referrer - the referrer, may be null

flags - the load flags to use, an OR-ed value of LOAD_FLAGS_*

loadUri

@AnyThread
public void loadUri(@NonNull
                               String uri,
                               @Nullable
                               String referrer,
                               int flags,
                               @Nullable
                               Map<String,String> additionalHeaders)

Load the given URI with the specified referrer, load type and HTTP request headers.

Parameters:

uri - the URI to load

referrer - the referrer, may be null

flags - the load flags to use, an OR-ed value of LOAD_FLAGS_*

additionalHeaders - any additional request headers used with the load

loadUri

@AnyThread
public void loadUri(@NonNull
                               String uri,
                               @Nullable
                               GeckoSession referrer,
                               int flags)

Load the given URI with the specified referrer and load type. This method will also do any applicable checks to ensure that the specified URI is both safe and allowable according to the referring GeckoSession.

Parameters:

uri - the URI to load

referrer - the referring GeckoSession, may be null

flags - the load flags to use, an OR-ed value of LOAD_FLAGS_*

loadUri

@AnyThread
public void loadUri(@NonNull
                               String uri,
                               @Nullable
                               GeckoSession referrer,
                               int flags,
                               @Nullable
                               Map<String,String> additionalHeaders)

Load the given URI with the specified referrer, load type and HTTP request headers. This method will also do any applicable checks to ensure that the specified URI is both safe and allowable according to the referring GeckoSession.

Parameters:

uri - the URI to load

referrer - the referring GeckoSession, may be null

flags - the load flags to use, an OR-ed value of LOAD_FLAGS_*

additionalHeaders - any additional request headers used with the load

loadUri

@AnyThread
public void loadUri(@NonNull
                               Uri uri)

Load the given URI.

Parameters:

uri - The URI of the resource to load.

loadUri

@AnyThread
public void loadUri(@NonNull
                               Uri uri,
                               @Nullable
                               Map<String,String> additionalHeaders)

Load the given URI with specified HTTP request headers.

Parameters:

uri - The URI of the resource to load.

additionalHeaders - any additional request headers used with the load

loadUri

@AnyThread
public void loadUri(@NonNull
                               Uri uri,
                               int flags)

Load the given URI with the specified referrer and load type.

Parameters:

uri - the URI to load

flags - the load flags to use, an OR-ed value of LOAD_FLAGS_*

loadUri

@AnyThread
public void loadUri(@NonNull
                               Uri uri,
                               @Nullable
                               Uri referrer,
                               int flags)

Load the given URI with the specified referrer and load type.

Parameters:

uri - the URI to load

referrer - the Uri to use as the referrer

flags - the load flags to use, an OR-ed value of LOAD_FLAGS_*

loadUri

@AnyThread
public void loadUri(@NonNull
                               Uri uri,
                               @Nullable
                               Uri referrer,
                               int flags,
                               @Nullable
                               Map<String,String> additionalHeaders)

Load the given URI with the specified referrer, load type and HTTP request headers.

Parameters:

uri - the URI to load

referrer - the Uri to use as the referrer

flags - the load flags to use, an OR-ed value of LOAD_FLAGS_*

additionalHeaders - any additional request headers used with the load

loadString

@AnyThread
public void loadString(@NonNull
                                  String data,
                                  @Nullable
                                  String mimeType)

Load the specified String data. Internally this is converted to a data URI.

Parameters:

data - a String representing the data

mimeType - the mime type of the data, e.g. "text/plain". Maybe be null, in which case the type is guessed.

loadData

@AnyThread
public void loadData(@NonNull
                                byte[] bytes,
                                @Nullable
                                String mimeType)

Load the specified bytes. Internally this is converted to a data URI.

Parameters:

bytes - the data to load

mimeType - the mime type of the data, e.g. video/mp4. May be null, in which case the type is guessed.

createDataUri

@AnyThread
 @NonNull
public static String createDataUri(@NonNull
                                                        byte[] bytes,
                                                        @Nullable
                                                        String mimeType)

Creates a data URI of of the form "data:<mime type>,<base64-encoded data>"

Parameters:

bytes - the bytes that should be contained in the URL

mimeType - optional mime type, e.g. text/plain

Returns:

a URI String

createDataUri

@AnyThread
 @NonNull
public static String createDataUri(@NonNull
                                                        String data,
                                                        @Nullable
                                                        String mimeType)

Creates a data URI of of the form "data:<mime type>,<base64-encoded data>"

Parameters:

data - the String data that should be contained in the URL

mimeType - optional mime type, e.g. text/plain

Returns:

a URI String

reload

@AnyThread
public void reload()

Reload the current URI.

stop

@AnyThread
public void stop()

Stop loading.

goBack

@AnyThread
public void goBack()

Go back in history.

goForward

@AnyThread
public void goForward()

Go forward in history.

gotoHistoryIndex

@AnyThread
public void gotoHistoryIndex(int index)

Navigate to an index in browser history; the index of the currently viewed page can be retrieved from an up-to-date HistoryList by calling GeckoSession.HistoryDelegate.HistoryList.getCurrentIndex().

Parameters:

index - The index of the location in browser history you want to navigate to.

purgeHistory

@AnyThread
public void purgeHistory()

Purge history for the session. The session history is used for back and forward history. Purging the session history means GeckoSession.NavigationDelegate.onCanGoBack(GeckoSession, boolean) and GeckoSession.NavigationDelegate.onCanGoForward(GeckoSession, boolean) will be false.

getFinder

@AnyThread
 @NonNull
public SessionFinder getFinder()

Get the SessionFinder instance for this session, to perform find-in-page operations.

Returns:

SessionFinder instance.

setActive

@AnyThread
public void setActive(boolean active)

Set this GeckoSession as active or inactive, which represents if the session is currently visible or not. Setting a GeckoSession to inactive will significantly reduce its memory footprint, but should only be done if the GeckoSession is not currently visible. Note that a session can be active (i.e. visible) but not focused. When a session is set inactive, it will flush the session state and trigger a `ProgressDelegate.onSessionStateChange` callback.

Parameters:

active - A boolean determining whether the GeckoSession is active.

See Also:

setFocused(boolean)

setFocused

@AnyThread
public void setFocused(boolean focused)

Move focus to this session or away from this session. Only one session has focus at a given time. Note that a session can be unfocused but still active (i.e. visible).

Parameters:

focused - True if the session should gain focus or false if the session should lose focus.

See Also:

setActive(boolean)

restoreState

@AnyThread
public void restoreState(@NonNull
                                    GeckoSession.SessionState state)

Restore a saved state to this GeckoSession; only data that is saved (history, scroll position, zoom, and form data) will be restored. These will overwrite the corresponding state of this GeckoSession.

Parameters:

state - A saved session state; this should originate from onSessionStateChange().

acquireDisplay

@UiThread
 @NonNull
public GeckoDisplay acquireDisplay()

Acquire the GeckoDisplay instance for providing the session with a drawing Surface. Be sure to call GeckoDisplay.surfaceChanged(Surface, int, int) on the acquired display if there is already a valid Surface.

Returns:

GeckoDisplay instance.

See Also:

releaseDisplay(GeckoDisplay)

releaseDisplay

@UiThread
public void releaseDisplay(@NonNull
                                     GeckoDisplay display)

Release an acquired GeckoDisplay instance. Be sure to call GeckoDisplay.surfaceDestroyed() before releasing the display if it still has a valid Surface.

Parameters:

display - Acquired GeckoDisplay instance.

See Also:

acquireDisplay()

getSettings

@AnyThread
 @NonNull
public GeckoSessionSettings getSettings()

exitFullScreen

@AnyThread
public void exitFullScreen()

Exits fullscreen mode

setContentDelegate

@UiThread
public void setContentDelegate(@Nullable
                                         GeckoSession.ContentDelegate delegate)

Set the content callback handler. This will replace the current handler.

Parameters:

delegate - An implementation of ContentDelegate.

getContentDelegate

@UiThread
 @Nullable
public GeckoSession.ContentDelegate getContentDelegate()

Get the content callback handler.

Returns:

The current content callback handler.

setProgressDelegate

@UiThread
public void setProgressDelegate(@Nullable
                                          GeckoSession.ProgressDelegate delegate)

Set the progress callback handler. This will replace the current handler.

Parameters:

delegate - An implementation of ProgressDelegate.

getProgressDelegate

@UiThread
 @Nullable
public GeckoSession.ProgressDelegate getProgressDelegate()

Get the progress callback handler.

Returns:

The current progress callback handler.

setNavigationDelegate

@UiThread
public void setNavigationDelegate(@Nullable
                                            GeckoSession.NavigationDelegate delegate)

Set the navigation callback handler. This will replace the current handler.

Parameters:

delegate - An implementation of NavigationDelegate.

getNavigationDelegate

@UiThread
 @Nullable
public GeckoSession.NavigationDelegate getNavigationDelegate()

Get the navigation callback handler.

Returns:

The current navigation callback handler.

setScrollDelegate

@UiThread
public void setScrollDelegate(@Nullable
                                        GeckoSession.ScrollDelegate delegate)

Set the content scroll callback handler. This will replace the current handler.

Parameters:

delegate - An implementation of ScrollDelegate.

getScrollDelegate

@UiThread
 @Nullable
public GeckoSession.ScrollDelegate getScrollDelegate()

setHistoryDelegate

@AnyThread
public void setHistoryDelegate(@Nullable
                                          GeckoSession.HistoryDelegate delegate)

Set the history tracking delegate for this session, replacing the current delegate if one is set.

Parameters:

delegate - The history tracking delegate, or null to unset.

getHistoryDelegate

@AnyThread
 @Nullable
public GeckoSession.HistoryDelegate getHistoryDelegate()

Returns:

The history tracking delegate for this session.

setContentBlockingDelegate

@AnyThread
public void setContentBlockingDelegate(@Nullable
                                                  ContentBlocking.Delegate delegate)

Set the content blocking callback handler. This will replace the current handler.

Parameters:

delegate - An implementation of ContentBlocking.Delegate.

getContentBlockingDelegate

@AnyThread
 @Nullable
public ContentBlocking.Delegate getContentBlockingDelegate()

Get the content blocking callback handler.

Returns:

The current content blocking callback handler.

setPromptDelegate

@AnyThread
public void setPromptDelegate(@Nullable
                                         GeckoSession.PromptDelegate delegate)

Set the current prompt delegate for this GeckoSession.

Parameters:

delegate - PromptDelegate instance or null to use the built-in delegate.

getPromptDelegate

@AnyThread
 @Nullable
public GeckoSession.PromptDelegate getPromptDelegate()

Get the current prompt delegate for this GeckoSession.

Returns:

PromptDelegate instance or null if using built-in delegate.

setSelectionActionDelegate

@UiThread
public void setSelectionActionDelegate(@Nullable
                                                 GeckoSession.SelectionActionDelegate delegate)

Set the current selection action delegate for this GeckoSession.

Parameters:

delegate - SelectionActionDelegate instance or null to unset.

setMediaDelegate

@AnyThread
public void setMediaDelegate(@Nullable
                                        GeckoSession.MediaDelegate delegate)

Set the media callback handler. This will replace the current handler.

Parameters:

delegate - An implementation of MediaDelegate.

getMediaDelegate

@AnyThread
 @Nullable
public GeckoSession.MediaDelegate getMediaDelegate()

Get the Media callback handler.

Returns:

The current Media callback handler.

getSelectionActionDelegate

@AnyThread
 @Nullable
public GeckoSession.SelectionActionDelegate getSelectionActionDelegate()

Get the current selection action delegate for this GeckoSession.

Returns:

SelectionActionDelegate instance or null if not set.

setShouldPinOnScreen

@UiThread
protected void setShouldPinOnScreen(boolean pinned)

getPanZoomController

@UiThread
 @NonNull
public PanZoomController getPanZoomController()

Get the PanZoomController instance for this session.

Returns:

PanZoomController instance.

getOverscrollEdgeEffect

@UiThread
 @NonNull
public OverscrollEdgeEffect getOverscrollEdgeEffect()

Get the OverscrollEdgeEffect instance for this session.

Returns:

OverscrollEdgeEffect instance.

getDynamicToolbarAnimator

@UiThread
 @NonNull
public DynamicToolbarAnimator getDynamicToolbarAnimator()

Get the DynamicToolbarAnimator instance for this session.

Returns:

DynamicToolbarAnimator instance.

getCompositorController

@UiThread
 @NonNull
public CompositorController getCompositorController()

Get the CompositorController instance for this session.

Returns:

CompositorController instance.

getClientToSurfaceMatrix

@UiThread
public void getClientToSurfaceMatrix(@NonNull
                                               Matrix matrix)

Get a matrix for transforming from client coordinates to surface coordinates.

Parameters:

matrix - Matrix to be replaced by the transformation matrix.

See Also:

getClientToScreenMatrix(Matrix), getPageToSurfaceMatrix(Matrix)

getClientToScreenMatrix

@UiThread
public void getClientToScreenMatrix(@NonNull
                                              Matrix matrix)

Get a matrix for transforming from client coordinates to screen coordinates. The client coordinates are in CSS pixels and are relative to the viewport origin; their relation to screen coordinates does not depend on the current scroll position.

Parameters:

matrix - Matrix to be replaced by the transformation matrix.

See Also:

getClientToSurfaceMatrix(Matrix), getPageToScreenMatrix(Matrix)

getPageToScreenMatrix

@UiThread
public void getPageToScreenMatrix(@NonNull
                                            Matrix matrix)

Get a matrix for transforming from page coordinates to screen coordinates. The page coordinates are in CSS pixels and are relative to the page origin; their relation to screen coordinates depends on the current scroll position of the outermost frame.

Parameters:

matrix - Matrix to be replaced by the transformation matrix.

See Also:

getPageToSurfaceMatrix(Matrix), getClientToScreenMatrix(Matrix)

getPageToSurfaceMatrix

@UiThread
public void getPageToSurfaceMatrix(@NonNull
                                             Matrix matrix)

Get a matrix for transforming from page coordinates to surface coordinates.

Parameters:

matrix - Matrix to be replaced by the transformation matrix.

See Also:

getPageToScreenMatrix(Matrix), getClientToSurfaceMatrix(Matrix)

getClientBounds

@UiThread
public void getClientBounds(@NonNull
                                      RectF rect)

Get the bounds of the client area in client coordinates. The returned top-left coordinates are always (0, 0). Use the matrix from getClientToSurfaceMatrix(Matrix) or getClientToScreenMatrix(Matrix) to map these bounds to surface or screen coordinates, respectively.

Parameters:

rect - RectF to be replaced by the client bounds in client coordinates.

See Also:

getSurfaceBounds(Rect)

getSurfaceBounds

@UiThread
public void getSurfaceBounds(@NonNull
                                       Rect rect)

Get the bounds of the client area in surface coordinates. This is equivalent to mapping the bounds returned by #getClientBounds(RectF) with the matrix returned by #getClientToSurfaceMatrix(Matrix).

Parameters:

rect - Rect to be replaced by the client bounds in surface coordinates.

setAutofillDelegate

@UiThread
public void setAutofillDelegate(@Nullable
                                          Autofill.Delegate delegate)

Sets the autofill delegate for this session.

Parameters:

delegate - An instance of Autofill.Delegate.

getAutofillDelegate

@UiThread
 @Nullable
public Autofill.Delegate getAutofillDelegate()

Returns:

The current Autofill.Delegate for this session, if any.

autofill

@UiThread
public void autofill(@NonNull
                               SparseArray<CharSequence> values)

Perform autofill using the specified values.

Parameters:

values - Map of autofill IDs to values.

getAutofillSession

@UiThread
 @NonNull
public Autofill.Session getAutofillSession()

Provides an autofill structure similar to View.onProvideAutofillVirtualStructure(ViewStructure, int) , but does not rely on ViewStructure to build the tree. This is useful for apps that want to provide autofill functionality without using the Android autofill system or requiring API 26.

Returns:

The elements available for autofill.