PopupMenu - Android SDK

Summary: Nested Classes | Ctors | Methods | Inherited Methods | [Expand All]

public class

PopupMenu

extends Object

java.lang.Object
↳	android.support.v7.widget.PopupMenu

Class Overview

Static library support version of the framework's PopupMenu. 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 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) Construct a new PopupMenu.
	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 `View.OnTouchListener` that can be added to the anchor view to implement drag-to-open behavior.
int	getGravity()
Menu	getMenu()
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) Set a listener that will be notified when this menu is dismissed.
void	setOnMenuItemClickListener(PopupMenu.OnMenuItemClickListener listener) Set 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.

[Expand]

Inherited Methods

From class java.lang.Object

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals(Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of `Class` that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

Public Constructors

public PopupMenu (Context context, View anchor)

Construct a new PopupMenu.

Parameters

context	Context for the PopupMenu.
anchor	Anchor view for this popup. The popup will appear below the anchor if there is room, or above it if there is not.

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 the popup menu is running in, through which it can access the current theme, resources, etc.
anchor	Anchor view for this popup. The popup will appear below the anchor if there is room, or above it if there is not.
gravity	The `Gravity` value for aligning the popup with its anchor.

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 the popup menu is running in, through which it can access the current theme, resources, etc.
anchor	Anchor view for this popup. The popup will appear below the anchor if there is room, or above it if there is not.
gravity	The `Gravity` value for aligning the popup with its anchor.
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.
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

public void dismiss ()

Dismiss the menu popup.

public 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

a touch listener that controls drag-to-open behavior

public int getGravity ()

Returns

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

public Menu getMenu ()

Returns

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

public MenuInflater getMenuInflater ()

Returns

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

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	Menu resource to inflate

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

public void setOnDismissListener (PopupMenu.OnDismissListener listener)

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

Parameters

listener	Listener to notify

public void setOnMenuItemClickListener (PopupMenu.OnMenuItemClickListener listener)

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

Parameters

listener	Listener to notify

public void show ()

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

Results

Interfaces

Classes

PopupMenu

Class Overview

Summary

Public Constructors

public PopupMenu (Context context, View anchor)

Parameters

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

Parameters

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

Parameters

Public Methods

public void dismiss ()

See Also

public View.OnTouchListener getDragToOpenListener ()

Returns

public int getGravity ()

Returns

See Also

public Menu getMenu ()

Returns

See Also

public MenuInflater getMenuInflater ()

Returns

See Also

public void inflate (int menuRes)

Parameters

public void setGravity (int gravity)

Parameters

See Also

public void setOnDismissListener (PopupMenu.OnDismissListener listener)

Parameters

public void setOnMenuItemClickListener (PopupMenu.OnMenuItemClickListener listener)

Parameters

public void show ()

See Also