Package com.intellij.ui.popup

Class PopupFactoryImpl

java.lang.Object

com.intellij.openapi.ui.popup.JBPopupFactory

com.intellij.ui.popup.PopupFactoryImpl

public class PopupFactoryImpl
extends JBPopupFactory

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PopupFactoryImpl.ActionGroupPopup
static class	PopupFactoryImpl.ActionItem

Nested classes/interfaces inherited from class com.intellij.openapi.ui.popup.JBPopupFactory

JBPopupFactory.ActionSelectionAid

Field Summary

Fields

Modifier and Type	Field and Description
static Key<java.awt.Point>	ANCHOR_POPUP_POINT If corresponding value is defined for an Editor, popups shown for the editor will be located at specified point.
static Key<VisualPosition>	ANCHOR_POPUP_POSITION Allows to get an editor position for which a popup with auxiliary information might be shown.

Constructor Summary

Constructors

Constructor and Description
PopupFactoryImpl()

Method Summary

Modifier and Type	Method and Description
ListPopup	createActionGroupPopup(java.lang.String title, ActionGroup actionGroup, DataContext dataContext, boolean showNumbers, boolean showDisabledActions, boolean honorActionMnemonics, java.lang.Runnable disposeCallback, int maxRowCount, Condition<? super AnAction> preselectActionCondition)
ListPopup	createActionGroupPopup(java.lang.String title, ActionGroup actionGroup, DataContext dataContext, JBPopupFactory.ActionSelectionAid aid, boolean showDisabledActions, java.lang.Runnable disposeCallback, int maxRowCount, Condition<? super AnAction> preselectActionCondition, java.lang.String actionPlace)
ListPopupStep<PopupFactoryImpl.ActionItem>	createActionsStep(ActionGroup actionGroup, DataContext dataContext, java.lang.String actionPlace, boolean showNumbers, boolean showDisabledActions, java.lang.String title, java.awt.Component component, boolean honorActionMnemonics, int defaultOptionIndex, boolean autoSelectionEnabled)
BalloonBuilder	createBalloonBuilder(javax.swing.JComponent content)
ComponentPopupBuilder	createComponentPopupBuilder(javax.swing.JComponent content, javax.swing.JComponent preferableFocusComponent)
ListPopup	createConfirmation(java.lang.String title, java.lang.Runnable onYes, int defaultOptionIndex) Creates a popup with the specified title and two options, Yes and No.
ListPopup	createConfirmation(java.lang.String title, java.lang.String yesText, java.lang.String noText, java.lang.Runnable onYes, int defaultOptionIndex) Creates a popup allowing to choose one of two specified options and execute code when one of them is selected.
ListPopup	createConfirmation(java.lang.String title, java.lang.String yesText, java.lang.String noText, java.lang.Runnable onYes, java.lang.Runnable onNo, int defaultOptionIndex) Creates a popup allowing to choose one of two specified options and execute code when either of them is selected.
BalloonBuilder	createDialogBalloonBuilder(javax.swing.JComponent content, java.lang.String title)
BalloonBuilder	createHtmlTextBalloonBuilder(java.lang.String htmlContent, javax.swing.Icon icon, java.awt.Color textColor, java.awt.Color fillColor, javax.swing.event.HyperlinkListener listener)
BalloonBuilder	createHtmlTextBalloonBuilder(java.lang.String htmlContent, MessageType messageType, javax.swing.event.HyperlinkListener listener)
ListPopup	createListPopup(ListPopupStep step) Creates a custom list popup with the specified step.
ListPopup	createListPopup(ListPopupStep step, int maxRowCount) Creates a custom list popup with the specified step.
JBPopup	createMessage(java.lang.String text)
<T> IPopupChooserBuilder<T>	createPopupChooserBuilder(java.util.List<? extends T> list)
protected <T> PopupChooserBuilder.PopupComponentAdapter<T>	createPopupComponentAdapter(PopupChooserBuilder<T> builder, javax.swing.JList<T> list)
protected <T> PopupChooserBuilder.PopupComponentAdapter<T>	createPopupComponentAdapter(PopupChooserBuilder<T> builder, javax.swing.JTable table)
protected <T> PopupChooserBuilder.PopupComponentAdapter<T>	createPopupComponentAdapter(PopupChooserBuilder<T> builder, javax.swing.JTree tree)
TreePopup	createTree(JBPopup parent, TreePopupStep aStep, java.lang.Object parentValue)
TreePopup	createTree(TreePopupStep aStep)
java.awt.Point	getCenterOf(javax.swing.JComponent container, javax.swing.JComponent content)
java.util.List<JBPopup>	getChildPopups(java.awt.Component component)
Balloon	getParentBalloonFor(java.awt.Component c)
RelativePoint	guessBestPopupLocation(DataContext dataContext) Returns the location where a popup with the specified data context is displayed.
RelativePoint	guessBestPopupLocation(Editor editor) Returns the location where a popup invoked from the specified editor should be displayed.
RelativePoint	guessBestPopupLocation(javax.swing.JComponent component)
boolean	isBestPopupLocationVisible(Editor editor)
boolean	isPopupActive()

