Package com.intellij.ui.popup

Class AbstractPopup

java.lang.Object

com.intellij.ui.popup.AbstractPopup

All Implemented Interfaces:

ScreenAreaConsumer, Disposable, JBPopup

Direct Known Subclasses:

WizardPopup

public class AbstractPopup
extends java.lang.Object
implements JBPopup, ScreenAreaConsumer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractPopup.MyContentPanel

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	FIRST_TIME_SIZE
protected boolean	myOk
protected java.awt.Component	myOwner
protected SpeedSearch	mySpeedSearch
protected SearchTextField	mySpeedSearchPatternField
static java.lang.String	SHOW_HINTS

Fields inherited from interface com.intellij.openapi.ui.popup.JBPopup

KEY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractPopup()

Method Summary

Modifier and Type	Method and Description
void	addListener(JBPopupListener listener)
protected void	addPopupListener(JBPopupListener listener)
void	addResizeListener(java.lang.Runnable runnable, Disposable parentDisposable) Passed listener will be notified if popup is resized by user (using mouse)
protected void	afterShow()
protected void	afterShowSync()
protected boolean	beforeShow()
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.
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.
protected AbstractPopup.MyContentPanel	createContentPanel(boolean resizable, PopupBorder border, boolean isToDrawMacCorner)
boolean	dispatchKeyEvent(java.awt.event.KeyEvent e) This callback is called when new key event from the event queue is being processed.
void	dispose() Usually not invoked directly, see class javadoc.
void	focusPreferredComponent()
java.awt.Point	getBestPositionFor(DataContext dataContext) Returns location most appropriate for the specified data context.
static java.awt.Point	getCenterOf(java.awt.Component aContainer, javax.swing.JComponent content)
static java.util.List<JBPopup>	getChildPopups(java.awt.Component component)
javax.swing.JComponent	getComponent()
java.awt.Rectangle	getConsumedScreenBounds()
javax.swing.JComponent	getContent() Returns the Swing component contained in the popup.
java.lang.String	getDimensionServiceKey()
java.awt.Dimension	getFooterPreferredSize()
java.awt.Dimension	getHeaderPreferredSize()
java.awt.Point	getLocationOnScreen()
java.awt.Component	getOwner()
PopupBorder	getPopupBorder()
java.awt.Window	getPopupWindow()
Project	getProject()
java.awt.Dimension	getSize()
CaptionPanel	getTitle()
java.awt.Window	getUnderlyingWindow()
<T> T	getUserData(java.lang.Class<T> userDataClass)
protected AbstractPopup	init(Project project, javax.swing.JComponent component, javax.swing.JComponent preferredFocusedComponent, boolean requestFocus, boolean focusable, boolean movable, java.lang.String dimensionServiceKey, boolean resizable, java.lang.String caption, Computable<java.lang.Boolean> callback, boolean cancelOnClickOutside, java.util.Set<JBPopupListener> listeners, boolean useDimServiceForXYLocation, ActiveComponent commandButton, IconButton cancelButton, MouseChecker cancelOnMouseOutCallback, boolean cancelOnWindow, ActiveIcon titleIcon, boolean cancelKeyEnabled, boolean locateByContent, boolean placeWithinScreenBounds, java.awt.Dimension minSize, float alpha, MaskProvider maskProvider, boolean inStack, boolean modalContext, java.awt.Component [] focusOwners, java.lang.String adText, int adTextAlignment, boolean headerAlwaysFocusable, java.util.List<? extends Pair<java.awt.event.ActionListener,javax.swing.KeyStroke>> keyboardActions, java.awt.Component settingsButtons, Processor<? super JBPopup> pinCallback, boolean mayBeParent, boolean showShadow, boolean showBorder, java.awt.Color borderColor, boolean cancelOnWindowDeactivation, BooleanFunction<? super java.awt.event.KeyEvent> keyEventHandler)
protected boolean	isBusy()
boolean	isCancelKeyEnabled()
static boolean	isCloseRequest(java.awt.event.KeyEvent e)
boolean	isDisposed()
boolean	isFocused()
static boolean	isFocused(java.awt.Component [] components)
boolean	isModalContext()
boolean	isNativePopup()
boolean	isPersistent()
boolean	isVisible() Checks if the popup is currently visible.
static java.awt.Window	moveTo(javax.swing.JComponent content, java.awt.Point screenPoint, java.awt.Dimension headerCorrectionSize)
void	moveToFitScreen()
protected void	onSpeedSearchPatternChanged()
void	pack(boolean width, boolean height)
protected void	prepareToShow()
void	removeListener(JBPopupListener listener)
protected boolean	requestFocus()
void	setAdText(java.lang.String s)
void	setAdText(java.lang.String s, int alignment)
void	setCaption(java.lang.String title)
void	setDataProvider(DataProvider dataProvider)
void	setDimensionServiceKey(java.lang.String dimensionServiceKey)
void	setFinalRunnable(java.lang.Runnable finalRunnable)
protected void	setHeaderComponent(javax.swing.JComponent c)
void	setLocation(java.awt.Point screenPoint) Moves popup to the given point.
void	setLocation(RelativePoint p)
void	setMinimumSize(java.awt.Dimension size)
void	setOk(boolean ok)
void	setOkHandler(java.lang.Runnable okHandler)
void	setRequestFocus(boolean requestFocus)
void	setShowHints(boolean show)
void	setSize(java.awt.Dimension size)
static java.awt.Window	setSize(javax.swing.JComponent content, java.awt.Dimension size)
void	setSpeedSearchAlwaysShown(boolean value)
void	setUiVisible(boolean visible)
void	setUserData(java.util.List<java.lang.Object> userData)
void	setWarning(java.lang.String text)
void	show(java.awt.Component owner) Shows in best position with a given owner
void	show(java.awt.Component owner, int aScreenX, int aScreenY, boolean considerForcedXY)
void	show(RelativePoint aPoint) 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 aComponent) 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 aComponent) Shows the popup at the bottom left corner of the specified component.
void	storeDimensionSize()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SHOW_HINTS

