ListPopupWindow (material 1.3.1 API)

java.lang.Object
- com.rey.material.widget.ListPopupWindow

```
public class ListPopupWindow
extends java.lang.Object
```
This is a copy of android.support.v7.widget.ListPopupWindow. Just change DropDownListView's parent class to com.rey.material.widget.ListView to support RippleEffect in child view.

See Also:

ListPopupWindow

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ListPopupWindow.ForwardingListener
Abstract class that forwards touch events to a ListPopupWindow.

Nested Classes
Modifier and Type	Class and Description
`static class`	`ListPopupWindow.ForwardingListener` Abstract class that forwards touch events to a `ListPopupWindow`.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`INPUT_METHOD_FROM_FOCUSABLE` Mode for `setInputMethodMode(int)`: the requirements for the input method should be based on the focusability of the popup.
`static int`	`INPUT_METHOD_NEEDED` Mode for `setInputMethodMode(int)`: this popup always needs to work with an input method, regardless of whether it is focusable.
`static 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.
`static int`	`MATCH_PARENT` Alias for `ViewGroup.LayoutParams#MATCH_PARENT`.
`static int`	`POSITION_PROMPT_ABOVE` The provided prompt view should appear above list content.
`static int`	`POSITION_PROMPT_BELOW` The provided prompt view should appear below list content.
`static int`	`WRAP_CONTENT` Alias for `ViewGroup.LayoutParams#WRAP_CONTENT`.

Constructor Summary

