Creating a ContextMenu on a ListView

by plusminus » Sun Jun 15, 2008 3:18 pm

Creating a ContextMenu on a ListView

What you learn: You will learn how to create a ContextMenu on a ListView. This can easily be applied to other situations.
Difficulty: 2 of 5

Questions/Problems: Simply post below...

What it will look like:

Description:
The Context-Menu gets visible when long-pressing an entry in the ListView.
Layout: "/res/main.xml"

Syntax: [ Download ] [ Hide ]

Syntax: [ Download ] [ Show ]

Using xml Syntax Highlighting

1. <?xml version="1.0" encoding="utf-8"?>
2. <LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
3.         android:orientation="vertical"
4.         android:layout_width="fill_parent"
5.         android:layout_height="fill_parent">
6.         <TextView
7.                 android:layout_width="fill_parent"
8.                 android:layout_height="wrap_content"
9.                 android:text="Long-Press on of the Items in the list." />
10.         <ListView android:id="@+id/list_favorites"
11.                 android:layout_width="fill_parent"
12.                 android:layout_height="fill_parent"/>
13. </LinearLayout>

Parsed in 0.002 seconds, using GeSHi 1.0.8.4

We will create a ListView that gets filled by a list of a custom Class (Favorite). In the ContextMenu we will offer the user a possibility to delete the entry he long-pressed.

Syntax: [ Download ] [ Hide ]

Syntax: [ Download ] [ Show ]

Using java Syntax Highlighting

1. package org.anddev.contextmenusample;
2.  
3. import java.util.ArrayList;
4.  
5. import android.app.Activity;
6. import android.os.Bundle;
7. import android.view.ContextMenu;
8. import android.view.View;
9. import android.view.Menu.Item;
10. import android.view.View.OnPopulateContextMenuListener;
11. import android.widget.ArrayAdapter;
12. import android.widget.ListView;
13. import android.widget.AdapterView.ContextMenuInfo;
14.  
15. public class ContextMenuSample extends Activity {
16.  
17.         // ===========================================================
18.         // Final Fields
19.         // ===========================================================
20.         protected static final int CONTEXTMENU_DELETEITEM = 0;
21.  
22.         // ===========================================================
23.         // Fields
24.         // ===========================================================
25.  
26.         protected ListView mFavList;
27.         protected ArrayList<Favorite> fakeFavs = new ArrayList<Favorite>();
28.  
29.         // ===========================================================
30.         // "Constructors"
31.         // ===========================================================
32.  
33.         /** Called when the activity is first created. */
34.         @Override
35.         public void onCreate(Bundle icicle) {
36.                 super.onCreate(icicle);
37.                 setContentView(R.layout.main);
38.  
39.                 /* Add some items to the list the listview will be showing. */
40.                 fakeFavs.add(new Favorite("John", "nice guy"));
41.                 fakeFavs.add(new Favorite("Yasmin", "hot girl"));
42.                 fakeFavs.add(new Favorite("Jack", "cool guy"));
43.  
44.                 this.mFavList = (ListView) this.findViewById(R.id.list_favorites);
45.                 initListView();
46.         }
47.  
48.         private void refreshFavListItems() {
49.                 mFavList.setAdapter(new ArrayAdapter<Favorite>(this,
50.                                 android.R.layout.simple_list_item_1, fakeFavs));
51.         }
52.  
53.         private void initListView() {
54.                 /* Loads the items to the ListView. */
55.                 refreshFavListItems();
56.  
57.                 /* Add Context-Menu listener to the ListView. */
58.                 mFavList.setOnPopulateContextMenuListener(new OnPopulateContextMenuListener() {
59.  
60.                         @Override
61.                         public void onPopulateContextMenu(ContextMenu conMenu, View arg1, Object arg2) {
62.                                 conMenu.setHeader("ContextMenu");
63.                                 conMenu.add(0, CONTEXTMENU_DELETEITEM, "Delete this favorite!");
64.                                 /* Add as many context-menu-options as you want to. */
65.                         }
66.                 });
67.         }
68.  
69.         // ===========================================================
70.         // Methods from SuperClass/Interfaces
71.         // ===========================================================
72.  
73.         @Override
74.         public boolean onContextItemSelected(Item aItem) {
75.                 ContextMenuInfo menuInfo = (ContextMenuInfo) aItem.getMenuInfo();
76.  
77.                 /* Switch on the ID of the item, to get what the user selected. */
78.                 switch (aItem.getId()) {
79.                         case CONTEXTMENU_DELETEITEM:
80.                                 /* Get the selected item out of the Adapter by its position. */
81.                                 Favorite favContexted = (Favorite) mFavList.getAdapter()
82.                                         .getItem(menuInfo.position);
83.                                 /* Remove it from the list.*/
84.                                 fakeFavs.remove(favContexted);
85.  
86.                                 refreshFavListItems();
87.                                 return true; /* true means: "we handled the event". */
88.                 }
89.                 return false;
90.         }
91.  
92.         // ===========================================================
93.         // Inner and Anonymous Classes
94.         // ===========================================================
95.  
96.         /** Small class holding some basic */
97.         protected class Favorite {
98.  
99.                 protected String name;
100.                 protected String kindness;
101.  
102.                 protected Favorite(String name, String kindness) {
103.                         this.name = name;
104.                         this.kindness = kindness;
105.                 }
106.  
107.                 /** The ListView is going to display the toString() return-value! */
108.                 public String toString() {
109.                         return name + " (" + kindness + ")";
110.                 }
111.  
112.                 public boolean equals(Object o) {
113.                         return o instanceof Favorite && ((Favorite) o).name.compareTo(name) == 0;
114.                 }
115.         }
116. }

Parsed in 0.044 seconds, using GeSHi 1.0.8.4

That's it

Regards,
plusminus

| Android Development Community / Tutorials

by shiteiru » Tue Jun 17, 2008 7:42 pm

by phannguyen » Wed Oct 08, 2008 4:24 am

by plusminus » Wed Oct 08, 2008 5:02 am

Hi phannguyen,

MapView handles stuff a bit different

So I put some code to the snippet-section, that works fine for AndNav:
mapview_longpress_gesturedetector_ontouchlistener-t3071.html

Regards,
plusminus

| Android Development Community / Tutorials

by phannguyen » Wed Oct 08, 2008 9:31 am

by happy_bob » Mon Oct 20, 2008 3:13 pm

by miguelo » Mon Nov 17, 2008 4:10 pm

by Ventrix » Fri Mar 20, 2009 4:00 pm

I can not to run with new sdk:(

by laji1110 » Fri Apr 17, 2009 5:53 am

by WarrenFaith » Fri Apr 17, 2009 10:20 am

Hi WarrenFaith

by laji1110 » Sat Apr 18, 2009 3:57 am

Attachments

ContextMenuSample.zip

(29.83 KiB) Downloaded 620 times

Hi all!

by laji1110 » Sun May 10, 2009 5:23 pm

Attachments

ContextMenuSample.zip

(31.58 KiB) Downloaded 820 times

by mccarthycw » Fri Jul 17, 2009 5:43 pm

by mccarthycw » Fri Jul 17, 2009 6:03 pm

by qlimax » Wed Oct 07, 2009 11:45 pm

thank you for this tutorial (and updates)!

big up!