Package com.intellij.openapi.actionSystem

Class ToggleOptionAction

java.lang.Object

com.intellij.openapi.actionSystem.AnAction

com.intellij.openapi.actionSystem.ToggleAction

com.intellij.openapi.actionSystem.ToggleOptionAction

All Implemented Interfaces:

Toggleable, PossiblyDumbAware

public class ToggleOptionAction
extends ToggleAction

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ToggleOptionAction.Option

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
ToggleOptionAction(java.util.function.Function<AnActionEvent,ToggleOptionAction.Option> optionSupplier)
ToggleOptionAction(java.util.function.Function<AnActionEvent,ToggleOptionAction.Option> optionSupplier, javax.swing.Icon icon)
ToggleOptionAction(ToggleOptionAction.Option option)
ToggleOptionAction(ToggleOptionAction.Option option, javax.swing.Icon icon)

Method Summary

Modifier and Type	Method and Description
boolean	isSelected(AnActionEvent event) Returns the selected (checked, pressed) state of the action.
void	setSelected(AnActionEvent event, boolean selected) Sets the selected state of the action to the specified value.
void	update(AnActionEvent event) Updates the state of the action.

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

actionPerformed

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

ToggleOptionAction

public ToggleOptionAction(ToggleOptionAction.Option option)

ToggleOptionAction

public ToggleOptionAction(ToggleOptionAction.Option option,
                          javax.swing.Icon icon)

ToggleOptionAction

public ToggleOptionAction(java.util.function.Function<AnActionEvent,ToggleOptionAction.Option> optionSupplier)

ToggleOptionAction

public ToggleOptionAction(java.util.function.Function<AnActionEvent,ToggleOptionAction.Option> optionSupplier,
                          javax.swing.Icon icon)

Method Detail

isSelected

public final boolean isSelected(AnActionEvent event)

Description copied from class: ToggleAction

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

Specified by:

isSelected in class ToggleAction

Parameters:

event - 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 final void setSelected(AnActionEvent event,
                              boolean selected)

Description copied from class: ToggleAction

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

Specified by:

setSelected in class ToggleAction

Parameters:

event - the action event which caused the state change.

selected - the new selected state of the action.

update

public final void update(AnActionEvent event)

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 ToggleAction

Parameters:

event - Carries information on the invocation place and data available