Android Toolbar,你想知道的都在这里了

Android 3.0之后,Google引入了ActionBar,想统一安卓应用的导航栏样式。但由于ActionBar难以定制,很大程度上限制了开发人员,比如标题文字大小、间距等不易实现个性化,很多开发者放弃了ActionBar的使用,而是使用普通的ViewGroup来封装自己的App Bar,或者使用JakeWharton大神ActionBarSherlock库。

后来,自2014年Google I/O 上Material Design横空出世后,市场上的应用又逐步趋向了样式的风格统一,support library中很快就出来了Toolbar控件,一个定制化的ViewGroup,来完善ActionBar的使用,App Bar又迎来了春天。

基本使用


第一步,在Theme中隐藏现有的ActionBar,有以下两种方式:

1
2
3
4
5
<style name="AppTheme.Base" parent="Theme.AppCompat">
<item name="windowActionBar">false</item>
<item name="android:windowNoTitle">true</item>
......
</style>

或者

1
2
3
<style name="AppTheme.Base" parent="heme.AppCompat.Light.NoActionBar">
......
</style>

第二步,在布局中添加v7包中的Toolbar控件(注意在builde.gradle文件中添加support.v7包的依赖:compile ‘com.android.support:appcompat-v7:23.3.0’),如:

1
2
3
4
5
6
7
8
9
10
<android.support.v7.widget.Toolbar
xmlns:app="http://schemas.android.com/apk/res-auto"
android:id="@+id/tb_toolbar"
android:layout_width="match_parent"
android:layout_height="?attr/actionBarSize"
app:title="@string/app_name"
app:titleTextColor="@android:color/white"
android:background="@color/colorPrimary">


</android.support.v7.widget.Toolbar>

第三步,在Activity代码中使用Toolbar对象替换ActionBar:

1
2
Toolbar mToolbarTb = (Toolbar) findViewById(R.id.tb_toolbar);
setSupportActionBar(mToolbarTb);

效果如下:

oolbar-sample-01.png

诸如logo、title、subTitle、navigationIcon等,都可以通过app:xxx属性和Java代码来控制。titleTextAppearance、subtitleTextAppearance也可以用来控制标题颜色和大小,如:

1
2
3
4
<style name="Theme.ToolBar.Base.Title" parent="@style/TextAppearance.Widget.AppCompat.Toolbar.Title">
<item name="android:textSize">18sp</item>
<item name="android:textColor">@android:color/white</item>
</style>

Options Menu


ActionBar 的用法一致,在menu资源目录下新建一个search.xml文件,添加menu内容,如:

1
2
3
4
5
6
7
8
9
10
11
<?xml version="1.0" encoding="utf-8"?>
<menu xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:app="http://schemas.android.com/apk/res-auto">


<item
android:id="@+id/action_search"
android:title="search"
android:icon="@android:drawable/ic_menu_search"
app:showAsAction="collapseActionView"/>


</menu>

在Java代码中添加为Toolbar添加对应的Menu Item,并设置点击事件,如:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
@Override
public boolean onCreateOptionsMenu(Menu menu) {
getMenuInflater().inflate(R.menu.search, menu);
return super.onCreateOptionsMenu(menu);
}

@Override
public boolean onOptionsItemSelected(MenuItem item) {
switch (item.getItemId()) {
case R.id.action_search:
//TODO search
break;
}
return super.onOptionsItemSelected(item);
}

效果如下:

toolbar-sample-02

如图,溢出按钮的颜色是黑色,那么怎么修改成与主题色搭配的白色呢?可以通过修改Toolbar的theme和popupTheme属性来改变,在Toolbar中添加如下属性:

1
2
3
4
5
6
<android.support.v7.widget.Toolbar
......
app:popupTheme="@style/ThemeOverlay.AppCompat.Light"
app:theme="@style/ThemeOverlay.AppCompat.Dark.ActionBar">


</android.support.v7.widget.Toolbar>

还有另一种方式,就是使用theme中的actionMenuTextColor属性设置Menu Item的字体颜色,如:

1
2
3
4
<style name="OverFlowMenuTheme" parent="Theme.AppCompat.NoActionBar">
<item name="android:actionMenuTextColor">@android:color/white</item>
<item name="overlapAnchor">false</item>
</style>

Toolbar中的相关theme设置如下:

