blob: bafbc65e7167aa0b3e89635aec57bbd8b8e1ce04 [file] [log] [blame]
page.title=菜单
parent.title=用户界面
parent.link=index.html
@jd:body
<div id="qv-wrapper">
<div id="qv">
<h2>本文内容</h2>
<ol>
<li><a href="#xml">使用 XML 定义菜单</a></li>
<li><a href="#options-menu">创建选项菜单</a>
<ol>
<li><a href="#RespondingOptionsMenu">处理点击事件</a></li>
<li><a href="#ChangingTheMenu">在运行时更改菜单项</a></li>
</ol>
</li>
<li><a href="#context-menu">创建上下文菜单</a>
<ol>
<li><a href="#FloatingContextMenu">创建浮动上下文菜单</a></li>
<li><a href="#CAB">使用上下文操作模式</a></li>
</ol>
</li>
<li><a href="#PopupMenu">创建弹出菜单</a>
<ol>
<li><a href="#PopupEvents">处理点击事件</a></li>
</ol>
</li>
<li><a href="#groups">创建菜单组</a>
<ol>
<li><a href="#checkable">使用可选中的菜单项</a></li>
</ol>
</li>
<li><a href="#intents">添加基于 Intent 的菜单项</a>
<ol>
<li><a href="#AllowingToAdd">允许将 Activity 添加到其他菜单中</a></li>
</ol>
</li>
</ol>
<h2>关键类</h2>
<ol>
<li>{@link android.view.Menu}</li>
<li>{@link android.view.MenuItem}</li>
<li>{@link android.view.ContextMenu}</li>
<li>{@link android.view.ActionMode}</li>
</ol>
<h2>另请参阅</h2>
<ol>
<li><a href="{@docRoot}guide/topics/ui/actionbar.html">操作栏</a></li>
<li><a href="{@docRoot}guide/topics/resources/menu-resource.html">菜单资源</a></li>
<li><a href="http://android-developers.blogspot.com/2012/01/say-goodbye-to-menu-button.html">从此告别菜单按钮</a>
</li>
</ol>
</div>
</div>
<p>菜单是许多应用中常见的用户界面组件。要提供熟悉而一致的用户体验,您应使用 {@link android.view.Menu} API
呈现 Activity 中的用户操作和其他选项。
</p>
<p>
Android 3.0API 级别 11)开始,采用 Android 技术的设备不必再提供一个专用“菜单”按钮。<em></em>随着这种改变,Android
应用需摆脱对包含
6 个项目的传统菜单面板的依赖,取而代之的是要提供一个操作栏来呈现常见的用户操作。</p>
<p>尽管某些菜单项的设计和用户体验已发生改变,但定义一系列操作和选项所使用的语义仍是以
{@link android.view.Menu} API 为基础。本指南将介绍所有
Android 版本系统中三种基本菜单或操作呈现效果的创建方法:
</p>
<dl>
<dt><strong>选项菜单和操作栏</strong></dt>
<dd><a href="#options-menu">选项菜单</a>是某个 Activity 的主菜单项,
供您放置对应用产生全局影响的操作,如“搜索”、“撰写电子邮件”和“设置”。
<p>如果您的应用是针对
Android 2.3 或更低版本的系统而开发,则用户可以通过按“菜单”按钮显示选项菜单面板。<em></em></p>
<p>
Android 3.0 及更高版本的系统中,<a href="{@docRoot}guide/topics/ui/actionbar.html">操作栏</a>以屏幕操作项和溢出选项的组合形式呈现选项菜单中的各项。从 Android 3.0 开始,“菜单”按钮已弃用(某些设备没有该按钮),因此您应改为使用操作栏,来提供对操作和其他选项的访问。<em></em>
</p>
<p>请参阅<a href="#options-menu">创建选项菜单</a>部分。</p>
</dd>
<dt><strong>上下文菜单和上下文操作模式</strong></dt>
<dd>上下文菜单是用户长按某一元素时出现的<a href="#FloatingContextMenu">浮动菜单</a>。
它提供的操作将影响所选内容或上下文框架。
<p>开发针对 Android 3.0 及更高版本系统的应用时,您应改为使用<a href="#CAB">上下文操作模式</a>,以便对所选内容启用操作。此模式在屏幕顶部栏显示影响所选内容的操作项目,并允许用户选择多项。
</p>
<p>请参阅<a href="#context-menu">创建上下文菜单</a>部分。</p>
</dd>
<dt><strong>弹出菜单</strong></dt>
<dd>弹出菜单将以垂直列表形式显示一系列项目,这些项目将锚定到调用该菜单的视图中。
它特别适用于提供与特定内容相关的大量操作,或者为命令的另一部分提供选项。
弹出菜单中的操作<strong>不会</strong>直接影响对应的内容,而上下文操作则会影响。
相反,弹出菜单适用于与您 Activity 中的内容区域相关的扩展操作。
<p>请参阅<a href="#PopupMenu">创建弹出菜单</a>部分。</p>
</dd>
</dl>
<h2 id="xml">使用 XML 定义菜单</h2>
<p>对于所有菜单类型,Android
提供了标准的 XML 格式来定义菜单项。您应在
XML <a href="{@docRoot}guide/topics/resources/menu-resource.html">菜单资源</a>中定义菜单及其所有项,而不是在 Activity 的代码中构建菜单。定义后,您可以在 Activity 或片段中扩充菜单资源(将其作为
{@link android.view.Menu}
对象加载)。</p>
<p>使用菜单资源是一种很好的做法,原因如下:</p>
<ul>
<li>更易于使用 XML 可视化菜单结构</li>
<li>将菜单内容与应用的行为代码分离</li>
<li>允许您利用<a href="{@docRoot}guide/topics/resources/index.html">应用资源</a>框架,为不同的平台版本、屏幕尺寸和其他配置创建备用菜单配置
</li>
</ul>
<p>要定义菜单,请在项目 <code>res/menu/</code>
目录内创建一个 XML 文件,并使用以下元素构建菜单:</p>
<dl>
<dt><code>&lt;menu></code></dt>
<dd>定义 {@link android.view.Menu},即菜单项的容器。<code>&lt;menu></code>
元素必须是该文件的根节点,并且能够包含一个或多个
<code>&lt;item></code> 和 <code>&lt;group></code> 元素。</dd>
<dt><code>&lt;item></code></dt>
<dd>创建 {@link android.view.MenuItem},此元素表示菜单中的一项,可能包含嵌套的 <code>&lt;menu></code>
元素,以便创建子菜单。</dd>
<dt><code>&lt;group></code></dt>
<dd>{@code &lt;item&gt;} 元素的不可见容器(可选)。它支持您对菜单项进行分类,使其共享活动状态和可见性等属性。
如需了解详细信息,请参阅<a href="#groups">创建菜单组</a>部分。
</dd>
</dl>
<p>以下是名为 <code>game_menu.xml</code> 的菜单示例:</p>
<pre>
&lt;?xml version="1.0" encoding="utf-8"?&gt;
&lt;menu xmlns:android="http://schemas.android.com/apk/res/android"&gt;
&lt;item android:id="@+id/new_game"
android:icon="@drawable/ic_new_game"
android:title="@string/new_game"
android:showAsAction="ifRoom"/&gt;
&lt;item android:id="@+id/help"
android:icon="@drawable/ic_help"
android:title="@string/help" /&gt;
&lt;/menu&gt;
</pre>
<p><code>&lt;item></code>
元素支持多个属性,您可使用这些属性定义项目的外观和行为。上述菜单中的项目包括以下属性:</p>
<dl>
<dt>{@code android:id}</dt>
<dd>项目特有的资源
ID,让应用能够在用户选择项目时识别该项目。</dd>
<dt>{@code android:icon}</dt>
<dd>引用一个要用作项目图标的 Drawable 类。</dd>
<dt>{@code android:title}</dt>
<dd>引用一个要用作项目标题的字符串。</dd>
<dt>{@code android:showAsAction}</dt>
<dd>指定此项应作为操作项目显示在<a href="{@docRoot}guide/topics/ui/actionbar.html">操作栏</a>中的时间和方式。</dd>
</dl>
<p>这些是您应使用的最重要属性,但还有许多其他属性。有关所有受支持属性的信息,请参阅<a href="{@docRoot}guide/topics/resources/menu-resource.html">菜单资源</a>文档。
</p>
<p>您可以通过以 {@code &lt;item&gt;}
子元素的形式添加 {@code &lt;menu&gt;} 元素,向任何菜单(子菜单除外)中的某个菜单项添加子菜单。当应用具有大量可按主题进行组织的功能时,类似于 PC 应用程序菜单栏中的菜单项(“文件”、“编辑”、“视图”等),子菜单非常有用。
例如:</p>
<pre>
&lt;?xml version="1.0" encoding="utf-8"?&gt;
&lt;menu xmlns:android="http://schemas.android.com/apk/res/android"&gt;
&lt;item android:id="@+id/file"
android:title="@string/file" &gt;
&lt;!-- "file" submenu --&gt;
&lt;menu&gt;
&lt;item android:id="@+id/create_new"
android:title="@string/create_new" /&gt;
&lt;item android:id="@+id/open"
android:title="@string/open" /&gt;
&lt;/menu&gt;
&lt;/item&gt;
&lt;/menu&gt;
</pre>
<p>要在 Activity 中使用菜单,您需要使用 {@link android.view.MenuInflater#inflate(int,Menu)
MenuInflater.inflate()} 扩充菜单资源(将 XML
资源转换为可编程对象)。在下文中,您将了解如何扩充每种类型的菜单。
</p>
<h2 id="options-menu">创建选项菜单</h2>
<div class="figure" style="width:200px;margin:0">
<img src="{@docRoot}images/options_menu.png" height="333" alt="" />
<p class="img-caption"><strong>图 1. </strong>Android 2.3 系统上浏览器
中的选项菜单。</p>
</div>
<p>在选项菜单中,您应当包括与当前 Activity 上下文相关的操作和其他选项,如“搜索”、“撰写电子邮件”和“设置”。
</p>
<p>选项菜单中的项目在屏幕上的显示位置取决于您开发的应用所适用的 Android 版本:
</p>
<ul>
<li>如果您开发的应用是用于
<strong>Android
2.3.xAPI 级别 10)或更低版本</strong>的系统,则当用户按“菜单”按钮时,选项菜单的内容会出现在屏幕底部,如图 1 所示。<em></em>打开时,第一个可见部分是图标菜单,其中包含多达 6 个菜单项。
如果菜单包括 6 个以上项目,则
Android
会将第六项和其余项目放入溢出菜单。用户可以通过选择“更多”打开该菜单。<em></em></li>
<li>如果您开发的应用是用于 <strong>Android
3.0API 级别 11)及更高版本</strong>的系统,则选项菜单中的项目将出现在<a href="{@docRoot}guide/topics/ui/actionbar.html">操作栏</a>中。默认情况下,系统会将所有项目均放入操作溢出菜单中。用户可以使用操作栏右侧的操作溢出菜单图标(或者,通过按设备“菜单”按钮(如有))显示操作溢出菜单。
<em></em>要支持快速访问重要操作,您可以将
{@code android:showAsAction="ifRoom"}
添加到对应的
{@code &lt;item&gt;} 元素,从而将几个项目提升到操作栏中(请参阅图
2)。 <p>如需了解有关操作项目和其他操作栏行为的详细信息,请参阅<a href="{@docRoot}guide/topics/ui/actionbar.html">操作栏</a>指南。 </p>
<p class="note"><strong>注:</strong>即使您的应用不是针对
Android 3.0 或更高版本的系统而开发,但仍可构建自己的操作栏布局,以获得类似的效果。<em></em>有关如何使用操作栏支持旧版
Android
的示例,请参阅<a href="{@docRoot}resources/samples/ActionBarCompat/index.html">操作栏兼容性</a>示例。</p>
</li>
</ul>
<img src="{@docRoot}images/ui/actionbar.png" alt="" />
<p class="img-caption"><strong>图 2. </strong>摘自
<a href="{@docRoot}resources/samples/HoneycombGallery/index.html">Honeycomb Gallery</a> 应用的操作栏,其中显示了导航选项卡和相机操作项目(以及操作溢出菜单按钮)。</p>
<p>您可以通过 {@link android.app.Activity}
子类或 {@link android.app.Fragment} 子类为选项菜单声明项目。如果您的 Activity 和片段均为选项菜单声明项目,则这些项目将合并到
UI 中。系统将首先显示 Activity 的项目,随后按每个片段添加到 Activity 中的顺序显示该片段的项目。
如有必要,您可以使用 {@code android:orderInCategory}
属性,对需要移动的每个 {@code &lt;item&gt;} 中的菜单项重新排序。</p>
<p>要为 Activity 指定选项菜单,请重写 {@link
android.app.Activity#onCreateOptionsMenu(Menu) onCreateOptionsMenu()}(Fragment 会提供自己的
{@link android.app.Fragment#onCreateOptionsMenu onCreateOptionsMenu()} 回调)。通过此方法,您可以将菜单资源(<a href="#xml">使用
XML</a> 定义)扩充到回调中提供的 {@link
android.view.Menu} 中。例如:</p>
<pre>
&#64;Override
public boolean onCreateOptionsMenu(Menu menu) {
MenuInflater inflater = {@link android.app.Activity#getMenuInflater()};
inflater.inflate(R.menu.game_menu, menu);
return true;
}
</pre>
<p>此外,您还可以使用 {@link android.view.Menu#add(int,int,int,int)
add()} 添加菜单项,并使用
{@link android.view.Menu#findItem findItem()} 检索项目,以便使用 {@link android.view.MenuItem} API 修改其属性。</p>
<p>如果您开发的应用是用于 Android 2.3.x 及更低版本的系统,则当用户首次打开选项菜单时,系统会调用 {@link
android.app.Activity#onCreateOptionsMenu(Menu) onCreateOptionsMenu()}
来创建该菜单。如果您开发的应用是用于
Android 3.0 及更高版本的系统,则系统将在启动 Activity 时调用
{@link android.app.Activity#onCreateOptionsMenu(Menu) onCreateOptionsMenu()},以便向操作栏显示项目。</p>
<h3 id="RespondingOptionsMenu">处理点击事件</h3>
<p>用户从选项菜单中选择项目(包括操作栏中的操作项目)时,系统将调用 Activity
{@link android.app.Activity#onOptionsItemSelected(MenuItem)
onOptionsItemSelected()} 方法。此方法将传递所选的 {@link android.view.MenuItem}。您可以通过调用
{@link android.view.MenuItem#getItemId()} 方法来识别项目,该方法将返回菜单项的唯一 ID(由菜单资源中的 {@code android:id} 属性定义,或通过提供给 {@link android.view.Menu#add(int,int,int,int) add()}
方法的整型数定义)。
您可以将此
ID 与已知的菜单项匹配,以执行适当的操作。例如:</p>
<pre>
&#64;Override
public boolean onOptionsItemSelected(MenuItem item) {
// Handle item selection
switch (item.getItemId()) {
case R.id.new_game:
newGame();
return true;
case R.id.help:
showHelp();
return true;
default:
return super.onOptionsItemSelected(item);
}
}
</pre>
<p>成功处理菜单项后,系统将返回 {@code true}。如果未处理菜单项,则应调用 {@link
android.app.Activity#onOptionsItemSelected(MenuItem) onOptionsItemSelected()}
的超类实现(默认实现将返回 false)。
</p>
<p>如果 Activity 包括片段,则系统将依次为 Activity 和每个片段(按照每个片段的添加顺序)调用 {@link
android.app.Activity#onOptionsItemSelected(MenuItem) onOptionsItemSelected()}
,直到有一返回结果为
{@code true} 或所有片段均调用完毕为止。</p>
<p class="note"><strong>提示:</strong>Android 3.0 新增了一项功能,支持您在 XML 中使用 {@code android:onClick}
属性为菜单项定义点击行为。该属性的值必须是 Activity 使用菜单定义的方法的名称。
该方法必须是公用的,且接受单个
{@link android.view.MenuItem}
参数;当系统调用此方法时,它会传递所选的菜单项。如需了解详细信息和示例,请参阅<a href="{@docRoot}guide/topics/resources/menu-resource.html">菜单资源</a>文档。</p>
<p class="note"><strong>提示:</strong>如果应用包含多个 Activity,且其中某些 Activity 提供相同的选项菜单,则可考虑创建一个仅实现
{@link android.app.Activity#onCreateOptionsMenu(Menu)
onCreateOptionsMenu()} {@link android.app.Activity#onOptionsItemSelected(MenuItem)
onOptionsItemSelected()}
方法的 Activity。然后,为每个应共享相同选项菜单的 Activity 扩展此类。
通过这种方式,您可以管理一个用于处理菜单操作的代码集,且每个子级类均会继承菜单行为。若要将菜单项添加到一个子级 Activity,请重写该 Activity 中的
{@link android.app.Activity#onCreateOptionsMenu(Menu)
onCreateOptionsMenu()}。
调用 {@code super.onCreateOptionsMenu(menu)},以便创建原始菜单项,然后使用
{@link
android.view.Menu#add(int,int,int,int) menu.add()} 添加新菜单项。此外,您还可以替代各个菜单项的超类行为。
</p>
<h3 id="ChangingTheMenu">在运行时更改菜单项</h3>
<p>系统调用
{@link android.app.Activity#onCreateOptionsMenu(Menu)
onCreateOptionsMenu()} 后,将保留您填充的 {@link android.view.Menu} 实例。除非菜单由于某些原因而失效,否则不会再次调用
{@link android.app.Activity#onCreateOptionsMenu(Menu) onCreateOptionsMenu()}。但是,您仅应使用
{@link
android.app.Activity#onCreateOptionsMenu(Menu) onCreateOptionsMenu()} 来创建初始菜单状态,而不应使用它在 Activity 生命周期中执行任何更改。</p>
<p>如需根据在 Activity 生命周期中发生的事件修改选项菜单,则可通过
{@link android.app.Activity#onPrepareOptionsMenu(Menu) onPrepareOptionsMenu()}
方法执行此操作。此方法向您传递
{@link android.view.Menu}
对象(因为该对象目前存在),以便您能够对其进行修改,如添加、删除或禁用项目。(此外,片段还提供 {@link
android.app.Fragment#onPrepareOptionsMenu onPrepareOptionsMenu()} 回调。)</p>
<p>
Android 2.3.x 及更低版本中,每当用户打开选项菜单时(按“菜单”按钮),系统均会调用 {@link
android.app.Activity#onPrepareOptionsMenu(Menu)
onPrepareOptionsMenu()}。<em></em></p>
<p>
Android 3.0 及更高版本中,当菜单项显示在操作栏中时,选项菜单被视为始终处于打开状态。发生事件时,如果您要执行菜单更新,则必须调用
{@link android.app.Activity#invalidateOptionsMenu invalidateOptionsMenu()} 来请求系统调用
{@link android.app.Activity#onPrepareOptionsMenu(Menu) onPrepareOptionsMenu()}。</p>
<p class="note"><strong>注:</strong>切勿根据目前处于焦点的
{@link android.view.View}
更改选项菜单中的项目。处于触摸模式(用户未使用轨迹球或方向键)时,视图无法形成焦点,因此切勿根据焦点修改选项菜单中的项目。
若要为 {@link
android.view.View} 提供上下文相关的菜单项,请使用<a href="#context-menu">上下文菜单</a>。</p>
<h2 id="context-menu">创建上下文菜单</h2>
<div class="figure" style="width:420px;margin-top:-1em">
<img src="{@docRoot}images/ui/menu-context.png" alt="" />
<p class="img-caption"><strong>图 3. </strong>浮动上下文菜单(左)和上下文操作栏(右)的屏幕截图。
</p>
</div>
<p>上下文菜单提供了许多操作,这些操作影响 UI 中的特定项目或上下文框架。您可以为任何视图提供上下文菜单,但这些菜单通常用于
{@link
android.widget.ListView}、{@link android.widget.GridView}
或用户可直接操作每个项目的其他视图集合中的项目。</p>
<p>提供上下文操作的方法有两种:</p>
<ul>
<li>使用<a href="#FloatingContextMenu">浮动上下文菜单</a>。用户长按(按住)一个声明支持上下文菜单的视图时,菜单显示为菜单项的浮动列表(类似于对话框)。
用户一次可对一个项目执行上下文操作。
</li>
<li>使用<a href="#CAB">上下文操作模式</a>。此模式是
{@link android.view.ActionMode}
的系统实现,它将在屏幕顶部显示上下文操作栏,其中包括影响所选项的操作项目。<em></em>当此模式处于活动状态时,用户可以同时对多项执行操作(如果应用允许)。
</li>
</ul>
<p class="note"><strong>注:</strong>上下文操作模式可用于
Android 3.0API
级别 11)及更高版本的系统,是显示上下文操作(如果可用)的首选方法。如果应用支持低于
3.0 版本的系统,则应在这些设备上回退到浮动上下文菜单。</p>
<h3 id="FloatingContextMenu">创建浮动上下文菜单</h3>
<p>要提供浮动上下文菜单,请执行以下操作:</p>
<ol>
<li>通过调用
{@link android.app.Activity#registerForContextMenu(View) registerForContextMenu()},注册应与上下文菜单关联的
{@link android.view.View} 并将其传递给 {@link android.view.View}。
<p>如果 Activity 使用 {@link android.widget.ListView} {@link android.widget.GridView}
且您希望每个项目均提供相同的上下文菜单,请通过将
{@link android.widget.ListView} {@link android.widget.GridView} 传递给 {@link
android.app.Activity#registerForContextMenu(View) registerForContextMenu()},为上下文菜单注册所有项目。</p>
</li>
<li> {@link android.app.Activity} {@link android.app.Fragment} 中实现 {@link
android.view.View.OnCreateContextMenuListener#onCreateContextMenu onCreateContextMenu()}
方法。
<p>当注册后的视图收到长按事件时,系统将调用您的 {@link
android.view.View.OnCreateContextMenuListener#onCreateContextMenu onCreateContextMenu()}
方法。在此方法中,您通常可通过扩充菜单资源来定义菜单项。例如:
</p>
<pre>
&#64;Override
public void onCreateContextMenu(ContextMenu menu, View v,
ContextMenuInfo menuInfo) {
super.onCreateContextMenu(menu, v, menuInfo);
MenuInflater inflater = getMenuInflater();
inflater.inflate(R.menu.context_menu, menu);
}
</pre>
<p>{@link android.view.MenuInflater} 允许您通过<a href="{@docRoot}guide/topics/resources/menu-resource.html">菜单资源</a>扩充上下文菜单。回调方法参数包括用户所选的
{@link android.view.View},以及一个提供有关所选项的附加信息的
{@link android.view.ContextMenu.ContextMenuInfo}
对象。如果 Activity 有多个视图,每个视图均提供不同的上下文菜单,则可使用这些参数确定要扩充的上下文菜单。
</p>
</li>
<li>实现 {@link android.app.Activity#onContextItemSelected(MenuItem)
onContextItemSelected()}。
<p>用户选择菜单项时,系统将调用此方法,以便您能够执行适当的操作。
例如:</p>
<pre>
&#64;Override
public boolean onContextItemSelected(MenuItem item) {
AdapterContextMenuInfo info = (AdapterContextMenuInfo) item.getMenuInfo();
switch (item.getItemId()) {
case R.id.edit:
editNote(info.id);
return true;
case R.id.delete:
deleteNote(info.id);
return true;
default:
return super.onContextItemSelected(item);
}
}
</pre>
<p>{@link android.view.MenuItem#getItemId()}
方法将查询所选菜单项的 ID,您应使用 {@code
android:id} 属性将此 ID 分配给 XML 中的每个菜单项,如<a href="#xml">使用
XML 定义菜单</a>部分所示。</p>
<p>成功处理菜单项后,系统将返回 {@code true}。如果未处理菜单项,则应将菜单项传递给超类实现。
如果 Activity 包括片段,则 Activity 将先收到此回调。
通过在未处理的情况下调用超类,系统将事件逐一传递给每个片段中相应的回调方法(按照每个片段的添加顺序),直到返回
{@code true} {@code false}
为止。({@link android.app.Activity}
{@code android.app.Fragment} 的默认实现返回 {@code
false},因此您始终应在未处理的情况下调用超类。)</p>
</li>
</ol>
<h3 id="CAB">使用上下文操作模式</h3>
<p>上下文操作模式是
{@link android.view.ActionMode} 的一种系统实现,它将用户交互的重点转到执行上下文操作上。用户通过选择项目启用此模式时,屏幕顶部将出现一个“上下文操作栏”,显示用户可对当前所选项执行的操作。
<em></em>启用此模式后,用户可以选择多个项目(若您允许)、取消选择项目以及继续在 Activity 内导航(在您允许的最大范围内)。
当用户取消选择所有项目、按“返回”按钮或选择操作栏左侧的“完成”操作时,该操作模式将会禁用,且上下文操作栏将会消失。
<em></em></p>
<p class="note"><strong>注:</strong>上下文操作栏不一定与<a href="{@docRoot}guide/topics/ui/actionbar.html">操作栏</a>相关联。
尽管表面上看来上下文操作栏取代了操作栏的位置,但事实上二者独立运行。
</p>
<p>如果您的应用是针对
Android 3.0(API 级别 11)或更高版本的系统而开发,则通常应使用上下文操作模式(而不是<a href="#FloatingContextMenu">浮动上下文菜单</a>)显示上下文操作。</p>
<p>对于提供上下文操作的视图,当出现以下两个事件(或之一)时,您通常应调用上下文操作模式:
</p>
<ul>
<li>用户长按视图。</li>
<li>用户选中复选框或视图内的类似 UI 组件。</li>
</ul>
<p>应用如何调用上下文操作模式以及如何定义每个操作的行为,具体取决于您的设计。
设计基本上分为两种:</p>
<ul>
<li>针对单个任意视图的上下文操作。</li>
<li>针对 {@link
android.widget.ListView} {@link android.widget.GridView}
中项目组的批处理上下文操作(允许用户选择多个项目并针对所有项目执行操作)。</li>
</ul>
<p>下文介绍每种场景所需的设置。</p>
<h4 id="CABforViews">为单个视图启用上下文操作模式</h4>
<p>如果希望仅当用户选择特定视图时才调用上下文操作模式,则应:
</p>
<ol>
<li>实现 {@link android.view.ActionMode.Callback} 接口。在其回调方法中,您既可以为上下文操作栏指定操作,又可以响应操作项目的点击事件,还可以处理操作模式的其他生命周期事件。
</li>
<li>当需要显示操作栏时(例如,用户长按视图),请调用
{@link android.app.Activity#startActionMode startActionMode()}。</li>
</ol>
<p>例如:</p>
<ol>
<li>实现 {@link android.view.ActionMode.Callback ActionMode.Callback} 接口:
<pre>
private ActionMode.Callback mActionModeCallback = new ActionMode.Callback() {
// Called when the action mode is created; startActionMode() was called
&#64;Override
public boolean onCreateActionMode(ActionMode mode, Menu menu) {
// Inflate a menu resource providing context menu items
MenuInflater inflater = mode.getMenuInflater();
inflater.inflate(R.menu.context_menu, menu);
return true;
}
// Called each time the action mode is shown. Always called after onCreateActionMode, but
// may be called multiple times if the mode is invalidated.
&#64;Override
public boolean onPrepareActionMode(ActionMode mode, Menu menu) {
return false; // Return false if nothing is done
}
// Called when the user selects a contextual menu item
&#64;Override
public boolean onActionItemClicked(ActionMode mode, MenuItem item) {
switch (item.getItemId()) {
case R.id.menu_share:
shareCurrentItem();
mode.finish(); // Action picked, so close the CAB
return true;
default:
return false;
}
}
// Called when the user exits the action mode
&#64;Override
public void onDestroyActionMode(ActionMode mode) {
mActionMode = null;
}
};
</pre>
<p>请注意,这些事件回调与<a href="#options-menu">选项菜单</a>的回调几乎完全相同,只是其中每个回调还会传递与事件相关联的 {@link
android.view.ActionMode} 对象。您可以使用
{@link
android.view.ActionMode} API CAB 进行各种更改,例如:使用 {@link android.view.ActionMode#setTitle setTitle()}
{@link
android.view.ActionMode#setSubtitle setSubtitle()}(这对指示要选择多少个项目非常有用)修改标题和副标题。</p>
<p>另请注意,操作模式被销毁时,上述示例会将 {@code mActionMode}
变量设置为 null。在下一步中,您将了解如何初始化该变量,以及保存 Activity 或片段中的成员变量有何作用。
</p>
</li>
<li>调用 {@link android.app.Activity#startActionMode startActionMode()}
以便适时启用上下文操作模式,例如:响应对 {@link
android.view.View} 的长按操作:</p>
<pre>
someView.setOnLongClickListener(new View.OnLongClickListener() {
// Called when the user long-clicks on someView
public boolean onLongClick(View view) {
if (mActionMode != null) {
return false;
}
// Start the CAB using the ActionMode.Callback defined above
mActionMode = getActivity().startActionMode(mActionModeCallback);
view.setSelected(true);
return true;
}
});
</pre>
<p>当您调用 {@link android.app.Activity#startActionMode startActionMode()} 时,系统将返回已创建的
{@link android.view.ActionMode}。通过将其保存在成员变量中,您可以更改上下文操作栏来响应其他事件。
在上述示例中,
{@link android.view.ActionMode}
用于在启动操作模式之前检查成员是否为空,以确保当 {@link android.view.ActionMode}
实例已激活时不再重建该实例。</p>
</li>
</ol>
<h4 id="CABforListView">在 ListView GridView 中启用批处理上下文操作</h4>
<p>如果您在 {@link android.widget.ListView} {@link
android.widget.GridView} 中有一组项目(或 {@link android.widget.AbsListView}
的其他扩展),且需要允许用户执行批处理操作,则应:</p>
<ul>
<li>实现
{@link android.widget.AbsListView.MultiChoiceModeListener} 接口,并使用 {@link android.widget.AbsListView#setMultiChoiceModeListener
setMultiChoiceModeListener()} 为视图组设置该接口。在侦听器的回调方法中,您既可以为上下文操作栏指定操作,也可以响应操作项目的点击事件,还可以处理从
{@link android.view.ActionMode.Callback}
接口继承的其他回调。</li>
<li>使用 {@link
android.widget.AbsListView#CHOICE_MODE_MULTIPLE_MODAL} 参数调用 {@link android.widget.AbsListView#setChoiceMode setChoiceMode()}。</li>
</ul>
<p>例如:</p>
<pre>
ListView listView = getListView();
listView.setChoiceMode(ListView.CHOICE_MODE_MULTIPLE_MODAL);
listView.setMultiChoiceModeListener(new MultiChoiceModeListener() {
&#64;Override
public void onItemCheckedStateChanged(ActionMode mode, int position,
long id, boolean checked) {
// Here you can do something when items are selected/de-selected,
// such as update the title in the CAB
}
&#64;Override
public boolean onActionItemClicked(ActionMode mode, MenuItem item) {
// Respond to clicks on the actions in the CAB
switch (item.getItemId()) {
case R.id.menu_delete:
deleteSelectedItems();
mode.finish(); // Action picked, so close the CAB
return true;
default:
return false;
}
}
&#64;Override
public boolean onCreateActionMode(ActionMode mode, Menu menu) {
// Inflate the menu for the CAB
MenuInflater inflater = mode.getMenuInflater();
inflater.inflate(R.menu.context, menu);
return true;
}
&#64;Override
public void onDestroyActionMode(ActionMode mode) {
// Here you can make any necessary updates to the activity when
// the CAB is removed. By default, selected items are deselected/unchecked.
}
&#64;Override
public boolean onPrepareActionMode(ActionMode mode, Menu menu) {
// Here you can perform updates to the CAB due to
// an {@link android.view.ActionMode#invalidate} request
return false;
}
});
</pre>
<p>就这么简单。现在,当用户通过长按选择项目时,系统即会调用 {@link
android.widget.AbsListView.MultiChoiceModeListener#onCreateActionMode onCreateActionMode()}
方法,并显示包含指定操作的上下文操作栏。当上下文操作栏可见时,用户可以选择其他项目。
</p>
<p>在某些情况下,如果上下文操作提供常用的操作项目,则您可能需要添加一个复选框或类似的
UI
元素来支持用户选择项目,这是因为他们可能没有发现长按行为。用户选中该复选框时,您可以通过使用
{@link android.widget.AbsListView#setItemChecked setItemChecked()}
将相应的列表项设置为选中状态,以此调用上下文操作模式。</p>
<h2 id="PopupMenu">创建弹出菜单</h2>
<div class="figure" style="width:220px">
<img src="{@docRoot}images/ui/popupmenu.png" alt="" />
<p><strong> 4. </strong>Gmail 应用中的弹出菜单,锚定到右上角的溢出按钮。
</p>
</div>
<p>{@link android.widget.PopupMenu}
是锚定到 {@link android.view.View} 的模态菜单。如果空间足够,它将显示在定位视图下方,否则显示在其上方。它适用于:</p>
<ul>
<li>为与特定内容确切相关的操作提供溢出样式菜单(例如,Gmail
的电子邮件标头,如图 4 所示)。<em></em>
<p class="note"><strong>注:</strong>这与上下文菜单不同,后者通常用于影响所选内容的操作。
<em></em>对于影响所选内容的操作,请使用<a href="#CAB">上下文操作模式</a>或<a href="#FloatingContextMenu">浮动上下文菜单</a>。
</p></li>
<li>提供命令语句的另一部分(例如,标记为“添加”且使用不同的“添加”选项生成弹出菜单的按钮)。
</li>
<li>提供类似于
{@link android.widget.Spinner} 且不保留永久选择的下拉菜单。</li>
</ul>
<p class="note"><strong>注:</strong>{@link android.widget.PopupMenu} API
级别 11 及更高版本中可用。</p>
<p>如果<a href="#xml">使用 XML 定义菜单</a>,则显示弹出菜单的方法如下:</p>
<ol>
<li>实例化
{@link android.widget.PopupMenu} 及其构造函数,该函数将提取当前应用的 {@link android.content.Context} 以及菜单应锚定到的
{@link android.view.View}。</li>
<li>使用 {@link android.view.MenuInflater} 将菜单资源扩充到 {@link
android.widget.PopupMenu#getMenu() PopupMenu.getMenu()} 返回的 {@link
android.view.Menu} 对象中。在 API 级别 14 及更高版本中,您可以改为使用
{@link android.widget.PopupMenu#inflate PopupMenu.inflate()}。</li>
<li>调用 {@link android.widget.PopupMenu#show() PopupMenu.show()}。</li>
</ol>
<p>例如,以下是一个使用
{@link android.R.attr#onClick android:onClick} 属性显示弹出菜单的按钮:</p>
<pre>
&lt;ImageButton
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:src="@drawable/ic_overflow_holo_dark"
android:contentDescription="@string/descr_overflow_button"
android:onClick="showPopup" />
</pre>
<p>稍后,Activity 可按照如下方式显示弹出菜单:</p>
<pre>
public void showPopup(View v) {
PopupMenu popup = new PopupMenu(this, v);
MenuInflater inflater = popup.getMenuInflater();
inflater.inflate(R.menu.actions, popup.getMenu());
popup.show();
}
</pre>
<p> API 级别 14 及更高版本中,您可以将两行合在一起,使用 {@link
android.widget.PopupMenu#inflate PopupMenu.inflate()} 扩充菜单。</p>
<p>当用户选择项目或触摸菜单以外的区域时,系统即会清除此菜单。
您可使用 {@link
android.widget.PopupMenu.OnDismissListener} 侦听清除事件。</p>
<h3 id="PopupEvents">处理点击事件</h3>
<p>要在用户选择菜单项时执行操作,您必须实现
{@link
android.widget.PopupMenu.OnMenuItemClickListener} 接口,并通过调用 {@link android.widget.PopupMenu#setOnMenuItemClickListener
setOnMenuItemclickListener()} 将其注册到 {@link
android.widget.PopupMenu}。用户选择项目时,系统会在接口中调用 {@link
android.widget.PopupMenu.OnMenuItemClickListener#onMenuItemClick onMenuItemClick()}
回调。</p>
<p>例如:</p>
<pre>
public void showMenu(View v) {
PopupMenu popup = new PopupMenu(this, v);
// This activity implements OnMenuItemClickListener
popup.setOnMenuItemClickListener(this);
popup.inflate(R.menu.actions);
popup.show();
}
&#64;Override
public boolean onMenuItemClick(MenuItem item) {
switch (item.getItemId()) {
case R.id.archive:
archive(item);
return true;
case R.id.delete:
delete(item);
return true;
default:
return false;
}
}
</pre>
<h2 id="groups">创建菜单组</h2>
<p>菜单组是指一系列具有某些共同特征的菜单项。通过菜单组,您可以:
</p>
<ul>
<li>使用 {@link android.view.Menu#setGroupVisible(int,boolean)
setGroupVisible()} 显示或隐藏所有项目</li>
<li>使用 {@link android.view.Menu#setGroupEnabled(int,boolean)
setGroupEnabled()} 启用或禁用所有项目</li>
<li>使用 {@link
android.view.Menu#setGroupCheckable(int,boolean,boolean) setGroupCheckable()} 指定所有项目是否可选中</li>
</ul>
<p>通过将 {@code &lt;item&gt;} 元素嵌套在菜单资源中的 {@code &lt;group&gt;}
元素内,或者通过使用 {@link
android.view.Menu#add(int,int,int,int) add()} 方法指定组 ID,您可以创建组。</p>
<p>以下是包含组的菜单资源示例:</p>
<pre>
&lt;?xml version="1.0" encoding="utf-8"?&gt;
&lt;menu xmlns:android="http://schemas.android.com/apk/res/android"&gt;
&lt;item android:id="@+id/menu_save"
android:icon="@drawable/menu_save"
android:title="@string/menu_save" /&gt;
&lt;!-- menu group --&gt;
&lt;group android:id="@+id/group_delete"&gt;
&lt;item android:id="@+id/menu_archive"
android:title="@string/menu_archive" /&gt;
&lt;item android:id="@+id/menu_delete"
android:title="@string/menu_delete" /&gt;
&lt;/group&gt;
&lt;/menu&gt;
</pre>
<p>组中的项目出现在与第一项相同的级别,即:菜单中的所有三项均为同级。
但是,您可以通过引用组 ID
并使用上面列出的方法,修改组中两项的特征。此外,系统也绝不会分离已分组的项目。
例如,如果为每个项目声明
{@code
android:showAsAction="ifRoom"},则它们会同时显示在操作栏或操作溢出菜单中。</p>
<h3 id="checkable">使用可选中的菜单项</h3>
<div class="figure" style="width:200px">
<img src="{@docRoot}images/radio_buttons.png" height="333" alt="" />
<p class="img-caption"><strong>图 5. </strong>含可选中项目的子菜单的屏幕截图。
</p>
</div>
<p>作为启用/禁用选项的接口,菜单非常实用,既可针对独立选项使用复选框,也可针对互斥选项组使用单选按钮。
5 显示了一个子菜单,其中的项目可使用单选按钮选中。
</p>
<p class="note"><strong>注:</strong>“图标菜单”(在选项菜单中)的菜单项无法显示复选框或单选按钮。
如果您选择使“图标菜单”中的项目可选中,则必须在选中状态每次发生变化时交换图标和/或文本,手动指出该状态。
</p>
<p>您可以使用 {@code &lt;item&gt;} 元素中的 {@code
android:checkable} 属性为各个菜单项定义可选中的行为,或者使用 {@code &lt;group&gt;} 元素中的
{@code android:checkableBehavior} 属性为整个组定义可选中的行为。例如,此菜单组中的所有项目均可使用单选按钮选中:
</p>
<pre>
&lt;?xml version="1.0" encoding="utf-8"?&gt;
&lt;menu xmlns:android="http://schemas.android.com/apk/res/android"&gt;
&lt;group android:checkableBehavior="single"&gt;
&lt;item android:id="@+id/red"
android:title="@string/red" /&gt;
&lt;item android:id="@+id/blue"
android:title="@string/blue" /&gt;
&lt;/group&gt;
&lt;/menu&gt;
</pre>
<p>{@code android:checkableBehavior} 属性接受以下任一选项:
<dl>
<dt>{@code single}</dt>
<dd>组中只有一个项目可以选中(单选按钮)</dd>
<dt>{@code all}</dt>
<dd>所有项目均可选中(复选框)</dd>
<dt>{@code none}</dt>
<dd>所有项目均无法选中</dd>
</dl>
<p>您可以使用 {@code &lt;item&gt;}
元素中的 {@code android:checked} 属性将默认的选中状态应用于项目,并可使用 {@link
android.view.MenuItem#setChecked(boolean) setChecked()} 方法在代码中更改此默认状态。</p>
<p>选择可选中项目后,系统将调用所选项目的相应回调方法(例如,{@link android.app.Activity#onOptionsItemSelected(MenuItem) onOptionsItemSelected()})。
此时,您必须设置复选框的状态,因为复选框或单选按钮不会自动更改其状态。
您可以使用 {@link android.view.MenuItem#isChecked()}
查询项目的当前状态(正如用户选择该项目之前一样),然后使用
{@link android.view.MenuItem#setChecked(boolean) setChecked()} 设置选中状态。例如:</p>
<pre>
&#64;Override
public boolean onOptionsItemSelected(MenuItem item) {
switch (item.getItemId()) {
case R.id.vibrate:
case R.id.dont_vibrate:
if (item.isChecked()) item.setChecked(false);
else item.setChecked(true);
return true;
default:
return super.onOptionsItemSelected(item);
}
}
</pre>
<p>如果未通过这种方式设置选中状态,则项目的可见状态(复选框或单选按钮)不会因为用户选择它而发生变化。
如果已设置该状态,则 Activity 会保留项目的选中状态。这样一来,当用户稍后打开菜单时,您设置的选中状态将会可见。
</p>
<p class="note"><strong>注:</strong>可选中菜单项的使用往往因会话而异,且在应用销毁后不予保存。
如果您想为用户保存某些应用设置,则应使用<a href="{@docRoot}guide/topics/data/data-storage.html#pref">共享首选项</a>存储数据。
</p>
<h2 id="intents">添加基于 Intent 的菜单项</h2>
<p>有时,您希望菜单项通过使用
{@link android.content.Intent} 启动 Activity(无论该 Activity 是位于您的应用还是其他应用中)。如果您知道自己要使用的 Intent,且具有启动 Intent 的特定菜单项,则可在相应的
on-item-selected 回调方法(例如,{@link
android.app.Activity#onOptionsItemSelected(MenuItem) onOptionsItemSelected()} 回调)期间使用
{@link android.app.Activity#startActivity(Intent) startActivity()}
执行 Intent。</p>
<p>但是,如果不确定用户的设备是否包含可处理 Intent 的应用,则添加调用 Intent 的菜单项可能会导致该菜单项无法正常工作,这是因为 Intent 可能无法解析为 Activity
为了解决这一问题,当
Android 在设备上找到可处理 Intent Activity 时,则允许您向菜单动态添加菜单项。</p>
<p>要根据接受 Intent 的可用 Activity 添加菜单项,请执行以下操作:</p>
<ol>
<li>使用类别
{@link android.content.Intent#CATEGORY_ALTERNATIVE} 和/或
{@link android.content.Intent#CATEGORY_SELECTED_ALTERNATIVE} 以及任何其他要求定义 Intent。</li>
<li>调用 {@link
android.view.Menu#addIntentOptions(int,int,int,ComponentName,Intent[],Intent,int,MenuItem[])
Menu.addIntentOptions()}。Android
随后即会搜索能够执行 Intent 的所有应用,并将其添加到菜单中。</li>
</ol>
<p>如果未安装可处理 Intent 的应用,则不会添加任何菜单项。
</p>
<p class="note"><strong>注:</strong>
{@link android.content.Intent#CATEGORY_SELECTED_ALTERNATIVE}
用于处理屏幕上当前所选的元素。因此,只有在 {@link
android.app.Activity#onCreateContextMenu(ContextMenu,View,ContextMenuInfo)
onCreateContextMenu()} 中创建菜单时,才能使用它。</p>
<p>例如:</p>
<pre>
&#64;Override
public boolean onCreateOptionsMenu(Menu menu){
super.onCreateOptionsMenu(menu);
// Create an Intent that describes the requirements to fulfill, to be included
// in our menu. The offering app must include a category value of Intent.CATEGORY_ALTERNATIVE.
Intent intent = new Intent(null, dataUri);
intent.addCategory(Intent.CATEGORY_ALTERNATIVE);
// Search and populate the menu with acceptable offering applications.
menu.addIntentOptions(
R.id.intent_group, // Menu group to which new items will be added
0, // Unique item ID (none)
0, // Order for the items (none)
this.getComponentName(), // The current activity name
null, // Specific items to place first (none)
intent, // Intent created above that describes our requirements
0, // Additional flags to control items (none)
null); // Array of MenuItems that correlate to specific items (none)
return true;
}</pre>
<p>如果发现 Activity 提供的 Intent 过滤器与定义的 Intent 匹配,则会添加菜单项,并使用 Intent 过滤器
<code>android:label</code>
中的值作为菜单项标题,使用应用图标作为菜单项图标。{@link android.view.Menu#addIntentOptions(int,int,int,ComponentName,Intent[],Intent,int,MenuItem[])
addIntentOptions()}
方法将返回已添加的菜单项数量。</p>
<p class="note"><strong>注:</strong>调用
{@link
android.view.Menu#addIntentOptions(int,int,int,ComponentName,Intent[],Intent,int,MenuItem[])
addIntentOptions()} 方法时,它将使用第一个参数中指定的菜单组替代所有菜单项。</p>
<h3 id="AllowingToAdd">允许将 Activity 添加到其他菜单中</h3>
<p>此外,您还可以为其他应用提供您的 Activity 服务,以便您的应用能够包含在其他应用的菜单中(与上述角色相反)。
</p>
<p>要包含在其他应用菜单中,您需要按常规方式定义 Intent 过滤器,但请确保为 Intent 过滤器类别添加
{@link android.content.Intent#CATEGORY_ALTERNATIVE}
和/或 {@link android.content.Intent#CATEGORY_SELECTED_ALTERNATIVE}
值。例如:</p>
<pre>
&lt;intent-filter label="&#64;string/resize_image">
...
&lt;category android:name="android.intent.category.ALTERNATIVE" />
&lt;category android:name="android.intent.category.SELECTED_ALTERNATIVE" />
...
&lt;/intent-filter>
</pre>
<p>请仔细阅读<a href="/guide/components/intents-filters.html"> Intent Intent 过滤器</a>文档中更多有关编写 Intent 过滤器的内容。
</p>
<p>有关使用此方法的应用示例,请参阅<a href="{@docRoot}resources/samples/NotePad/src/com/example/android/notepad/NoteEditor.html">记事本</a>示例代码。
</p>