Package com.intellij.openapi.actionSystem

Class ToggleAction

java.lang.Object

com.intellij.openapi.actionSystem.AnAction

com.intellij.openapi.actionSystem.ToggleAction

All Implemented Interfaces:

Toggleable, PossiblyDumbAware

Direct Known Subclasses:

AbstractToggleUseSoftWrapsAction, AnnotateToggleAction, BaseToggleStateAction, BaseToolWindowToggleAction, BooleanPropertyToggleAction, ChangeHierarchyViewActionBase, CheckboxAction, ContentEntryEditingAction, DebugBuildProcessToggleAction, DeepCompareAction, DirDiffAction, DumbAwareToggleAction, EditorToggleDecorationAction, EnableBackgroundTrackingAction, ExternalSystemToggleAction, FlattenModulesToggleAction, FlattenPackagesAction, GroupByConfigurationStatusAction, GroupByConfigurationTypeAction, GroupByContributorAction, GroupByScopeTypeAction, GroupByServiceGroupsAction, HideWhitespaceAction, HierarchyBrowserBaseEx.AlphaSortAction, IntelliSortChooserToggleAction, LineStatusMarkerPopupRenderer.ToggleByWordDiffAction, MemberChooser.ShowContainersAction, MuteBreakpointAction, PauseOutputAction, PauseOutputAction, ProjectWindowAction, PyVariableViewSettings.PolicyAction, PyVariableViewSettings.SimplifiedView, RegistryToggleAction, RulerGuideAction, ScrollToTheEndToolbarAction, SetEditorBidiTextDirectionAction, ShowClassesWithDiffAction, ShowClassesWithInstanceAction, ShowColumns, ShowComponentTagsAction, ShowDiffPreviewAction, ShowExpert, ShowFilesAction, ShowFilterAction, ShowGridAction, ShowHiddensAction, ShowHideAspectAction, ShowHideRecycledAction, ShowModuleGroupsAction, ShowModulesAction, ShowModulesAction, ShowServicesAction, ShowTrackedAction, SortElementsToggleAction, SortValuesToggleAction, SwitchUpdateModeAction, TableTabAction, TextDiffViewerUtil.ReadOnlyLockAction, ToggleBooleanProperty, ToggleColumnModeAction, ToggleCompletionHintsAction, ToggleDockModeAction, ToggleEditorModeAction, ToggleFileNameAction, ToggleFileSizeAction, ToggleFloatingModeAction, ToggleFocusViewModeAction, ToggleGridAction, ToggleOfflineAction, ToggleOptionAction, TogglePowerSaveAction, ToggleRenderDocsOnFileOpeningAction, ToggleSelectionOnlyAction, ToggleShowDocsOnHoverAction, ToggleShowElementContentAction, ToggleShowImportPopupsAction, ToggleShowIndentLinesGloballyAction, ToggleShowLineNumbersGloballyAction, ToggleTagsPanelAction, ToggleToolbarAction, ToggleTransparencyChessboardAction, ToggleUseSoftWrapsInPreviewAction, ToggleWindowedModeAction, TrackInstancesToggleAction, TreeActionWrapper, UiDropperAction, UiInspectorAction, UnmuteOnStopAction, UseInlineDebuggerAction, VerboseAction, ViewMainMenuAction, ViewNavigationBarAction, ViewNavigationBarMembersAction, ViewStatusBarAction, ViewToolbarAction, ViewToolWindowButtonsAction, WarnOnDeletion, XSwitchWatchesInVariables

public abstract class ToggleAction
extends AnAction
implements Toggleable

An action which has a selected state, and which toggles its selected state when performed. Can be used to represent a menu item with a checkbox, or a toolbar button which keeps its pressed state.

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

Fields inherited from interface com.intellij.openapi.actionSystem.Toggleable

SELECTED_PROPERTY

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(AnActionEvent e) Implement this method to provide your action handler.
abstract boolean	isSelected(AnActionEvent e) Returns the selected (checked, pressed) state of the action.
abstract void	setSelected(AnActionEvent e, boolean state) Sets the selected state of the action to the specified value.
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.actionSystem.Toggleable

isSelected, setSelected

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

isDumbAware

Constructor Detail

ToggleAction

public ToggleAction()

ToggleAction

public ToggleAction(java.lang.String text)

ToggleAction

public ToggleAction(java.util.function.Supplier<java.lang.String> text)

ToggleAction

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

ToggleAction

public ToggleAction(java.util.function.Supplier<java.lang.String> text,
                    java.util.function.Supplier<java.lang.String> description,
                    javax.swing.Icon icon)

ToggleAction

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

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

isSelected

public abstract boolean isSelected(AnActionEvent e)

Returns the selected (checked, pressed) state of the action.

Parameters:

e - the action event representing the place and context in which the selected state is queried.

Returns:

true if the action is selected, false otherwise

setSelected

public abstract void setSelected(AnActionEvent e,
                                 boolean state)

Sets the selected state of the action to the specified value.

Parameters:

e - the action event which caused the state change.

state - the new selected state of the action.

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