Package com.intellij.openapi.actionSystem.ex

Interface CustomComponentAction

All Known Implementing Classes:

AbstractComboBoxAction, ChangeCompareModeGroup, CheckboxAction, CheckBoxSearchEverywhereToggleAction, ChooseFileEncodingAction, ChooseLocaleAction, ComboBoxAction, DefaultCustomComponentAction, EditorHeaderSetSearchContextAction, EditorHeaderToggleAction, FilterByThemeComboBoxAction, HideCoverageInfoAction, HierarchyBrowserBaseEx.ChangeScopeAction, IconWithTextAction, LabeledComboBoxAction, LevelChooserAction, LocalQuickFixWrapper, MoreAction, QuickFixAction, RunAnythingAction, RunConfigurationsComboBoxAction, ScopesChooser, SearchEverywhereAction, SearchFieldAction, SelectFilteringAction, SelectGroupingAction, SetTodoFilterAction, SplitButtonAction, StatusTextAction, StatusTextAction, SwitchTaskAction, TextDiffViewerUtil.ComboBoxSettingAction, TextDiffViewerUtil.HighlightPolicySettingAction, TextDiffViewerUtil.IgnorePolicySettingAction, TextFieldAction, ThreeStateCheckboxAction, ToggleAction, ToggleAnywhereAction, ToggleExceptCommentsAction, ToggleExceptCommentsAndLiteralsAction, ToggleExceptLiteralsAction, ToggleInCommentsAction, ToggleInLiteralsOnlyAction, ToggleMatchCase, TogglePreserveCaseAction, ToggleRegex, ToggleWholeWordsOnlyAction, ToolbarLabelAction, VcsLogClassicFilterUi.FilterActionComponent, VcsToolbarLabelAction

public interface CustomComponentAction

Field Summary

Fields

Modifier and Type	Field and Description
static Key<AnAction>	ACTION_KEY
static Key<javax.swing.JComponent>	COMPONENT_KEY

Method Summary

Modifier and Type	Method and Description
default javax.swing.JComponent	createCustomComponent(Presentation presentation) Deprecated. Use createCustomComponent(Presentation, String)
default javax.swing.JComponent	createCustomComponent(Presentation presentation, java.lang.String place)

Field Detail

COMPONENT_KEY

static final Key<javax.swing.JComponent> COMPONENT_KEY

ACTION_KEY

static final Key<AnAction> ACTION_KEY

Method Detail

createCustomComponent

default javax.swing.JComponent createCustomComponent(Presentation presentation,
                                                     java.lang.String place)

Returns:

custom JComponent that represents action in UI. You (as a client/implementor) or this interface are not allowed to invoke this method directly. Only action system can invoke it!

The component should not be stored in the action instance because it may be shown on several toolbars simultaneously. Use COMPONENT_KEY to retrieve current component from a Presentation instance in AnAction.update(AnActionEvent) method.

createCustomComponent

@Deprecated
default javax.swing.JComponent createCustomComponent(Presentation presentation)

Deprecated. Use createCustomComponent(Presentation, String)