Package org.mozilla.geckoview

Class BasicSelectionActionDelegate

Object

org.mozilla.geckoview.BasicSelectionActionDelegate

All Implemented Interfaces:

ActionMode.Callback, GeckoSession.SelectionActionDelegate

@UiThread
public class BasicSelectionActionDelegate
extends Object
implements ActionMode.Callback, GeckoSession.SelectionActionDelegate

Class that implements a basic SelectionActionDelegate. This class is used by GeckoView by default if the consumer does not explicitly set a SelectionActionDelegate.

To provide custom actions, extend this class and override the following methods,

1) Override getAllActions() to include custom action IDs in the returned array. This array must include all actions, available or not, and must not change over the class lifetime.

2) Override isActionAvailable(java.lang.String) to return whether a custom action is currently available.

3) Override prepareAction(java.lang.String, android.view.MenuItem) to set custom title and/or icon for a custom action.

4) Override performAction(java.lang.String, android.view.MenuItem) to perform a custom action when used.

Nested Class Summary

Nested classes/interfaces inherited from interface org.mozilla.geckoview.GeckoSession.SelectionActionDelegate

GeckoSession.SelectionActionDelegate.ClipboardPermission, GeckoSession.SelectionActionDelegate.Selection

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	ACTION_PROCESS_TEXT	Intent action for processing text.
protected ActionMode	mActionMode	The current action mode, if any.
protected final Activity	mActivity	The activity associated with this delegate.
protected boolean	mRepopulatedMenu	Whether the menu has been repopulated.
protected GeckoSession.SelectionActionDelegate.Selection	mSelection	The current text selection.
protected GeckoSession	mSession	The current GeckoSession associated with selection.
protected final boolean	mUseFloatingToolbar	Whether to use floating toolbar for selection actions.

Fields inherited from interface org.mozilla.geckoview.GeckoSession.SelectionActionDelegate

ACTION_COLLAPSE_TO_END, ACTION_COLLAPSE_TO_START, ACTION_COPY, ACTION_CUT, ACTION_DELETE, ACTION_HIDE, ACTION_PASTE, ACTION_PASTE_AS_PLAIN_TEXT, ACTION_SELECT_ALL, ACTION_UNSELECT, FLAG_IS_COLLAPSED, FLAG_IS_EDITABLE, FLAG_IS_PASSWORD, HIDE_REASON_ACTIVE_SCROLL, HIDE_REASON_ACTIVE_SELECTION, HIDE_REASON_INVISIBLE_SELECTION, HIDE_REASON_NO_SELECTION, PERMISSION_CLIPBOARD_READ

Constructor Summary

Constructors

Constructor	Description
BasicSelectionActionDelegate(Activity activity)	Construct a BasicSelectionActionDelegate.
BasicSelectionActionDelegate(Activity activity, boolean useFloatingToolbar)	Construct a BasicSelectionActionDelegate.

Method Summary

Modifier and Type	Method	Description
boolean	areExternalActionsEnabled()	Get whether text actions from other apps are enabled.
void	clearSelection()	Clear the current selection, if possible.
void	enableExternalActions(boolean enable)	Set whether to include text actions from other apps in the floating toolbar.
protected String[]	getAllActions()	Return list of all actions in proper order, regardless of their availability at present.
GeckoSession.SelectionActionDelegate.Selection	getSelection()	Get the current selection object.
boolean	isActionAvailable()	Provides access to whether there are text selection actions available.
protected boolean	isActionAvailable(String id)	Return whether an action is presently available.
boolean	onActionItemClicked(ActionMode actionMode, MenuItem menuItem)
boolean	onCreateActionMode(ActionMode actionMode, Menu menu)
void	onDestroyActionMode(ActionMode actionMode)
void	onDismissClipboardPermissionRequest(GeckoSession session)	Dismiss action mode for requesting clipboard permission popup or model.
void	onGetContentRect(ActionMode mode, View view, Rect outRect)	Called to get the content rectangle for the selection.
void	onHideAction(GeckoSession session, int reason)	Previous actions are no longer available due to the user interacting with the page.
boolean	onPrepareActionMode(ActionMode actionMode, Menu menu)
void	onShowActionRequest(GeckoSession session, GeckoSession.SelectionActionDelegate.Selection selection)	Selection actions are available.
GeckoResult<AllowOrDeny>	onShowClipboardPermissionRequest(GeckoSession session, GeckoSession.SelectionActionDelegate.ClipboardPermission permission)	Show action mode bar to request clipboard permission
protected boolean	performAction(String id, MenuItem item)	Perform the specified action.
protected void	prepareAction(String id, MenuItem item)	Prepare a menu item corresponding to a certain action.

Methods inherited from class java.lang.Object

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

Field Details

ACTION_PROCESS_TEXT

protected static final String ACTION_PROCESS_TEXT

Intent action for processing text.

See Also:

• Constant Field Values

mActivity

@NonNull
protected final Activity mActivity

The activity associated with this delegate.

mUseFloatingToolbar

protected final boolean mUseFloatingToolbar

Whether to use floating toolbar for selection actions.

mActionMode

@Nullable
protected ActionMode mActionMode

The current action mode, if any.

mSession

@Nullable
protected GeckoSession mSession

The current GeckoSession associated with selection.

mSelection

@Nullable
protected GeckoSession.SelectionActionDelegate.Selection mSelection

The current text selection.

mRepopulatedMenu

protected boolean mRepopulatedMenu

Whether the menu has been repopulated.

Constructor Details

BasicSelectionActionDelegate

public BasicSelectionActionDelegate(@NonNull
 Activity activity)

Construct a BasicSelectionActionDelegate.

Parameters:

activity - The activity to associate with this delegate

BasicSelectionActionDelegate

public BasicSelectionActionDelegate(@NonNull
 Activity activity,
 boolean useFloatingToolbar)

Construct a BasicSelectionActionDelegate.

Parameters:

activity - The activity to associate with this delegate

useFloatingToolbar - Whether to use floating toolbar for selection

Method Details

enableExternalActions

public void enableExternalActions(boolean enable)

Set whether to include text actions from other apps in the floating toolbar.

Parameters:

enable - True if external actions should be enabled.

areExternalActionsEnabled

public boolean areExternalActionsEnabled()

Get whether text actions from other apps are enabled.

Returns:

True if external actions are enabled.

getAllActions

@NonNull
protected String[] getAllActions()

Return list of all actions in proper order, regardless of their availability at present. Override to add to or remove from the default set.

Returns:

Array of action IDs in proper order.

isActionAvailable

protected boolean isActionAvailable(@NonNull
 String id)

Return whether an action is presently available. Override to indicate availability for custom actions.

Parameters:

id - Action ID.

Returns:

True if the action is presently available.

isActionAvailable

public boolean isActionAvailable()

Provides access to whether there are text selection actions available. Override to indicate availability for custom actions.

Returns:

True if there are text selection actions available.

prepareAction

protected void prepareAction(@NonNull
 String id,
 @NonNull
 MenuItem item)

Prepare a menu item corresponding to a certain action. Override to prepare menu item for custom action.

Parameters:

id - Action ID.

item - New menu item to prepare.

performAction

protected boolean performAction(@NonNull
 String id,
 @NonNull
 MenuItem item)

Perform the specified action. Override to perform custom actions.

Parameters:

id - Action ID.

item - Nenu item for the action.

Returns:

True if the action was performed.

getSelection

@Nullable
public GeckoSession.SelectionActionDelegate.Selection getSelection()

Get the current selection object. This object should not be stored as it does not update when the selection becomes invalid. Stale actions are ignored.

Returns:

The GeckoSession.SelectionActionDelegate.Selection attached to the current action menu. null if no action menu is active.

clearSelection

public void clearSelection()

Clear the current selection, if possible.

onCreateActionMode

public boolean onCreateActionMode(ActionMode actionMode,
 Menu menu)

Specified by:

onCreateActionMode in interface ActionMode.Callback

onPrepareActionMode

public boolean onPrepareActionMode(ActionMode actionMode,
 Menu menu)

Specified by:

onPrepareActionMode in interface ActionMode.Callback

onActionItemClicked

public boolean onActionItemClicked(ActionMode actionMode,
 MenuItem menuItem)

Specified by:

onActionItemClicked in interface ActionMode.Callback

onDestroyActionMode

public void onDestroyActionMode(ActionMode actionMode)

Specified by:

onDestroyActionMode in interface ActionMode.Callback

onGetContentRect

public void onGetContentRect(@Nullable
 ActionMode mode,
 @Nullable
 View view,
 @NonNull
 Rect outRect)

Called to get the content rectangle for the selection.

Parameters:

mode - The action mode

view - The view

outRect - The rectangle to be filled with content bounds

onShowActionRequest

public void onShowActionRequest(GeckoSession session,
 GeckoSession.SelectionActionDelegate.Selection selection)

Description copied from interface: GeckoSession.SelectionActionDelegate

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 GeckoSession.SelectionActionDelegate.onHideAction(org.mozilla.geckoview.GeckoSession, int) call (with particular reasons) or another GeckoSession.SelectionActionDelegate.onShowActionRequest(org.mozilla.geckoview.GeckoSession, org.mozilla.geckoview.GeckoSession.SelectionActionDelegate.Selection) call is received, the previous Selection object is no longer usable.

Specified by:

onShowActionRequest in interface GeckoSession.SelectionActionDelegate

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

public void onHideAction(GeckoSession session,
 int reason)

Description copied from interface: GeckoSession.SelectionActionDelegate

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

Specified by:

onHideAction in interface GeckoSession.SelectionActionDelegate

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

public GeckoResult<AllowOrDeny> onShowClipboardPermissionRequest(GeckoSession session,
 GeckoSession.SelectionActionDelegate.ClipboardPermission permission)

Show action mode bar to request clipboard permission

Specified by:

onShowClipboardPermissionRequest in interface GeckoSession.SelectionActionDelegate

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

public void onDismissClipboardPermissionRequest(GeckoSession session)

Dismiss action mode for requesting clipboard permission popup or model.

Specified by:

onDismissClipboardPermissionRequest in interface GeckoSession.SelectionActionDelegate

Parameters:

session - The GeckoSession that initiated the callback.