Package com.intellij.ui

Class ToggleActionButton

java.lang.Object

com.intellij.openapi.actionSystem.AnAction

com.intellij.ui.AnActionButton

com.intellij.ui.ToggleActionButton

All Implemented Interfaces:

ShortcutProvider, Toggleable, PossiblyDumbAware

Direct Known Subclasses:

TextDiffViewerUtil.ToggleAutoScrollAction, TextDiffViewerUtil.ToggleExpandByDefaultAction

public abstract class ToggleActionButton
extends AnActionButton
implements Toggleable

Nested Class Summary

Nested classes/interfaces inherited from class com.intellij.ui.AnActionButton

AnActionButton.ActionButtonListener, AnActionButton.AnActionButtonWrapper, AnActionButton.AnActionEventWrapper, AnActionButton.CheckedAnActionButton

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
ToggleActionButton(java.lang.String text, javax.swing.Icon icon)
ToggleActionButton(java.util.function.Supplier<java.lang.String> text, 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	updateButton(AnActionEvent e)

Methods inherited from class com.intellij.ui.AnActionButton

addActionButtonListener, addCustomUpdater, fromAction, getContextComponent, getDataContext, getPreferredPopupPoint, getShortcut, isEnabled, isVisible, removeActionButtonListener, setContextComponent, setEnabled, setShortcut, setVisible, update

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

ToggleActionButton

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

ToggleActionButton

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

Method Detail

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.

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

updateButton

public final void updateButton(AnActionEvent e)

Overrides:

updateButton in class AnActionButton