Added inAPI level 1
Summary:Nested Classes|XML Attrs|Constants|Ctors|Methods|Inherited Methods

PopupWindow

---

Kotlin|Java

`
public

class
PopupWindow

extends [Object](https://developer.android.com/reference/java/lang/Object)

“

`

|—|—————————-|
| java.lang.Object ||
| ↳ | android.widget.PopupWindow |

---

This class represents a popup window that can be used to display an arbitrary view. The popup window is a floating container that appears on top of the current activity.

Animation

On all versions of Android, popup window enter and exit animations may be specified by callingsetAnimationStyle(int)and passing the resource ID for an animation style that defineswindowEnterAnimationandwindowExitAnimation. For example, passingR.style.Animation_Dialogwill give a scale and alpha animation.
A window animation style may also be specified in the popup window’s style XML via thepopupAnimationStyleattribute.

Starting with API 23, more complex popup window enter and exit transitions may be specified by calling eithersetEnterTransition(android.transition.Transition)orsetExitTransition(android.transition.Transition)and passing aTransition.
Popup enter and exit transitions may also be specified in the popup window’s style XML via thepopupEnterTransitionandpopupExitTransitionattributes, respectively.

See also:

• AutoCompleteTextView
• Spinner

Summary

### Nested classes
interface	PopupWindow.OnDismissListener Listener that is called when this popup window is dismissed.

### XML attributes
android:overlapAnchor	Whether the popup window should overlap its anchor view.
android:popupAnimationStyle	The animation style to use for the popup window.
android:popupBackground	The background to use for the popup window.
android:popupElevation	Window elevation to use for the popup window.
android:popupEnterTransition	Transition used to move views into the popup window.
android:popupExitTransition	Transition used to move views out of the popup window.

### Constants
int	INPUT_METHOD_FROM_FOCUSABLE Mode forsetInputMethodMode(int): the requirements for the input method should be based on the focusability of the popup.
int	INPUT_METHOD_NEEDED Mode forsetInputMethodMode(int): this popup always needs to work with an input method, regardless of whether it is focusable.
int	INPUT_METHOD_NOT_NEEDED Mode forsetInputMethodMode(int): this popup never needs to work with an input method, regardless of whether it is focusable.

### Public constructors
PopupWindow() Create a new empty, non focusable popup window of dimension (0,0).
PopupWindow(Contextcontext) Create a new empty, non focusable popup window of dimension (0,0).
PopupWindow(Contextcontext,AttributeSetattrs) Create a new empty, non focusable popup window of dimension (0,0).
PopupWindow(Contextcontext,AttributeSetattrs, int defStyleAttr) Create a new empty, non focusable popup window of dimension (0,0).
PopupWindow(Contextcontext,AttributeSetattrs, int defStyleAttr, int defStyleRes) Create a new, empty, non focusable popup window of dimension (0,0).
PopupWindow(ViewcontentView) Create a new non focusable popup window which can display thecontentView.
PopupWindow(ViewcontentView, int width, int height) Create a new non focusable popup window which can display thecontentView.
PopupWindow(ViewcontentView, int width, int height, boolean focusable) Create a new popup window which can display thecontentView.
PopupWindow(int width, int height) Create a new empty, non focusable popup window.

