使用操作视图和操作提供程序

尝试 Compose 方式
Jetpack Compose 是推荐用于 Android 的 UI 工具包。了解如何在 Compose 中添加组件。
应用栏 →

AndroidX 库的 Toolbar 为用户提供了与应用互动的方式。添加和处理操作 描述了如何定义一个 action，它可以是按钮或菜单项。本文档描述了如何添加两个通用组件

  • 操作视图是一种在应用栏中提供丰富功能的操作。例如，搜索操作视图允许用户在应用栏中键入搜索文本，而无需更改 Activity 或 Fragment。
  • 操作提供程序是具有自己的自定义布局的操作。操作最初显示为按钮或菜单项；当用户点按操作时，操作提供程序会以您定义的任何方式控制操作的行为。例如，操作提供程序可以通过显示菜单来响应点按。

AndroidX 提供了几个专门的操作视图和操作提供程序微件。例如，SearchView 微件实现了一个用于输入搜索查询的操作视图。ShareActionProvider 微件实现了一个用于与其他应用共享信息的操作提供程序。您还可以定义自己的操作视图和操作提供程序。

添加操作视图

要添加操作视图，请在工具栏的菜单资源中创建一个 <item> 元素，如添加和处理操作中所述。向 <item> 元素添加以下任一属性

  • actionViewClass：实现该操作的微件类
  • actionLayout：描述操作组件的布局资源

将 showAsAction 属性设置为 "ifRoom|collapseActionView" 或 "never|collapseActionView"。collapseActionView 标志指示当用户未与微件互动时如何显示该微件。如果微件位于应用栏上，应用会将其显示为图标。如果微件位于溢出菜单中，应用会将其显示为菜单项。当用户与操作视图互动时，它会展开以填充应用栏。

例如，以下代码将 SearchView 微件添加到应用栏

<item android:id="@+id/action_search"
     android:title="@string/action_search"
     android:icon="@drawable/ic_search"
     app:showAsAction="ifRoom|collapseActionView"
     app:actionViewClass="androidx.appcompat.widget.SearchView" />

如果用户未与微件互动，应用会将其显示为 android:icon 指定的图标。如果应用栏中没有足够的空间，应用会将该操作添加到溢出菜单中。

An image showing a search bar with a leading and trailing icons.
图 1. 带前后图标的搜索栏。

当用户点按图标或菜单项时，微件会展开以填充工具栏，允许用户与之互动。

An image showing a search view open once the search bar is focused.
图 2. 搜索栏获得焦点后，搜索视图随即打开。

如果您需要配置操作，请在 Activity 的 onCreateOptionsMenu() 回调中进行。您可以通过调用 getActionView() 方法来获取操作视图的对象引用。例如，以下代码获取了前面代码示例中定义的 SearchView 微件的对象引用

Kotlin

override fun onCreateOptionsMenu(menu: Menu?): Boolean {
    menuInflater.inflate(R.menu.main_activity_actions, menu)

    val searchItem = menu?.findItem(R.id.action_search)
    val searchView = searchItem?.actionView as SearchView

    // Configure the search info and add any event listeners.

    return super.onCreateOptionsMenu(menu)
}

Java

@Override
public boolean onCreateOptionsMenu(Menu menu) {
    getMenuInflater().inflate(R.menu.main_activity_actions, menu);

    MenuItem searchItem = menu.findItem(R.id.action_search);
    SearchView searchView =
            (SearchView) searchItem.getActionView();

    // Configure the search info and add any event listeners.

    return super.onCreateOptionsMenu(menu);
}

响应操作视图展开

如果操作的 <item> 元素具有 collapseActionView 标志，则应用会将操作视图显示为图标，直到用户与操作视图互动。当用户点按图标时，onOptionsItemSelected() 的内置处理程序会展开操作视图。如果您的 Activity 子类重写了 onOptionsItemSelected() 方法，则您的重写方法必须调用 super.onOptionsItemSelected()，以便超类可以展开操作视图。

如果您想在操作展开或折叠时执行某些操作，您可以定义一个实现 MenuItem.OnActionExpandListener 的类，并将该类的一个成员传递给 setOnActionExpandListener()。例如，您可能希望根据操作视图是展开还是折叠来更新 Activity。以下代码段展示了如何定义和传递监听器

Kotlin

override fun onCreateOptionsMenu(menu: Menu?): Boolean {
    menuInflater.inflate(R.menu.options, menu)

    // Define the listener.
    val expandListener = object : MenuItem.OnActionExpandListener {
        override fun onMenuItemActionCollapse(item: MenuItem): Boolean {
            // Do something when the action item collapses.
            return true // Return true to collapse the action view.
        }

        override fun onMenuItemActionExpand(item: MenuItem): Boolean {
            // Do something when it expands.
            return true // Return true to expand the action view.
        }
    }

    // Get the MenuItem for the action item.
    val actionMenuItem = menu?.findItem(R.id.myActionItem)

    // Assign the listener to that action item.
    actionMenuItem?.setOnActionExpandListener(expandListener)

    // For anything else you have to do when creating the options menu,
    // do the following:

    return true
}

Java

@Override
public boolean onCreateOptionsMenu(Menu menu) {
    getMenuInflater().inflate(R.menu.options, menu);

    // Define the listener.
    OnActionExpandListener expandListener = new OnActionExpandListener() {
        @Override
        public boolean onMenuItemActionCollapse(MenuItem item) {
            // Do something when the action item collapses.
            return true;  // Return true to collapse action view.
        }

        @Override
        public boolean onMenuItemActionExpand(MenuItem item) {
            // Do something when it expands.
            return true;  // Return true to expand the action view.
        }
    };

    // Get the MenuItem for the action item.
    MenuItem actionMenuItem = menu.findItem(R.id.myActionItem);

    // Assign the listener to that action item.
    MenuItemCompat.setOnActionExpandListener(actionMenuItem, expandListener);

    // For anything else you have to do when creating the options menu,
    // do the following:

    return true;
}

添加操作提供程序

要声明操作提供程序，请在工具栏的菜单资源中创建一个 <item> 元素，如添加和处理操作中所述。添加一个 actionProviderClass 属性，并将其设置为操作提供程序类的完全限定类名。

例如，以下代码声明了一个 ShareActionProvider，它是 AndroidX 库中定义的一个微件，可让您的应用与其他应用共享数据

<item android:id="@+id/action_share"
    android:title="@string/share"
    app:showAsAction="ifRoom"
    app:actionProviderClass="androidx.appcompat.widget.ShareActionProvider"/>

在这种情况下，无需为微件声明图标，因为 ShareActionProvider 提供了自己的图形。如果您使用的是自定义操作，请声明一个图标。

其他资源

  • 请参阅 ShareActionProvider，了解如何将分享操作添加到顶部应用栏的示例。
  • 请参阅 ActionProvider，了解有关创建自定义操作提供程序的更多信息。