1
2
3
4
5
6
<android.support.v7.widget.Toolbar
......
app:popupTheme="@style/OverFlowMenuTheme"
app:theme="@style/ThemeOverlay.AppCompat.Dark.ActionBar">


</android.support.v7.widget.Toolbar>

一般也是采用这种做法,将Toolbar相关属性集中写到一个style中,比如:

1
2
3
4
5
6
7
8
<style name="OverFlowMenuTheme" parent="Theme.AppCompat.NoActionBar">
<!-- 设置Menu菜单的背景色 -->
<item name="android:itemBackground">@android:color/white</item>
<!-- 设置Menu菜单的字体颜色 -->
<item name="android:textColorPrimary">@android:color/black</item>
<!-- 设置Menu窗口不覆盖Toolbar视图 -->
<item name="overlapAnchor">false</item>
</style>

这样设置下的效果如下图所示:

toolbar-sample-04.png

ActionMenuView


Toolbar 默认将 Menu 内容显示在右边,那如何将其显示在左边或者中间呢?不妨试一下 ActionMenuView

ActionMenuView 是将原本位于 Toolbar 或者 ActionBar 中的 Menu 内容移到自己的名下,以 ViewGroup 的姿态将一些列的 Menu Item 囊括其中,再将自己搁置于 Toolbar 容器中,这样,更方便于管理和呈现 Menu 内容。所以,原本孤立的 Toolbar 控件,就有了一个 Child,代码如下:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
<android.support.v7.widget.Toolbar
xmlns:app="http://schemas.android.com/apk/res-auto"
android:id="@+id/tb_toolbar"
android:layout_width="match_parent"
android:layout_height="?actionBarSize"
android:background="@color/colorPrimary"
app:theme="@style/OverFlowMenuTheme"
app:popupTheme="@style/OverFlowMenuTheme"
app:title="@string/app_name"
app:titleTextColor="@android:color/white">


<android.support.v7.widget.ActionMenuView
android:id="@+id/amv_search"
android:layout_gravity="center"
android:layout_width="wrap_content"
android:layout_height="wrap_content"/>


</android.support.v7.widget.Toolbar>

再在 Activity 文件中,将 Menu 资源文件加载到使用 findViewById() 方法获取到的 ActionMenuView 对象中:

1
2
3
4
5
@Override
public boolean onCreateOptionsMenu(Menu menu) {
getMenuInflater().inflate(R.menu.home, mHomeAmv.getMenu());
return super.onCreateOptionsMenu(menu);
}

至于 Menu Item 的点击事件方法 onOptionsItemSelected 无需改动,只要将 ActionMenuView 对象的点击事件设置转移即可:

1
2
3
4
5
6
7
mHomeAmv = (ActionMenuView) findViewById(R.id.amv_home);
mHomeAmv.setOnMenuItemClickListener(new ActionMenuView.OnMenuItemClickListener() {
@Override
public boolean onMenuItemClick(MenuItem item) {
return onOptionsItemSelected(item);
}
});

还可以利用 getMenu() 方法获取到 Menu 对象,动态添加或删除 Menu Item,甚至加载另外一个 Menu 资源文件,比如:

1
2
mHomeAmv.getMenu().clear();
getMenuInflater().inflate(R.menu.search, mSearchAmv.getMenu());

现在有这样一个需求,设计图如下 (图片来源:stack overflow):

就可以利用 ActionMenuView 控制 Menu Item 的位置了。当然,这里面还需要另外几个知识点,顺便补充说明一下。

第一,Menu Item 间距问题。Item 默认的宽度是56dp ,可以利用 style 中的属性修改,并将样式设置给 Activity 主题即可,比如:

1
2
3
4
5
6
7
8
9
10
11
<style name="AppTheme" parent="Theme.AppCompat.Light.NoActionBar">
<item name="colorPrimary">@color/colorPrimary</item>
<item name="colorPrimaryDark">@color/colorPrimaryDark</item>
<item name="colorAccent">@color/colorAccent</item>
<item name="android:actionButtonStyle">@style/MyActionButtonStyle</item>
</style>


<style name="MyActionButtonStyle" parent="@android:style/Widget.Holo.ActionBar">
<item name="android:minWidth">72dip</item>
<item name="android:padding">0dp</item>
</style>

第二,Menu Item 图标高亮问题。当然,你可以使用两套图标,在点击时修改图标资源。但借助 ColorFilter 使用一套图标也能做到,还能减少 APK 文件大小,比如:

1
2
3
4
5
6
7
8
9
public boolean onOptionsItemSelected(MenuItem item) {
switch (item.getItemId()) {
case R.id.option_walk:
item.getIcon().setColorFilter(ContextCompat.getColor(this,
android.R.color.darker_gray), PorterDuff.Mode.MULTIPLY);
break;
}
return super.onOptionsItemSelected(item);
}

Up Enable


在二级界面等Activity中,通过如下设置可以在Toolbar左边显示一个返回按钮:

1
getSupportActionBar().setDisplayHomeAsUpEnabled(true);

然后通过android.R.id.home监听返回按钮的点击事件,比如可以返回上级Activity中:

1
2
3
4
5
6
7
8
9
@Override
public boolean onOptionsItemSelected(MenuItem item) {
switch (item.getItemId()) {
case android.R.id.home:
finish();
break;
}
return super.onOptionsItemSelected(item);
}

当然,也可以通过为Toolbar设置导航图标的点击事件来达到这个监听效果:

1
2
3
4
5
6
mToolbarTb.setNavigationOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View v) {
finish();
}
});

显示效果如下:

toolbar-sample-05.png

至于导航返回按钮的图标,可以通过mToolbarTb.setNavigationIcon方法或者app:navigationIcon属性来修改。

标题居中


前面我们说过,Toolbar就是一个定制化的ViewGroup,所以可以在Toolbar里面放置一个TextView控件作为居中的标题来使用,再将Toolbar的Title隐藏起来即可实现Toolbar标题居中的效果,如:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
<android.support.v7.widget.Toolbar
xmlns:app="http://schemas.android.com/apk/res-auto"
android:id="@+id/tb_toolbar"
android:layout_width="match_parent"
android:layout_height="?attr/actionBarSize"
app:popupTheme="@style/OverFlowMenuTheme"
app:theme="@style/ThemeOverlay.AppCompat.Dark.ActionBar"
android:background="@color/colorPrimary">


<TextView
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:layout_gravity="center"
android:text="SecondActivity"
style="@style/TextAppearance.AppCompat.Widget.ActionBar.Title"/>


</android.support.v7.widget.Toolbar>

这里给TextView设置了style属性,与ActionBar.Title保持一致,然后还需要去除Toolbar自有的Title,在布局中使用app:title=""是不会起作用的,会显示ActionBar的标题,所以在代码中隐藏ActionBar的标题即可:

1
getSupportActionBar().setDisplayShowTitleEnabled(false);

效果如下:

toolbar-sample-06.png

搜索功能


系统提供了search dialogsearch widget两种方式给Toolbar添加搜索功能,实现方式可参考 API 指南:Creating a Search Interface。但系统提供的搜索功能略显僵硬,既无法引起用户的搜索欲望,也无法满足多数的产品设计需求,适用性不强,所以这里不作过多介绍。相反,使用自定义的搜索功能并为之添加适当的转场过度动画,效果立竿见影,参考开源项目:Material-SearchTransition,对应博文介绍:Exposing the Searchbar,效果如下:

transition-to-search.gif

Fragment中使用


有时候需要在Fragment中使用Toolbar,比如Activity中不同的Tab显示不同的Fragment,同时每个Tab的Toolbar标题、Menu均不相同,这时在Activity中使用同一个Toolbar就相当不方便了。我们可以在每个Fragment的布局中添加各自的Toolbar,然后在Fragment中单独控制。

与Activity中使用Toolbar有所不同。替换ActionBar时,需要给setSupportActionBar方法添加作用对象:

1
((AppCompatActivity)getActivity()).setSupportActionBar((Toolbar) mContentView.findViewById(R.id.tb_toolbar));

添加Options Menu时,需要额外调用setHasOptionsMenu(true);方法,确保onCreateOptionsMenu()方法得以调用,并且onCreateOptionsMenu()方法多了一个MenuInflater参数:

1
2
3
4
5
@Override
public void onCreateOptionsMenu(Menu menu, MenuInflater inflater) {
super.onCreateOptionsMenu(menu, inflater);
inflater.inflate(R.menu.search, menu);
}

相关知识


关于Toolar的更多介绍可以从官网中学习借鉴,链接为:Adding the App Bar | Android Developers。从其使用上可以看出,Toolbar是ActionBar的一种替代解决方案,所以很多用法均可参考ActionBar,大家可以从郭神的译文中掌握ActionBar的相关用法: