Android Navigation Drawer(导航抽屉)

Google I/O 2013 Android 更新了Support库，新版本的Support库中新加入了几个比较重要的功能。

• 添加 DrawerLayout 控件，支持创建  Navigation Drawer模式。可以设置从左边划出菜单或者右边，也可以左右菜单同时存在。
• 添加 SlidingPaneLayout 控件来支持各种屏幕上的摘要、详情界面模式。比如 Gmail邮件列表和单个邮件详情界面。当在手机上显示的时候，邮件列表和详情界面分别为两个界面；当在平板上显示的时候，则为一个界面。
• 添加 ActionBarDrawerToggle 工具类，方便把 DrawerLayout 和 ActionBar 功能结合起来。

具体可参考以下链接

Android Navigation Drawer Design ：http://developer.android.com/design/patterns/navigation-drawer.html

Android Navigation Drawer 教程：  Android Navigation Drawer Designhttp://developer.android.com/training/implementing-navigation/nav-drawer.html

下面来介绍下如何使用 DrawerLayout 控件来实现抽屉菜单

Demo 运行效果如下所示

未打开抽屉状态

打开抽屉菜单后

创建Drawer Layout
在需要抽屉菜单的界面，用DrawerLayout 作为界面根控件。在DrawerLayout里面第一个View为当前界面主内容；第二个和第三个View为抽屉菜单内容。如果当前界面只需要一个抽屉菜单，则第三个View可以省略。
下面的例子中DrawerLayout里面包含两个View，第一个FrameLayout中是当前界面主要内容显示区域(使用Fragment填充)；第二个ListView为抽屉菜单。

1. <android.support.v4.widget.DrawerLayout
2. xmlns:android="http://schemas.android.com/apk/res/android"
3. android:id="@+id/drawer_layout"
4. android:layout_width="match_parent"
5. android:layout_height="match_parent">
6. <!-- As the main content view, the view below consumes the entire
7. space available using match_parent in both dimensions. -->
8. <FrameLayout
9. android:id="@+id/content_frame"
10. android:layout_width="match_parent"
11. android:layout_height="match_parent" />
12. <!-- android:layout_gravity="start" tells DrawerLayout to treat
13. this as a sliding drawer on the left side for left-to-right
14. languages and on the right side for right-to-left languages.
15. The drawer is given a fixed width in dp and extends the full height of
16. the container. A solid background is used for contrast
17. with the content view. -->
18. <ListView
19. android:id="@+id/left_drawer"
20. android:layout_width="240dp"
21. android:layout_height="match_parent"
22. android:layout_gravity="start"
23. android:choiceMode="singleChoice"
24. android:divider="@android:color/transparent"
25. android:dividerHeight="0dp"
26. android:background="#111"/>
27. </android.support.v4.widget.DrawerLayout>

上面的代码中有如下几点需要注意：

• 显示界面主要内容的View (上面的 FrameLayout ) 必须为DrawerLayout的第一个子View， 原因在于 XML 布局文件中的View顺序为Android系统中的 z-ordering顺序，而抽屉必须出现在内容之上。
• 显示界面内容的View宽度和高度设置为和父View一样，原因在于当抽屉菜单不可见的时候，界面内容代表整个界面UI。
• 抽
  屉菜单 (上面的 ListView) 必须使用android:layout_gravity属性设置水平的 gravity值 .如果要支持
  right-to-left (RTL，从右向左阅读)语言 用 "start" 代替 "left" (当在 RTL语言运行时候，菜单出现在右侧)。
• 抽屉菜单的宽度为 dp 单位而高度和父View一样。抽屉菜单的宽度应该不超过320dp，这样用户可以在菜单打开的时候看到部分内容界面。

初始化抽屉菜单
在您的Activity中需要先初始化抽屉菜单内容，根据您的应用需要抽屉菜单内容的方式可能不一样。但是抽屉菜单通常是一个ListView，所以可以通过Adapter来填充ListView。

