Package com.intellij.openapi.roots.ui.configuration.artifacts.actions

Class LayoutTreeActionBase

java.lang.Object

com.intellij.openapi.actionSystem.AnAction

com.intellij.openapi.project.DumbAwareAction

com.intellij.openapi.roots.ui.configuration.artifacts.actions.LayoutTreeActionBase

All Implemented Interfaces:

DumbAware, PossiblyDumbAware

Direct Known Subclasses:

ExtractArtifactAction, RemovePackagingElementAction, SurroundElementWithAction

public abstract class LayoutTreeActionBase
extends DumbAwareAction

Nested Class Summary

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

AnAction.TransparentUpdate

Field Summary

Fields

Modifier and Type	Field and Description
protected ArtifactEditorEx	myArtifactEditor

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

ACTIONS_KEY, EMPTY_ARRAY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LayoutTreeActionBase(java.lang.String text, ArtifactEditorEx artifactEditor)
protected	LayoutTreeActionBase(java.lang.String text, java.lang.String description, javax.swing.Icon icon, ArtifactEditorEx artifactEditor)
protected	LayoutTreeActionBase(java.util.function.Supplier<java.lang.String> text, ArtifactEditorEx artifactEditor)

Method Summary

Modifier and Type	Method and Description
protected abstract boolean	isEnabled()
void	update(AnActionEvent e) Updates the state of the action.

Methods inherited from class com.intellij.openapi.project.DumbAwareAction

create, create

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

Field Detail

myArtifactEditor

protected final ArtifactEditorEx myArtifactEditor

Constructor Detail

LayoutTreeActionBase

protected LayoutTreeActionBase(java.lang.String text,
                               java.lang.String description,
                               javax.swing.Icon icon,
                               ArtifactEditorEx artifactEditor)

LayoutTreeActionBase

protected LayoutTreeActionBase(java.lang.String text,
                               ArtifactEditorEx artifactEditor)

LayoutTreeActionBase

protected LayoutTreeActionBase(java.util.function.Supplier<java.lang.String> text,
                               ArtifactEditorEx artifactEditor)

Method Detail

update

public 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

isEnabled

protected abstract boolean isEnabled()