Methods inherited from class com.intellij.openapi.ui.popup.JBPopupFactory

createActionGroupPopup, createActionGroupPopup, createActionGroupPopup, createActionGroupPopup, createActionsStep, createActionsStep, createHtmlTextBalloonBuilder, createListPopupBuilder, createPopupChooserBuilder, getChildFocusedPopup, getInstance, isChildPopupFocused

Methods inherited from class java.lang.Object

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

Field Detail

ANCHOR_POPUP_POSITION

public static final Key<VisualPosition> ANCHOR_POPUP_POSITION

Allows to get an editor position for which a popup with auxiliary information might be shown.

Primary intention for this key is to hint popup position for the non-caret location.

ANCHOR_POPUP_POINT

public static final Key<java.awt.Point> ANCHOR_POPUP_POINT

If corresponding value is defined for an Editor, popups shown for the editor will be located at specified point. This allows to show popups for non-default locations (caret location is used by default).

See Also:

JBPopupFactory.guessBestPopupLocation(Editor)

Constructor Detail

PopupFactoryImpl

public PopupFactoryImpl()

Method Detail

createPopupChooserBuilder

public <T> IPopupChooserBuilder<T> createPopupChooserBuilder(java.util.List<? extends T> list)

Specified by:

createPopupChooserBuilder in class JBPopupFactory

createConfirmation

public ListPopup createConfirmation(java.lang.String title,
                                    java.lang.Runnable onYes,
                                    int defaultOptionIndex)

Description copied from class: JBPopupFactory

Creates a popup with the specified title and two options, Yes and No.

Specified by:

createConfirmation in class JBPopupFactory

Parameters:

title - the title of the popup.

onYes - the runnable which is executed when the Yes option is selected.

defaultOptionIndex - the index of the option which is selected by default.

Returns:

the popup instance.

createConfirmation

public ListPopup createConfirmation(java.lang.String title,
                                    java.lang.String yesText,
                                    java.lang.String noText,
                                    java.lang.Runnable onYes,
                                    int defaultOptionIndex)

Description copied from class: JBPopupFactory

Creates a popup allowing to choose one of two specified options and execute code when one of them is selected.

Specified by:

createConfirmation in class JBPopupFactory

Parameters:

title - the title of the popup.

yesText - the title for the Yes option.

noText - the title for the No option.

onYes - the runnable which is executed when the Yes option is selected.

defaultOptionIndex - the index of the option which is selected by default.

Returns:

the popup instance.

createMessage

public JBPopup createMessage(java.lang.String text)

Specified by:

createMessage in class JBPopupFactory

getParentBalloonFor

public Balloon getParentBalloonFor(java.awt.Component c)

Specified by:

getParentBalloonFor in class JBPopupFactory

createPopupComponentAdapter

protected <T> PopupChooserBuilder.PopupComponentAdapter<T> createPopupComponentAdapter(PopupChooserBuilder<T> builder,
                                                                                       javax.swing.JList<T> list)

Specified by:

createPopupComponentAdapter in class JBPopupFactory

createPopupComponentAdapter

protected <T> PopupChooserBuilder.PopupComponentAdapter<T> createPopupComponentAdapter(PopupChooserBuilder<T> builder,
                                                                                       javax.swing.JTree tree)

Specified by:

createPopupComponentAdapter in class JBPopupFactory

createPopupComponentAdapter

protected <T> PopupChooserBuilder.PopupComponentAdapter<T> createPopupComponentAdapter(PopupChooserBuilder<T> builder,
                                                                                       javax.swing.JTable table)

Specified by:

createPopupComponentAdapter in class JBPopupFactory

createConfirmation

public ListPopup createConfirmation(java.lang.String title,
                                    java.lang.String yesText,
                                    java.lang.String noText,
                                    java.lang.Runnable onYes,
                                    java.lang.Runnable onNo,
                                    int defaultOptionIndex)

Description copied from class: JBPopupFactory

Creates a popup allowing to choose one of two specified options and execute code when either of them is selected.

Specified by:

createConfirmation in class JBPopupFactory

Parameters:

title - the title of the popup.

yesText - the title for the Yes option.

noText - the title for the No option.

onYes - the runnable which is executed when the Yes option is selected.

onNo - the runnable which is executed when the No option is selected.

defaultOptionIndex - the index of the option which is selected by default.

Returns:

the popup instance.

createActionGroupPopup

public ListPopup createActionGroupPopup(java.lang.String title,
                                        ActionGroup actionGroup,
                                        DataContext dataContext,
                                        JBPopupFactory.ActionSelectionAid aid,
                                        boolean showDisabledActions,
                                        java.lang.Runnable disposeCallback,
                                        int maxRowCount,
                                        Condition<? super AnAction> preselectActionCondition,
                                        java.lang.String actionPlace)

Specified by:

createActionGroupPopup in class JBPopupFactory

createActionGroupPopup

