ActionMode.Callback

Kotlin |Java

public static interface ActionMode.Callback

android.view.ActionMode.Callback

Known indirect subclasses

AbsListView.MultiChoiceModeListener, ActionMode.Callback2

AbsListView.MultiChoiceModeListener	A MultiChoiceModeListener receives events for `AbsListView#CHOICE_MODE_MULTIPLE_MODAL`.
ActionMode.Callback2	Extension of `ActionMode.Callback` to provide content rect information.

Callback interface for action modes. Supplied to View#startActionMode(Callback), a Callback configures and handles events raised by a user's interaction with an action mode.

An action mode's lifecycle is as follows:

Callback#onCreateActionMode(ActionMode, Menu) once on initial creation
Callback#onPrepareActionMode(ActionMode, Menu) after creation and any time the ActionMode is invalidated
Callback#onActionItemClicked(ActionMode, MenuItem) any time a contextual action button is clicked
Callback#onDestroyActionMode(ActionMode) when the action mode is closed

Summary

Public methods
`abstract boolean`	`onActionItemClicked(ActionMode mode, MenuItem item)` Called to report a user click on an action button.
`abstract boolean`	`onCreateActionMode(ActionMode mode, Menu menu)` Called when action mode is first created.
`abstract void`	`onDestroyActionMode(ActionMode mode)` Called when an action mode is about to be exited and destroyed.
`abstract boolean`	`onPrepareActionMode(ActionMode mode, Menu menu)` Called to refresh an action mode's action menu whenever it is invalidated.

Public methods

onActionItemClicked

Added in API level 11

public abstract boolean onActionItemClicked (ActionMode mode, 
                MenuItem item)

Called to report a user click on an action button.

Parameters
`mode`	`ActionMode`: The current ActionMode
`item`	`MenuItem`: The item that was clicked

Returns
`boolean`	true if this callback handled the event, false if the standard MenuItem invocation should continue.

Added in API level 11

public abstract boolean onCreateActionMode (ActionMode mode, 
                Menu menu)

Called when action mode is first created. The menu supplied will be used to generate action buttons for the action mode.

Parameters
`mode`	`ActionMode`: ActionMode being created
`menu`	`Menu`: Menu used to populate action buttons

Returns
`boolean`	true if the action mode should be created, false if entering this mode should be aborted.

onDestroyActionMode

Added in API level 11

public abstract void onDestroyActionMode (ActionMode mode)

Called when an action mode is about to be exited and destroyed.

Parameters
`mode`	`ActionMode`: The current ActionMode being destroyed

Added in API level 11

public abstract boolean onPrepareActionMode (ActionMode mode, 
                Menu menu)

Called to refresh an action mode's action menu whenever it is invalidated.

Parameters
`mode`	`ActionMode`: ActionMode being prepared
`menu`	`Menu`: Menu used to populate action buttons

Returns
`boolean`	true if the menu or action mode was updated, false otherwise.