Constructors
Constructor and Description
`ListPopupWindow(android.content.Context context)` Create a new, empty popup window capable of displaying items from a ListAdapter.
`ListPopupWindow(android.content.Context context, android.util.AttributeSet attrs)` Create a new, empty popup window capable of displaying items from a ListAdapter.
`ListPopupWindow(android.content.Context context, android.util.AttributeSet attrs, int defStyleAttr)` Create a new, empty popup window capable of displaying items from a ListAdapter.
`ListPopupWindow(android.content.Context context, android.util.AttributeSet attrs, int defStyleAttr, int defStyleRes)` Create a new, empty popup window capable of displaying items from a ListAdapter.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clearListSelection()` Clear any current list selection.
`android.view.View.OnTouchListener`	`createDragToOpenListener(android.view.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.
`android.view.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.
`android.graphics.drawable.Drawable`	`getBackground()`
`int`	`getHeight()`
`int`	`getHorizontalOffset()`
`int`	`getInputMethodMode()` Return the current value in `setInputMethodMode(int)`.
`ListView`	`getListView()`
`PopupWindow`	`getPopup()`
`int`	`getPromptPosition()`
`java.lang.Object`	`getSelectedItem()`
`long`	`getSelectedItemId()`
`int`	`getSelectedItemPosition()`
`android.view.View`	`getSelectedView()`
`int`	`getSoftInputMode()` Returns the current value in `setSoftInputMode(int)`.
`int`	`getVerticalOffset()`
`int`	`getWidth()`
`boolean`	`isDropDownAlwaysVisible()`
`boolean`	`isInputMethodNotNeeded()`
`boolean`	`isModal()` Returns whether the popup window will be modal when shown.
`boolean`	`isShowing()`
`boolean`	`onKeyDown(int keyCode, android.view.KeyEvent event)` Filter key down events.
`boolean`	`onKeyPreIme(int keyCode, android.view.KeyEvent event)` Filter pre-IME key events.
`boolean`	`onKeyUp(int keyCode, android.view.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(android.widget.ListAdapter adapter)` Sets the adapter that provides the data and the views to represent the data in this popup window.
`void`	`setAnchorView(android.view.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(android.graphics.drawable.Drawable background)`
`void`	`setContentWidth(int width)` Sets the width of the popup window by the size of its content.
`void`	`setDropDownAlwaysVisible(boolean dropDownAlwaysVisible)` Sets whether the drop-down should remain visible under certain conditions.
`void`	`setDropDownGravity(int gravity)` Set the gravity of the dropdown list.
`void`	`setForceIgnoreOutsideTouch(boolean forceIgnoreOutsideTouch)` Forces outside touches to be ignored.
`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`	`setItemAnimation(int id)`
`void`	`setItemAnimationOffset(int offset)`
`void`	`setListSelector(android.graphics.drawable.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(android.widget.PopupWindow.OnDismissListener listener)` Set a listener to receive a callback when the popup is dismissed.
`void`	`setOnItemClickListener(android.widget.AdapterView.OnItemClickListener clickListener)` Sets a listener to receive events when a list item is clicked.
`void`	`setOnItemSelectedListener(android.widget.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(android.view.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.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - POSITION_PROMPT_ABOVE
```
public static final int POSITION_PROMPT_ABOVE
```
    The provided prompt view should appear above list content.
    
    See Also:
    
    setPromptPosition(int), getPromptPosition(), setPromptView(View), Constant Field Values
  - POSITION_PROMPT_BELOW
```
public static final int POSITION_PROMPT_BELOW
```
    The provided prompt view should appear below list content.
    
    See Also:
    
    setPromptPosition(int), getPromptPosition(), setPromptView(View), Constant Field Values
  - MATCH_PARENT
```
public static final int MATCH_PARENT
```
    Alias for ViewGroup.LayoutParams#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.
    
    See Also:
    
    Constant Field Values
  - WRAP_CONTENT
```
public static final int WRAP_CONTENT
```
    Alias for ViewGroup.LayoutParams#WRAP_CONTENT. If used to specify a popup width, the popup will use the width of its content.
    
    See Also:
    
    Constant Field Values
  - INPUT_METHOD_FROM_FOCUSABLE
```
public static final int INPUT_METHOD_FROM_FOCUSABLE
```
    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.
    
    See Also:
    
    Constant Field Values
  - INPUT_METHOD_NEEDED
```
public static final int INPUT_METHOD_NEEDED
```
    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.
    
    See Also:
    
    Constant Field Values
  - INPUT_METHOD_NOT_NEEDED
```
public static final 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. 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.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ListPopupWindow
```
public ListPopupWindow(android.content.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.
  - ListPopupWindow
```
public ListPopupWindow(android.content.Context context,
                       android.util.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.
  - ListPopupWindow
```
public ListPopupWindow(android.content.Context context,
                       android.util.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.
  - ListPopupWindow
```
public ListPopupWindow(android.content.Context context,
                       android.util.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 - Default style attribute to use for popup content.
    
    defStyleRes - Default style to use for popup content.
- Method Detail
  - setItemAnimation
```
public void setItemAnimation(int id)
```
  - setItemAnimationOffset
```
public void setItemAnimationOffset(int offset)
```
  - setBackgroundDrawable
```
public void setBackgroundDrawable(android.graphics.drawable.Drawable background)
```
  - getBackground
```
public android.graphics.drawable.Drawable getBackground()
```
  - setAdapter
```
public void setAdapter(android.widget.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.
  - setPromptPosition
```
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:
    
    POSITION_PROMPT_ABOVE, POSITION_PROMPT_BELOW
  - getPromptPosition
```
public int getPromptPosition()
```
    Returns:
    
    Where the optional prompt view should appear.
    
    See Also:
    
    POSITION_PROMPT_ABOVE, POSITION_PROMPT_BELOW
  - setModal
```
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.
  - isModal
```
public boolean isModal()
```
    Returns whether the popup window will be modal when shown.
    
    Returns:
    
    true if the popup window will be modal, false otherwise.
  - setForceIgnoreOutsideTouch
```
public void setForceIgnoreOutsideTouch(boolean forceIgnoreOutsideTouch)
```
    Forces outside touches to be ignored. Normally if isDropDownAlwaysVisible() is false, we allow outside touch to dismiss the dropdown. If this is set to true, then we ignore outside touch even when the drop down is not set to always visible.
  - setDropDownAlwaysVisible
```
public void setDropDownAlwaysVisible(boolean dropDownAlwaysVisible)
```
    Sets whether the drop-down should remain visible under certain conditions. The drop-down will occupy the entire screen below getAnchorView() regardless of the size or content of the list. getBackground() will fill any space that is not used by the list.
    
    Parameters:
    
    dropDownAlwaysVisible - Whether to keep the drop-down visible.
  - isDropDownAlwaysVisible
```
public boolean isDropDownAlwaysVisible()
```
    Returns:
    
    Whether the drop-down is visible under special conditions.
  - setSoftInputMode
```
public void setSoftInputMode(int mode)
```
    Sets the operating mode for the soft input area.
    
    Parameters:
    
    mode - The desired mode, see WindowManager.LayoutParams.softInputMode for the full list
    
    See Also:
    
    WindowManager.LayoutParams.softInputMode, getSoftInputMode()
  - getSoftInputMode
```
public int getSoftInputMode()
```
    Returns the current value in setSoftInputMode(int).
    
    See Also:
    
    setSoftInputMode(int), WindowManager.LayoutParams.softInputMode
  - setListSelector
```
public void setListSelector(android.graphics.drawable.Drawable selector)
```
    Sets a drawable to use as the list item selector.
    
    Parameters:
    
    selector - List selector drawable to use in the popup.
  - setAnimationStyle
```
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.
  - getAnimationStyle
```
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.
  - getAnchorView
```
public android.view.View getAnchorView()
```
    Returns the view that will be used to anchor this popup.
    
    Returns:
    
    The popup's anchor view
  - setAnchorView
```
public void setAnchorView(android.view.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.
  - getHorizontalOffset
```
public int getHorizontalOffset()
```
    Returns:
    
    The horizontal offset of the popup from its anchor in pixels.
  - setHorizontalOffset
```
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.
  - getVerticalOffset
```
public int getVerticalOffset()
```
    Returns:
    
    The vertical offset of the popup from its anchor in pixels.
  - setVerticalOffset
```
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.
  - setDropDownGravity
```
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
  - getWidth
```
public int getWidth()
```
    Returns:
    
    The width of the popup window in pixels.
  - setWidth
```
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.
  - setContentWidth
```
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.
  - getHeight
```
public int getHeight()
```
    Returns:
    
    The height of the popup window in pixels.
  - setHeight
```
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.
  - setOnItemClickListener
```
public void setOnItemClickListener(android.widget.AdapterView.OnItemClickListener clickListener)
```
    Sets a listener to receive events when a list item is clicked.
    
    Parameters:
    
    clickListener - Listener to register
    
    See Also:
    
    AdapterView.setOnItemClickListener(AdapterView.OnItemClickListener)
  - setOnItemSelectedListener
```
public void setOnItemSelectedListener(android.widget.AdapterView.OnItemSelectedListener selectedListener)
```
    Sets a listener to receive events when a list item is selected.
    
    Parameters:
    
    selectedListener - Listener to register.
    
    See Also:
    
    AdapterView.setOnItemSelectedListener(AdapterView.OnItemSelectedListener)
  - setPromptView
```
public void setPromptView(android.view.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.
  - postShow
```
public void postShow()
```
    Post a show() call to the UI thread.
  - show
```
public void show()
```
    Show the popup list. If the list is already showing, this method will recalculate the popup's size and position.
  - dismiss
```
public void dismiss()
```
    Dismiss the popup window.
  - setOnDismissListener
```
public void setOnDismissListener(android.widget.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.
  - setInputMethodMode
```
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:
    
    getInputMethodMode(), show()
  - getInputMethodMode
```
public int getInputMethodMode()
```
    Return the current value in setInputMethodMode(int).
    
    See Also:
    
    setInputMethodMode(int)
  - setSelection
```
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.
  - clearListSelection
```
public void clearListSelection()
```
    Clear any current list selection. Only valid when isShowing() == true.
  - isShowing
```
public boolean isShowing()
```
    Returns:
    
    true if the popup is currently showing, false otherwise.
  - isInputMethodNotNeeded
```
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.
  - performItemClick
```
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.)
  - getSelectedItem
```
public java.lang.Object getSelectedItem()
```
    Returns:
    
    The currently selected item or null if the popup is not showing.
  - getSelectedItemPosition
```
public int getSelectedItemPosition()
```
    Returns:
    
    The position of the currently selected item or ListViewCompat.INVALID_POSITION if isShowing() == false.
    
    See Also:
    
    AdapterView.getSelectedItemPosition()
  - getSelectedItemId
```
public long getSelectedItemId()
```
    Returns:
    
    The ID of the currently selected item or AdapterView.INVALID_ROW_ID if isShowing() == false.
    
    See Also:
    
    AdapterView.getSelectedItemId()
  - getSelectedView
```
public android.view.View getSelectedView()
```
    Returns:
    
    The View for the currently selected item or null if isShowing() == false.
    
    See Also:
    
    AbsListView.getSelectedView()
  - getListView
```
public ListView getListView()
```
    Returns:
    
    The ListView displayed within the popup window. Only valid when isShowing() == true.
  - getPopup
```
public PopupWindow getPopup()
```
  - onKeyDown
```
public boolean onKeyDown(int keyCode,
                         android.view.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:
    
    setModal(boolean)
  - onKeyUp
```
public boolean onKeyUp(int keyCode,
                       android.view.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:
    
    setModal(boolean)
  - onKeyPreIme
```
public boolean onKeyPreIme(int keyCode,
                           android.view.KeyEvent event)
```
    Filter pre-IME key events. By forwarding View.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:
    
    setModal(boolean)
  - createDragToOpenListener
```
public android.view.View.OnTouchListener createDragToOpenListener(android.view.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(android.view.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

Class ListPopupWindow

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

POSITION_PROMPT_ABOVE

POSITION_PROMPT_BELOW

MATCH_PARENT

WRAP_CONTENT

INPUT_METHOD_FROM_FOCUSABLE

INPUT_METHOD_NEEDED

INPUT_METHOD_NOT_NEEDED

Constructor Detail

ListPopupWindow

ListPopupWindow

ListPopupWindow

ListPopupWindow

Method Detail

setItemAnimation

setItemAnimationOffset

setBackgroundDrawable

getBackground

setAdapter

setPromptPosition

getPromptPosition

setModal

isModal

setForceIgnoreOutsideTouch

setDropDownAlwaysVisible

isDropDownAlwaysVisible

setSoftInputMode

getSoftInputMode

setListSelector

setAnimationStyle

getAnimationStyle

getAnchorView

setAnchorView

getHorizontalOffset

setHorizontalOffset

getVerticalOffset

setVerticalOffset

setDropDownGravity

getWidth

setWidth

setContentWidth

getHeight

setHeight

setOnItemClickListener

setOnItemSelectedListener

setPromptView

postShow

show

dismiss

setOnDismissListener

setInputMethodMode

getInputMethodMode

setSelection

clearListSelection

isShowing

isInputMethodNotNeeded

performItemClick

getSelectedItem

getSelectedItemPosition

getSelectedItemId

getSelectedView

getListView

getPopup

onKeyDown

onKeyUp

onKeyPreIme

createDragToOpenListener