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.
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 |
int
|
getGravity()
|
Menu
|
getMenu()
Returns the |
MenuInflater
|
getMenuInflater()
|
void
|
inflate(int menuRes)
Inflate a menu resource into this PopupMenu. |
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
| |
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 (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 (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.
|
View.OnTouchListener getDragToOpenListener ()
Returns an View.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 |
int getGravity ()
| Returns | |
|---|---|
int |
the gravity used to align the popup window to its anchor view |
See also:
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:
MenuInflater getMenuInflater ()
| Returns | |
|---|---|
MenuInflater |
a MenuInflater that can be used to inflate menu items
from XML into the menu returned by getMenu() |
See also:
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
|
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:
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
|
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
|
void show ()
Show the menu popup anchored to the view specified during construction.
See also:
Developers