Package com.intellij.ide.util.gotoByName

Class ChooseByNameBase

java.lang.Object

com.intellij.ide.util.gotoByName.ChooseByNameBase

All Implemented Interfaces:

ChooseByNameViewModel

Direct Known Subclasses:

ChooseByNamePanel, ChooseByNamePopup

public abstract class ChooseByNameBase
extends java.lang.Object
implements ChooseByNameViewModel

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ChooseByNameBase.JPanelProvider
protected class	ChooseByNameBase.MyTextField

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	EXTRA_ELEM
protected ChooseByNamePopupComponent.Callback	myActionListener
protected Alarm	myAlarm
protected javax.swing.JCheckBox	myCheckBox
protected JBPopup	myDropdownPopup
protected javax.swing.JList<java.lang.Object>	myList
protected ChooseByNameModel	myModel
protected Project	myProject
protected ChooseByNameItemProvider	myProvider
protected ChooseByNameBase.MyTextField	myTextField
static java.lang.String	TEMPORARILY_FOCUSABLE_COMPONENT_KEY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ChooseByNameBase(Project project, ChooseByNameModel model, ChooseByNameItemProvider provider, java.lang.String initialText)
protected	ChooseByNameBase(Project project, ChooseByNameModel model, ChooseByNameItemProvider provider, java.lang.String initialText, int initialIndex)
protected	ChooseByNameBase(Project project, ChooseByNameModel model, java.lang.String initialText, PsiElement context)

Method Summary

Modifier and Type	Method and Description
int	calcSelectedIndex(java.lang.Object [] modelElements, java.lang.String trimmedText)
boolean	canShowListForEmptyPattern() If true, top matching candidates should be shown in the popup also when the entered pattern is empty.
boolean	checkDisposed()
protected void	chosenElementMightChange()
protected abstract void	close(boolean isOk)
protected boolean	closeForbidden(boolean ok)
protected void	doClose(boolean ok)
protected java.util.Set<java.lang.Object>	filter(java.util.Set<java.lang.Object> elements)
java.lang.Object	getChosenElement()
protected java.util.List<java.lang.Object>	getChosenElements()
int	getMaximumListSizeLimit() Returns the maximum number of candidates to show in the popup.
ChooseByNameModel	getModel()
java.lang.String []	getNames(boolean checkboxState)
Project	getProject()
ChooseByNameItemProvider	getProvider()
javax.swing.JTextField	getTextField()
java.lang.String	getTrimmedText()
boolean	hasPostponedAction() Deprecated. unused
protected abstract void	hideList()
protected void	initUI(ChooseByNamePopupComponent.Callback callback, ModalityState modalityState, boolean allowMultipleSelection)
void	invoke(ChooseByNamePopupComponent.Callback callback, ModalityState modalityState, boolean allowMultipleSelection)
protected abstract boolean	isCheckboxVisible()
protected abstract boolean	isCloseByFocusLost()
boolean	isClosedByShiftEnter()
boolean	isOpenInCurrentWindowRequested()
boolean	isSearchInAnyPlace() If true, the pattern entered in the dialog should be searched anywhere in the text of the candidate items, not just in the beginning.
protected abstract boolean	isShowListForEmptyPattern()
void	rebuildList(boolean initial) Default rebuild list.
void	scheduleCalcElements(java.lang.String text, boolean checkboxState, ModalityState modalityState, SelectionPolicy policy, Consumer<? super java.util.Set<?>> callback)
void	setAlwaysHasMore(boolean enabled) Display ... item at the end of the list regardless of whether it was filled up or not.
void	setCheckBoxShortcut(ShortcutSet shortcutSet)
void	setDisposed(boolean disposedFlag)
void	setFindUsagesTitle(java.lang.String findUsagesTitle)
void	setListSizeIncreasing(int listSizeIncreasing)
void	setMaximumListSizeLimit(int maximumListSizeLimit)
void	setSearchInAnyPlace(boolean searchInAnyPlace)
void	setToolArea(javax.swing.JComponent toolArea) Set tool area.
protected abstract void	showList()
protected void	showTextFieldPanel()
java.lang.String	transformPattern(java.lang.String pattern) Transforms text entered by the user in the dialog into the search pattern (for example, removes irrelevant suffixes like "line ...")

Methods inherited from class java.lang.Object

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

Field Detail

TEMPORARILY_FOCUSABLE_COMPONENT_KEY

public static final java.lang.String TEMPORARILY_FOCUSABLE_COMPONENT_KEY

See Also:

Constant Field Values

myProject

protected final Project myProject

myModel

protected final ChooseByNameModel myModel

myProvider

protected ChooseByNameItemProvider myProvider

myTextField

protected final ChooseByNameBase.MyTextField myTextField

myCheckBox

protected final javax.swing.JCheckBox myCheckBox

myList

protected final javax.swing.JList<java.lang.Object> myList

myActionListener

protected ChooseByNamePopupComponent.Callback myActionListener

myAlarm

protected final Alarm myAlarm

myDropdownPopup

protected JBPopup myDropdownPopup

EXTRA_ELEM

public static final java.lang.String EXTRA_ELEM

See Also:

Constant Field Values

Constructor Detail

ChooseByNameBase

