Please note that the contents of this offline web site may be out of date. To access the most recent documentation visit the online version .
Note that links that point to online resources are green in color and will open in a new window.
We would love it if you could give us feedback about this material by filling this form (You have to be online to fill it)

Developer Docs

Menus: Creating Contextual Menus

Android 3.0 changed the long press gesture—that is, a touch that's held in the same position for a moment—to be the global gesture to select data.. This affects the way you should handle multi-select and contextual actions in your apps.

 

What has changed?

In previous versions of Android, the long press gesture was universally used to display contextual actions for a given data item in a contextual menu.

This pattern changed with Android 3.0. The long press gesture is now used to select data, combining contextual actions and selection management functions for selected data into a new element called the contextual action bar (CAB).

Traditional use of the long press gesture to show contextual menus.

Using the contextual action bar

The contextual action bar (CAB) is a temporary action bar that overlays your app's current action bar while data is selected. It appears after the user long-presses on a selectable data item.

 

From here the user can:

  • Select additional data items by touching them.
  • Trigger an action from the CAB that applies to all highlighted data items. The CAB then automatically dismisses itself.
  • Dismiss the CAB via the navigation bar's Back button or the CAB's checkmark button. This removes the CAB along with all selection highlights.

Selecting CAB actions

You can decide which actions and elements appear in the CAB. Use the guidelines in the Action Bar pattern to decide which items to surface at the top level and which to move to the action overflow.

Dynamically adjust CAB actions

In most cases you need to adjust the actions in the CAB dynamically as the user adds more items to the selection. Actions that apply to a single selected data item don't necessarily apply to multiple selected data items of the same kind.

Adjusting actions in the CAB as additional items are selected.

Developer Guide

For information about how to create a contextual action bar, read Using the contextual action mode .

Checklist

  • Whenever your app supports the selection of multiple data items, make use of the contextual action bar (CAB).

  • Reserve the long press gesture for selection exclusively. Don't use it to display traditional contextual menus.

  • If you don't support multi-selection within a list, long press should do nothing.

  • Plan the actions you want to display inside of a CAB in the same way you would plan the actions inside your app's action bar.