public static final java.lang.String SHOW_HINTS

See Also:

Constant Field Values

FIRST_TIME_SIZE

public static final java.lang.String FIRST_TIME_SIZE

See Also:

Constant Field Values

myOwner

protected java.awt.Component myOwner

myOk

protected boolean myOk

mySpeedSearch

protected final SpeedSearch mySpeedSearch

mySpeedSearchPatternField

protected SearchTextField mySpeedSearchPatternField

Constructor Detail

AbstractPopup

protected AbstractPopup()

Method Detail

init

protected AbstractPopup init(Project project,
                             javax.swing.JComponent component,
                             javax.swing.JComponent preferredFocusedComponent,
                             boolean requestFocus,
                             boolean focusable,
                             boolean movable,
                             java.lang.String dimensionServiceKey,
                             boolean resizable,
                             java.lang.String caption,
                             Computable<java.lang.Boolean> callback,
                             boolean cancelOnClickOutside,
                             java.util.Set<JBPopupListener> listeners,
                             boolean useDimServiceForXYLocation,
                             ActiveComponent commandButton,
                             IconButton cancelButton,
                             MouseChecker cancelOnMouseOutCallback,
                             boolean cancelOnWindow,
                             ActiveIcon titleIcon,
                             boolean cancelKeyEnabled,
                             boolean locateByContent,
                             boolean placeWithinScreenBounds,
                             java.awt.Dimension minSize,
                             float alpha,
                             MaskProvider maskProvider,
                             boolean inStack,
                             boolean modalContext,
                             java.awt.Component [] focusOwners,
                             java.lang.String adText,
                             int adTextAlignment,
                             boolean headerAlwaysFocusable,
                             java.util.List<? extends Pair<java.awt.event.ActionListener,javax.swing.KeyStroke>> keyboardActions,
                             java.awt.Component settingsButtons,
                             Processor<? super JBPopup> pinCallback,
                             boolean mayBeParent,
                             boolean showShadow,
                             boolean showBorder,
                             java.awt.Color borderColor,
                             boolean cancelOnWindowDeactivation,
                             BooleanFunction<? super java.awt.event.KeyEvent> keyEventHandler)

createContentPanel

protected AbstractPopup.MyContentPanel createContentPanel(boolean resizable,
                                                          PopupBorder border,
                                                          boolean isToDrawMacCorner)

setShowHints

public void setShowHints(boolean show)

getDimensionServiceKey

public java.lang.String getDimensionServiceKey()

setDimensionServiceKey

public void setDimensionServiceKey(java.lang.String dimensionServiceKey)

setAdText

public void setAdText(java.lang.String s)

getPopupBorder

public PopupBorder getPopupBorder()

setAdText

public void setAdText(java.lang.String s,
                      int alignment)

Specified by:

setAdText in interface JBPopup

getCenterOf

public static java.awt.Point getCenterOf(java.awt.Component aContainer,
                                         javax.swing.JComponent content)

showCenteredInCurrentWindow

public void showCenteredInCurrentWindow(Project project)

Description copied from interface: JBPopup

Shows the popup in the center of the active window in the IDE frame for the specified project.

Specified by:

showCenteredInCurrentWindow in interface JBPopup

Parameters:

project - the project in which the popup should be displayed.

showInCenterOf

public void showInCenterOf(java.awt.Component aComponent)