public ListPopup createActionGroupPopup(java.lang.String title,
                                        ActionGroup actionGroup,
                                        DataContext dataContext,
                                        boolean showNumbers,
                                        boolean showDisabledActions,
                                        boolean honorActionMnemonics,
                                        java.lang.Runnable disposeCallback,
                                        int maxRowCount,
                                        Condition<? super AnAction> preselectActionCondition)

Specified by:

createActionGroupPopup in class JBPopupFactory

createActionsStep

public ListPopupStep<PopupFactoryImpl.ActionItem> createActionsStep(ActionGroup actionGroup,
                                                                    DataContext dataContext,
                                                                    java.lang.String actionPlace,
                                                                    boolean showNumbers,
                                                                    boolean showDisabledActions,
                                                                    java.lang.String title,
                                                                    java.awt.Component component,
                                                                    boolean honorActionMnemonics,
                                                                    int defaultOptionIndex,
                                                                    boolean autoSelectionEnabled)

Specified by:

createActionsStep in class JBPopupFactory

createListPopup

public ListPopup createListPopup(ListPopupStep step)

Description copied from class: JBPopupFactory

Creates a custom list popup with the specified step.

Specified by:

createListPopup in class JBPopupFactory

Parameters:

step - the custom step for the list popup.

Returns:

the popup instance.

createListPopup

public ListPopup createListPopup(ListPopupStep step,
                                 int maxRowCount)

Description copied from class: JBPopupFactory

Creates a custom list popup with the specified step.

Specified by:

createListPopup in class JBPopupFactory

Parameters:

step - the custom step for the list popup.

maxRowCount - the number of visible rows to show in the popup (if the popup has more items, a scrollbar will be displayed).

Returns:

the popup instance.

createTree

public TreePopup createTree(JBPopup parent,
                            TreePopupStep aStep,
                            java.lang.Object parentValue)

Specified by:

createTree in class JBPopupFactory

createTree

public TreePopup createTree(TreePopupStep aStep)

Specified by:

createTree in class JBPopupFactory

createComponentPopupBuilder

public ComponentPopupBuilder createComponentPopupBuilder(javax.swing.JComponent content,
                                                         javax.swing.JComponent preferableFocusComponent)

Specified by:

createComponentPopupBuilder in class JBPopupFactory

guessBestPopupLocation

public RelativePoint guessBestPopupLocation(DataContext dataContext)

Description copied from class: JBPopupFactory

Returns the location where a popup with the specified data context is displayed.

Specified by:

guessBestPopupLocation in class JBPopupFactory

Parameters:

dataContext - the data context from which the location is determined.

Returns:

location as close as possible to the action origin. Method has special handling of the following components:
- caret offset for editor
- current selected node for tree
- current selected row for list

guessBestPopupLocation

public RelativePoint guessBestPopupLocation(javax.swing.JComponent component)

Specified by:

guessBestPopupLocation in class JBPopupFactory

isBestPopupLocationVisible

public boolean isBestPopupLocationVisible(Editor editor)

Specified by:

isBestPopupLocationVisible in class JBPopupFactory

Parameters:

editor - the editor over which the popup is shown.

Returns:

true if popup location is located in visible area false if center would be suggested instead

guessBestPopupLocation

public RelativePoint guessBestPopupLocation(Editor editor)

Description copied from class: JBPopupFactory

Returns the location where a popup invoked from the specified editor should be displayed.

Specified by:

guessBestPopupLocation in class JBPopupFactory

Parameters:

editor - the editor over which the popup is shown.

Returns:

location as close as possible to the action origin.

getCenterOf

public java.awt.Point getCenterOf(javax.swing.JComponent container,
                                  javax.swing.JComponent content)

Specified by:

getCenterOf in class JBPopupFactory

getChildPopups

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

Specified by:

getChildPopups in class JBPopupFactory

isPopupActive

public boolean isPopupActive()

Specified by:

isPopupActive in class JBPopupFactory

createBalloonBuilder

public BalloonBuilder createBalloonBuilder(javax.swing.JComponent content)

Specified by:

createBalloonBuilder in class JBPopupFactory

createDialogBalloonBuilder

public BalloonBuilder createDialogBalloonBuilder(javax.swing.JComponent content,
                                                 java.lang.String title)

Specified by:

createDialogBalloonBuilder in class JBPopupFactory

createHtmlTextBalloonBuilder

public BalloonBuilder createHtmlTextBalloonBuilder(java.lang.String htmlContent,
                                                   javax.swing.Icon icon,
                                                   java.awt.Color textColor,
                                                   java.awt.Color fillColor,
                                                   javax.swing.event.HyperlinkListener listener)

Specified by:

createHtmlTextBalloonBuilder in class JBPopupFactory

createHtmlTextBalloonBuilder

public BalloonBuilder createHtmlTextBalloonBuilder(java.lang.String htmlContent,
                                                   MessageType messageType,
                                                   javax.swing.event.HyperlinkListener listener)

Specified by:

createHtmlTextBalloonBuilder in class JBPopupFactory