Added in API level 11

Summary: Nested Classes | Ctors | Methods | Inherited Methods

PopupMenu

Kotlin |Java

public class PopupMenu
extends Object

java.lang.Object
↳	android.widget.PopupMenu

A PopupMenu displays a Menu in a modal popup window anchored to a View. The popup will appear below the anchor view if there is room, or above it if there is not. If the IME is visible the popup will not overlap it until it is touched. Touching outside of the popup will dismiss it.

Summary

Nested classes
`interface`	`PopupMenu.OnDismissListener` Callback interface used to notify the application that the menu has closed.
`interface`	`PopupMenu.OnMenuItemClickListener` Interface responsible for receiving menu item click events if the items themselves do not have individual item click listeners.

Public constructors
`PopupMenu(Context context, View anchor)` Constructor to create a new popup menu with an anchor view.
`PopupMenu(Context context, View anchor, int gravity)` Constructor to create a new popup menu with an anchor view and alignment gravity.
`PopupMenu(Context context, View anchor, int gravity, int popupStyleAttr, int popupStyleRes)` Constructor a create a new popup menu with a specific style.

Public methods
`void`	`dismiss()` Dismiss the menu popup.
`View.OnTouchListener`	`getDragToOpenListener()` Returns an `OnTouchListener` that can be added to the anchor view to implement drag-to-open behavior.
`int`	`getGravity()`
`Menu`	`getMenu()` Returns the `Menu` associated with this popup.
`MenuInflater`	`getMenuInflater()`
`void`	`inflate(int menuRes)` Inflate a menu resource into this PopupMenu.
`void`	`setForceShowIcon(boolean forceShowIcon)` Sets whether the popup menu's adapter is forced to show icons in the menu item views.
`void`	`setGravity(int gravity)` Sets the gravity used to align the popup window to its anchor view.
`void`	`setOnDismissListener(PopupMenu.OnDismissListener listener)` Sets a listener that will be notified when this menu is dismissed.
`void`	`setOnMenuItemClickListener(PopupMenu.OnMenuItemClickListener listener)` Sets a listener that will be notified when the user selects an item from the menu.
`void`	`show()` Show the menu popup anchored to the view specified during construction.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public constructors

PopupMenu

Added in API level 11

public PopupMenu (Context context, 
                View anchor)

Constructor to create a new popup menu with an anchor view.

Parameters
`context`	`Context`: Context the popup menu is running in, through which it can access the current theme, resources, etc.
`anchor`	`View`: Anchor view for this popup. The popup will appear below the anchor if there is room, or above it if there is not.

PopupMenu

Added in API level 19

public PopupMenu (Context context, 
                View anchor, 
                int gravity)

Constructor to create a new popup menu with an anchor view and alignment gravity.

Parameters
`context`	`Context`: Context the popup menu is running in, through which it can access the current theme, resources, etc.
`anchor`	`View`: Anchor view for this popup. The popup will appear below the anchor if there is room, or above it if there is not.
`gravity`	`int`: The `Gravity` value for aligning the popup with its anchor.

PopupMenu

Added in API level 22

public PopupMenu (Context context, 
                View anchor, 
                int gravity, 
                int popupStyleAttr, 
                int popupStyleRes)

Constructor a create a new popup menu with a specific style.

Parameters
`context`	`Context`: Context the popup menu is running in, through which it can access the current theme, resources, etc.
`anchor`	`View`: Anchor view for this popup. The popup will appear below the anchor if there is room, or above it if there is not.
`gravity`	`int`: The `Gravity` value for aligning the popup with its anchor.
`popupStyleAttr`	`int`: An attribute in the current theme that contains a reference to a style resource that supplies default values for the popup window. Can be 0 to not look for defaults.
`popupStyleRes`	`int`: A resource identifier of a style resource that supplies default values for the popup window, used only if popupStyleAttr is 0 or can not be found in the theme. Can be 0 to not look for defaults.

Public methods

dismiss

Added in API level 11

public void dismiss ()

Dismiss the menu popup.

See also:

show()

getDragToOpenListener

Added in API level 19

public View.OnTouchListener getDragToOpenListener ()

Returns an OnTouchListener that can be added to the anchor view to implement drag-to-open behavior.

When the listener is set on a view, touching that view and dragging outside of its bounds will open the popup window. Lifting will select the currently touched list item.

Example usage:

 PopupMenu myPopup = new PopupMenu(context, myAnchor);
 myAnchor.setOnTouchListener(myPopup.getDragToOpenListener());

Returns
`View.OnTouchListener`	a touch listener that controls drag-to-open behavior

getGravity

Added in API level 23

public int getGravity ()

Returns
`int`	the gravity used to align the popup window to its anchor view

See also:

setGravity(int)

getMenu

Added in API level 11

public Menu getMenu ()

Returns the Menu associated with this popup. Populate the returned Menu with items before calling show().

Returns
`Menu`	the `Menu` associated with this popup

See also:

show()
getMenuInflater()

getMenuInflater

Added in API level 11

public MenuInflater getMenuInflater ()

Returns
`MenuInflater`	a `MenuInflater` that can be used to inflate menu items from XML into the menu returned by `getMenu()`

See also:

getMenu()

inflate

Added in API level 14

public void inflate (int menuRes)

Inflate a menu resource into this PopupMenu. This is equivalent to calling popupMenu.getMenuInflater().inflate(menuRes, popupMenu.getMenu()).

Parameters
`menuRes`	`int`: Menu resource to inflate

setForceShowIcon

Added in API level 29

public void setForceShowIcon (boolean forceShowIcon)

Sets whether the popup menu's adapter is forced to show icons in the menu item views.

Changes take effect on the next call to show().

Parameters
`forceShowIcon`	`boolean`: `true` to force icons to be shown, or `false` for icons to be optionally shown

setGravity

Added in API level 23

public void setGravity (int gravity)

Sets the gravity used to align the popup window to its anchor view.

If the popup is showing, calling this method will take effect only the next time the popup is shown.

Parameters
`gravity`	`int`: the gravity used to align the popup window

See also:

getGravity()

Added in API level 14

public void setOnDismissListener (PopupMenu.OnDismissListener listener)

Sets a listener that will be notified when this menu is dismissed.

Parameters
`listener`	`PopupMenu.OnDismissListener`: the listener to notify

Added in API level 11

public void setOnMenuItemClickListener (PopupMenu.OnMenuItemClickListener listener)

Sets a listener that will be notified when the user selects an item from the menu.

Parameters
`listener`	`PopupMenu.OnMenuItemClickListener`: the listener to notify

show

Added in API level 11

public void show ()

Show the menu popup anchored to the view specified during construction.

See also:

dismiss()

PopupMenu

Summary

Nested classes

Public constructors

Public methods

Inherited methods

Public constructors

PopupMenu

PopupMenu

PopupMenu

Public methods

dismiss

getDragToOpenListener

getGravity

getMenu

getMenuInflater

inflate

setForceShowIcon

setGravity

setOnDismissListener

setOnMenuItemClickListener

show