PopupWindow

INPUT_METHOD_FROM_FOCUSABLE

static val INPUT_METHOD_FROM_FOCUSABLE: Int

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.

Value: 0

INPUT_METHOD_NEEDED

static val INPUT_METHOD_NEEDED: Int

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.

Value: 1

INPUT_METHOD_NOT_NEEDED

static val INPUT_METHOD_NOT_NEEDED: Int

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.

Value: 2

PopupWindow

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

PopupWindow(context: Context!)

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

The popup does provide a background.

PopupWindow

PopupWindow(
    context: Context!, 
    attrs: AttributeSet!)

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

The popup does provide a background.

PopupWindow

PopupWindow(
    context: Context!, 
    attrs: AttributeSet!, 
    defStyleAttr: Int)

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

The popup does provide a background.

PopupWindow

PopupWindow(
    context: Context!, 
    attrs: AttributeSet!, 
    defStyleAttr: Int, 
    defStyleRes: Int)

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

The popup does not provide a background.

PopupWindow

PopupWindow(contentView: View!)

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

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

PopupWindow

PopupWindow(
    contentView: View!, 
    width: Int, 
    height: Int)

Create a new non focusable popup window which can display the contentView. 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.

PopupWindow

PopupWindow(
    contentView: View!, 
    width: Int, 
    height: Int, 
    focusable: Boolean)

Create a new popup window which can display the contentView. 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.

PopupWindow

PopupWindow(
    width: Int, 
    height: Int)

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.

dismiss

open fun dismiss(): Unit

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

getAnimationStyle

open fun getAnimationStyle(): Int

Return the animation style to use the popup appears and disappears

getBackground

open fun getBackground(): Drawable!

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

getContentView

open fun getContentView(): View!

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

getElevation

open fun getElevation(): Float

getEnterTransition

open fun getEnterTransition(): Transition?

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

getEpicenterBounds

open fun getEpicenterBounds(): Rect?

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.

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

getExitTransition

open fun getExitTransition(): Transition?

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

getHeight

open fun getHeight(): Int

Returns the popup's requested height. May be a layout constant such as LayoutParams.WRAP_CONTENT or LayoutParams.MATCH_PARENT.

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

getInputMethodMode

open fun getInputMethodMode(): Int

Return the current value in setInputMethodMode(int).

getMaxAvailableHeight

open fun getMaxAvailableHeight(anchor: View): Int

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.

getMaxAvailableHeight

open fun getMaxAvailableHeight(
    anchor: View, 
    yOffset: Int
): Int

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.

getMaxAvailableHeight

open fun getMaxAvailableHeight(
    anchor: View, 
    yOffset: Int, 
    ignoreBottomDecorations: Boolean
): Int

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.

getOverlapAnchor

open fun getOverlapAnchor(): Boolean

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

getSoftInputMode

open fun getSoftInputMode(): Int

Returns the current value in setSoftInputMode(int).

getWidth

open fun getWidth(): Int

Returns the popup's requested width. May be a layout constant such as LayoutParams.WRAP_CONTENT or LayoutParams.MATCH_PARENT.

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

getWindowLayoutType

open fun getWindowLayoutType(): Int

Returns the layout type for this window.

isAboveAnchor

open fun isAboveAnchor(): Boolean

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 after showAsDropDown(android.view.View) or showAsDropDown(android.view.View,int,int) was invoked.

isAttachedInDecor

open fun isAttachedInDecor(): Boolean

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

isClippedToScreen

open fun isClippedToScreen(): Boolean

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

isClippingEnabled

open fun isClippingEnabled(): Boolean

Indicates whether clipping of the popup window is enabled.

isFocusable

open fun isFocusable(): Boolean

Indicate whether the popup window can grab the focus.

isLaidOutInScreen

open fun isLaidOutInScreen(): Boolean

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

isOutsideTouchable

open fun isOutsideTouchable(): Boolean

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

isShowing

open fun isShowing(): Boolean

Indicate whether this popup window is showing on screen.

isSplitTouchEnabled

open fun isSplitTouchEnabled(): Boolean

Indicates whether the popup window supports splitting touches.

isTouchModal

open fun isTouchModal(): Boolean

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

isTouchable

open fun isTouchable(): Boolean

Indicates whether the popup window receives touch events.

setAnimationStyle

open fun setAnimationStyle(animationStyle: Int): Unit

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 the update() methods.

setAttachedInDecor

open fun setAttachedInDecor(enabled: Boolean): Unit

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 flag WindowManager.LayoutParams.FLAG_LAYOUT_ATTACHED_IN_DECOR.