Description copied from interface: JBPopup

Shows the popup in the center of the specified component.

Specified by:

showInCenterOf in interface JBPopup

Parameters:

aComponent - the component at which the popup should be centered.

showUnderneathOf

public void showUnderneathOf(java.awt.Component aComponent)

Description copied from interface: JBPopup

Shows the popup at the bottom left corner of the specified component.

Specified by:

showUnderneathOf in interface JBPopup

Parameters:

aComponent - the component near which the popup should be displayed.

show

public void show(RelativePoint aPoint)

Description copied from interface: JBPopup

Shows the popup at the specified point.

Specified by:

show in interface JBPopup

Parameters:

aPoint - the relative point where the popup should be displayed.

showInScreenCoordinates

public void showInScreenCoordinates(java.awt.Component owner,
                                    java.awt.Point point)

Specified by:

showInScreenCoordinates in interface JBPopup

getBestPositionFor

public java.awt.Point getBestPositionFor(DataContext dataContext)

Description copied from interface: JBPopup

Returns location most appropriate for the specified data context.

Specified by:

getBestPositionFor in interface JBPopup

See Also:

JBPopup.showInBestPositionFor(DataContext), JBPopup.setLocation(Point)

showInBestPositionFor

public void showInBestPositionFor(DataContext dataContext)

Description copied from interface: JBPopup

Shows the popup in the position most appropriate for the specified data context.

Specified by:

showInBestPositionFor in interface JBPopup

Parameters:

dataContext - the data context to which the popup is related.

See Also:

JBPopupFactory.guessBestPopupLocation(DataContext), JBPopup.getBestPositionFor(DataContext)

showInFocusCenter

public void showInFocusCenter()

Description copied from interface: JBPopup

Shows the popups in the center of currently focused component

Specified by:

showInFocusCenter in interface JBPopup

showInBestPositionFor

public void showInBestPositionFor(Editor editor)

Description copied from interface: JBPopup

Shows the popup near the cursor location in the specified editor.

Specified by:

showInBestPositionFor in interface JBPopup

Parameters:

editor - the editor relative to which the popup should be displayed.

See Also:

JBPopupFactory.guessBestPopupLocation(Editor)

addPopupListener

protected void addPopupListener(JBPopupListener listener)

closeOk

public final void closeOk(java.awt.event.InputEvent e)

Description copied from interface: JBPopup

Hides popup as if Enter was pressed or or any other "accept" action.

Specified by:

closeOk in interface JBPopup

cancel

public final void cancel()

Description copied from interface: JBPopup

Cancels the popup as if Esc was pressed or any other "cancel" action.

Specified by:

cancel in interface JBPopup

setRequestFocus

public void setRequestFocus(boolean requestFocus)

Specified by:

setRequestFocus in interface JBPopup

Parameters:

requestFocus - true if popup should request focus.

cancel

public void cancel(java.awt.event.InputEvent e)

Description copied from interface: JBPopup

Cancels the popup as a response to some mouse action. All the subsequent mouse events originated from the event's point will be consumed.

Specified by:

cancel in interface JBPopup

canClose

public boolean canClose()

Description copied from interface: JBPopup

Checks if it's currently allowed to close the popup.

Specified by:

canClose in interface JBPopup

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

public boolean isVisible()

Description copied from interface: JBPopup

Checks if the popup is currently visible.

Specified by:

isVisible in interface JBPopup

Returns:

true if the popup is visible, false otherwise.

show

public void show(java.awt.Component owner)

Description copied from interface: JBPopup

Shows in best position with a given owner

Specified by:

show in interface JBPopup

show

public void show(java.awt.Component owner,
                 int aScreenX,
                 int aScreenY,
                 boolean considerForcedXY)

focusPreferredComponent

public void focusPreferredComponent()

prepareToShow

protected void prepareToShow()

isDisposed

public boolean isDisposed()

Specified by:

isDisposed in interface JBPopup

beforeShow

protected boolean beforeShow()

afterShow

protected void afterShow()

afterShowSync

protected void afterShowSync()

requestFocus

protected final boolean requestFocus()

getContent

public javax.swing.JComponent getContent()

Description copied from interface: JBPopup

Returns the Swing component contained in the popup.

Specified by:

getContent in interface JBPopup

Returns:

the contents of the popup.

setLocation

public void setLocation(RelativePoint p)

pack

public void pack(boolean width,
                 boolean height)

Specified by:

pack in interface JBPopup

getComponent

public javax.swing.JComponent getComponent()

getProject

public Project getProject()

dispose

public void dispose()

Description copied from interface: Disposable

Usually not invoked directly, see class javadoc.

Specified by:

dispose in interface Disposable

storeDimensionSize

public void storeDimensionSize()

