Package com.intellij.ide.util

Class ChooseElementsDialog<T>

java.lang.Object

com.intellij.openapi.ui.DialogWrapper

com.intellij.ide.util.ChooseElementsDialog<T>

Direct Known Subclasses:

ChooseArtifactsDialog, ChooseModulesDialog

public abstract class ChooseElementsDialog<T>
extends DialogWrapper

Nested Class Summary

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

DialogWrapper.CancelAction, DialogWrapper.DialogStyle, DialogWrapper.DialogWrapperAction, DialogWrapper.DialogWrapperExitAction, DialogWrapper.DoNotAskOption, DialogWrapper.IdeModalityType, DialogWrapper.OkAction

Field Summary

Fields

Modifier and Type	Field and Description
protected ElementsChooser<T>	myChooser

Fields inherited from class com.intellij.openapi.ui.DialogWrapper

CANCEL_EXIT_CODE, CLOSE_EXIT_CODE, DEFAULT_ACTION, DIALOG_CONTENT_PANEL_PROPERTY, ERROR_FOREGROUND_COLOR, FOCUSED_ACTION, IS_VISUAL_PADDING_COMPENSATED_ON_COMPONENT_LEVEL_KEY, myCancelAction, myCheckBoxDoNotShowDialog, myDisposable, myHelpAction, myOKAction, myPerformAction, myPreferredFocusedComponent, NEXT_USER_EXIT_CODE, OK_EXIT_CODE

Constructor Summary

Constructors

Constructor and Description
ChooseElementsDialog(java.awt.Component parent, java.util.List<? extends T> items, java.lang.String title)
ChooseElementsDialog(java.awt.Component parent, java.util.List<? extends T> items, java.lang.String title, java.lang.String description, boolean sort)
ChooseElementsDialog(Project project, java.util.List<? extends T> items, java.lang.String title, java.lang.String description)
ChooseElementsDialog(Project project, java.util.List<? extends T> items, java.lang.String title, java.lang.String description, boolean sort)

Method Summary

Modifier and Type	Method and Description
protected boolean	canElementsBeMarked()
protected javax.swing.JComponent	createCenterPanel() Factory method.
java.util.List<T>	getChosenElements()
protected abstract javax.swing.Icon	getItemIcon(T item)
protected java.lang.String	getItemLocation(T item) Override this method and return non-null value to specify location of item.
protected abstract java.lang.String	getItemText(T item)
java.util.List<T>	getMarkedElements()
javax.swing.JComponent	getPreferredFocusedComponent()
protected boolean	isElementMarkedByDefault(T element)
void	selectElements(java.util.List<? extends T> elements)
java.util.List<T>	showAndGetResult()

Methods inherited from class com.intellij.openapi.ui.DialogWrapper

