ListPopupWindow

const val INPUT_METHOD_FROM_FOCUSABLE = 0: Int

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.

const val INPUT_METHOD_NEEDED = 1: Int

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.

const val INPUT_METHOD_NOT_NEEDED = 2: Int

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.

const val MATCH_PARENT = -1: Int

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.

const val POSITION_PROMPT_ABOVE = 0: Int

The provided prompt view should appear above list content.

const val POSITION_PROMPT_BELOW = 1: Int

The provided prompt view should appear below list content.

const val WRAP_CONTENT = -2: Int

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

ListPopupWindow(context: Context)

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

ListPopupWindow(context: Context, attrs: AttributeSet?)

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

ListPopupWindow(
    context: Context,
    attrs: AttributeSet?,
    defStyleAttr: @AttrRes Int
)

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

ListPopupWindow(
    context: Context,
    attrs: AttributeSet?,
    defStyleAttr: @AttrRes Int,
    defStyleRes: @StyleRes Int
)

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

fun clearListSelection(): Unit

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

fun createDragToOpenListener(src: View!): View.OnTouchListener!

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

fun dismiss(): Unit

Dismiss the popup window.

fun getAnchorView(): View?

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

fun getAnimationStyle(): @StyleRes Int

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

fun getBackground(): Drawable?

fun getEpicenterBounds(): Rect?

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

fun getHeight(): Int

fun getHorizontalOffset(): Int

fun getInputMethodMode(): Int

Return the current value in setInputMethodMode.

fun getListView(): ListView?

fun getPromptPosition(): Int

fun getSelectedItem(): Any?

fun getSelectedItemId(): Long

fun getSelectedItemPosition(): Int

fun getSelectedView(): View?

fun getSoftInputMode(): Int

Returns the current value in setSoftInputMode.

fun getVerticalOffset(): Int

fun getWidth(): Int

fun isInputMethodNotNeeded(): Boolean

fun isModal(): Boolean

Returns whether the popup window will be modal when shown.

fun isShowing(): Boolean

fun onKeyDown(keyCode: Int, event: KeyEvent): Boolean

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.

fun onKeyPreIme(keyCode: Int, event: KeyEvent): Boolean

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.

fun onKeyUp(keyCode: Int, event: KeyEvent): Boolean

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.

fun performItemClick(position: Int): Boolean

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

fun postShow(): Unit

Post a show call to the UI thread.

fun setAdapter(adapter: ListAdapter?): Unit

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

fun setAnchorView(anchor: View?): Unit

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

fun setAnimationStyle(animationStyle: @StyleRes Int): Unit

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

fun setBackgroundDrawable(d: Drawable?): Unit

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

fun setContentWidth(width: Int): Unit

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

fun setDropDownGravity(gravity: Int): Unit

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

fun setEpicenterBounds(bounds: Rect?): Unit

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

fun setHeight(height: Int): Unit

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

fun setHorizontalOffset(offset: Int): Unit

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

fun setInputMethodMode(mode: Int): Unit

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.

fun setListSelector(selector: Drawable!): Unit

Sets a drawable to use as the list item selector.

fun setModal(modal: Boolean): Unit

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.

fun setOnDismissListener(listener: PopupWindow.OnDismissListener?): Unit

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

fun setOnItemClickListener(clickListener: AdapterView.OnItemClickListener?): Unit

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

fun setOnItemSelectedListener(
    selectedListener: AdapterView.OnItemSelectedListener?
): Unit

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

fun setPromptPosition(position: Int): Unit

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

fun setPromptView(prompt: View?): Unit

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

fun setSelection(position: Int): Unit

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

fun setSoftInputMode(mode: Int): Unit

Sets the operating mode for the soft input area.

fun setVerticalOffset(offset: Int): Unit

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

fun setWidth(width: Int): Unit

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

fun setWindowLayoutType(layoutType: Int): Unit

Set the layout type for this popup window.

See type for possible values.

fun show(): Unit

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