Please note that the contents of this offline web site may be out of date. To access the most recent documentation visit the online version .
Note that links that point to online resources are green in color and will open in a new window.
We would love it if you could give us feedback about this material by filling this form (You have to be online to fill it)
Android APIs
public class

ListPopupWindow

extends Object
java.lang.Object
   ↳ android.widget.ListPopupWindow

Class Overview

A ListPopupWindow anchors itself to a host view and displays a list of choices.

ListPopupWindow contains a number of tricky behaviors surrounding positioning, scrolling parents to fit the dropdown, interacting sanely with the IME if present, and others.

See Also

Summary

Constants
int INPUT_METHOD_FROM_FOCUSABLE Mode for setInputMethodMode(int) : the requirements for the input method should be based on the focusability of the popup.
int INPUT_METHOD_NEEDED Mode for setInputMethodMode(int) : this popup always needs to work with an input method, regardless of whether it is focusable.
int INPUT_METHOD_NOT_NEEDED Mode for setInputMethodMode(int) : this popup never needs to work with an input method, regardless of whether it is focusable.
int MATCH_PARENT Alias for MATCH_PARENT .
int POSITION_PROMPT_ABOVE The provided prompt view should appear above list content.
int POSITION_PROMPT_BELOW The provided prompt view should appear below list content.
int WRAP_CONTENT Alias for WRAP_CONTENT .
Public Constructors
ListPopupWindow ( Context context)
Create a new, empty popup window capable of displaying items from a ListAdapter.
ListPopupWindow ( Context context, AttributeSet attrs)
Create a new, empty popup window capable of displaying items from a ListAdapter.
ListPopupWindow ( Context context, AttributeSet attrs, int defStyleAttr)
Create a new, empty popup window capable of displaying items from a ListAdapter.
ListPopupWindow ( Context context, AttributeSet attrs, int defStyleAttr, int defStyleRes)
Create a new, empty popup window capable of displaying items from a ListAdapter.
Public Methods
void clearListSelection ()
Clear any current list selection.
View.OnTouchListener createDragToOpenListener ( View src)
Returns an View.OnTouchListener that can be added to the source view to implement drag-to-open behavior.
void dismiss ()
Dismiss the popup window.
View getAnchorView ()
Returns the view that will be used to anchor this popup.
int getAnimationStyle ()
Returns the animation style that will be used when the popup window is shown or dismissed.
Drawable getBackground ()
int getHeight ()
int getHorizontalOffset ()
int getInputMethodMode ()
Return the current value in setInputMethodMode(int) .
ListView getListView ()
int getPromptPosition ()
Object getSelectedItem ()
long getSelectedItemId ()
int getSelectedItemPosition ()
View getSelectedView ()
int getSoftInputMode ()
Returns the current value in setSoftInputMode(int) .
int getVerticalOffset ()
int getWidth ()
boolean isInputMethodNotNeeded ()
boolean isModal ()
Returns whether the popup window will be modal when shown.
boolean isShowing ()
boolean onKeyDown (int keyCode, KeyEvent event)
Filter key down events.
boolean onKeyPreIme (int keyCode, KeyEvent event)
Filter pre-IME key events.
boolean onKeyUp (int keyCode, KeyEvent event)
Filter key down events.
boolean performItemClick (int position)
Perform an item click operation on the specified list adapter position.
void postShow ()
Post a show() call to the UI thread.
void setAdapter ( ListAdapter adapter)
Sets the adapter that provides the data and the views to represent the data in this popup window.
void setAnchorView ( View anchor)
Sets the popup's anchor view.
void setAnimationStyle (int animationStyle)
Set an animation style to use when the popup window is shown or dismissed.
void setBackgroundDrawable ( Drawable d)
Sets a drawable to be the background for the popup window.
void setContentWidth (int width)
Sets the width of the popup window by the size of its content.
void setDropDownGravity (int gravity)
Set the gravity of the dropdown list.
void setHeight (int height)
Sets the height of the popup window in pixels.
void setHorizontalOffset (int offset)
Set the horizontal offset of this popup from its anchor view in pixels.
void setInputMethodMode (int mode)
Control how the popup operates with an input method: one of INPUT_METHOD_FROM_FOCUSABLE , INPUT_METHOD_NEEDED , or INPUT_METHOD_NOT_NEEDED .
void setListSelector ( Drawable selector)
Sets a drawable to use as the list item selector.
void setModal (boolean modal)
Set whether this window should be modal when shown.
void setOnDismissListener ( PopupWindow.OnDismissListener listener)
Set a listener to receive a callback when the popup is dismissed.
void setOnItemClickListener ( AdapterView.OnItemClickListener clickListener)
Sets a listener to receive events when a list item is clicked.
void setOnItemSelectedListener ( AdapterView.OnItemSelectedListener selectedListener)
Sets a listener to receive events when a list item is selected.
void setPromptPosition (int position)
Set where the optional prompt view should appear.
void setPromptView ( View prompt)
Set a view to act as a user prompt for this popup window.
void setSelection (int position)
Set the selected position of the list.
void setSoftInputMode (int mode)
Sets the operating mode for the soft input area.
void setVerticalOffset (int offset)
Set the vertical offset of this popup from its anchor view in pixels.
void setWidth (int width)
Sets the width of the popup window in pixels.
void show ()
Show the popup list.
[Expand]
Inherited Methods
From class java.lang.Object