addKeyListener, addMouseListener, addMouseListener, canRecordDialogId, centerRelativeToParent, cleanupRootPane, cleanupWindowListeners, clickDefaultButton, close, close, createActions, createButtonsPanel, createCancelAction, createContentPane, createContentPaneBorder, createDefaultActions, createDefaultBorder, createDoNotAskCheckbox, createHelpButton, createJButtonForAction, createJButtonForAction, createLeftSideActions, createNorthPanel, createPeer, createPeer, createPeer, createPeer, createPeer, createPeer, createRootLayout, createSouthAdditionalPanel, createSouthPanel, createTitlePane, dispose, disposeIfNeeded, doCancelAction, doCancelAction, doHelpAction, doOKAction, doValidate, doValidateAll, extractMnemonic, findInstance, findInstanceFromFocus, getButton, getCancelAction, getContentPane, getContentPanel, getDimensionKey, getDimensionServiceKey, getDisposable, getDoNotShowMessage, getErrorTextAlignment, getExitCode, getHelpAction, getHelpId, getHorizontalStretch, getInitialLocation, getLocation, getOKAction, getOwner, getPeer, getPreferredSize, getRootPane, getSize, getStyle, getTitle, getTypeAheadTimeoutMs, getValidationThreadToUse, getVerticalStretch, getWindow, hasErrors, init, initValidation, isAutoAdjustable, isCenterStrictedToPreferredSize, isDisposed, isModal, isModalProgress, isMoveHelpButtonLeft, isNorthStrictedToPreferredSize, isOK, isOKActionEnabled, isProgressDialog, isResizable, isShowing, isSouthStrictedToPreferredSize, isToDispatchTypeAhead, isTypeAheadEnabled, isVisible, layoutButtonsPanel, pack, postponeValidation, processDoNotAskOnOk, repaint, setAutoAdjustable, setButtonsAlignment, setButtonsMargin, setCancelButtonIcon, setCancelButtonText, setCrossClosesWindow, setDoNotAskOption, setErrorInfoAll, setErrorText, setErrorText, setHelpTooltip, setHorizontalStretch, setInitialLocationCallback, setLocation, setLocation, setModal, setOKActionEnabled, setOKButtonIcon, setOKButtonMnemonic, setOKButtonText, setOKButtonTooltip, setResizable, setSize, setTitle, setUndecorated, setValidationDelay, setVerticalStretch, shouldAddErrorNearButtons, shouldCloseOnCross, show, showAndGet, showAndGetOk, startTrackingValidation, toBack, toBeShown, toFront, unregisterKeyboardActions, updateErrorInfo, validate

Methods inherited from class java.lang.Object

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

Field Detail

myChooser

protected ElementsChooser<T> myChooser

Constructor Detail

ChooseElementsDialog

public ChooseElementsDialog(Project project,
                            java.util.List<? extends T> items,
                            java.lang.String title,
                            java.lang.String description)

ChooseElementsDialog

public ChooseElementsDialog(Project project,
                            java.util.List<? extends T> items,
                            java.lang.String title,
                            java.lang.String description,
                            boolean sort)

ChooseElementsDialog

public ChooseElementsDialog(java.awt.Component parent,
                            java.util.List<? extends T> items,
                            java.lang.String title)

ChooseElementsDialog

public ChooseElementsDialog(java.awt.Component parent,
                            java.util.List<? extends T> items,
                            java.lang.String title,
                            java.lang.String description,
                            boolean sort)

Method Detail

canElementsBeMarked

protected boolean canElementsBeMarked()

Returns:

true if elements should have checkboxes

See Also:

getMarkedElements(), isElementMarkedByDefault(Object)

showAndGetResult

public java.util.List<T> showAndGetResult()

getItemText

protected abstract java.lang.String getItemText(T item)

getItemIcon

protected abstract javax.swing.Icon getItemIcon(T item)

getItemLocation

protected java.lang.String getItemLocation(T item)

Override this method and return non-null value to specify location of item. It will be shown as grayed text next to the item text.

getChosenElements

public java.util.List<T> getChosenElements()

selectElements

public void selectElements(java.util.List<? extends T> elements)

getPreferredFocusedComponent

public javax.swing.JComponent getPreferredFocusedComponent()

Overrides:

getPreferredFocusedComponent in class DialogWrapper

Returns:

component which should be focused when the dialog appears on the screen.

createCenterPanel

protected javax.swing.JComponent createCenterPanel()

Description copied from class: DialogWrapper

Factory method. It creates panel with dialog options. Options panel is located at the center of the dialog's content pane. The implementation can return null value. In this case there will be no options panel.

Specified by:

createCenterPanel in class DialogWrapper

isElementMarkedByDefault

protected boolean isElementMarkedByDefault(T element)

Returns:

true if element's checkbox should be selected by default Takes effect if canElementsBeMarked() returns true

getMarkedElements

public java.util.List<T> getMarkedElements()

Returns:

list of elements with selected checkboxes Works only if canElementsBeMarked() returns true

See Also:

isElementMarkedByDefault(Object)