PopupWindowCompat

Added in 1.1.0

public final class PopupWindowCompat

Helper for accessing features in PopupWindow.

Summary

Public methods
static boolean

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

Returns the layout type for this window.
static void
setOverlapAnchor(@NonNull PopupWindow popupWindow, boolean overlapAnchor)

Sets whether the popup window should overlap its anchor view when displayed as a drop-down.
static void
setWindowLayoutType(@NonNull PopupWindow popupWindow, int layoutType)

Set the layout type for this window.
static void
@ReplaceWith(expression = "popup.showAsDropDown(anchor, xoff, yoff, gravity)")
showAsDropDown(
    @NonNull PopupWindow popup,
    @NonNull View anchor,
    int xoff,
    int yoff,
    int gravity
)

This method is deprecated.

Call showAsDropDown directly.

Public methods

getOverlapAnchor

Added in 1.1.0
public static boolean getOverlapAnchor(@NonNull PopupWindow popupWindow)

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
public static int getWindowLayoutType(@NonNull PopupWindow popupWindow)

Returns the layout type for this window.

See also
setWindowLayoutType

setOverlapAnchor

Added in 1.1.0
public static void setOverlapAnchor(@NonNull PopupWindow popupWindow, boolean overlapAnchor)

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

Parameters
@NonNull PopupWindow popupWindow

popup window for which to set the anchor.
boolean overlapAnchor

Whether the popup should overlap its anchor.

setWindowLayoutType

Added in 1.1.0
public static void setWindowLayoutType(@NonNull PopupWindow popupWindow, int layoutType)

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
@NonNull PopupWindow popupWindow

popup window for which to set the layout type.
int layoutType

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)")
public static void showAsDropDown(
    @NonNull PopupWindow popup,
    @NonNull View anchor,
    int xoff,
    int yoff,
    int gravity
)

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
@NonNull PopupWindow popup

the PopupWindow to show
@NonNull View anchor

the view on which to pin the popup window
int xoff

A horizontal offset from the anchor in pixels
int yoff

A vertical offset from the anchor in pixels
int gravity

Alignment of the popup relative to the anchor