ListPopupWindow

public static final int INPUT_METHOD_FROM_FOCUSABLE = 0

Mode for setInputMethodMode: 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.

public static final int INPUT_METHOD_NEEDED = 1

Mode for setInputMethodMode: 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.

public static final int INPUT_METHOD_NOT_NEEDED = 2

Mode for setInputMethodMode: 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.

public static final int MATCH_PARENT = -1

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.

public static final int POSITION_PROMPT_ABOVE = 0

The provided prompt view should appear above list content.

public static final int POSITION_PROMPT_BELOW = 1

The provided prompt view should appear below list content.

public static final int WRAP_CONTENT = -2

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

public ListPopupWindow(@NonNull Context context)

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

public ListPopupWindow(@NonNull Context context, @Nullable AttributeSet attrs)

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

public ListPopupWindow(
    @NonNull Context context,
    @Nullable AttributeSet attrs,
    @AttrRes int defStyleAttr
)

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

public ListPopupWindow(
    @NonNull Context context,
    @Nullable AttributeSet attrs,
    @AttrRes int defStyleAttr,
    @StyleRes int defStyleRes
)

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

public void clearListSelection()

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

public View.OnTouchListener createDragToOpenListener(View src)

Returns an 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.

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);

public void dismiss()

Dismiss the popup window.

public @Nullable View getAnchorView()

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

public @StyleRes int getAnimationStyle()

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

public @Nullable Rect getEpicenterBounds()

Return custom anchor-relative bounds of the popup's transition epicenter

public int getInputMethodMode()

Return the current value in setInputMethodMode.

public int getSoftInputMode()

Returns the current value in setSoftInputMode.

public boolean isModal()

Returns whether the popup window will be modal when shown.

public boolean onKeyDown(int keyCode, @NonNull 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.

public boolean onKeyPreIme(int keyCode, @NonNull KeyEvent event)

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

public boolean onKeyUp(int keyCode, @NonNull KeyEvent event)

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

public boolean performItemClick(int position)

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

public void postShow()

Post a show call to the UI thread.

public void setAdapter(@Nullable ListAdapter adapter)

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

public void setAnchorView(@Nullable View anchor)

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

public void setAnimationStyle(@StyleRes int animationStyle)

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

public void setBackgroundDrawable(@Nullable Drawable d)

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

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.

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.

public void setEpicenterBounds(@Nullable Rect bounds)

Specifies the custom anchor-relative bounds of the popup's transition epicenter.

public void setHeight(int height)

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

public void setHorizontalOffset(int offset)

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

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.

public void setListSelector(Drawable selector)

Sets a drawable to use as the list item selector.

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.

public void setOnDismissListener(@Nullable PopupWindow.OnDismissListener listener)

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

public void setOnItemClickListener(
    @Nullable AdapterView.OnItemClickListener clickListener
)

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

public void setOnItemSelectedListener(
    @Nullable AdapterView.OnItemSelectedListener selectedListener
)

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

public void setPromptPosition(int position)

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

public void setPromptView(@Nullable 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.

public void setSelection(int position)

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

public void setSoftInputMode(int mode)

Sets the operating mode for the soft input area.

public void setVerticalOffset(int offset)

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

public void setWidth(int width)

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

public void setWindowLayoutType(int layoutType)

Set the layout type for this popup window.

See type for possible values.

public void show()

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