public final class MenuItemCompat
extends Object
java.lang.Object | |
↳ | android.support.v4.view.MenuItemCompat |
Helper用于访问以向后兼容的方式在API级别4之后引入的 MenuItem
功能。
注意:您无法获得此类的实例。 相反,它提供了与MenuItem
的方法相对应的静态方法,但将MenuItem
对象作为附加参数。
Nested classes |
|
---|---|
interface |
MenuItemCompat.OnActionExpandListener 在标记为 |
Constants |
|
---|---|
int |
SHOW_AS_ACTION_ALWAYS 始终将此项目显示为操作栏中的按钮。 |
int |
SHOW_AS_ACTION_COLLAPSE_ACTION_VIEW 此项目的动作视图会折叠为正常的菜单项目。 |
int |
SHOW_AS_ACTION_IF_ROOM 如果系统决定有空间,请在操作栏中将该项目显示为按钮。 |
int |
SHOW_AS_ACTION_NEVER 切勿将此项目显示为操作栏中的按钮。 |
int |
SHOW_AS_ACTION_WITH_TEXT 当此项目位于操作栏中时,即使它还有指定的图标,也始终显示文本标签。 |
Public methods |
|
---|---|
static boolean |
collapseActionView(MenuItem item) 折叠与此菜单项关联的操作视图。 |
static boolean |
expandActionView(MenuItem item) 展开与此菜单项关联的操作视图。 |
static ActionProvider |
getActionProvider(MenuItem item) 获取 |
static View |
getActionView(MenuItem item) 返回此菜单项的当前设置的操作视图。 |
static boolean |
isActionViewExpanded(MenuItem item) 如果此菜单项的操作视图已展开,则返回true。 |
static MenuItem |
setActionProvider(MenuItem item, ActionProvider provider) 如果项目放置在操作栏上,则设置负责创建操作视图的 |
static MenuItem |
setActionView(MenuItem item, int resId) 为此菜单项设置一个操作视图。 |
static MenuItem |
setActionView(MenuItem item, View view) 为此菜单项设置一个操作视图。 |
static MenuItem |
setOnActionExpandListener(MenuItem item, MenuItemCompat.OnActionExpandListener listener) 在该菜单项上设置 |
static void |
setShowAsAction(MenuItem item, int actionEnum) 设置如何在兼容的操作栏中显示此项目。 |
Inherited methods |
|
---|---|
From class java.lang.Object
|
int SHOW_AS_ACTION_ALWAYS
始终将此项目显示为操作栏中的按钮。 谨慎使用! 如果太多的项目被设置为始终显示在操作栏中,则它可以挤占操作栏并降低具有较小屏幕的设备上的用户体验。 一个好的经验法则是不要超过2个项目设置为始终显示。
常量值:2(0x00000002)
int SHOW_AS_ACTION_COLLAPSE_ACTION_VIEW
此项目的动作视图会折叠为正常的菜单项目。 展开后,动作视图暂时占据其容器的较大部分。
常量值:8(0x00000008)
int SHOW_AS_ACTION_IF_ROOM
如果系统决定有空间,请在操作栏中将该项目显示为按钮。
常数值:1(0x00000001)
int SHOW_AS_ACTION_NEVER
切勿将此项目显示为操作栏中的按钮。
常量值:0(0x00000000)
int SHOW_AS_ACTION_WITH_TEXT
当此项目位于操作栏中时,即使它还有指定的图标,也始终显示文本标签。
常量值:4(0x00000004)
boolean collapseActionView (MenuItem item)
折叠与此菜单项关联的操作视图。 菜单项必须有一个操作视图集,以及showAsAction标志SHOW_AS_ACTION_COLLAPSE_ACTION_VIEW
。 如果已经使用setOnActionExpandListener(MenuItem, android.support.v4.view.MenuItemCompat.OnActionExpandListener)
设置了侦听setOnActionExpandListener(MenuItem, android.support.v4.view.MenuItemCompat.OnActionExpandListener)
,则将调用其onMenuItemActionCollapse(MenuItem)
方法。 监听器可能会从此方法返回false以防止折叠操作视图。
Parameters | |
---|---|
item |
MenuItem
|
Returns | |
---|---|
boolean |
true if the action view was collapsed, false otherwise. |
boolean expandActionView (MenuItem item)
展开与此菜单项关联的操作视图。 菜单项必须有一个操作视图集,以及showAsAction标志SHOW_AS_ACTION_COLLAPSE_ACTION_VIEW
。 如果已经使用setOnActionExpandListener(MenuItem, OnActionExpandListener)
设置了侦听setOnActionExpandListener(MenuItem, OnActionExpandListener)
,则将调用其onMenuItemActionExpand(MenuItem)
方法。 监听器可能会从此方法返回false以防止扩大操作视图。
Parameters | |
---|---|
item |
MenuItem
|
Returns | |
---|---|
boolean |
true if the action view was expanded, false otherwise. |
ActionProvider getActionProvider (MenuItem item)
获取 ActionProvider
。
Parameters | |
---|---|
item |
MenuItem
|
Returns | |
---|---|
ActionProvider |
The action provider. |
View getActionView (MenuItem item)
返回此菜单项的当前设置的操作视图。
Parameters | |
---|---|
item |
MenuItem : the item to query |
Returns | |
---|---|
View |
This item's action view |
boolean isActionViewExpanded (MenuItem item)
如果此菜单项的操作视图已展开,则返回true。
Parameters | |
---|---|
item |
MenuItem
|
Returns | |
---|---|
boolean |
true if the item's action view is expanded, false otherwise. |
MenuItem setActionProvider (MenuItem item, ActionProvider provider)
如果项目放置在操作栏上,则设置负责创建操作视图的ActionProvider
。 如果项目放置在溢出菜单中,提供程序还会提供默认操作。
注意:设置操作提供程序将覆盖通过 setActionView(MenuItem, View)
设置的操作视图。
Parameters | |
---|---|
item |
MenuItem : item to change |
provider |
ActionProvider : The action provider. |
Returns | |
---|---|
MenuItem |
This Item so additional setters can be called. |
也可以看看:
MenuItem setActionView (MenuItem item, int resId)
为此菜单项设置一个操作视图。 当此项目显示为父级内的操作时,将会显示一个操作视图来代替UI中自动生成的菜单项元素。
注意:设置操作视图将覆盖通过 setActionProvider(MenuItem, ActionProvider)
设置的操作提供程序。
Parameters | |
---|---|
item |
MenuItem : the item to change |
resId |
int : Layout resource to use for presenting this item to the user. |
Returns | |
---|---|
MenuItem |
This Item so additional setters can be called. |
MenuItem setActionView (MenuItem item, View view)
为此菜单项设置一个操作视图。 当此项目显示为父级内的操作时,将会显示一个操作视图来代替UI中自动生成的菜单项元素。
Parameters | |
---|---|
item |
MenuItem : the item to change |
view |
View : View to use for presenting this item to the user. |
Returns | |
---|---|
MenuItem |
This Item so additional setters can be called. |
MenuItem setOnActionExpandListener (MenuItem item, MenuItemCompat.OnActionExpandListener listener)
在MenuItemCompat.OnActionExpandListener
上设置MenuItemCompat.OnActionExpandListener
,以便在关联的操作视图展开或折叠时得到通知。 该菜单项必须配置为使用标志SHOW_AS_ACTION_COLLAPSE_ACTION_VIEW
展开或折叠其操作视图。
Parameters | |
---|---|
item |
MenuItem
|
listener |
MenuItemCompat.OnActionExpandListener : Listener that will respond to expand/collapse events |
Returns | |
---|---|
MenuItem |
This menu item instance for call chaining |
void setShowAsAction (MenuItem item, int actionEnum)
设置如何在兼容的操作栏中显示此项目。 如果给定的项目是兼容的,这将调用该项目支持的实现setShowAsAction(int)
。
Parameters | |
---|---|
item |
MenuItem : - the item to change |
actionEnum |
int : - How the item should display. |