PopupWindow

INPUT_METHOD_FROM_FOCUSABLE

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.

Constant Value: 0 (0x00000000)

INPUT_METHOD_NEEDED

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.

Constant Value: 1 (0x00000001)

INPUT_METHOD_NOT_NEEDED

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.

Constant Value: 2 (0x00000002)

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, 
                AttributeSet attrs)

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

The popup does provide a background.

PopupWindow

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.

PopupWindow

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.

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 (View contentView)

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

PopupWindow

PopupWindow (View contentView, 
                int width, 
                int height)

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 (View contentView, 
                int width, 
                int height, 
                boolean focusable)

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.

dismiss

void dismiss ()

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

int getAnimationStyle ()

Return the animation style to use the popup appears and disappears

getBackground

Drawable getBackground ()

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

Related XML Attributes:

• android:popupBackground

getContentView

View getContentView ()

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

getElevation

float getElevation ()

Related XML Attributes:

• android:popupElevation

getEnterTransition

Transition getEnterTransition ()

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

Related XML Attributes:

• android:popupEnterTransition

getExitTransition

Transition getExitTransition ()

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

Related XML Attributes:

• android:popupExitTransition

getHeight

int getHeight ()

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

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

getInputMethodMode

int getInputMethodMode ()

Return the current value in setInputMethodMode(int).

getMaxAvailableHeight

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.

getMaxAvailableHeight

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.

getMaxAvailableHeight

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.

getOverlapAnchor

boolean getOverlapAnchor ()

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

getSoftInputMode

int getSoftInputMode ()

Returns the current value in setSoftInputMode(int).

getWidth

int getWidth ()

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

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

getWindowLayoutType

int getWindowLayoutType ()

Returns the layout type for this window.

isAboveAnchor

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

isAttachedInDecor

boolean isAttachedInDecor ()

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

isClippingEnabled

boolean isClippingEnabled ()

Indicates whether clipping of the popup window is enabled.

isFocusable

boolean isFocusable ()

Indicate whether the popup window can grab the focus.

isOutsideTouchable

boolean isOutsideTouchable ()

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

isShowing

boolean isShowing ()

Indicate whether this popup window is showing on screen.

isSplitTouchEnabled

boolean isSplitTouchEnabled ()

Indicates whether the popup window supports splitting touches.

isTouchable

boolean isTouchable ()

Indicates whether the popup window receives touch events.

setAnimationStyle

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

setAttachedInDecor

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

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

setBackgroundDrawable

void setBackgroundDrawable (Drawable background)

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

Related XML Attributes:

• android:popupBackground

setClippingEnabled

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

setContentView

void setContentView (View contentView)

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

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

setElevation

void setElevation (float elevation)

Specifies the elevation for this popup window.

Related XML Attributes:

• android:popupElevation

setEnterTransition

void setEnterTransition (Transition enterTransition)

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

Related XML Attributes:

• android:popupEnterTransition

setExitTransition

void setExitTransition (Transition exitTransition)

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

Related XML Attributes:

• android:popupExitTransition

setFocusable

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 focusable 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

void setHeight (int height)

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

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

setInputMethodMode

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

setOnDismissListener

void setOnDismissListener (PopupWindow.OnDismissListener onDismissListener)

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

setOutsideTouchable

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

setOverlapAnchor

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.

setSoftInputMode

void setSoftInputMode (int mode)

Sets the operating mode for the soft input area.

setSplitTouchEnabled

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.

setTouchInterceptor

void setTouchInterceptor (View.OnTouchListener l)

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

setTouchable

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

setWidth

void setWidth (int width)

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

void setWindowLayoutMode (int widthSpec, 
                int heightSpec)

This method was deprecated in API level 23.
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 WRAP_CONTENT or 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

void setWindowLayoutType (int layoutType)

Set the layout type for this window.

See type for possible values.

showAsDropDown

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.

showAsDropDown

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

showAsDropDown

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

showAtLocation

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. See WindowManager.LayoutParams for more information on how gravity and the x and y parameters are related. Specifying a gravity of NO_GRAVITY is similar to specifying Gravity.LEFT | Gravity.TOP.

update

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

update

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

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

update

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

update

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)

update

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

update

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