Constants

public static final int INPUT_METHOD_FROM_FOCUSABLE

Added in API level 11

Mode for setInputMethodMode(int) : the requirements for the input method should be based on the focusability of the popup. That is if it is focusable than it needs to work with the input method, else it doesn't.

Constant Value: 0 (0x00000000)

public static final int INPUT_METHOD_NEEDED

Added in API level 11

Mode for setInputMethodMode(int) : this popup always needs to work with an input method, regardless of whether it is focusable. This means that it will always be displayed so that the user can also operate the input method while it is shown.

Constant Value: 1 (0x00000001)

public static final int INPUT_METHOD_NOT_NEEDED

Added in API level 11

Mode for setInputMethodMode(int) : this popup never needs to work with an input method, regardless of whether it is focusable. This means that it will always be displayed to use as much space on the screen as needed, regardless of whether this covers the input method.

Constant Value: 2 (0x00000002)

public static final int MATCH_PARENT

Added in API level 11

Alias for MATCH_PARENT . If used to specify a popup width, the popup will match the width of the anchor view. If used to specify a popup height, the popup will fill available space.

Constant Value: -1 (0xffffffff)

public static final int POSITION_PROMPT_ABOVE

Added in API level 11

The provided prompt view should appear above list content.

See Also
Constant Value: 0 (0x00000000)

public static final int POSITION_PROMPT_BELOW

Added in API level 11

The provided prompt view should appear below list content.

See Also
Constant Value: 1 (0x00000001)

public static final int WRAP_CONTENT

Added in API level 11

Alias for WRAP_CONTENT . If used to specify a popup width, the popup will use the width of its content.

Constant Value: -2 (0xfffffffe)

Public Constructors

public ListPopupWindow ( Context context)

Create a new, empty popup window capable of displaying items from a ListAdapter. Backgrounds should be set using setBackgroundDrawable(Drawable) .

Parameters
context Context used for contained views.

public ListPopupWindow ( Context context, AttributeSet attrs)

Create a new, empty popup window capable of displaying items from a ListAdapter. Backgrounds should be set using setBackgroundDrawable(Drawable) .

Parameters
context Context used for contained views.
attrs Attributes from inflating parent views used to style the popup.

public ListPopupWindow ( Context context, AttributeSet attrs, int defStyleAttr)

Create a new, empty popup window capable of displaying items from a ListAdapter. Backgrounds should be set using setBackgroundDrawable(Drawable) .

Parameters
context Context used for contained views.
attrs Attributes from inflating parent views used to style the popup.
defStyleAttr Default style attribute to use for popup content.

