Package com.intellij.structuralsearch.plugin.ui.filters

Class FilterAction

java.lang.Object

com.intellij.openapi.actionSystem.AnAction

com.intellij.structuralsearch.plugin.ui.filters.FilterAction

All Implemented Interfaces:

PossiblyDumbAware, Filter

Direct Known Subclasses:

ContextFilter, CountFilter, ReferenceFilter, ScriptFilter, TextFilter, TypeFilter

public abstract class FilterAction
extends AnAction
implements Filter

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 SimpleColoredComponent	myLabel
protected FilterTable	myTable

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

ACTIONS_KEY, EMPTY_ARRAY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FilterAction(java.util.function.Supplier<java.lang.String> text, FilterTable table)

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(AnActionEvent e) Implement this method to provide your action handler.
boolean	checkApplicable(java.util.List<? extends PsiElement> nodes, boolean completePattern, boolean target)
abstract void	clearFilter()
SimpleColoredComponent	getRenderer()
abstract boolean	hasFilter()
protected void	initFilter()
protected abstract boolean	isApplicable(java.util.List<? extends PsiElement> nodes, boolean completePattern, boolean target)
boolean	isAvailable()
int	position()
protected abstract void	setLabel(SimpleColoredComponent component)
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.structuralsearch.plugin.ui.filters.Filter

getEditor

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

isDumbAware

Field Detail

myLabel

protected final SimpleColoredComponent myLabel

myTable

protected final FilterTable myTable

Constructor Detail

FilterAction

protected FilterAction(java.util.function.Supplier<java.lang.String> text,
                       FilterTable table)

Method Detail

position

public final int position()

Specified by:

position in interface Filter

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

getRenderer

public final SimpleColoredComponent getRenderer()

Specified by:

getRenderer in interface Filter

setLabel

protected abstract void setLabel(SimpleColoredComponent component)

hasFilter

public abstract boolean hasFilter()

initFilter

protected void initFilter()

clearFilter

public abstract void clearFilter()

isApplicable

protected abstract boolean isApplicable(java.util.List<? extends PsiElement> nodes,
                                        boolean completePattern,
                                        boolean target)

isAvailable

public boolean isAvailable()

checkApplicable

public boolean checkApplicable(java.util.List<? extends PsiElement> nodes,
                               boolean completePattern,
                               boolean target)

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