菜单资源

菜单资源定义了一个应用程序菜单（选项菜单、上下文菜单或子菜单），可以使用 MenuInflater 进行膨胀。

有关使用菜单的指南，请参阅添加菜单。

文件位置
res/menu/filename.xml
文件名用作资源 ID
编译后的资源数据类型
指向 Menu（或子类）资源的资源指针
资源引用
在 Java 中：R.menu.filename
在 XML 中：@[package:]menu.filename
语法
<?xml version="1.0" encoding="utf-8"?>
<menu xmlns:android="http://schemas.android.com/apk/res/android">
    <item android:id="@[+][package:]id/resource_name"
          android:title="string"
          android:titleCondensed="string"
          android:icon="@[package:]drawable/drawable_resource_name"
          android:onClick="method name"
          android:showAsAction=["ifRoom" | "never" | "withText" | "always" | "collapseActionView"]
          android:actionLayout="@[package:]layout/layout_resource_name"
          android:actionViewClass="class name"
          android:actionProviderClass="class name"
          android:alphabeticShortcut="string"
          android:alphabeticModifiers=["META" | "CTRL" | "ALT" | "SHIFT" | "SYM" | "FUNCTION"]
          android:numericShortcut="string"
          android:numericModifiers=["META" | "CTRL" | "ALT" | "SHIFT" | "SYM" | "FUNCTION"]
          android:checkable=["true" | "false"]
          android:visible=["true" | "false"]
          android:enabled=["true" | "false"]
          android:menuCategory=["container" | "system" | "secondary" | "alternative"]
          android:orderInCategory="integer" />
    <group android:id="@[+][package:]id/resource name"
           android:checkableBehavior=["none" | "all" | "single"]
           android:visible=["true" | "false"]
           android:enabled=["true" | "false"]
           android:menuCategory=["container" | "system" | "secondary" | "alternative"]
           android:orderInCategory="integer" >
        <item />
    </group>
    <item >
        <menu>
          <item />
        </menu>
    </item>
</menu>
元素
必需。 这必须是根节点。包含 <item> 和/或 <group> 元素。

属性

xmlns:android
XML 命名空间。必需。 定义 XML 命名空间，该命名空间必须是 "http://schemas.android.com/apk/res/android"。
<item>
菜单项。可能包含 <menu> 元素（用于子菜单）。必须是 <menu> 或 <group> 元素的子元素。

属性

android:id
资源 ID。唯一的资源 ID。要为该项创建新的资源 ID，请使用以下形式："@+id/name"。加号表示这将创建一个新的 ID。
android:title
字符串资源。菜单标题，可以是字符串资源或原始字符串。
android:titleCondensed
字符串资源。简明标题，可以是字符串资源或原始字符串。当普通标题过长时使用此标题。
android:icon
Drawable 资源。用作菜单项图标的图像。
android:onClick
方法名称。当此菜单项被点击时要调用的方法。该方法必须在 activity 中声明为 public。它接受一个 MenuItem 作为其唯一参数，该参数指示被点击的项。此方法优先于对 onOptionsItemSelected() 的标准回调。请参阅本页末尾的示例。

警告： 如果您使用 ProGuard 或类似工具混淆您的代码，请务必将此属性中指定的方法排除在重命名之外，因为它可能会破坏功能。

在 API 级别 11 中引入。

android:showAsAction
关键字。此项在应用栏中显示为操作项的时间和方式。菜单项仅在 activity 包含应用栏时才能显示为操作项。有效值
值说明
ifRoom仅在有足够空间时才将此项放在应用栏中。如果没有足够的空间容纳所有标记为 "ifRoom" 的项，则 orderInCategory 值最低的项将显示为操作，其余项将显示在溢出菜单中。
withText还包括操作项的标题文本（由 android:title 定义）。您可以通过使用竖线 | 分隔，将此值与其中一个其他值作为标志集一起包含。
never切勿将此项放在应用栏中。而是将此项列在应用栏的溢出菜单中。
always始终将此项放在应用栏中。除非此项始终显示在操作栏中至关重要，否则请避免使用此项。将多个项设置为始终显示为操作项可能会导致它们与应用栏中的其他 UI 重叠。
collapseActionView与此操作项关联的操作视图（由 android:actionLayout 或 android:actionViewClass 声明）是可折叠的。
在 API 级别 14 中引入。

有关详细信息，请参阅添加应用栏。

在 API 级别 11 中引入。

android:actionLayout
布局资源。用作操作视图的布局。

有关详细信息，请参阅使用操作视图和操作提供程序。

在 API 级别 11 中引入。

android:actionViewClass
类名。用作操作视图的 View 的完全限定类名。例如，"android.widget.SearchView" 用于将 SearchView 用作操作视图。

有关详细信息，请参阅使用操作视图和操作提供程序。

警告： 如果您使用 ProGuard 或类似工具混淆您的代码，请务必将此属性中指定的类排除在重命名之外，因为它可能会破坏功能。

在 API 级别 11 中引入。

android:actionProviderClass
类名。用于替代操作项的 ActionProvider 的完全限定类名。例如，"android.widget.ShareActionProvider" 用于使用 ShareActionProvider。

有关详细信息，请参阅使用操作视图和操作提供程序。

