Package com.intellij.openapi.ui.popup

Interface ListPopupStep<T>

All Known Subinterfaces:

ListPopupStepEx<T>

All Known Implementing Classes:

ActionPopupStep, AttachToProcessActionBase.AttachListStep, BaseListPopupStep, IntentionListStep, JsonSchemaInfoPopupStep, LookupActionsStep, MultiSelectionListPopupStep, PythonSdkDetailsStep

public interface ListPopupStep<T>

Interface for a custom step in a list popup.

See Also:

ListPopup, JBPopupFactory.createListPopup(ListPopupStep)

Method Summary

Modifier and Type	Method and Description
int	getDefaultOptionIndex() Returns the index of the item to be initially selected in the list.
javax.swing.Icon	getIconFor(T aValue) Returns the icon to display for the specified list item.
default javax.swing.Icon	getSelectedIconFor(T value)
ListSeparator	getSeparatorAbove(T value) Returns the separator to display above the specified list item.
java.lang.String	getTextFor(T value) Returns the text to display for the specified list item.
java.util.List<T>	getValues() Returns the values to be displayed in the list popup.
boolean	isSelectable(T value) Checks if the specified value in the list can be selected.

Method Detail

getValues

java.util.List<T> getValues()

Returns the values to be displayed in the list popup.

Returns:

the list of values to be displayed in the list popup.

isSelectable

boolean isSelectable(T value)

Checks if the specified value in the list can be selected.

Parameters:

value - the value to check.

Returns:

true if the value can be selected, false otherwise.

getIconFor

javax.swing.Icon getIconFor(T aValue)

Returns the icon to display for the specified list item.

Parameters:

aValue - the value for which the icon is requested.

Returns:

the icon to display, or null if no icon is necessary.

getSelectedIconFor

default javax.swing.Icon getSelectedIconFor(T value)

getTextFor

java.lang.String getTextFor(T value)

Returns the text to display for the specified list item.

Parameters:

value - the value for which the text is requested.

Returns:

the text to display.

getSeparatorAbove

ListSeparator getSeparatorAbove(T value)

Returns the separator to display above the specified list item.

Parameters:

value - the value for which the separator is requested.

Returns:

the separator to display, or null if no separator is necessary.

getDefaultOptionIndex

int getDefaultOptionIndex()

Returns the index of the item to be initially selected in the list.

Returns:

the index of the item to be initially selected in the list.