Package org.mozilla.geckoview

Interface GeckoSession.SelectionActionDelegate

All Known Implementing Classes:

BasicSelectionActionDelegate

Enclosing class:

GeckoSession

public static interface GeckoSession.SelectionActionDelegate

Interface for handling text selection actions and providing custom selection action items.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	GeckoSession.SelectionActionDelegate.ClipboardPermission	Represents attributes of a clipboard permission.
static class	GeckoSession.SelectionActionDelegate.Selection	Represents attributes of a selection.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ACTION_COLLAPSE_TO_END	Collapse the current selection to its end position.
static final String	ACTION_COLLAPSE_TO_START	Collapse the current selection to its start position.
static final String	ACTION_COPY	Copy the selected content onto the clipboard.
static final String	ACTION_CUT	Copy onto the clipboard then delete the selected content.
static final String	ACTION_DELETE	Delete the selected content.
static final String	ACTION_HIDE	Hide selection actions and cause onHideAction(org.mozilla.geckoview.GeckoSession, int) to be called.
static final String	ACTION_PASTE	Replace the selected content with the clipboard content.
static final String	ACTION_PASTE_AS_PLAIN_TEXT	Replace the selected content with the clipboard content as plain text.
static final String	ACTION_SELECT_ALL	Select the entire content of the document or editor.
static final String	ACTION_UNSELECT	Clear the current selection.
static final int	FLAG_IS_COLLAPSED	The selection is collapsed at a single position.
static final int	FLAG_IS_EDITABLE	The selection is inside editable content such as an input element or contentEditable node.
static final int	FLAG_IS_PASSWORD	The selection is inside a password field.
static final int	HIDE_REASON_ACTIVE_SCROLL	Actions are no longer available due to the user actively scrolling the page.
static final int	HIDE_REASON_ACTIVE_SELECTION	Actions are no longer available due to the user actively changing the selection.
static final int	HIDE_REASON_INVISIBLE_SELECTION	Actions are no longer available due to the user moving the selection out of view.
static final int	HIDE_REASON_NO_SELECTION	Actions are no longer available due to the user clearing the selection.
static final int	PERMISSION_CLIPBOARD_READ	Permission for reading clipboard data.

Method Summary

Modifier and Type	Method	Description
default void	onDismissClipboardPermissionRequest(GeckoSession session)	Dismiss requesting clipboard permission popup or model.
default void	onHideAction(GeckoSession session, int reason)	Previous actions are no longer available due to the user interacting with the page.
default void	onShowActionRequest(GeckoSession session, GeckoSession.SelectionActionDelegate.Selection selection)	Selection actions are available.
default GeckoResult<AllowOrDeny>	onShowClipboardPermissionRequest(GeckoSession session, GeckoSession.SelectionActionDelegate.ClipboardPermission permission)	Request clipboard permission.

Field Details

FLAG_IS_COLLAPSED

static final int FLAG_IS_COLLAPSED

The selection is collapsed at a single position.

See Also:

• Constant Field Values

FLAG_IS_EDITABLE

static final int FLAG_IS_EDITABLE

The selection is inside editable content such as an input element or contentEditable node.

See Also:

• Constant Field Values

FLAG_IS_PASSWORD

static final int FLAG_IS_PASSWORD

The selection is inside a password field.

See Also:

• Constant Field Values

ACTION_HIDE

static final String ACTION_HIDE

Hide selection actions and cause onHideAction(org.mozilla.geckoview.GeckoSession, int) to be called.

See Also:

• Constant Field Values

ACTION_CUT

static final String ACTION_CUT

Copy onto the clipboard then delete the selected content. Selection must be editable.

See Also:

• Constant Field Values

ACTION_COPY

static final String ACTION_COPY

Copy the selected content onto the clipboard.

See Also:

• Constant Field Values

ACTION_DELETE

static final String ACTION_DELETE

Delete the selected content. Selection must be editable.

See Also:

• Constant Field Values

ACTION_PASTE

static final String ACTION_PASTE

Replace the selected content with the clipboard content. Selection must be editable.

See Also:

• Constant Field Values

ACTION_PASTE_AS_PLAIN_TEXT

static final String ACTION_PASTE_AS_PLAIN_TEXT

Replace the selected content with the clipboard content as plain text. Selection must be editable.

See Also:

• Constant Field Values

ACTION_SELECT_ALL

static final String ACTION_SELECT_ALL

Select the entire content of the document or editor.