### Public methods
void	dismiss() Disposes of the popup window.
int	getAnimationStyle() Return the animation style to use the popup appears and disappears
Drawable	getBackground() Return the drawable used as the popup window’s background.
View	getContentView() Return the view used as the content of the popup window.
float	getElevation()
Transition	getEnterTransition() Returns the enter transition to be used when the popup window is shown.
Rect	getEpicenterBounds() Returns bounds which are used as a center of the enter and exit transitions.
Transition	getExitTransition() Returns the exit transition to be used when the popup window is dismissed.
int	getHeight() Returns the popup’s requested height.
int	getInputMethodMode() Return the current value insetInputMethodMode(int).
int	getMaxAvailableHeight(Viewanchor) Returns the maximum height that is available for the popup to be completely shown.
int	getMaxAvailableHeight(Viewanchor, int yOffset) Returns the maximum height that is available for the popup to be completely shown.
int	getMaxAvailableHeight(Viewanchor, int yOffset, boolean ignoreBottomDecorations) Returns the maximum height that is available for the popup to be completely shown, optionally ignoring any bottom decorations such as the input method.
boolean	getOverlapAnchor() Returns whether the popup window should overlap its anchor view when displayed as a drop-down.
int	getSoftInputMode() Returns the current value insetSoftInputMode(int).
int	getWidth() Returns the popup’s requested width.
int	getWindowLayoutType() Returns the layout type for this window.
boolean	isAboveAnchor() Indicates whether the popup is showing above (the y coordinate of the popup’s bottom is less than the y coordinate of the anchor) or below the anchor view (the y coordinate of the popup is greater than y coordinate of the anchor’s bottom).
boolean	isAttachedInDecor() Indicates whether the popup window will be attached in the decor frame of its parent window.
boolean	isClippedToScreen() Indicates whether this popup will be clipped to the screen and not to the containing window
boolean	isClippingEnabled() Indicates whether clipping of the popup window is enabled.
boolean	isFocusable() Indicate whether the popup window can grab the focus.
boolean	isLaidOutInScreen() Indicates whether the popup window will be forced into using absolute screen coordinates for positioning.
boolean	isOutsideTouchable() Indicates whether the popup window will be informed of touch events outside of its window.
boolean	isShowing() Indicate whether this popup window is showing on screen.
boolean	isSplitTouchEnabled() Indicates whether the popup window supports splitting touches.
boolean	isTouchModal() Indicates whether outside touches will be sent to this window or other windows behind it
boolean	isTouchable() Indicates whether the popup window receives touch events.
void	setAnimationStyle(int animationStyle) Change the animation style resource for this popup.
void	setAttachedInDecor(boolean enabled) This will attach the popup window to the decor frame of the parent window to avoid overlaping with screen decorations like the navigation bar.
void	setBackgroundDrawable(Drawablebackground) Specifies the background drawable for this popup window.
void	setClippingEnabled(boolean enabled) Allows the popup window to extend beyond the bounds of the screen.
void	setContentView(ViewcontentView) Change the popup’s content.
void	setElevation(float elevation) Specifies the elevation for this popup window.
void	setEnterTransition(TransitionenterTransition) Sets the enter transition to be used when the popup window is shown.
void	setEpicenterBounds(Rectbounds) Sets the bounds used as the epicenter of the enter and exit transitions.
void	setExitTransition(TransitionexitTransition) Sets the exit transition to be used when the popup window is dismissed.
void	setFocusable(boolean focusable) Changes the focusability of the popup window.
void	setHeight(int height) Sets the popup’s requested height.
void	setIgnoreCheekPress() Set the flag on popup to ignore cheek press events; by default this flag is set to false which means the popup will not ignore cheek press dispatch events.
void	setInputMethodMode(int mode) Control how the popup operates with an input method: one ofINPUT_METHOD_FROM_FOCUSABLE,INPUT_METHOD_NEEDED, orINPUT_METHOD_NOT_NEEDED.
void	setIsClippedToScreen(boolean enabled) Clip this popup window to the screen, but not to the containing window.
void	setIsLaidOutInScreen(boolean enabled) Allows the popup window to force the flagWindowManager.LayoutParams.FLAG_LAYOUT_IN_SCREEN, overriding default behavior.
void	setOnDismissListener(PopupWindow.OnDismissListeneronDismissListener) Sets the listener to be called when the window is dismissed.
void	setOutsideTouchable(boolean touchable) Controls whether the pop-up will be informed of touch events outside of its window.
void	setOverlapAnchor(boolean overlapAnchor) Sets whether the popup window should overlap its anchor view when displayed as a drop-down.
void	setSoftInputMode(int mode) Sets the operating mode for the soft input area.
void	setSplitTouchEnabled(boolean enabled) Allows the popup window to split touches across other windows that also support split touch.
void	setTouchInterceptor(View.OnTouchListenerl) Set a callback for all touch events being dispatched to the popup window.
void	setTouchModal(boolean touchModal) Set whether this window is touch modal or if outside touches will be sent to other windows behind it.
void	setTouchable(boolean touchable) Changes the touchability of the popup window.
void	setWidth(int width) Sets the popup’s requested width.
void	setWindowLayoutMode(int widthSpec, int heightSpec) This method was deprecated in API level 23. UsesetWidth(int)andsetHeight(int).
void	setWindowLayoutType(int layoutType) Set the layout type for this window.
void	showAsDropDown(Viewanchor) Display the content view in a popup window anchored to the bottom-left corner of the anchor view.
void	showAsDropDown(Viewanchor, int xoff, int yoff, int gravity) Displays the content view in a popup window anchored to the corner of another view.
void	showAsDropDown(Viewanchor, int xoff, int yoff) 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.
void	showAtLocation(Viewparent, int gravity, int x, int y) Display the content view in a popup window at the specified location.
void	update(Viewanchor, int width, int height) Updates the position and the dimension of the popup window.
void	update(Viewanchor, int xoff, int yoff, int width, int height) Updates the position and the dimension of the popup window.
void	update(int width, int height) Updates the dimension of the popup window.
void	update() Updates the state of the popup window, if it is currently being displayed, from the currently set state.
void	update(int x, int y, int width, int height, boolean force) Updates the position and the dimension of the popup window.
void	update(int x, int y, int width, int height) Updates the position and the dimension of the popup window.

