Package com.intellij.openapi.actionSystem.ex

Class CheckboxAction

java.lang.Object

com.intellij.openapi.actionSystem.AnAction

com.intellij.openapi.actionSystem.ToggleAction

com.intellij.openapi.actionSystem.ex.CheckboxAction

All Implemented Interfaces:

CustomComponentAction, Toggleable, PossiblyDumbAware

Direct Known Subclasses:

CheckBoxSearchEverywhereToggleAction, EditorHeaderToggleAction, ToggleAction

public abstract class CheckboxAction
extends ToggleAction
implements CustomComponentAction

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.ex.CustomComponentAction

ACTION_KEY, COMPONENT_KEY

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

SELECTED_PROPERTY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CheckboxAction()
protected	CheckboxAction(java.lang.String text)
protected	CheckboxAction(java.lang.String text, java.lang.String description, javax.swing.Icon icon)
protected	CheckboxAction(java.util.function.Supplier<java.lang.String> dynamicText)
protected	CheckboxAction(java.util.function.Supplier<java.lang.String> dynamicText, java.util.function.Supplier<java.lang.String> dynamicDescription, javax.swing.Icon icon)

Method Summary

Modifier and Type	Method and Description
javax.swing.JComponent	createCustomComponent(Presentation presentation, java.lang.String place)
void	update(AnActionEvent e) Updates the state of the action.
protected void	updateCustomComponent(javax.swing.JCheckBox checkBox, Presentation presentation)

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

actionPerformed, isSelected, setSelected

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.ex.CustomComponentAction

createCustomComponent

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

isSelected, setSelected

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

isDumbAware

Constructor Detail

CheckboxAction

protected CheckboxAction()

CheckboxAction

protected CheckboxAction(java.lang.String text)

CheckboxAction

protected CheckboxAction(java.util.function.Supplier<java.lang.String> dynamicText)

CheckboxAction

protected CheckboxAction(java.lang.String text,
                         java.lang.String description,
                         javax.swing.Icon icon)

CheckboxAction

protected CheckboxAction(java.util.function.Supplier<java.lang.String> dynamicText,
                         java.util.function.Supplier<java.lang.String> dynamicDescription,
                         javax.swing.Icon icon)

Method Detail

createCustomComponent

public javax.swing.JComponent createCustomComponent(Presentation presentation,
                                                    java.lang.String place)

Specified by:

createCustomComponent in interface CustomComponentAction

Returns:

custom JComponent that represents action in UI. You (as a client/implementor) or this interface are not allowed to invoke this method directly. Only action system can invoke it!

The component should not be stored in the action instance because it may be shown on several toolbars simultaneously. Use CustomComponentAction.COMPONENT_KEY to retrieve current component from a Presentation instance in AnAction.update(AnActionEvent) method.

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 ToggleAction

Parameters:

e - Carries information on the invocation place and data available

updateCustomComponent

protected void updateCustomComponent(javax.swing.JCheckBox checkBox,
                                     Presentation presentation)