By default the flag is set on SDK version Build.VERSION_CODES.LOLLIPOP_MR1 or greater and cleared on lesser SDK versions.

setBackgroundDrawable

open fun setBackgroundDrawable(background: Drawable!): Unit

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

setClippingEnabled

open fun setClippingEnabled(enabled: Boolean): Unit

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 the update() methods.

setContentView

open fun setContentView(contentView: View!): Unit

Change the popup's content. The content is represented by an instance of android.view.View.

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

setElevation

open fun setElevation(elevation: Float): Unit

Specifies the elevation for this popup window.

setEnterTransition

open fun setEnterTransition(enterTransition: Transition?): Unit

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

setEpicenterBounds

open fun setEpicenterBounds(bounds: Rect?): Unit

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.

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

setExitTransition

open fun setExitTransition(exitTransition: Transition?): Unit

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

setFocusable

open fun setFocusable(focusable: Boolean): Unit

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 focusable android.view.View. 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 the update() methods.

setHeight

open fun setHeight(height: Int): Unit

Sets the popup's requested height. May be a layout constant such as LayoutParams.WRAP_CONTENT or LayoutParams.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.

setIgnoreCheekPress

open fun setIgnoreCheekPress(): Unit

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 the update() methods.

setInputMethodMode

open 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 one of the update() methods.

setIsClippedToScreen

open fun setIsClippedToScreen(enabled: Boolean): Unit

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 the update() methods.

setIsLaidOutInScreen

open fun setIsLaidOutInScreen(enabled: Boolean): Unit

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

setOnDismissListener

open fun setOnDismissListener(onDismissListener: PopupWindow.OnDismissListener!): Unit

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

setOutsideTouchable

open fun setOutsideTouchable(touchable: Boolean): Unit

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 the update() methods.

setOverlapAnchor

open fun setOverlapAnchor(overlapAnchor: Boolean): Unit

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.

setSoftInputMode

open fun setSoftInputMode(mode: Int): Unit

Sets the operating mode for the soft input area.

setSplitTouchEnabled

open fun setSplitTouchEnabled(enabled: Boolean): Unit

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.

setTouchInterceptor

open fun setTouchInterceptor(l: View.OnTouchListener!): Unit

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

setTouchModal

open fun setTouchModal(touchModal: Boolean): Unit

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 the update() methods.

setTouchable

open fun setTouchable(touchable: Boolean): Unit

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 the update() methods.

setWidth

open fun setWidth(width: Int): Unit

Sets the popup's requested width. May be a layout constant such as LayoutParams.WRAP_CONTENT or LayoutParams.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.

setWindowLayoutMode

open fun setWindowLayoutMode(
    widthSpec: Int, 
    heightSpec: Int
): Unit

Deprecated: Use setWidth(int) and setHeight(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 supply ViewGroup.LayoutParams.WRAP_CONTENT or ViewGroup.LayoutParams.MATCH_PARENT to 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.

setWindowLayoutType

open fun setWindowLayoutType(layoutType: Int): Unit

Set the layout type for this window.

See WindowManager.LayoutParams.type for possible values.

showAsDropDown

open fun showAsDropDown(anchor: View!): Unit

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.

showAsDropDown

open fun showAsDropDown(
    anchor: View!, 
    xoff: Int, 
    yoff: 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.

showAsDropDown

open fun showAsDropDown(
    anchor: View!, 
    xoff: Int, 
    yoff: Int, 
    gravity: Int
): Unit

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

showAtLocation

open fun showAtLocation(
    parent: View!, 
    gravity: Int, 
    x: Int, 
    y: Int
): Unit

Display the content view in a popup window at the specified location. If the popup window cannot fit on screen, it will be clipped. See android.view.WindowManager.LayoutParams for more information on how gravity and the x and y parameters are related. Specifying a gravity of android.view.Gravity#NO_GRAVITY is similar to specifying Gravity.LEFT | Gravity.TOP.

update

open fun update(): Unit

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

open fun update(
    anchor: View!, 
    width: Int, 
    height: Int
): Unit

Updates the position and the dimension of the popup window.

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

update

open fun update(
    anchor: View!, 
    xoff: Int, 
    yoff: Int, 
    width: Int, 
    height: Int
): Unit

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 for update().

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

update

open fun update(
    width: Int, 
    height: Int
): Unit

Updates the dimension of the popup window.

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

update

open fun update(
    x: Int, 
    y: Int, 
    width: Int, 
    height: Int
): Unit

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 for update().

update

open fun update(
    x: Int, 
    y: Int, 
    width: Int, 
    height: Int, 
    force: Boolean
): Unit

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 for update().