| ### Inherited methods |
|———————–|—|
| From classjava.lang.Object |——————————————————————————–|———————————————————————————————————————————————————————————————————————————————————————————–| | Object | clone() Creates and returns a copy of this object. | | boolean | equals(Objectobj) Indicates whether some other object is “equal to” this one. | | void | finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. | | finalClass<?> | getClass() Returns the runtime class of thisObject. | | int | hashCode() Returns a hash code value for the object. | | final void | notify() Wakes up a single thread that is waiting on this object’s monitor. | | final void | notifyAll() Wakes up all threads that are waiting on this object’s monitor. | | String | toString() Returns a string representation of the object. | | final void | wait(long timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by beingnotified orinterrupted, or until a certain amount of real time has elapsed. | | final void | wait(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by beingnotified orinterrupted, or until a certain amount of real time has elapsed. | | final void | wait() Causes the current thread to wait until it is awakened, typically by beingnotified orinterrupted. | ||

XML attributes

android:overlapAnchor

Whether the popup window should overlap its anchor view.

May be a boolean value, such as “true” or “false“.

android:popupAnimationStyle

The animation style to use for the popup window.

May be a reference to another resource, in the form “@[+][package :]type /name” or a theme attribute in the form “?[package :]type /name“.

android:popupBackground

The background to use for the popup window.

May be a reference to another resource, in the form “@[+][package :]type /name” or a theme attribute in the form “?[package :]type /name“.

May be a color value, in the form of “#rgb“, “#argb“, “#rrggbb“, or “#aarrggbb“.

Related methods:

• setBackgroundDrawable(Drawable)

android:popupElevation

Window elevation to use for the popup window.

May be a dimension value, which is a floating point number appended with a unit such as “14.5sp“. Available units are: px (pixels), dp (density-independent pixels), sp (scaled pixels based on preferred font size), in (inches), and mm (millimeters).

Related methods:

• setElevation(float)

android:popupEnterTransition

Transition used to move views into the popup window.

May be a reference to another resource, in the form “@[+][package :]type /name” or a theme attribute in the form “?[package :]type /name“.

Related methods:

• setEnterTransition(Transition)

android:popupExitTransition

Transition used to move views out of the popup window.

May be a reference to another resource, in the form “@[+][package :]type /name” or a theme attribute in the form “?[package :]type /name“.

Related methods:

• setExitTransition(Transition)

Constants

INPUT_METHOD_FROM_FOCUSABLE

Added inAPI level 3

public static final int INPUT_METHOD_FROM_FOCUSABLE

Mode forsetInputMethodMode(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.

Constant Value: 0 (0x00000000)

INPUT_METHOD_NEEDED

Added inAPI level 3

public static final int INPUT_METHOD_NEEDED

Mode forsetInputMethodMode(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.

Constant Value: 1 (0x00000001)

INPUT_METHOD_NOT_NEEDED

Added inAPI level 3

public static final int INPUT_METHOD_NOT_NEEDED

Mode forsetInputMethodMode(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.

Constant Value: 2 (0x00000002)

Public constructors

PopupWindow

Added inAPI level 1

public PopupWindow ()

Create a new empty, non focusable popup window of dimension (0,0).

The popup does not provide any background. This should be handled by the content view.

PopupWindow

Added inAPI level 1

public PopupWindow (Context context)

Create a new empty, non focusable popup window of dimension (0,0).

The popup does provide a background.

Parameters
context	Context

PopupWindow

Added inAPI level 1

public PopupWindow (Context context, 
                AttributeSet attrs)

Create a new empty, non focusable popup window of dimension (0,0).

The popup does provide a background.

Parameters
context	Context
attrs	AttributeSet

PopupWindow

Added inAPI level 1

public PopupWindow (Context context, 
                AttributeSet attrs, 
                int defStyleAttr)

Create a new empty, non focusable popup window of dimension (0,0).

The popup does provide a background.

Parameters
context	Context
attrs	AttributeSet
defStyleAttr	int

PopupWindow

Added inAPI level 11

public PopupWindow (Context context, 
                AttributeSet attrs, 
                int defStyleAttr, 
                int defStyleRes)

Create a new, empty, non focusable popup window of dimension (0,0).

The popup does not provide a background.

Parameters
context	Context
attrs	AttributeSet
defStyleAttr	int
defStyleRes	int

PopupWindow

Added inAPI level 1

public PopupWindow (View contentView)

Create a new non focusable popup window which can display thecontentView. The dimension of the window are (0,0).

The popup does not provide any background. This should be handled by the content view.

Parameters
contentView	View: the popup’s content

PopupWindow

Added inAPI level 1

public PopupWindow (View contentView, 
                int width, 
                int height)

Create a new non focusable popup window which can display thecontentView. The dimension of the window must be passed to this constructor.

The popup does not provide any background. This should be handled by the content view.

Parameters
contentView	View: the popup’s content
width	int: the popup’s width
height	int: the popup’s height

PopupWindow

Added inAPI level 1

public PopupWindow (View contentView, 
                int width, 
                int height, 
                boolean focusable)

Create a new popup window which can display thecontentView. The dimension of the window must be passed to this constructor.

The popup does not provide any background. This should be handled by the content view.

Parameters
contentView	View: the popup’s content
width	int: the popup’s width
height	int: the popup’s height
focusable	boolean: true if the popup can be focused, false otherwise

PopupWindow

Added inAPI level 1

public PopupWindow (int width, 
                int height)

Create a new empty, non focusable popup window. The dimension of the window must be passed to this constructor.

The popup does not provide any background. This should be handled by the content view.

Parameters
width	int: the popup’s width
height	int: the popup’s height

Public methods

dismiss

Added inAPI level 1

public void dismiss ()

Disposes of the popup window. This method can be invoked only aftershowAsDropDown(android.view.View)has been executed. Failing that, calling this method will have no effect.

See also:

• showAsDropDown(android.view.View)

getAnimationStyle

Added inAPI level 1

public int getAnimationStyle ()

Return the animation style to use the popup appears and disappears

Returns
int	the animation style to use the popup appears and disappears

getBackground

Added inAPI level 1

public Drawable getBackground ()

Return the drawable used as the popup window’s background.

Related XML Attributes:

• android:popupBackground

Returns
Drawable	the background drawable ornullif not set

See also:

• setBackgroundDrawable(Drawable)

getContentView

Added inAPI level 1

public View getContentView ()

Return the view used as the content of the popup window.

Returns
View	aViewrepresenting the popup’s content

See also:

• setContentView(android.view.View)

getElevation

Added inAPI level 21

public float getElevation ()

Related XML Attributes:

• android:popupElevation

Returns
float	the elevation for this popup window in pixels

See also:

• setElevation(float)

getEnterTransition

Added inAPI level 24

public Transition getEnterTransition ()

Returns the enter transition to be used when the popup window is shown.

Related XML Attributes:

• android:popupEnterTransition

Returns
Transition	the enter transition, ornullif not set

See also:

• setEnterTransition(Transition)

getEpicenterBounds

Added inAPI level 29

public Rect getEpicenterBounds ()

Returns bounds which are used as a center of the enter and exit transitions.

Transitions use Rect, referred to as the epicenter, to orient the direction of travel. For popup windows, the anchor view bounds are used as the default epicenter.

SeeTransition.setEpicenterCallback(EpicenterCallback)for more information about how transition epicenters work.

Returns
Rect	bounds relative to anchor view, ornullif not set

See also:

• setEpicenterBounds(Rect)

getExitTransition

Added inAPI level 24

public Transition getExitTransition ()

Returns the exit transition to be used when the popup window is dismissed.

Related XML Attributes:

• android:popupExitTransition

Returns
Transition	the exit transition, ornullif not set

See also:

• setExitTransition(Transition)

getHeight

Added inAPI level 1

public int getHeight ()

Returns the popup’s requested height. May be a layout constant such asLayoutParams.WRAP_CONTENTorLayoutParams.MATCH_PARENT.

The actual size of the popup may depend on other factors such as clipping and window layout.

Returns
int	the popup height in pixels or a layout constant

See also:

• setHeight(int)

getInputMethodMode

Added inAPI level 3

public int getInputMethodMode ()

Return the current value insetInputMethodMode(int).

Returns
int

See also:

• setInputMethodMode(int)

getMaxAvailableHeight

Added inAPI level 1

public int getMaxAvailableHeight (View anchor)

Returns the maximum height that is available for the popup to be completely shown. It is recommended that this height be the maximum for the popup’s height, otherwise it is possible that the popup will be clipped.

Parameters
anchor	View: The view on which the popup window must be anchored. This value cannot benull.

Returns
int	The maximum available height for the popup to be completely shown.

getMaxAvailableHeight

Added inAPI level 3

public int getMaxAvailableHeight (View anchor, 
                int yOffset)

Returns the maximum height that is available for the popup to be completely shown. It is recommended that this height be the maximum for the popup’s height, otherwise it is possible that the popup will be clipped.

Parameters
anchor	View: The view on which the popup window must be anchored. This value cannot benull.
yOffset	int: y offset from the view’s bottom edge

Returns
int	The maximum available height for the popup to be completely shown.

getMaxAvailableHeight

Added inAPI level 24

public int getMaxAvailableHeight (View anchor, 
                int yOffset, 
                boolean ignoreBottomDecorations)

Returns the maximum height that is available for the popup to be completely shown, optionally ignoring any bottom decorations such as the input method. It is recommended that this height be the maximum for the popup’s height, otherwise it is possible that the popup will be clipped.

Parameters
anchor	View: The view on which the popup window must be anchored. This value cannot benull.
yOffset	int: y offset from the view’s bottom edge
ignoreBottomDecorations	boolean: if true, the height returned will be all the way to the bottom of the display, ignoring any bottom decorations

Returns
int	The maximum available height for the popup to be completely shown.

getOverlapAnchor

Added inAPI level 23

public boolean getOverlapAnchor ()

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.

See also:

• setOverlapAnchor(boolean)

getSoftInputMode

Added inAPI level 4

public int getSoftInputMode ()

Returns the current value insetSoftInputMode(int).

Returns

int

Value is either0or a combination ofWindowManager.LayoutParams.SOFT_INPUT_STATE_UNSPECIFIED,WindowManager.LayoutParams.SOFT_INPUT_STATE_UNCHANGED,WindowManager.LayoutParams.SOFT_INPUT_STATE_HIDDEN,WindowManager.LayoutParams.SOFT_INPUT_STATE_ALWAYS_HIDDEN,WindowManager.LayoutParams.SOFT_INPUT_STATE_VISIBLE,WindowManager.LayoutParams.SOFT_INPUT_STATE_ALWAYS_VISIBLE,WindowManager.LayoutParams.SOFT_INPUT_ADJUST_UNSPECIFIED,WindowManager.LayoutParams.SOFT_INPUT_ADJUST_RESIZE,WindowManager.LayoutParams.SOFT_INPUT_ADJUST_PAN,WindowManager.LayoutParams.SOFT_INPUT_ADJUST_NOTHING, andWindowManager.LayoutParams.SOFT_INPUT_IS_FORWARD_NAVIGATION

See also:

• setSoftInputMode(int)
• WindowManager.LayoutParams.softInputMode

getWidth

Added inAPI level 1

public int getWidth ()

Returns the popup’s requested width. May be a layout constant such asLayoutParams.WRAP_CONTENTorLayoutParams.MATCH_PARENT.

The actual size of the popup may depend on other factors such as clipping and window layout.

Returns
int	the popup width in pixels or a layout constant

See also:

• setWidth(int)

getWindowLayoutType

Added inAPI level 23

public int getWindowLayoutType ()

Returns the layout type for this window.

Returns
int

See also:

• setWindowLayoutType(int)

isAboveAnchor

Added inAPI level 3

public boolean isAboveAnchor ()

Indicates whether the popup is showing above (the y coordinate of the popup’s bottom is less than the y coordinate of the anchor) or below the anchor view (the y coordinate of the popup is greater than y coordinate of the anchor’s bottom). The value returned by this method is meaningful only aftershowAsDropDown(android.view.View)orshowAsDropDown(android.view.View, int, int)was invoked.

Returns
boolean	True if this popup is showing above the anchor view, false otherwise.

isAttachedInDecor

Added inAPI level 22

public boolean isAttachedInDecor ()

Indicates whether the popup window will be attached in the decor frame of its parent window.

Returns
boolean	true if the window will be attached to the decor frame of its parent window.

See also:

• setAttachedInDecor(boolean)
• WindowManager.LayoutParams.FLAG_LAYOUT_ATTACHED_IN_DECOR

isClippedToScreen

Added inAPI level 29

public boolean isClippedToScreen ()

Indicates whether this popup will be clipped to the screen and not to the containing window

Returns
boolean	true if popup will be clipped to the screen instead of the window, false otherwise

See also:

• setIsClippedToScreen(boolean)

isClippingEnabled

Added inAPI level 3

public boolean isClippingEnabled ()

Indicates whether clipping of the popup window is enabled.

Returns
boolean	true if the clipping is enabled, false otherwise

See also:

• setClippingEnabled(boolean)

isFocusable

Added inAPI level 1

public boolean isFocusable ()

Indicate whether the popup window can grab the focus.

Returns
boolean	true if the popup is focusable, false otherwise

See also:

• setFocusable(boolean)

isLaidOutInScreen

Added inAPI level 29

public boolean isLaidOutInScreen ()

Indicates whether the popup window will be forced into using absolute screen coordinates for positioning.

Returns
boolean	true if the window will always be positioned in screen coordinates.

See also:

• setIsLaidOutInScreen(boolean)

isOutsideTouchable

Added inAPI level 3

public boolean isOutsideTouchable ()

Indicates whether the popup window will be informed of touch events outside of its window.

Returns
boolean	true if the popup is outside touchable, false otherwise

See also:

• setOutsideTouchable(boolean)

isShowing

Added inAPI level 1

public boolean isShowing ()

Indicate whether this popup window is showing on screen.

Returns
boolean	true if the popup is showing, false otherwise

isSplitTouchEnabled

Added inAPI level 11

public boolean isSplitTouchEnabled ()

Indicates whether the popup window supports splitting touches.

Returns
boolean	true if the touch splitting is enabled, false otherwise

See also:

• setSplitTouchEnabled(boolean)

isTouchModal

Added inAPI level 29

public boolean isTouchModal ()

Indicates whether outside touches will be sent to this window or other windows behind it

Returns
boolean	true if touches will be sent to this window, false otherwise

See also:

• setTouchModal(boolean)

isTouchable

Added inAPI level 3

public boolean isTouchable ()

Indicates whether the popup window receives touch events.

Returns
boolean	true if the popup is touchable, false otherwise

See also:

• setTouchable(boolean)

setAnimationStyle

Added inAPI level 1

public void setAnimationStyle (int animationStyle)

Change the animation style resource for this popup.

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 one of theupdate()methods.

Parameters
animationStyle	int: animation style to use when the popup appears and disappears. Set to -1 for the default animation, 0 for no animation, or a resource identifier for an explicit animation.

See also:

• update()

setAttachedInDecor

Added inAPI level 22

public void setAttachedInDecor (boolean enabled)

This will attach the popup window to the decor frame of the parent window to avoid overlaping with screen decorations like the navigation bar. Overrides the default behavior of the flagWindowManager.LayoutParams.FLAG_LAYOUT_ATTACHED_IN_DECOR.

By default the flag is set on SDK versionBuild.VERSION_CODES.LOLLIPOP_MR1or greater and cleared on lesser SDK versions.

Parameters
enabled	boolean: true if the popup should be attached to the decor frame of its parent window.

See also:

• WindowManager.LayoutParams.FLAG_LAYOUT_ATTACHED_IN_DECOR

setBackgroundDrawable

Added inAPI level 1

public void setBackgroundDrawable (Drawable background)

Specifies the background drawable for this popup window. The background can be set tonull.

Related XML Attributes:

• android:popupBackground

Parameters
background	Drawable: the popup’s background

See also:

• getBackground()

setClippingEnabled

Added inAPI level 3

public void setClippingEnabled (boolean enabled)

Allows the popup window to extend beyond the bounds of the screen. By default the window is clipped to the screen boundaries. Setting this to false will allow windows to be accurately positioned.

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 one of theupdate()methods.

Parameters
enabled	boolean: false if the window should be allowed to extend outside of the screen

See also:

• isShowing()
• isClippingEnabled()
• update()

setContentView

Added inAPI level 1

public void setContentView (View contentView)

Change the popup’s content. The content is represented by an instance ofView.

This method has no effect if called when the popup is showing.

Parameters
contentView	View: the new content for the popup

See also:

• getContentView()
• isShowing()

setElevation

Added inAPI level 21

public void setElevation (float elevation)

Specifies the elevation for this popup window.

Related XML Attributes:

• android:popupElevation

Parameters
elevation	float: the popup’s elevation in pixels

See also:

• getElevation()

setEnterTransition

Added inAPI level 23

public void setEnterTransition (Transition enterTransition)

Sets the enter transition to be used when the popup window is shown.

Related XML Attributes:

• android:popupEnterTransition

Parameters
enterTransition	Transition: the enter transition, ornullto clear

See also:

• getEnterTransition()

setEpicenterBounds

Added inAPI level 29

public void setEpicenterBounds (Rect bounds)

Sets the bounds used as the epicenter of the enter and exit transitions.

Transitions use Rect, referred to as the epicenter, to orient the direction of travel. For popup windows, the anchor view bounds are used as the default epicenter.

SeeTransition.setEpicenterCallback(EpicenterCallback)for more information about how transition epicenters work.

Parameters
bounds	Rect: the epicenter bounds relative to the anchor view, ornullto use the default epicenter

See also:

• getEpicenterBounds()

setExitTransition

Added inAPI level 23

public void setExitTransition (Transition exitTransition)

Sets the exit transition to be used when the popup window is dismissed.

Related XML Attributes:

• android:popupExitTransition

Parameters
exitTransition	Transition: the exit transition, ornullto clear

See also:

• getExitTransition()

setFocusable

Added inAPI level 1

public void setFocusable (boolean focusable)

Changes the focusability of the popup window. When focusable, the window will grab the focus from the current focused widget if the popup contains a focusableView. By default a popup window is not focusable.

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 one of theupdate()methods.

Parameters
focusable	boolean: true if the popup should grab focus, false otherwise.

See also:

• isFocusable()
• isShowing()
• update()

setHeight

Added inAPI level 1

public void setHeight (int height)

Sets the popup’s requested height. May be a layout constant such asLayoutParams.WRAP_CONTENTorLayoutParams.MATCH_PARENT.

The actual size of the popup may depend on other factors such as clipping and window layout.

If the popup is showing, calling this method will take effect the next time the popup is shown.

Parameters
height	int: the popup height in pixels or a layout constant

See also:

• getHeight()
• isShowing()

setIgnoreCheekPress

Added inAPI level 1

public void setIgnoreCheekPress ()

Set the flag on popup to ignore cheek press events; by default this flag is set to false which means the popup will not ignore cheek press dispatch events.

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 one of theupdate()methods.

See also:

• update()

setInputMethodMode

Added inAPI level 3

public void setInputMethodMode (int mode)

Control how the popup operates with an input method: one ofINPUT_METHOD_FROM_FOCUSABLE,INPUT_METHOD_NEEDED, orINPUT_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 one of theupdate()methods.

Parameters
mode	int

See also:

• getInputMethodMode()
• update()

setIsClippedToScreen

Added inAPI level 29

public void setIsClippedToScreen (boolean enabled)

Clip this popup window to the screen, but not to the containing window.

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 one of theupdate()methods.

Parameters
enabled	boolean: true to clip to the screen.

See also:

• isClippedToScreen()

setIsLaidOutInScreen

Added inAPI level 29

public void setIsLaidOutInScreen (boolean enabled)

Allows the popup window to force the flagWindowManager.LayoutParams.FLAG_LAYOUT_IN_SCREEN, overriding default behavior. This will cause the popup to be positioned in absolute screen coordinates.

Parameters
enabled	boolean: true if the popup should always be positioned in screen coordinates

See also:

• isLaidOutInScreen()

setOnDismissListener

Added inAPI level 1

public void setOnDismissListener (PopupWindow.OnDismissListener onDismissListener)

Sets the listener to be called when the window is dismissed.

Parameters
onDismissListener	PopupWindow.OnDismissListener: The listener.

setOutsideTouchable

Added inAPI level 3

public void setOutsideTouchable (boolean touchable)

Controls whether the pop-up will be informed of touch events outside of its window. This only makes sense for pop-ups that are touchable but not focusable, which means touches outside of the window will be delivered to the window behind. The default is false.

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 one of theupdate()methods.

Parameters
touchable	boolean: true if the popup should receive outside touch events, false otherwise

See also:

• isOutsideTouchable()
• isShowing()
• update()

setOverlapAnchor

Added inAPI level 23

public void setOverlapAnchor (boolean overlapAnchor)

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

If the popup is showing, calling this method will take effect only the next time the popup is shown.

Parameters
overlapAnchor	boolean: Whether the popup should overlap its anchor.

See also:

• getOverlapAnchor()
• isShowing()

setSoftInputMode

Added inAPI level 4

public void setSoftInputMode (int mode)

Sets the operating mode for the soft input area.

Parameters

mode

int: The desired mode, seeWindowManager.LayoutParams.softInputModefor the full list Value is either0or a combination ofWindowManager.LayoutParams.SOFT_INPUT_STATE_UNSPECIFIED,WindowManager.LayoutParams.SOFT_INPUT_STATE_UNCHANGED,WindowManager.LayoutParams.SOFT_INPUT_STATE_HIDDEN,WindowManager.LayoutParams.SOFT_INPUT_STATE_ALWAYS_HIDDEN,WindowManager.LayoutParams.SOFT_INPUT_STATE_VISIBLE,WindowManager.LayoutParams.SOFT_INPUT_STATE_ALWAYS_VISIBLE,WindowManager.LayoutParams.SOFT_INPUT_ADJUST_UNSPECIFIED,WindowManager.LayoutParams.SOFT_INPUT_ADJUST_RESIZE,WindowManager.LayoutParams.SOFT_INPUT_ADJUST_PAN,WindowManager.LayoutParams.SOFT_INPUT_ADJUST_NOTHING, andWindowManager.LayoutParams.SOFT_INPUT_IS_FORWARD_NAVIGATION

See also:

• WindowManager.LayoutParams.softInputMode
• getSoftInputMode()

setSplitTouchEnabled

Added inAPI level 11

public void setSplitTouchEnabled (boolean enabled)

Allows the popup window to split touches across other windows that also support split touch. When this flag is false, the first pointer that goes down determines the window to which all subsequent touches go until all pointers go up. When this flag is true, each pointer (not necessarily the first) that goes down determines the window to which all subsequent touches of that pointer will go until that pointer goes up thereby enabling touches with multiple pointers to be split across multiple windows.

Parameters
enabled	boolean: true if the split touches should be enabled, false otherwise

See also:

• isSplitTouchEnabled()

setTouchInterceptor

Added inAPI level 3

public void setTouchInterceptor (View.OnTouchListener l)

Set a callback for all touch events being dispatched to the popup window.

Parameters
l	View.OnTouchListener

setTouchModal

Added inAPI level 29

public void setTouchModal (boolean touchModal)

Set whether this window is touch modal or if outside touches will be sent to other windows behind it.

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 one of theupdate()methods.

Parameters
touchModal	boolean: true to sent all outside touches to this window, false to other windows behind it

See also:

• isTouchModal()

setTouchable

Added inAPI level 3

public void setTouchable (boolean touchable)

Changes the touchability of the popup window. When touchable, the window will receive touch events, otherwise touch events will go to the window below it. By default the window is touchable.

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 one of theupdate()methods.

Parameters
touchable	boolean: true if the popup should receive touch events, false otherwise

See also:

• isTouchable()
• isShowing()
• update()

setWidth

Added inAPI level 1

public void setWidth (int width)

Sets the popup’s requested width. May be a layout constant such asLayoutParams.WRAP_CONTENTorLayoutParams.MATCH_PARENT.

The actual size of the popup may depend on other factors such as clipping and window layout.

If the popup is showing, calling this method will take effect the next time the popup is shown.

Parameters
width	int: the popup width in pixels or a layout constant

See also:

• getWidth()
• isShowing()

setWindowLayoutMode

Added inAPI level 3
Deprecated inAPI level 23

public void setWindowLayoutMode (int widthSpec, 
                int heightSpec)

This method was deprecated in API level 23.
UsesetWidth(int)andsetHeight(int).

Change the width and height measure specs that are given to the window manager by the popup. By default these are 0, meaning that the current width or height is requested as an explicit size from the window manager. You can supplyViewGroup.LayoutParams.WRAP_CONTENTorViewGroup.LayoutParams.MATCH_PARENTto have that measure spec supplied instead, replacing the absolute width and height that has been set in the popup.

If the popup is showing, calling this method will take effect only the next time the popup is shown.

Parameters
widthSpec	int: an explicit width measure spec mode, eitherViewGroup.LayoutParams.WRAP_CONTENT,ViewGroup.LayoutParams.MATCH_PARENT, or 0 to use the absolute width.
heightSpec	int: an explicit height measure spec mode, eitherViewGroup.LayoutParams.WRAP_CONTENT,ViewGroup.LayoutParams.MATCH_PARENT, or 0 to use the absolute height.

setWindowLayoutType

Added inAPI level 23

public void setWindowLayoutType (int layoutType)

Set the layout type for this window.

SeeWindowManager.LayoutParams.typefor possible values.

Parameters
layoutType	int: Layout type for this window.

See also:

• WindowManager.LayoutParams.type

showAsDropDown

Added inAPI level 1

public void showAsDropDown (View anchor)

Display the content view in a popup window anchored to the bottom-left corner of the anchor view. 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.

Parameters
anchor	View: the view on which to pin the popup window

See also:

• dismiss()

showAsDropDown

Added inAPI level 19

public void showAsDropDown (View anchor, 
                int xoff, 
                int yoff, 
                int gravity)

Displays the content view in a popup window anchored to the corner of another view. The window is positioned according to the specified gravity and 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 view can be scrolled, the specified vertical gravity will be ignored and the popup will anchor itself such that it is visible.

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

Parameters
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

See also:

• dismiss()

showAsDropDown

Added inAPI level 1

public void showAsDropDown (View anchor, 
                int xoff, 
                int yoff)

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 moveanchorto a different location, the popup will be moved correspondingly.

Parameters
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

See also:

• dismiss()

showAtLocation

Added inAPI level 1

public void showAtLocation (View parent, 
                int gravity, 
                int x, 
                int y)

Display the content view in a popup window at the specified location. If the popup window cannot fit on screen, it will be clipped. SeeWindowManager.LayoutParamsfor more information on how gravity and the x and y parameters are related. Specifying a gravity ofGravity.NO_GRAVITYis similar to specifyingGravity.LEFT | Gravity.TOP.

Parameters
parent	View: a parent view to get theView.getWindowToken()token from
gravity	int: the gravity which controls the placement of the popup window
x	int: the popup’s x location offset
y	int: the popup’s y location offset

update

Added inAPI level 1

public void update (View anchor, 
                int width, 
                int height)

Updates the position and the dimension of the popup window.

Calling this function also updates the window with the current popup state as described forupdate().

Parameters
anchor	View: the popup’s anchor view
width	int: the new width in pixels, must be >= 0 or -1 to ignore
height	int: the new height in pixels, must be >= 0 or -1 to ignore

update

Added inAPI level 1

public void update (View anchor, 
                int xoff, 
                int yoff, 
                int width, 
                int height)

Updates the position and the dimension of the popup window.

Width and height can be set to -1 to update location only. Calling this function also updates the window with the current popup state as described forupdate().

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

Parameters
anchor	View: the popup’s anchor view
xoff	int: x offset from the view’s left edge
yoff	int: y offset from the view’s bottom edge
width	int: the new width in pixels, must be >= 0 or -1 to ignore
height	int: the new height in pixels, must be >= 0 or -1 to ignore

update

Added inAPI level 4

public void update (int width, 
                int height)

Updates the dimension of the popup window.

Calling this function also updates the window with the current popup state as described forupdate().

Parameters
width	int: the new width in pixels, must be >= 0 or -1 to ignore
height	int: the new height in pixels, must be >= 0 or -1 to ignore

update

Added inAPI level 3

public void update ()

Updates the state of the popup window, if it is currently being displayed, from the currently set state.

This includes:

• setClippingEnabled(boolean)
• setFocusable(boolean)
• setIgnoreCheekPress()
• setInputMethodMode(int)
• setTouchable(boolean)
• setAnimationStyle(int)
• setTouchModal(boolean)(boolean)}
• setIsClippedToScreen(boolean)

update

Added inAPI level 3

public void update (int x, 
                int y, 
                int width, 
                int height, 
                boolean force)

Updates the position and the dimension of the popup window.

Width and height can be set to -1 to update location only. Calling this function also updates the window with the current popup state as described forupdate().

Parameters
x	int: the new x location
y	int: the new y location
width	int: the new width in pixels, must be >= 0 or -1 to ignore
height	int: the new height in pixels, must be >= 0 or -1 to ignore
force	boolean:trueto reposition the window even if the specified position already seems to correspond to the LayoutParams,falseto only reposition if needed

update

Added inAPI level 1

public void update (int x, 
                int y, 
                int width, 
                int height)

Updates the position and the dimension of the popup window.

Width and height can be set to -1 to update location only. Calling this function also updates the window with the current popup state as described forupdate().

Parameters
x	int: the new x location
y	int: the new y location
width	int: the new width in pixels, must be >= 0 or -1 to ignore
height	int: the new height in pixels, must be >= 0 or -1 to ignore