com.actionbarsherlock.view

Interface ActionMode.Callback

All Known Subinterfaces:

ListView.MultiChoiceModeListener

All Known Implementing Classes:

ListView.MultiChoiceModeWrapper

Enclosing class:

ActionMode

public static interface ActionMode.Callback

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:

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

Method Summary

Methods

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

Method Detail

onCreateActionMode

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 being created

menu - Menu used to populate action buttons

Returns:

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

onPrepareActionMode

boolean onPrepareActionMode(ActionMode mode,
                          Menu menu)

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

Parameters:

mode - ActionMode being prepared

menu - Menu used to populate action buttons

Returns:

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

onActionItemClicked

boolean onActionItemClicked(ActionMode mode,
                          MenuItem item)

Called to report a user click on an action button.

Parameters:

mode - The current ActionMode

item - The item that was clicked

Returns:

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

onDestroyActionMode

void onDestroyActionMode(ActionMode mode)

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

Parameters:

mode - The current ActionMode being destroyed