Android APIs
public class

ActionMenuView

extends LinearLayout
implements MenuBuilder.ItemInvoker
java.lang.Object
   ↳ android.view.View
     ↳ android.view.ViewGroup
       ↳ android.widget.LinearLayout
         ↳ android.widget.ActionMenuView

Class Overview

ActionMenuView is a presentation of a series of menu options as a View. It provides several top level options as action buttons while spilling remaining options over as items in an overflow menu. This allows applications to present packs of actions inline with specific or repeating content.

Summary

Nested Classes
class ActionMenuView.LayoutParams  
interface ActionMenuView.OnMenuItemClickListener Interface responsible for receiving menu item click events if the items themselves do not have individual item click listeners. 
[Expand]
Inherited XML Attributes
From class android.widget.LinearLayout
From class android.view.ViewGroup
From class android.view.View
[Expand]
Inherited Constants
From class android.widget.LinearLayout
From class android.view.ViewGroup
From class android.view.View
[Expand]
Inherited Fields
From class android.view.View
Public Constructors
ActionMenuView(Context context)
ActionMenuView(Context context, AttributeSet attrs)
Public Methods
void dismissPopupMenus()
Dismiss any popups associated with this menu view.
ActionMenuView.LayoutParams generateLayoutParams(AttributeSet attrs)
Returns a new set of layout parameters based on the supplied attributes set.
Menu getMenu()
Returns the Menu object that this ActionMenuView is currently presenting.
Drawable getOverflowIcon()
Return the current drawable used as the overflow icon.
int getPopupTheme()
boolean hideOverflowMenu()
Hide the overflow items from the associated menu.
boolean isOverflowMenuShowing()
Check whether the overflow menu is currently showing.
void onConfigurationChanged(Configuration newConfig)
Called when the current configuration of the resources being used by the application have changed.
void onDetachedFromWindow()
This is called when the view is detached from a window.
void setOnMenuItemClickListener(ActionMenuView.OnMenuItemClickListener listener)
void setOverflowIcon(Drawable icon)
Set the icon to use for the overflow button.
void setPopupTheme(int resId)
Specifies the theme to use when inflating popup menus.
boolean showOverflowMenu()
Show the overflow items from the associated menu.
Protected Methods
boolean checkLayoutParams(ViewGroup.LayoutParams p)
ActionMenuView.LayoutParams generateDefaultLayoutParams()
Returns a set of layout parameters with a width of MATCH_PARENT and a height of WRAP_CONTENT when the layout's orientation is VERTICAL.
ActionMenuView.LayoutParams generateLayoutParams(ViewGroup.LayoutParams p)
Returns a safe set of layout parameters based on the supplied layout params.
void onLayout(boolean changed, int left, int top, int right, int bottom)
Called from layout when this view should assign a size and position to each of its children.
void onMeasure(int widthMeasureSpec, int heightMeasureSpec)

Measure the view and its content to determine the measured width and the measured height.

[Expand]
Inherited Methods
From class android.widget.LinearLayout
From class android.view.ViewGroup
From class android.view.View
From class java.lang.Object
From interface android.view.ViewParent
From interface android.view.ViewManager
From interface android.graphics.drawable.Drawable.Callback
From interface android.view.KeyEvent.Callback
From interface android.view.accessibility.AccessibilityEventSource
From interface com.android.internal.view.menu.MenuBuilder.ItemInvoker

Public Constructors

public ActionMenuView (Context context)

Added in API level 21

public ActionMenuView (Context context, AttributeSet attrs)

Added in API level 21

Public Methods

public void dismissPopupMenus ()

Added in API level 21

Dismiss any popups associated with this menu view.

public ActionMenuView.LayoutParams generateLayoutParams (AttributeSet attrs)

Added in API level 21

Returns a new set of layout parameters based on the supplied attributes set.

Parameters
attrs the attributes to build the layout parameters from
Returns

public Menu getMenu ()

Added in API level 21

Returns the Menu object that this ActionMenuView is currently presenting.

Applications should use this method to obtain the ActionMenuView's Menu object and inflate or add content to it as necessary.

Returns
  • the Menu presented by this view

public Drawable getOverflowIcon ()

Added in API level 23

Return the current drawable used as the overflow icon.