See Also:

• Constant Field Values

ACTION_UNSELECT

static final String ACTION_UNSELECT

Clear the current selection. Selection must not be editable.

See Also:

• Constant Field Values

ACTION_COLLAPSE_TO_START

static final String ACTION_COLLAPSE_TO_START

Collapse the current selection to its start position. Selection must be editable.

See Also:

• Constant Field Values

ACTION_COLLAPSE_TO_END

static final String ACTION_COLLAPSE_TO_END

Collapse the current selection to its end position. Selection must be editable.

See Also:

• Constant Field Values

HIDE_REASON_NO_SELECTION

static final int HIDE_REASON_NO_SELECTION

Actions are no longer available due to the user clearing the selection.

See Also:

• Constant Field Values

HIDE_REASON_INVISIBLE_SELECTION

static final int HIDE_REASON_INVISIBLE_SELECTION

Actions are no longer available due to the user moving the selection out of view. Previous actions are still available after a callback with this reason.

See Also:

• Constant Field Values

HIDE_REASON_ACTIVE_SELECTION

static final int HIDE_REASON_ACTIVE_SELECTION

Actions are no longer available due to the user actively changing the selection. onShowActionRequest(org.mozilla.geckoview.GeckoSession, org.mozilla.geckoview.GeckoSession.SelectionActionDelegate.Selection) may be called again once the user has set a selection, if the new selection has available actions.

See Also:

• Constant Field Values

HIDE_REASON_ACTIVE_SCROLL

static final int HIDE_REASON_ACTIVE_SCROLL

Actions are no longer available due to the user actively scrolling the page. onShowActionRequest(org.mozilla.geckoview.GeckoSession, org.mozilla.geckoview.GeckoSession.SelectionActionDelegate.Selection) may be called again once the user has stopped scrolling the page, if the selection is still visible. Until then, previous actions are still available after a callback with this reason.

See Also:

• Constant Field Values

PERMISSION_CLIPBOARD_READ

static final int PERMISSION_CLIPBOARD_READ

Permission for reading clipboard data. See: Clipboard.readText()

See Also:

• Constant Field Values

Method Details

onShowActionRequest

@UiThread
default void onShowActionRequest(@NonNull
 GeckoSession session,
 @NonNull
 GeckoSession.SelectionActionDelegate.Selection selection)

Selection actions are available. Selection actions become available when the user selects some content in the document or editor. Inside an editor, selection actions can also become available when the user explicitly requests editor action UI, for example by tapping on the caret handle.

In response to this callback, applications typically display a toolbar containing the selection actions. To perform a certain action, check if the action is available with GeckoSession.SelectionActionDelegate.Selection.isActionAvailable(java.lang.String) then either use the relevant helper method or GeckoSession.SelectionActionDelegate.Selection.execute(java.lang.String)

Once an onHideAction(org.mozilla.geckoview.GeckoSession, int) call (with particular reasons) or another onShowActionRequest(org.mozilla.geckoview.GeckoSession, org.mozilla.geckoview.GeckoSession.SelectionActionDelegate.Selection) call is received, the previous Selection object is no longer usable.

Parameters:

session - The GeckoSession that initiated the callback.

selection - Current selection attributes and Callback object for performing built-in actions. May be used multiple times to perform multiple actions at once.

onHideAction

@UiThread
default void onHideAction(@NonNull
 GeckoSession session,
 int reason)

Previous actions are no longer available due to the user interacting with the page. Applications typically hide the action toolbar in response.

Parameters:

session - The GeckoSession that initiated the callback.

reason - The reason that actions are no longer available, as one of the HIDE_REASON_* constants.

onShowClipboardPermissionRequest

@UiThread
@Nullable
default GeckoResult<AllowOrDeny> onShowClipboardPermissionRequest(@NonNull
 GeckoSession session,
 @NonNull
 GeckoSession.SelectionActionDelegate.ClipboardPermission permission)

Request clipboard permission.

Parameters:

session - The GeckoSession that initiated the callback.

permission - An GeckoSession.SelectionActionDelegate.ClipboardPermission describing the permission being requested.

Returns:

A GeckoResult with AllowOrDeny, determining the response to the permission request for this site.

onDismissClipboardPermissionRequest

@UiThread
default void onDismissClipboardPermissionRequest(@NonNull
 GeckoSession session)

Dismiss requesting clipboard permission popup or model.

Parameters:

session - The GeckoSession that initiated the callback.