# PopupMenu

Artifact: [androidx.appcompat:appcompat](https://developer.android.com/jetpack/androidx/releases/appcompat) [View Source](https://cs.android.com/search?q=file:androidx/appcompat/widget/PopupMenu.java+class:androidx.appcompat.widget.PopupMenu) Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appcompat#1.1.0)

*** ** * ** ***


```
public class PopupMenu
```

<br />

*** ** * ** ***

Static library support version of the framework's `https://developer.android.com/reference/android/widget/PopupMenu.html`. Used to write apps that run on platforms prior to Android 3.0. When running on Android 3.0 or above, this implementation is still used; it does not try to switch to the framework's implementation. See the framework SDK documentation for a class overview.

## Summary

| ### Nested types |
|---|
| `public interface https://developer.android.com/reference/androidx/appcompat/widget/PopupMenu.OnDismissListener` Callback interface used to notify the application that the menu has closed. |
| `public interface https://developer.android.com/reference/androidx/appcompat/widget/PopupMenu.OnMenuItemClickListener` Interface responsible for receiving menu item click events if the items themselves do not have individual item click listeners. |

| ### Public constructors |
|---|
| `https://developer.android.com/reference/androidx/appcompat/widget/PopupMenu#PopupMenu(android.content.Context,android.view.View)(@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/content/Context.html context, @https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/view/View.html anchor)` Constructor to create a new popup menu with an anchor view. |
| `https://developer.android.com/reference/androidx/appcompat/widget/PopupMenu#PopupMenu(android.content.Context,android.view.View,int)(@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/content/Context.html context, @https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/view/View.html anchor, int gravity)` Constructor to create a new popup menu with an anchor view and alignment gravity. |
| `https://developer.android.com/reference/androidx/appcompat/widget/PopupMenu#PopupMenu(android.content.Context,android.view.View,int,int,int)( @https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/content/Context.html context, @https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/view/View.html anchor, int gravity, @https://developer.android.com/reference/androidx/annotation/AttrRes int popupStyleAttr, @https://developer.android.com/reference/androidx/annotation/StyleRes int popupStyleRes )` Constructor a create a new popup menu with a specific style. |

| ### Public methods |
|---|---|
| `void` | `https://developer.android.com/reference/androidx/appcompat/widget/PopupMenu#dismiss()()` Dismiss the menu popup. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/view/View.OnTouchListener.html` | `https://developer.android.com/reference/androidx/appcompat/widget/PopupMenu#getDragToOpenListener()()` Returns an `https://developer.android.com/reference/android/view/View.OnTouchListener.html` that can be added to the anchor view to implement drag-to-open behavior. |
| `int` | `https://developer.android.com/reference/androidx/appcompat/widget/PopupMenu#getGravity()()` |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/view/Menu.html` | `https://developer.android.com/reference/androidx/appcompat/widget/PopupMenu#getMenu()()` Returns the `https://developer.android.com/reference/android/view/Menu.html` associated with this popup. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/view/MenuInflater.html` | `https://developer.android.com/reference/androidx/appcompat/widget/PopupMenu#getMenuInflater()()` |
| `void` | `https://developer.android.com/reference/androidx/appcompat/widget/PopupMenu#inflate(int)(@https://developer.android.com/reference/androidx/annotation/MenuRes int menuRes)` Inflate a menu resource into this PopupMenu. |
| `void` | `https://developer.android.com/reference/androidx/appcompat/widget/PopupMenu#setForceShowIcon(boolean)(boolean forceShowIcon)` Sets whether the popup menu's adapter is forced to show icons in the menu item views. |
| `void` | `https://developer.android.com/reference/androidx/appcompat/widget/PopupMenu#setGravity(int)(int gravity)` Sets the gravity used to align the popup window to its anchor view. |
| `void` | `https://developer.android.com/reference/androidx/appcompat/widget/PopupMenu#setOnDismissListener(androidx.appcompat.widget.PopupMenu.OnDismissListener)(@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/androidx/appcompat/widget/PopupMenu.OnDismissListener listener)` Sets a listener that will be notified when this menu is dismissed. |
| `void` | `https://developer.android.com/reference/androidx/appcompat/widget/PopupMenu#setOnMenuItemClickListener(androidx.appcompat.widget.PopupMenu.OnMenuItemClickListener)( @https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/androidx/appcompat/widget/PopupMenu.OnMenuItemClickListener listener )` Sets a listener that will be notified when the user selects an item from the menu. |
| `void` | `https://developer.android.com/reference/androidx/appcompat/widget/PopupMenu#show()()` Show the menu popup anchored to the view specified during construction. |

## Public constructors

### PopupMenu

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appcompat#1.1.0)

```
public PopupMenu(@NonNull Context context, @NonNull View anchor)
```

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

| Parameters |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/content/Context.html context` | Context the popup menu is running in, through which it can access the current theme, resources, etc. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/view/View.html anchor` | 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 [1.1.0](https://developer.android.com/jetpack/androidx/releases/appcompat#1.1.0)

```
public PopupMenu(@NonNull Context context, @NonNull View anchor, int gravity)
```

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

| Parameters |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/content/Context.html context` | Context the popup menu is running in, through which it can access the current theme, resources, etc. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/view/View.html anchor` | Anchor view for this popup. The popup will appear below the anchor if there is room, or above it if there is not. |
| `int gravity` | The `https://developer.android.com/reference/android/view/Gravity.html` value for aligning the popup with its anchor. |

### PopupMenu

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appcompat#1.1.0)

```
public PopupMenu(
    @NonNull Context context,
    @NonNull View anchor,
    int gravity,
    @AttrRes int popupStyleAttr,
    @StyleRes int popupStyleRes
)
```

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

| Parameters |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/content/Context.html context` | Context the popup menu is running in, through which it can access the current theme, resources, etc. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/view/View.html anchor` | Anchor view for this popup. The popup will appear below the anchor if there is room, or above it if there is not. |
| `int gravity` | The `https://developer.android.com/reference/android/view/Gravity.html` value for aligning the popup with its anchor. |
| `@https://developer.android.com/reference/androidx/annotation/AttrRes int popupStyleAttr` | 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. |
| `@https://developer.android.com/reference/androidx/annotation/StyleRes int popupStyleRes` | 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 [1.1.0](https://developer.android.com/jetpack/androidx/releases/appcompat#1.1.0)

```
public void dismiss()
```

Dismiss the menu popup.

| See also |
|---|---|
| `https://developer.android.com/reference/androidx/appcompat/widget/PopupMenu#show()` |   |

### getDragToOpenListener

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appcompat#1.1.0)

```
public @NonNull View.OnTouchListener getDragToOpenListener()
```

Returns an `https://developer.android.com/reference/android/view/View.OnTouchListener.html` 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 |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/view/View.OnTouchListener.html` | a touch listener that controls drag-to-open behavior |

### getGravity

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appcompat#1.1.0)

```
public int getGravity()
```

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

| See also |
|---|---|
| `https://developer.android.com/reference/androidx/appcompat/widget/PopupMenu#setGravity(int)` |   |

### getMenu

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appcompat#1.1.0)

```
public @NonNull Menu getMenu()
```

Returns the `https://developer.android.com/reference/android/view/Menu.html` associated with this popup. Populate the returned Menu with items before calling `https://developer.android.com/reference/androidx/appcompat/widget/PopupMenu#show()`.

| Returns |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/view/Menu.html` | the `https://developer.android.com/reference/android/view/Menu.html` associated with this popup |

| See also |
|---|---|
| `https://developer.android.com/reference/androidx/appcompat/widget/PopupMenu#show()` |   |
| `https://developer.android.com/reference/androidx/appcompat/widget/PopupMenu#getMenuInflater()` |   |

### getMenuInflater

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appcompat#1.1.0)

```
public @NonNull MenuInflater getMenuInflater()
```

| Returns |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/view/MenuInflater.html` | a `https://developer.android.com/reference/android/view/MenuInflater.html` that can be used to inflate menu items from XML into the menu returned by `https://developer.android.com/reference/androidx/appcompat/widget/PopupMenu#getMenu()` |

| See also |
|---|---|
| `https://developer.android.com/reference/androidx/appcompat/widget/PopupMenu#getMenu()` |   |

### inflate

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appcompat#1.1.0)

```
public void inflate(@MenuRes int menuRes)
```

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

| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/MenuRes int menuRes` | Menu resource to inflate |

### setForceShowIcon

Added in [1.4.0](https://developer.android.com/jetpack/androidx/releases/appcompat#1.4.0)

```
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 |
|---|---|
| `boolean forceShowIcon` | `true` to force icons to be shown, or `false` for icons to be optionally shown |

### setGravity

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appcompat#1.1.0)

```
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 |
|---|---|
| `int gravity` | the gravity used to align the popup window |

| See also |
|---|---|
| `https://developer.android.com/reference/androidx/appcompat/widget/PopupMenu#getGravity()` |   |

### setOnDismissListener

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appcompat#1.1.0)

```
public void setOnDismissListener(@Nullable PopupMenu.OnDismissListener listener)
```

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

| Parameters |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/androidx/appcompat/widget/PopupMenu.OnDismissListener listener` | the listener to notify |

### setOnMenuItemClickListener

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appcompat#1.1.0)

```
public void setOnMenuItemClickListener(
    @Nullable PopupMenu.OnMenuItemClickListener listener
)
```

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

| Parameters |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/androidx/appcompat/widget/PopupMenu.OnMenuItemClickListener listener` | the listener to notify |

### show

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appcompat#1.1.0)

```
public void show()
```

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

| See also |
|---|---|
| `https://developer.android.com/reference/androidx/appcompat/widget/PopupMenu#dismiss()` |   |