JBPopup (Unofficial IntelliJ Community Edition API docs)

All Superinterfaces:

Disposable

All Known Subinterfaces:

ListPopup, TreePopup

All Known Implementing Classes:

AbstractPopup, AsyncPopupImpl, BranchActionGroupPopup, BranchLogSpeedSearchPopup, ComboBoxPopup, FlatSpeedSearchPopup, ListPopupImpl, MockConfirmation, PopupFactoryImpl.ActionGroupPopup, TreePopupImpl, WizardPopup
```
public interface JBPopup
extends Disposable
```
Base interface for popup windows.

See Also:

JBPopupFactory

Nested Class Summary
- Nested classes/interfaces inherited from interface com.intellij.openapi.Disposable
  Disposable.Parent

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String KEY

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`KEY`

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`void`	`addListener(JBPopupListener listener)`
`void`	`cancel()` Cancels the popup as if `Esc` was pressed or any other "cancel" action.
`void`	`cancel(java.awt.event.InputEvent e)` Cancels the popup as a response to some mouse action.
`boolean`	`canClose()` Checks if it's currently allowed to close the popup.
`default boolean`	`canShow()` Whether it's OK to invoke one of the 'show' methods.
`void`	`closeOk(java.awt.event.InputEvent e)` Hides popup as if `Enter` was pressed or or any other "accept" action.
`boolean`	`dispatchKeyEvent(java.awt.event.KeyEvent e)` This callback is called when new key event from the event queue is being processed.
`java.awt.Point`	`getBestPositionFor(DataContext dataContext)` Returns location most appropriate for the specified data context.
`javax.swing.JComponent`	`getContent()` Returns the Swing component contained in the popup.
`java.awt.Point`	`getLocationOnScreen()`
`java.awt.Component`	`getOwner()`
`java.awt.Dimension`	`getSize()`
`<T> T`	`getUserData(java.lang.Class<T> userDataClass)`
`boolean`	`isCancelKeyEnabled()`
`boolean`	`isDisposed()`
`boolean`	`isFocused()`
`boolean`	`isModalContext()`
`boolean`	`isNativePopup()`
`boolean`	`isPersistent()`
`boolean`	`isVisible()` Checks if the popup is currently visible.
`void`	`moveToFitScreen()`
`void`	`pack(boolean width, boolean height)`
`void`	`removeListener(JBPopupListener listener)`
`void`	`setAdText(java.lang.String s, int alignment)`
`void`	`setCaption(java.lang.String title)`
`void`	`setDataProvider(DataProvider dataProvider)`
`void`	`setFinalRunnable(java.lang.Runnable runnable)`
`void`	`setLocation(java.awt.Point screenPoint)` Moves popup to the given point.
`void`	`setMinimumSize(java.awt.Dimension size)`
`void`	`setRequestFocus(boolean b)`
`void`	`setSize(java.awt.Dimension size)`
`void`	`setUiVisible(boolean visible)`
`void`	`show(java.awt.Component owner)` Shows in best position with a given owner
`void`	`show(RelativePoint point)` Shows the popup at the specified point.
`void`	`showCenteredInCurrentWindow(Project project)` Shows the popup in the center of the active window in the IDE frame for the specified project.
`void`	`showInBestPositionFor(DataContext dataContext)` Shows the popup in the position most appropriate for the specified data context.
`void`	`showInBestPositionFor(Editor editor)` Shows the popup near the cursor location in the specified editor.
`void`	`showInCenterOf(java.awt.Component component)` Shows the popup in the center of the specified component.
`void`	`showInFocusCenter()` Shows the popups in the center of currently focused component
`void`	`showInScreenCoordinates(java.awt.Component owner, java.awt.Point point)`
`void`	`showUnderneathOf(java.awt.Component componentUnder)` Shows the popup at the bottom left corner of the specified component.

Methods inherited from interface com.intellij.openapi.Disposable
dispose

- Field Detail
  - KEY
```
static final java.lang.String KEY
```
    See Also:
    
    Constant Field Values
- Method Detail
  - showUnderneathOf
```
void showUnderneathOf(java.awt.Component componentUnder)
```
    Shows the popup at the bottom left corner of the specified component.
    
    Parameters:
    
    componentUnder - the component near which the popup should be displayed.
  - show
```
void show(RelativePoint point)
```
    Shows the popup at the specified point.
    
    Parameters:
    
    point - the relative point where the popup should be displayed.
  - showInScreenCoordinates
```
void showInScreenCoordinates(java.awt.Component owner,
                             java.awt.Point point)
```
  - getBestPositionFor
```
java.awt.Point getBestPositionFor(DataContext dataContext)
```
    Returns location most appropriate for the specified data context.
    
    See Also:
    
    showInBestPositionFor(DataContext), setLocation(Point)
  - showInBestPositionFor
```
void showInBestPositionFor(DataContext dataContext)
```
    Shows the popup in the position most appropriate for the specified data context.
    
    Parameters:
    
    dataContext - the data context to which the popup is related.
    
    See Also:
    
    JBPopupFactory.guessBestPopupLocation(DataContext), getBestPositionFor(DataContext)
  - showInBestPositionFor