1. @Override
2. protected void onCreate(Bundle savedInstanceState) {
3. super.onCreate(savedInstanceState);
4. setContentView(R.layout.activity_main);
5. findView();
6. if (savedInstanceState == null) {
7. selectItem(0);
8. }
9. }
10. @SuppressLint("NewApi")
11. private void findView() {
12. mTitle = mDrawerTitle = getTitle();
13. mDrawerLayout = (DrawerLayout) findViewById(R.id.drawer_layout);
14. mDrawerList = (ListView) findViewById(R.id.left_drawer);
15. // set a custom shadow that overlays the main content when the drawer opens
16. mDrawerLayout.setDrawerShadow(R.drawable.drawer_shadow, GravityCompat.START);
17. mNavMenuTitles = getResources().getStringArray(R.array.nav_drawer_items);
18. // nav drawer icons from resources
19. mNavMenuIconsTypeArray = getResources()
20. .obtainTypedArray(R.array.nav_drawer_icons);
21. mNavDrawerItems = new ArrayList<NavDrawerItem>();
22. // adding nav drawer items to array
23. // Home
24. mNavDrawerItems.add(new NavDrawerItem(mNavMenuTitles[0], mNavMenuIconsTypeArray
25. .getResourceId(0, -1)));
26. // Find People
27. mNavDrawerItems.add(new NavDrawerItem(mNavMenuTitles[1], mNavMenuIconsTypeArray
28. .getResourceId(1, -1)));
29. // Photos
30. mNavDrawerItems.add(new NavDrawerItem(mNavMenuTitles[2], mNavMenuIconsTypeArray
31. .getResourceId(2, -1)));
32. // Communities, Will add a counter here
33. mNavDrawerItems.add(new NavDrawerItem(mNavMenuTitles[3], mNavMenuIconsTypeArray
34. .getResourceId(3, -1), true, "22"));
35. // Pages
36. mNavDrawerItems.add(new NavDrawerItem(mNavMenuTitles[4], mNavMenuIconsTypeArray
37. .getResourceId(4, -1)));
38. // What's hot, We will add a counter here
39. mNavDrawerItems.add(new NavDrawerItem(mNavMenuTitles[5], mNavMenuIconsTypeArray
40. .getResourceId(5, -1), true, "50+"));
41. // Recycle the typed array
42. mNavMenuIconsTypeArray.recycle();
43. // setting the nav drawer list adapter
44. mAdapter = new NavDrawerListAdapter(getApplicationContext(),
45. mNavDrawerItems);
46. mDrawerList.setAdapter(mAdapter);
47. mDrawerList.setOnItemClickListener(this);

处理菜单点击事件
当用户选择菜单List中的条目时，系统会调用  OnItemClickListener的 onItemClick()函数。
根据您的应用需要onItemClick函数的实现方式可能不同。下面的示例中，选择菜单条目会在程序主界面中插入不同的 Fragment(ID 为 R.id.content_frame 的FrameLayout)。

1. @Override
2. public void onItemClick(AdapterView<?> parent, View view, int position,
3. long id) {
4. selectItem(position);
5. }
6. /**
7. * Diplaying fragment view for selected nav drawer list item
8. * */
9. private void selectItem(int position) {
10. // update the main content by replacing fragments
11. Fragment fragment = null;
12. switch (position) {
13. case 0:
14. fragment = new HomeFragment();
15. break;
16. case 1:
17. fragment = new FindPeopleFragment();
18. break;
19. case 2:
20. fragment = new PhotosFragment();
21. break;
22. case 3:
23. fragment = new CommunityFragment();
24. break;
25. case 4:
26. fragment = new PagesFragment();
27. break;
28. case 5:
29. fragment = new WhatsHotFragment();
30. break;
31. default:
32. break;
33. }
34. if (fragment != null) {
35. FragmentManager fragmentManager = getSupportFragmentManager();
36. fragmentManager.beginTransaction()
37. .replace(R.id.content_frame, fragment).commit();
38. // update selected item and title, then close the drawer
39. mDrawerList.setItemChecked(position, true);
40. mDrawerList.setSelection(position);
41. setTitle(mNavMenuTitles[position]);
42. mDrawerLayout.closeDrawer(mDrawerList);
43. } else {
44. // error in creating fragment
45. Log.e("MainActivity", "Error in creating fragment");
46. }
47. }
48. @SuppressLint("NewApi")
49. @Override
50. public void setTitle(CharSequence title) {
51. mTitle = title;
52. getActionBar().setTitle(mTitle);
53. }

监听菜单打开关闭事件
如果需要监听菜单打开关闭事件，则需要调用 DrawerLayout类的
setDrawerListener() 函数，参数为
DrawerLayout.DrawerListener接口的实现。该接口提供了菜单打开关闭等事件的回调函数，例如
onDrawerOpened() 和onDrawerClosed().
如果您的Activity使用了 action bar，则您可以使用Support库提供的 ActionBarDrawerToggle
类，该类实现了 DrawerLayout.DrawerListener接口，并且您还可以根据需要重写相关的函数。该类实现了菜单和Action
bar相关的操作。
根据在 Navigation Drawer 设计指南中的介绍，当菜单显示的时候您应该根据情况隐藏ActionBar上的功能菜单并且修改ActionBar的标题。下面的代码演示了如何重写 ActionBarDrawerToggle 类的相关函数来实现该功能。

1. // ActionBarDrawerToggle ties together the the proper interactions
2. // between the sliding drawer and the action bar app icon
3. mDrawerToggle = new ActionBarDrawerToggle(
4. this,                  /* host Activity */
5. mDrawerLayout,         /* DrawerLayout object */
6. R.drawable.ic_drawer,  /* nav drawer image to replace 'Up' caret */
7. R.string.drawer_open,  /* "open drawer" description for accessibility */
8. R.string.drawer_close  /* "close drawer" description for accessibility */
9. ) {
10. public void onDrawerClosed(View view) {
11. getActionBar().setTitle(mTitle);
12. invalidateOptionsMenu(); // creates call to onPrepareOptionsMenu()
13. }
14. public void onDrawerOpened(View drawerView) {
15. getActionBar().setTitle(mDrawerTitle);
16. invalidateOptionsMenu(); // creates call to onPrepareOptionsMenu()
17. }
18. };
19. mDrawerLayout.setDrawerListener(mDrawerToggle);
20. }
21. @Override
22. public boolean onCreateOptionsMenu(Menu menu) {
23. // Inflate the menu; this adds items to the action bar if it is present.
24. getMenuInflater().inflate(R.menu.main, menu);
25. return true;
26. }
27. /* Called whenever we call invalidateOptionsMenu() */
28. @Override
29. public boolean onPrepareOptionsMenu(Menu menu) {
30. // If the nav drawer is open, hide action items related to the content view
31. boolean drawerOpen = mDrawerLayout.isDrawerOpen(mDrawerList);
32. menu.findItem(R.id.action_refresh).setVisible(!drawerOpen);
33. return super.onPrepareOptionsMenu(menu);
34. }