public ListPopupWindow ( Context context, AttributeSet attrs, int defStyleAttr, int defStyleRes)

Create a new, empty popup window capable of displaying items from a ListAdapter. Backgrounds should be set using setBackgroundDrawable(Drawable) .

Parameters
context Context used for contained views.
attrs Attributes from inflating parent views used to style the popup.
defStyleAttr Style attribute to read for default styling of popup content.
defStyleRes Style resource ID to use for default styling of popup content.

Public Methods

public void clearListSelection ()

Clear any current list selection. Only valid when isShowing() == true .

public View.OnTouchListener createDragToOpenListener ( View src)

Returns an View.OnTouchListener that can be added to the source view to implement drag-to-open behavior. Generally, the source view should be the same view that was passed to setAnchorView(View) .

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: 

          ListPopupWindow myPopup = new ListPopupWindow(context);
 myPopup.setAnchor(myAnchor);
 OnTouchListener dragListener = myPopup.createDragToOpenListener(myAnchor);
 myAnchor.setOnTouchListener(dragListener);

Parameters
src the view on which the resulting listener will be set
Returns
  • a touch listener that controls drag-to-open behavior

public void dismiss ()

Dismiss the popup window.

public View getAnchorView ()

Returns the view that will be used to anchor this popup.

Returns
  • The popup's anchor view

public int getAnimationStyle ()

Returns the animation style that will be used when the popup window is shown or dismissed.

Returns
  • Animation style that will be used.

public Drawable getBackground ()

Returns
  • The background drawable for the popup window.

public int getHeight ()

Returns
  • The height of the popup window in pixels.

public int getHorizontalOffset ()

Returns
  • The horizontal offset of the popup from its anchor in pixels.

public int getInputMethodMode ()

Return the current value in setInputMethodMode(int) .

See Also

public ListView getListView ()

Returns

public int getPromptPosition ()

Returns
  • Where the optional prompt view should appear.
See Also

public Object getSelectedItem ()

Returns
  • The currently selected item or null if the popup is not showing.

public long getSelectedItemId ()

Returns
See Also

public int getSelectedItemPosition ()

Returns
See Also

public View getSelectedView ()

Returns
  • The View for the currently selected item or null if isShowing() == false .
See Also

public int getSoftInputMode ()

Returns the current value in setSoftInputMode(int) .

See Also

public int getVerticalOffset ()

Returns
  • The vertical offset of the popup from its anchor in pixels.

public int getWidth ()

Returns
  • The width of the popup window in pixels.

public boolean isInputMethodNotNeeded ()

Returns
  • true if this popup is configured to assume the user does not need to interact with the IME while it is showing, false otherwise.

public boolean isModal ()

Returns whether the popup window will be modal when shown.

Returns
  • true if the popup window will be modal, false otherwise.

public boolean isShowing ()

Returns
  • true if the popup is currently showing, false otherwise.

public boolean onKeyDown (int keyCode, KeyEvent event)

Filter key down events. By forwarding key down events to this function, views using non-modal ListPopupWindow can have it handle key selection of items.

Parameters
keyCode keyCode param passed to the host view's onKeyDown
event event param passed to the host view's onKeyDown
Returns
  • true if the event was handled, false if it was ignored.
See Also

public boolean onKeyPreIme (int keyCode, KeyEvent event)

Filter pre-IME key events. By forwarding onKeyPreIme(int, KeyEvent) events to this function, views using ListPopupWindow can have it dismiss the popup when the back key is pressed.

Parameters
keyCode keyCode param passed to the host view's onKeyPreIme
event event param passed to the host view's onKeyPreIme
Returns
  • true if the event was handled, false if it was ignored.
See Also

public boolean onKeyUp (int keyCode, KeyEvent event)

Filter key down events. By forwarding key up events to this function, views using non-modal ListPopupWindow can have it handle key selection of items.

Parameters
keyCode keyCode param passed to the host view's onKeyUp
event event param passed to the host view's onKeyUp
Returns
  • true if the event was handled, false if it was ignored.