Returns
  • The overflow icon drawable

public int getPopupTheme ()

Added in API level 21

Returns
  • resource identifier of the theme used to inflate popup menus, or 0 if menus are inflated against the action menu view theme

public boolean hideOverflowMenu ()

Added in API level 21

Hide the overflow items from the associated menu.

Returns
  • true if the menu was able to be hidden, false otherwise

public boolean isOverflowMenuShowing ()

Added in API level 21

Check whether the overflow menu is currently showing. This may not reflect a pending show operation in progress.

Returns
  • true if the overflow menu is currently showing

public void onConfigurationChanged (Configuration newConfig)

Added in API level 21

Called when the current configuration of the resources being used by the application have changed. You can use this to decide when to reload resources that can changed based on orientation and other configuration characteristics. You only need to use this if you are not relying on the normal Activity mechanism of recreating the activity instance upon a configuration change.

Parameters
newConfig The new resource configuration.

public void onDetachedFromWindow ()

Added in API level 21

This is called when the view is detached from a window. At this point it no longer has a surface for drawing.

public void setOnMenuItemClickListener (ActionMenuView.OnMenuItemClickListener listener)

Added in API level 21

public void setOverflowIcon (Drawable icon)

Added in API level 23

Set the icon to use for the overflow button.

Parameters
icon Drawable to set, may be null to clear the icon

public void setPopupTheme (int resId)

Added in API level 21

Specifies the theme to use when inflating popup menus. By default, uses the same theme as the action menu view itself.

Parameters
resId theme used to inflate popup menus
See Also

public boolean showOverflowMenu ()

Added in API level 21

Show the overflow items from the associated menu.

Returns
  • true if the menu was able to be shown, false otherwise

Protected Methods

protected boolean checkLayoutParams (ViewGroup.LayoutParams p)

Added in API level 21

protected ActionMenuView.LayoutParams generateDefaultLayoutParams ()

Added in API level 21

Returns a set of layout parameters with a width of MATCH_PARENT and a height of WRAP_CONTENT when the layout's orientation is VERTICAL. When the orientation is HORIZONTAL, the width is set to WRAP_CONTENT and the height to WRAP_CONTENT.

Returns
  • a set of default layout parameters or null

protected ActionMenuView.LayoutParams generateLayoutParams (ViewGroup.LayoutParams p)

Added in API level 21

Returns a safe set of layout parameters based on the supplied layout params. When a ViewGroup is passed a View whose layout params do not pass the test of checkLayoutParams(android.view.ViewGroup.LayoutParams), this method is invoked. This method should return a new set of layout params suitable for this ViewGroup, possibly by copying the appropriate attributes from the specified set of layout params.

Parameters
p The layout parameters to convert into a suitable set of layout parameters for this ViewGroup.
Returns

protected void onLayout (boolean changed, int left, int top, int right, int bottom)

Added in API level 21

Called from layout when this view should assign a size and position to each of its children. Derived classes with children should override this method and call layout on each of their children.

Parameters
changed This is a new size or position for this view
left Left position, relative to parent
top Top position, relative to parent
right Right position, relative to parent
bottom Bottom position, relative to parent

protected void onMeasure (int widthMeasureSpec, int heightMeasureSpec)

Added in API level 21

Measure the view and its content to determine the measured width and the measured height. This method is invoked by measure(int, int) and should be overridden by subclasses to provide accurate and efficient measurement of their contents.

CONTRACT: When overriding this method, you must call setMeasuredDimension(int, int) to store the measured width and height of this view. Failure to do so will trigger an IllegalStateException, thrown by measure(int, int). Calling the superclass' onMeasure(int, int) is a valid use.

The base class implementation of measure defaults to the background size, unless a larger size is allowed by the MeasureSpec. Subclasses should override onMeasure(int, int) to provide better measurements of their content.

If this method is overridden, it is the subclass's responsibility to make sure the measured height and width are at least the view's minimum height and width (getSuggestedMinimumHeight() and getSuggestedMinimumWidth()).

Parameters
widthMeasureSpec horizontal space requirements as imposed by the parent. The requirements are encoded with View.MeasureSpec.
heightMeasureSpec vertical space requirements as imposed by the parent. The requirements are encoded with View.MeasureSpec.