Package com.intellij.openapi.actionSystem.ex

Class DefaultCustomComponentAction

java.lang.Object

com.intellij.openapi.actionSystem.AnAction

com.intellij.openapi.actionSystem.ex.DefaultCustomComponentAction

All Implemented Interfaces:

LightEditCompatible, CustomComponentAction, PossiblyDumbAware

public class DefaultCustomComponentAction
extends AnAction
implements CustomComponentAction, LightEditCompatible

Nested Class Summary

Nested classes/interfaces inherited from class com.intellij.openapi.actionSystem.AnAction

AnAction.TransparentUpdate

Field Summary

Fields inherited from class com.intellij.openapi.actionSystem.AnAction

ACTIONS_KEY, EMPTY_ARRAY

Fields inherited from interface com.intellij.openapi.actionSystem.ex.CustomComponentAction

ACTION_KEY, COMPONENT_KEY

Constructor Summary

Constructors

Constructor and Description
DefaultCustomComponentAction(java.util.function.Supplier<? extends javax.swing.JComponent> producer)

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(AnActionEvent e) Implement this method to provide your action handler.
javax.swing.JComponent	createCustomComponent(Presentation presentation, java.lang.String place)

Methods inherited from class com.intellij.openapi.actionSystem.AnAction

addTextOverride, applyTextOverride, beforeActionPerformedUpdate, copyFrom, copyShortcutFrom, displayTextInToolbar, getEventProject, getShortcutSet, getTemplatePresentation, getTemplateText, isDefaultIcon, isEnabledInModalContext, isInInjectedContext, isTransparentUpdate, registerCustomShortcutSet, registerCustomShortcutSet, registerCustomShortcutSet, registerCustomShortcutSet, setDefaultIcon, setEnabledInModalContext, setInjectedContext, setShortcutSet, startInTransaction, toString, unregisterCustomShortcutSet, update, useSmallerFontForTextInToolbar

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.openapi.actionSystem.ex.CustomComponentAction

createCustomComponent

Methods inherited from interface com.intellij.openapi.project.PossiblyDumbAware

isDumbAware

Constructor Detail

DefaultCustomComponentAction

public DefaultCustomComponentAction(java.util.function.Supplier<? extends javax.swing.JComponent> producer)

Method Detail

actionPerformed

public void actionPerformed(AnActionEvent e)

Description copied from class: AnAction

Implement this method to provide your action handler.

Specified by:

actionPerformed in class AnAction

Parameters:

e - Carries information on the invocation place

createCustomComponent

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

Specified by:

createCustomComponent in interface CustomComponentAction

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 CustomComponentAction.COMPONENT_KEY to retrieve current component from a Presentation instance in AnAction.update(AnActionEvent) method.