setLocation

public void setLocation(java.awt.Point screenPoint)

Description copied from interface: JBPopup

Moves popup to the given point. Does nothing if popup is invisible.

Specified by:

setLocation in interface JBPopup

Parameters:

screenPoint - Point to move to.

moveTo

public static java.awt.Window moveTo(javax.swing.JComponent content,
                                     java.awt.Point screenPoint,
                                     java.awt.Dimension headerCorrectionSize)

getLocationOnScreen

public java.awt.Point getLocationOnScreen()

Specified by:

getLocationOnScreen in interface JBPopup

setSize

public void setSize(java.awt.Dimension size)

Specified by:

setSize in interface JBPopup

getSize

public java.awt.Dimension getSize()

Specified by:

getSize in interface JBPopup

moveToFitScreen

public void moveToFitScreen()

Specified by:

moveToFitScreen in interface JBPopup

setSize

public static java.awt.Window setSize(javax.swing.JComponent content,
                                      java.awt.Dimension size)

setCaption

public void setCaption(java.lang.String title)

Specified by:

setCaption in interface JBPopup

setSpeedSearchAlwaysShown

public void setSpeedSearchAlwaysShown(boolean value)

isPersistent

public boolean isPersistent()

Specified by:

isPersistent in interface JBPopup

isNativePopup

public boolean isNativePopup()

Specified by:

isNativePopup in interface JBPopup

setUiVisible

public void setUiVisible(boolean visible)

Specified by:

setUiVisible in interface JBPopup

getPopupWindow

public java.awt.Window getPopupWindow()

setUserData

public void setUserData(java.util.List<java.lang.Object> userData)

getUserData

public <T> T getUserData(java.lang.Class<T> userDataClass)

Specified by:

getUserData in interface JBPopup

isModalContext

public boolean isModalContext()

Specified by:

isModalContext in interface JBPopup

isFocused

public boolean isFocused()

Specified by:

isFocused in interface JBPopup

isFocused

public static boolean isFocused(java.awt.Component [] components)

isCancelKeyEnabled

public boolean isCancelKeyEnabled()

Specified by:

isCancelKeyEnabled in interface JBPopup

getTitle

public CaptionPanel getTitle()

setHeaderComponent

protected void setHeaderComponent(javax.swing.JComponent c)

setWarning

public void setWarning(java.lang.String text)

addListener

public void addListener(JBPopupListener listener)

Specified by:

addListener in interface JBPopup

removeListener

public void removeListener(JBPopupListener listener)

Specified by:

removeListener in interface JBPopup

onSpeedSearchPatternChanged

protected void onSpeedSearchPatternChanged()

getOwner

public java.awt.Component getOwner()

Specified by:

getOwner in interface JBPopup

setMinimumSize

public void setMinimumSize(java.awt.Dimension size)

Specified by:

setMinimumSize in interface JBPopup

setOkHandler

public void setOkHandler(java.lang.Runnable okHandler)

setFinalRunnable

public void setFinalRunnable(java.lang.Runnable finalRunnable)

Specified by:

setFinalRunnable in interface JBPopup

setOk

public void setOk(boolean ok)

setDataProvider

public void setDataProvider(DataProvider dataProvider)

Specified by:

setDataProvider in interface JBPopup

dispatchKeyEvent

public boolean dispatchKeyEvent(java.awt.event.KeyEvent e)

Description copied from interface: JBPopup

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

Specified by:

dispatchKeyEvent in interface JBPopup

Parameters:

e - new key event being processed

Returns:

true if the event is completely dispatched, i.e. no further processing is necessary; false otherwise

getHeaderPreferredSize

public java.awt.Dimension getHeaderPreferredSize()

getFooterPreferredSize

public java.awt.Dimension getFooterPreferredSize()

isCloseRequest

public static boolean isCloseRequest(java.awt.event.KeyEvent e)

isBusy

protected boolean isBusy()

getChildPopups

public static java.util.List<JBPopup> getChildPopups(java.awt.Component component)

canShow

public boolean canShow()

Description copied from interface: JBPopup

Whether it's OK to invoke one of the 'show' methods. Some implementation might prohibit it e.g. if the popup is shown already.

Specified by:

canShow in interface JBPopup

getConsumedScreenBounds

public java.awt.Rectangle getConsumedScreenBounds()

Specified by:

getConsumedScreenBounds in interface ScreenAreaConsumer

getUnderlyingWindow

public java.awt.Window getUnderlyingWindow()

Specified by:

getUnderlyingWindow in interface ScreenAreaConsumer

addResizeListener

public void addResizeListener(java.lang.Runnable runnable,
                              Disposable parentDisposable)

Passed listener will be notified if popup is resized by user (using mouse)