Package com.intellij.ui

Class AnActionButton

java.lang.Object

com.intellij.openapi.actionSystem.AnAction

com.intellij.ui.AnActionButton

All Implemented Interfaces:

ShortcutProvider, PossiblyDumbAware

Direct Known Subclasses:

AnActionButton.AnActionButtonWrapper, DeleteFromFavoritesAction, DumbAwareActionButton, FavoritesToolbarButtonAction, ToggleActionButton, ToolbarDecorator.ElementActionButton

public abstract class AnActionButton
extends AnAction
implements ShortcutProvider

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AnActionButton.ActionButtonListener
static class	AnActionButton.AnActionButtonWrapper
static class	AnActionButton.AnActionEventWrapper
static class	AnActionButton.CheckedAnActionButton

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

Constructor and Description
AnActionButton()
AnActionButton(java.lang.String text)
AnActionButton(java.lang.String text, javax.swing.Icon icon)
AnActionButton(java.lang.String text, java.lang.String description, javax.swing.Icon icon)
AnActionButton(java.util.function.Supplier<java.lang.String> dynamicText)
AnActionButton(java.util.function.Supplier<java.lang.String> dynamicText, javax.swing.Icon icon)
AnActionButton(java.util.function.Supplier<java.lang.String> dynamicText, java.util.function.Supplier<java.lang.String> dynamicDescription, javax.swing.Icon icon)

Method Summary

Modifier and Type	Method and Description
void	addActionButtonListener(AnActionButton.ActionButtonListener l, Disposable parentDisposable)
void	addCustomUpdater(AnActionButtonUpdater updater)
static AnActionButton	fromAction(AnAction action)
javax.swing.JComponent	getContextComponent()
DataContext	getDataContext()
RelativePoint	getPreferredPopupPoint()
ShortcutSet	getShortcut()
boolean	isEnabled()
boolean	isVisible()
boolean	removeActionButtonListener(AnActionButton.ActionButtonListener l)
void	setContextComponent(javax.swing.JComponent contextComponent)
void	setEnabled(boolean enabled)
void	setShortcut(ShortcutSet shortcut)
void	setVisible(boolean visible)
void	update(AnActionEvent e) Updates the state of the action.
void	updateButton(AnActionEvent e)

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

actionPerformed, 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

AnActionButton

public AnActionButton(java.lang.String text)

AnActionButton

public AnActionButton(java.util.function.Supplier<java.lang.String> dynamicText)

AnActionButton

public AnActionButton(java.lang.String text,
                      java.lang.String description,
                      javax.swing.Icon icon)

AnActionButton

public AnActionButton(java.util.function.Supplier<java.lang.String> dynamicText,
                      java.util.function.Supplier<java.lang.String> dynamicDescription,
                      javax.swing.Icon icon)

AnActionButton

public AnActionButton(java.lang.String text,
                      javax.swing.Icon icon)

AnActionButton

public AnActionButton(java.util.function.Supplier<java.lang.String> dynamicText,
                      javax.swing.Icon icon)

AnActionButton

public AnActionButton()

Method Detail

fromAction

public static AnActionButton fromAction(AnAction action)

isEnabled

public boolean isEnabled()

setEnabled

public void setEnabled(boolean enabled)

isVisible

public boolean isVisible()

setVisible

public void setVisible(boolean visible)

update

public final void update(AnActionEvent e)

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:

e - Carries information on the invocation place and data available

addCustomUpdater

public final void addCustomUpdater(AnActionButtonUpdater updater)

updateButton

public void updateButton(AnActionEvent e)

getShortcut

public ShortcutSet getShortcut()

Specified by:

getShortcut in interface ShortcutProvider

setShortcut

public void setShortcut(ShortcutSet shortcut)

setContextComponent

public void setContextComponent(javax.swing.JComponent contextComponent)

getContextComponent

public javax.swing.JComponent getContextComponent()

getDataContext

public DataContext getDataContext()

getPreferredPopupPoint

public final RelativePoint getPreferredPopupPoint()

addActionButtonListener

public void addActionButtonListener(AnActionButton.ActionButtonListener l,
                                    Disposable parentDisposable)

removeActionButtonListener

public boolean removeActionButtonListener(AnActionButton.ActionButtonListener l)