Package com.intellij.ui

Class SwingActionDelegate

java.lang.Object

com.intellij.openapi.actionSystem.AnAction

com.intellij.ui.SwingActionDelegate

All Implemented Interfaces:

DumbAware, PossiblyDumbAware

Direct Known Subclasses:

ListActions, ScrollPaneActions, TableActions, TreeActions

public class SwingActionDelegate
extends AnAction
implements DumbAware

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SwingActionDelegate(java.lang.String actionId)

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(AnActionEvent event) Implement this method to provide your action handler.
static void	configureMapping(javax.swing.JComponent component, java.util.function.Function<java.lang.String,javax.swing.JComponent> mapping)
static void	configureMapping(javax.swing.JComponent base, javax.swing.JComponent dependant, java.lang.String... actions)
static void	disableFor(javax.swing.JComponent component)
protected javax.swing.JComponent	getComponent(AnActionEvent event)
void	update(AnActionEvent event) Updates the state of the action.

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, 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.project.PossiblyDumbAware

isDumbAware

Constructor Detail

SwingActionDelegate

protected SwingActionDelegate(java.lang.String actionId)

Method Detail

getComponent

protected javax.swing.JComponent getComponent(AnActionEvent event)

update

public final void update(AnActionEvent event)

Description copied from class: AnAction

Updates the state of the action. Default implementation does nothing. Override this method to provide the ability to dynamically change action's state and(or) presentation depending on the context (For example when your action state depends on the selection you can check for selection and change the state accordingly).

This method can be called frequently, and on UI thread. This means that this method is supposed to work really fast, no real work should be done at this phase. For example, checking selection in a tree or a list, is considered valid, but working with a file system or PSI (especially resolve) is not. If you cannot determine the state of the action fast enough, you should do it in the AnAction.actionPerformed(AnActionEvent) method and notify the user that action cannot be executed if it's the case.

If the action is added to a toolbar, its "update" can be called twice a second, but only if there was any user activity or a focus transfer. If your action's availability is changed in absence of any of these events, please call ActivityTracker.getInstance().inc() to notify action subsystem to update all toolbar actions when your subsystem's determines that its actions' visibility might be affected.

Overrides:

update in class AnAction

Parameters:

event - Carries information on the invocation place and data available

actionPerformed

public final void actionPerformed(AnActionEvent event)

Description copied from class: AnAction

Implement this method to provide your action handler.

Specified by:

actionPerformed in class AnAction

Parameters:

event - Carries information on the invocation place

configureMapping

public static void configureMapping(javax.swing.JComponent component,
                                    java.util.function.Function<java.lang.String,javax.swing.JComponent> mapping)

Parameters:

component - the base component that delegates performing of actions to a dependant component

mapping - a function that returns a component that able to perform a named action, or null to remove mapping for the given base component

configureMapping

public static void configureMapping(javax.swing.JComponent base,
                                    javax.swing.JComponent dependant,
                                    java.lang.String... actions)

Parameters:

base - the base component that delegates performing of actions to the dependant component

dependant - the dependant component that should perform suported actions instead of the base component

actions - a list of supported actions

disableFor

public static void disableFor(javax.swing.JComponent component)

Parameters:

component - the base component that should not perform actions