protected ChooseByNameBase(Project project,
                           ChooseByNameModel model,
                           java.lang.String initialText,
                           PsiElement context)

Parameters:

initialText - initial text which will be in the lookup text field

ChooseByNameBase

protected ChooseByNameBase(Project project,
                           ChooseByNameModel model,
                           ChooseByNameItemProvider provider,
                           java.lang.String initialText)

ChooseByNameBase

protected ChooseByNameBase(Project project,
                           ChooseByNameModel model,
                           ChooseByNameItemProvider provider,
                           java.lang.String initialText,
                           int initialIndex)

Parameters:

initialText - initial text which will be in the lookup text field

Method Detail

checkDisposed

public boolean checkDisposed()

setDisposed

public void setDisposed(boolean disposedFlag)

getProject

public Project getProject()

Specified by:

getProject in interface ChooseByNameViewModel

isSearchInAnyPlace

public boolean isSearchInAnyPlace()

Description copied from interface: ChooseByNameViewModel

If true, the pattern entered in the dialog should be searched anywhere in the text of the candidate items, not just in the beginning.

Specified by:

isSearchInAnyPlace in interface ChooseByNameViewModel

setSearchInAnyPlace

public void setSearchInAnyPlace(boolean searchInAnyPlace)

isClosedByShiftEnter

public boolean isClosedByShiftEnter()

isOpenInCurrentWindowRequested

public boolean isOpenInCurrentWindowRequested()

setToolArea

public void setToolArea(javax.swing.JComponent toolArea)

Set tool area. The method may be called only before invoke.

Parameters:

toolArea - a tool area component

setFindUsagesTitle

public void setFindUsagesTitle(java.lang.String findUsagesTitle)

invoke

public void invoke(ChooseByNamePopupComponent.Callback callback,
                   ModalityState modalityState,
                   boolean allowMultipleSelection)

getModel

public ChooseByNameModel getModel()

Specified by:

getModel in interface ChooseByNameViewModel

initUI

protected void initUI(ChooseByNamePopupComponent.Callback callback,
                      ModalityState modalityState,
                      boolean allowMultipleSelection)

Parameters:

modalityState - - if not null rebuilds list in given ModalityState

setCheckBoxShortcut

public void setCheckBoxShortcut(ShortcutSet shortcutSet)

rebuildList

public void rebuildList(boolean initial)

Default rebuild list. It uses myRebuildDelay and current modality state.

transformPattern

public java.lang.String transformPattern(java.lang.String pattern)

Description copied from interface: ChooseByNameViewModel

Transforms text entered by the user in the dialog into the search pattern (for example, removes irrelevant suffixes like "line ...")

Specified by:

transformPattern in interface ChooseByNameViewModel

doClose

protected void doClose(boolean ok)

closeForbidden

protected boolean closeForbidden(boolean ok)

getTrimmedText

public java.lang.String getTrimmedText()

getNames

public java.lang.String [] getNames(boolean checkboxState)

filter

protected java.util.Set<java.lang.Object> filter(java.util.Set<java.lang.Object> elements)

isCheckboxVisible

protected abstract boolean isCheckboxVisible()

isShowListForEmptyPattern

protected abstract boolean isShowListForEmptyPattern()

isCloseByFocusLost

protected abstract boolean isCloseByFocusLost()

showTextFieldPanel

protected void showTextFieldPanel()

scheduleCalcElements

public void scheduleCalcElements(java.lang.String text,
                                 boolean checkboxState,
                                 ModalityState modalityState,
                                 SelectionPolicy policy,
                                 Consumer<? super java.util.Set<?>> callback)

calcSelectedIndex

public int calcSelectedIndex(java.lang.Object [] modelElements,
                             java.lang.String trimmedText)

hasPostponedAction

@Deprecated
public boolean hasPostponedAction()

Deprecated. unused

showList

protected abstract void showList()

hideList

protected abstract void hideList()

close

protected abstract void close(boolean isOk)

getChosenElement

public java.lang.Object getChosenElement()

getChosenElements

protected java.util.List<java.lang.Object> getChosenElements()

chosenElementMightChange

protected void chosenElementMightChange()

getProvider

public ChooseByNameItemProvider getProvider()

canShowListForEmptyPattern

public boolean canShowListForEmptyPattern()

Description copied from interface: ChooseByNameViewModel

If true, top matching candidates should be shown in the popup also when the entered pattern is empty. If false, an empty list is displayed when the user has not entered any pattern.

Specified by:

canShowListForEmptyPattern in interface ChooseByNameViewModel

getMaximumListSizeLimit

public int getMaximumListSizeLimit()

Description copied from interface: ChooseByNameViewModel

Returns the maximum number of candidates to show in the popup.

Specified by:

getMaximumListSizeLimit in interface ChooseByNameViewModel

setMaximumListSizeLimit

public void setMaximumListSizeLimit(int maximumListSizeLimit)

setListSizeIncreasing

public void setListSizeIncreasing(int listSizeIncreasing)

setAlwaysHasMore

public void setAlwaysHasMore(boolean enabled)

Display ... item at the end of the list regardless of whether it was filled up or not. This option can be useful in cases, when it can't be said beforehand, that the next call to ChooseByNameItemProvider won't give new items.

getTextField

public javax.swing.JTextField getTextField()