See Also

public boolean performItemClick (int position)

Perform an item click operation on the specified list adapter position.

Parameters
position Adapter position for performing the click
Returns
  • true if the click action could be performed, false if not. (e.g. if the popup was not showing, this method would return false.)

public void postShow ()

Post a show() call to the UI thread.

public void setAdapter ( ListAdapter adapter)

Sets the adapter that provides the data and the views to represent the data in this popup window.

Parameters
adapter The adapter to use to create this window's content.

public void setAnchorView ( View anchor)

Sets the popup's anchor view. This popup will always be positioned relative to the anchor view when shown.

Parameters
anchor The view to use as an anchor.

public void setAnimationStyle (int animationStyle)

Set an animation style to use when the popup window is shown or dismissed.

Parameters
animationStyle Animation style to use.

public void setBackgroundDrawable ( Drawable d)

Sets a drawable to be the background for the popup window.

Parameters
d A drawable to set as the background.

public void setContentWidth (int width)

Sets the width of the popup window by the size of its content. The final width may be larger to accommodate styled window dressing.

Parameters
width Desired width of content in pixels.

public void setDropDownGravity (int gravity)

Set the gravity of the dropdown list. This is commonly used to set gravity to START or END for alignment with the anchor.

Parameters
gravity Gravity value to use

public void setHeight (int height)

Sets the height of the popup window in pixels. Can also be MATCH_PARENT .

Parameters
height Height of the popup window.

public void setHorizontalOffset (int offset)

Set the horizontal offset of this popup from its anchor view in pixels.

Parameters
offset The horizontal offset of the popup from its anchor.

public void setInputMethodMode (int mode)

Control how the popup operates with an input method: one of INPUT_METHOD_FROM_FOCUSABLE , INPUT_METHOD_NEEDED , or INPUT_METHOD_NOT_NEEDED .

If the popup is showing, calling this method will take effect only the next time the popup is shown or through a manual call to the show() method.

See Also

public void setListSelector ( Drawable selector)

Sets a drawable to use as the list item selector.

Parameters
selector List selector drawable to use in the popup.

public void setModal (boolean modal)

Set whether this window should be modal when shown.

If a popup window is modal, it will receive all touch and key input. If the user touches outside the popup window's content area the popup window will be dismissed.

Parameters
modal true if the popup window should be modal, false otherwise.

public void setOnDismissListener ( PopupWindow.OnDismissListener listener)

Set a listener to receive a callback when the popup is dismissed.

Parameters
listener Listener that will be notified when the popup is dismissed.

public void setOnItemClickListener ( AdapterView.OnItemClickListener clickListener)

Sets a listener to receive events when a list item is clicked.

Parameters
clickListener Listener to register
See Also

public void setOnItemSelectedListener ( AdapterView.OnItemSelectedListener selectedListener)

Sets a listener to receive events when a list item is selected.

Parameters
selectedListener Listener to register.
See Also

public void setPromptPosition (int position)

Set where the optional prompt view should appear. The default is POSITION_PROMPT_ABOVE .

Parameters
position A position constant declaring where the prompt should be displayed.
See Also

public void setPromptView ( View prompt)

Set a view to act as a user prompt for this popup window. Where the prompt view will appear is controlled by setPromptPosition(int) .

Parameters
prompt View to use as an informational prompt.

public void setSelection (int position)

Set the selected position of the list. Only valid when isShowing() == true .

Parameters
position List position to set as selected.

public void setSoftInputMode (int mode)

Sets the operating mode for the soft input area.

Parameters
mode The desired mode, see softInputMode for the full list
See Also

public void setVerticalOffset (int offset)

Set the vertical offset of this popup from its anchor view in pixels.

Parameters
offset The vertical offset of the popup from its anchor.

public void setWidth (int width)

Sets the width of the popup window in pixels. Can also be MATCH_PARENT or WRAP_CONTENT .

Parameters
width Width of the popup window.

public void show ()

Show the popup list. If the list is already showing, this method will recalculate the popup's size and position.