Package com.intellij.internal

Class SelectionBasedPsiElementInternalAction<T extends PsiElement>

java.lang.Object

com.intellij.openapi.actionSystem.AnAction

com.intellij.internal.SelectionBasedPsiElementInternalAction<T>

All Implemented Interfaces:

PossiblyDumbAware

public abstract class SelectionBasedPsiElementInternalAction<T extends PsiElement>
extends AnAction

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 java.lang.Class<T>	myClass
protected java.lang.Class<? extends PsiFile>	myFileClass

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

ACTIONS_KEY, EMPTY_ARRAY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SelectionBasedPsiElementInternalAction(java.lang.Class<T> aClass, java.lang.Class<? extends PsiFile> fileClass)

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(AnActionEvent e) Implement this method to provide your action handler.
protected java.util.List<T>	getElement(Editor editor, PsiFile file)
protected java.util.List<T>	getElementAtOffset(Editor editor, PsiFile file)
protected T	getElementFromSelection(PsiFile file, SelectionModel selectionModel)
protected abstract java.lang.String	getErrorHint()
protected abstract java.lang.String	getInformationHint(T element)
protected void	showError(Editor editor)
void	update(AnActionEvent e) 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

Field Detail

myClass

protected final java.lang.Class<T extends PsiElement> myClass

myFileClass

protected final java.lang.Class<? extends PsiFile> myFileClass

Constructor Detail

SelectionBasedPsiElementInternalAction

protected SelectionBasedPsiElementInternalAction(java.lang.Class<T> aClass,
                                                 java.lang.Class<? extends PsiFile> fileClass)

Method Detail

actionPerformed

public final 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

showError

protected void showError(Editor editor)

getInformationHint

protected abstract java.lang.String getInformationHint(T element)

getErrorHint

protected abstract java.lang.String getErrorHint()

getElement

protected java.util.List<T> getElement(Editor editor,
                                       PsiFile file)

getElementAtOffset

protected java.util.List<T> getElementAtOffset(Editor editor,
                                               PsiFile file)

getElementFromSelection

protected T getElementFromSelection(PsiFile file,
                                    SelectionModel selectionModel)

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