PopupWindowCompat

Added in 1.1.0

class PopupWindowCompat


Helper for accessing features in PopupWindow.

Summary

Public functions

java-static Boolean

Returns whether the popup window should overlap its anchor view when displayed as a drop-down.

java-static Int

Returns the layout type for this window.

java-static Unit
setOverlapAnchor(popupWindow: PopupWindow, overlapAnchor: Boolean)

Sets whether the popup window should overlap its anchor view when displayed as a drop-down.

java-static Unit
setWindowLayoutType(popupWindow: PopupWindow, layoutType: Int)

Set the layout type for this window.

java-static Unit
@ReplaceWith(expression = "popup.showAsDropDown(anchor, xoff, yoff, gravity)")
showAsDropDown(
    popup: PopupWindow,
    anchor: View,
    xoff: Int,
    yoff: Int,
    gravity: Int
)

This function is deprecated.

Call showAsDropDown directly.

Public functions

getOverlapAnchor

Added in 1.1.0
java-static fun getOverlapAnchor(popupWindow: PopupWindow): Boolean

Returns whether the popup window should overlap its anchor view when displayed as a drop-down.

Returns
Boolean

Whether the popup should overlap its anchor.

getWindowLayoutType

Added in 1.1.0
java-static fun getWindowLayoutType(popupWindow: PopupWindow): Int

Returns the layout type for this window.

setOverlapAnchor

Added in 1.1.0
java-static fun setOverlapAnchor(popupWindow: PopupWindow, overlapAnchor: Boolean): Unit

Sets whether the popup window should overlap its anchor view when displayed as a drop-down.

Parameters
popupWindow: PopupWindow

popup window for which to set the anchor.

overlapAnchor: Boolean

Whether the popup should overlap its anchor.

setWindowLayoutType

Added in 1.1.0
java-static fun setWindowLayoutType(popupWindow: PopupWindow, layoutType: Int): Unit

Set the layout type for this window. This value will be passed through to type therefore the value should match any value type accepts.

Parameters
popupWindow: PopupWindow

popup window for which to set the layout type.

layoutType: Int

Layout type for this window.

See also
type

showAsDropDown

Added in 1.1.0
Deprecated in 1.15.0
@ReplaceWith(expression = "popup.showAsDropDown(anchor, xoff, yoff, gravity)")
java-static fun showAsDropDown(
    popup: PopupWindow,
    anchor: View,
    xoff: Int,
    yoff: Int,
    gravity: Int
): Unit

Display the content view in a popup window anchored to the bottom-left corner of the anchor view offset by the specified x and y coordinates. If there is not enough room on screen to show the popup in its entirety, this method tries to find a parent scroll view to scroll. If no parent scroll view can be scrolled, the bottom-left corner of the popup is pinned at the top left corner of the anchor view.

If the view later scrolls to move anchor to a different location, the popup will be moved correspondingly.

Parameters
popup: PopupWindow

the PopupWindow to show

anchor: View

the view on which to pin the popup window

xoff: Int

A horizontal offset from the anchor in pixels

yoff: Int

A vertical offset from the anchor in pixels

gravity: Int

Alignment of the popup relative to the anchor