通过应用图打开或关闭抽屉
用户可以从屏幕边缘滑动来打开抽屉菜单，如果您使用了 action bar，应该让用户通过点击应用图标也可以打开抽屉菜单。并且应用图标也应该使用一个特殊的图标来指示抽屉菜单。您可以使用 ActionBarDrawerToggle 类来实现这些功能。
要使用 ActionBarDrawerToggle ，先通过其构造函数来创建该对象，构造函数需要如下参数：

• 显示抽屉的 Activity 对象。
• DrawerLayout 对象。
• 一个用来指示抽屉的 drawable资源。
• 一个用来描述打开抽屉的文本 (用于支持可访问性)。
• 一个用来描述关闭抽屉的文本(用于支持可访问性)。

无论你是否继承 ActionBarDrawerToggle 来实现抽屉监听器，您都需要在Activity的生命周期函数中调用ActionBarDrawerToggle 的一些函数。

1. // enable ActionBar app icon to behave as action to toggle nav drawer
2. getActionBar().setDisplayHomeAsUpEnabled(true);
3. getActionBar().setHomeButtonEnabled(true);
4. // ActionBarDrawerToggle ties together the the proper interactions
5. // between the sliding drawer and the action bar app icon
6. mDrawerToggle = new ActionBarDrawerToggle(
7. this,                  /* host Activity */
8. mDrawerLayout,         /* DrawerLayout object */
9. R.drawable.ic_drawer,  /* nav drawer image to replace 'Up' caret */
10. R.string.drawer_open,  /* "open drawer" description for accessibility */
11. R.string.drawer_close  /* "close drawer" description for accessibility */
12. ) {
13. public void onDrawerClosed(View view) {
14. getActionBar().setTitle(mTitle);
15. invalidateOptionsMenu(); // creates call to onPrepareOptionsMenu()
16. }
17. public void onDrawerOpened(View drawerView) {
18. getActionBar().setTitle(mDrawerTitle);
19. invalidateOptionsMenu(); // creates call to onPrepareOptionsMenu()
20. }
21. };
22. mDrawerLayout.setDrawerListener(mDrawerToggle);
23. }
24. @Override
25. public boolean onCreateOptionsMenu(Menu menu) {
26. // Inflate the menu; this adds items to the action bar if it is present.
27. getMenuInflater().inflate(R.menu.main, menu);
28. return true;
29. }
30. /* Called whenever we call invalidateOptionsMenu() */
31. @Override
32. public boolean onPrepareOptionsMenu(Menu menu) {
33. // If the nav drawer is open, hide action items related to the content view
34. boolean drawerOpen = mDrawerLayout.isDrawerOpen(mDrawerList);
35. menu.findItem(R.id.action_refresh).setVisible(!drawerOpen);
36. return super.onPrepareOptionsMenu(menu);
37. }
38. @Override
39. public boolean onOptionsItemSelected(MenuItem item) {
40. // The action bar home/up action should open or close the drawer.
41. // ActionBarDrawerToggle will take care of this.
42. if (mDrawerToggle.onOptionsItemSelected(item)) {
43. return true;
44. }
45. // Handle action buttons
46. switch(item.getItemId()) {
47. case R.id.action_search:
48. Toast.makeText(this, R.string.action_search, Toast.LENGTH_SHORT).show();
49. return true;
50. case R.id.action_refresh:
51. Toast.makeText(this, R.string.action_refresh, Toast.LENGTH_SHORT).show();
52. return true;
53. default:
54. return super.onOptionsItemSelected(item);
55. }
56. }
57. @Override
58. protected void onPostCreate(Bundle savedInstanceState) {
59. super.onPostCreate(savedInstanceState);
60. // Sync the toggle state after onRestoreInstanceState has occurred.
61. mDrawerToggle.syncState();
62. }
63. @Override
64. public void onConfigurationChanged(Configuration newConfig) {
65. super.onConfigurationChanged(newConfig);
66. // Pass any configuration change to the drawer toggls
67. mDrawerToggle.onConfigurationChanged(newConfig);
68. }

到这来就完啦，还有不懂的可以去参看官方Docs

http://developer.android.com/training/implementing-navigation/nav-drawer.html

Demo 下载地址：http://download.csdn.net/detail/fx_sky/6705135