```
void showInBestPositionFor(Editor editor)
```
    Shows the popup near the cursor location in the specified editor.
    
    Parameters:
    
    editor - the editor relative to which the popup should be displayed.
    
    See Also:
    
    JBPopupFactory.guessBestPopupLocation(Editor)
  - showInCenterOf
```
void showInCenterOf(java.awt.Component component)
```
    Shows the popup in the center of the specified component.
    
    Parameters:
    
    component - the component at which the popup should be centered.
  - showInFocusCenter
```
void showInFocusCenter()
```
    Shows the popups in the center of currently focused component
  - show
```
void show(java.awt.Component owner)
```
    Shows in best position with a given owner
  - showCenteredInCurrentWindow
```
void showCenteredInCurrentWindow(Project project)
```
    Shows the popup in the center of the active window in the IDE frame for the specified project.
    
    Parameters:
    
    project - the project in which the popup should be displayed.
  - closeOk
```
void closeOk(java.awt.event.InputEvent e)
```
    Hides popup as if Enter was pressed or or any other "accept" action.
  - cancel
```
void cancel()
```
    Cancels the popup as if Esc was pressed or any other "cancel" action.
  - setRequestFocus
```
void setRequestFocus(boolean b)
```
    Parameters:
    
    b - true if popup should request focus.
  - cancel
```
void cancel(java.awt.event.InputEvent e)
```
    Cancels the popup as a response to some mouse action. All the subsequent mouse events originated from the event's point will be consumed.
  - canClose
```
boolean canClose()
```
    Checks if it's currently allowed to close the popup.
    
    Returns:
    
    true if the popup can be closed, false if a callback disallowed closing the popup.
    
    See Also:
    
    ComponentPopupBuilder.setCancelCallback(com.intellij.openapi.util.Computable)
  - isVisible
```
boolean isVisible()
```
    Checks if the popup is currently visible.
    
    Returns:
    
    true if the popup is visible, false otherwise.
  - getContent
```
javax.swing.JComponent getContent()
```
    Returns the Swing component contained in the popup.
    
    Returns:
    
    the contents of the popup.
  - setLocation
```
void setLocation(java.awt.Point screenPoint)
```
    Moves popup to the given point. Does nothing if popup is invisible.
    
    Parameters:
    
    screenPoint - Point to move to.
  - setSize
```
void setSize(java.awt.Dimension size)
```
  - getSize
```
java.awt.Dimension getSize()
```
  - setCaption
```
void setCaption(java.lang.String title)
```
  - isPersistent
```
boolean isPersistent()
```
  - isModalContext
```
boolean isModalContext()
```
  - isNativePopup
```
boolean isNativePopup()
```
  - setUiVisible
```
void setUiVisible(boolean visible)
```
  - getUserData
```
<T> T getUserData(java.lang.Class<T> userDataClass)
```
  - isFocused
```
boolean isFocused()
```
  - isCancelKeyEnabled
```
boolean isCancelKeyEnabled()
```
  - addListener
```
void addListener(JBPopupListener listener)
```
  - removeListener
```
void removeListener(JBPopupListener listener)
```
  - isDisposed
```
boolean isDisposed()
```
  - getOwner
```
java.awt.Component getOwner()
```
  - setMinimumSize
```
void setMinimumSize(java.awt.Dimension size)
```
  - setFinalRunnable
```
void setFinalRunnable(java.lang.Runnable runnable)
```
  - moveToFitScreen
```
void moveToFitScreen()
```
  - getLocationOnScreen
```
java.awt.Point getLocationOnScreen()
```
  - pack
```
void pack(boolean width,
          boolean height)
```
  - setAdText
```
void setAdText(java.lang.String s,
               int alignment)
```
  - setDataProvider
```
void setDataProvider(DataProvider dataProvider)
```
  - dispatchKeyEvent
```
boolean dispatchKeyEvent(java.awt.event.KeyEvent e)
```
    This callback is called when new key event from the event queue is being processed.
    The popup has a right to decide if its further processing should be continued (method return value).
    
    Parameters:
    
    e - new key event being processed
    
    Returns:
    
    true if the event is completely dispatched, i.e. no further processing is necessary; false otherwise
  - canShow
```
default boolean canShow()
```
    Whether it's OK to invoke one of the 'show' methods. Some implementation might prohibit it e.g. if the popup is shown already.

Interface JBPopup

Nested Class Summary

Nested classes/interfaces inherited from interface com.intellij.openapi.Disposable

Field Summary

Method Summary

Methods inherited from interface com.intellij.openapi.Disposable

Field Detail

KEY

Method Detail

showUnderneathOf

show

showInScreenCoordinates

getBestPositionFor

showInBestPositionFor

showInBestPositionFor

showInCenterOf

showInFocusCenter

show

showCenteredInCurrentWindow

closeOk

cancel

setRequestFocus

cancel

canClose

isVisible

getContent

setLocation

setSize

getSize

setCaption

isPersistent

isModalContext

isNativePopup

setUiVisible

getUserData

isFocused

isCancelKeyEnabled

addListener

removeListener

isDisposed

getOwner

setMinimumSize

setFinalRunnable

moveToFitScreen

getLocationOnScreen

pack

setAdText

setDataProvider

dispatchKeyEvent

canShow