警告： 如果您使用 ProGuard 或类似工具混淆您的代码，请务必将此属性中指定的类排除在重命名之外，因为它可能会破坏功能。

在 API 级别 14 中引入。

android:alphabeticShortcut
字符。字母快捷键的字符。
android:numericShortcut
整数。数字快捷键的数字。
android:alphabeticModifiers
关键字。菜单项字母快捷键的修饰符。默认值对应于 Control 键。有效值
值说明
META 对应于 Meta 元键。
CTRL 对应于 Control 元键。
ALT 对应于 Alt 元键。
SHIFT 对应于 Shift 元键。
SYM 对应于 Sym 元键。
FUNCTION 对应于 Function 元键。

注意：您可以在一个属性中指定多个关键字。例如，android:alphabeticModifiers="CTRL|SHIFT" 表示要触发相应的菜单项，用户需要同时按下 Control 和 Shift 元键以及快捷键。

您可以使用 setAlphabeticShortcut() 方法以编程方式设置属性值。有关 alphabeticModifier 属性的更多信息，请参阅 alphabeticModifiers。

android:numericModifiers
关键字。菜单项数字快捷键的修饰符。默认值对应于 Control 键。有效值
值说明
META 对应于 Meta 元键。
CTRL 对应于 Control 元键。
ALT 对应于 Alt 元键。
SHIFT 对应于 Shift 元键。
SYM 对应于 Sym 元键。
FUNCTION 对应于 Function 元键。

注意：您可以在一个属性中指定多个关键字。例如，android:numericModifiers="CTRL|SHIFT" 表示要触发相应的菜单项，用户需要同时按下 Control 和 Shift 元键以及快捷键。

您可以使用 setNumericShortcut() 方法以编程方式设置属性值。有关 numericModifier 属性的更多信息，请参阅 numericModifiers。

android:checkable
布尔值。如果该项可勾选，则为 True。
android:checked
布尔值。如果该项默认已勾选，则为 True。
android:visible
布尔值。如果该项默认可见，则为 True。
android:enabled
布尔值。如果该项默认启用，则为 True。
android:menuCategory
关键字。与 Menu CATEGORY_* 常量对应的值，这些常量定义了项的优先级。有效值
值说明
container用于作为容器一部分的项。
system用于系统提供的项。
secondary用于用户提供的次要（不常用）选项。
alternative用于当前显示数据的替代操作。
android:orderInCategory
整数。项在组中的重要性顺序。
<group>
菜单组，用于创建共享特性的项集合，例如它们是否可见、启用或可选。包含一个或多个 <item> 元素。必须是 <menu> 元素的子元素。

属性

android:id
资源 ID。唯一的资源 ID。要为该项创建新的资源 ID，请使用以下形式："@+id/name"。加号表示这将创建一个新的 ID。
android:checkableBehavior
关键字。组的可选择行为类型。有效值
值说明
none不可选择。
all所有项都可以选择（使用复选框）。
single只能选择一个项（使用单选按钮）。
android:visible
布尔值。如果组可见，则为 True。
android:enabled
布尔值。如果组已启用，则为 True。
android:menuCategory
关键字。与 Menu CATEGORY_* 常量对应的值，这些常量定义了组的优先级。有效值
值说明
container用于作为容器一部分的组。
system用于系统提供的组。
secondary用于用户提供的次要（不常用）选项的组。
alternative用于当前显示数据的替代操作的组。
android:orderInCategory
整数。项在类别中的默认顺序。
示例
XML 文件保存于 res/menu/example_menu.xml
<menu xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto">
    <item android:id="@+id/item1"
          android:title="@string/item1"
          android:icon="@drawable/group_item1_icon"
          app:showAsAction="ifRoom|withText"/>
    <group android:id="@+id/group">
        <item android:id="@+id/group_item1"
              android:onClick="onGroupItemClick"
              android:title="@string/group_item1"
              android:icon="@drawable/group_item1_icon" />
        <item android:id="@+id/group_item2"
              android:onClick="onGroupItemClick"
              android:title="@string/group_item2"
              android:icon="@drawable/group_item2_icon" />
    </group>
    <item android:id="@+id/submenu"
          android:title="@string/submenu_title"
          app:showAsAction="ifRoom|withText" >
        <menu>
            <item android:id="@+id/submenu_item1"
                  android:title="@string/submenu_item1" />
        </menu>
    </item>
</menu>

以下应用程序代码从 onCreateOptionsMenu(Menu) 回调中膨胀菜单，并声明了其中两个项的点击回调

Kotlin

override fun onCreateOptionsMenu(menu: Menu): Boolean {
    menuInflater.inflate(R.menu.example_menu, menu)
    return true
}

fun onGroupItemClick(item: MenuItem) {
    // One of the group items (using the onClick attribute) was clicked.
    // The item parameter passed here indicates which item it is.
    // All other menu item clicks are handled by Activity.onOptionsItemSelected.
}

Java

public boolean onCreateOptionsMenu(Menu menu) {
    MenuInflater inflater = getMenuInflater();
    inflater.inflate(R.menu.example_menu, menu);
    return true;
}

public void onGroupItemClick(MenuItem item) {
    // One of the group items (using the onClick attribute) was clicked.
    // The item parameter passed here indicates which item it is.
    // All other menu item clicks are handled by Activity.onOptionsItemSelected.
}
上一篇
布局
下一篇
字符串