Package com.intellij.find.editorHeaderActions

Class EditorHeaderToggleAction

java.lang.Object

com.intellij.openapi.actionSystem.AnAction

com.intellij.openapi.actionSystem.ToggleAction

com.intellij.openapi.actionSystem.ex.CheckboxAction

com.intellij.find.editorHeaderActions.EditorHeaderToggleAction

All Implemented Interfaces:

LightEditCompatible, CustomComponentAction, Toggleable, DumbAware, PossiblyDumbAware

Direct Known Subclasses:

EditorHeaderSetSearchContextAction, ToggleMatchCase, TogglePreserveCaseAction, ToggleRegex, ToggleWholeWordsOnlyAction

public abstract class EditorHeaderToggleAction
extends CheckboxAction
implements DumbAware, LightEditCompatible

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	EditorHeaderToggleAction(java.lang.String text)
protected	EditorHeaderToggleAction(java.lang.String text, javax.swing.Icon icon, javax.swing.Icon hoveredIcon, javax.swing.Icon selectedIcon)

Method Summary

Modifier and Type	Method and Description
javax.swing.JComponent	createCustomComponent(Presentation presentation, java.lang.String place)
boolean	displayTextInToolbar() Override with true returned if your action has to display its text along with the icon when placed in the toolbar
boolean	isSelected(AnActionEvent e) Returns the selected (checked, pressed) state of the action.
protected abstract boolean	isSelected(SearchSession session)
void	setSelected(AnActionEvent e, boolean selected) Sets the selected state of the action to the specified value.
protected abstract void	setSelected(SearchSession session, boolean selected)

Methods inherited from class com.intellij.openapi.actionSystem.ex.CheckboxAction

update, updateCustomComponent

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

actionPerformed

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

addTextOverride, applyTextOverride, beforeActionPerformedUpdate, copyFrom, copyShortcutFrom, 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

EditorHeaderToggleAction

protected EditorHeaderToggleAction(java.lang.String text)

EditorHeaderToggleAction

protected EditorHeaderToggleAction(java.lang.String text,
                                   javax.swing.Icon icon,
                                   javax.swing.Icon hoveredIcon,
                                   javax.swing.Icon selectedIcon)

Method Detail

displayTextInToolbar

public boolean displayTextInToolbar()

Description copied from class: AnAction

Override with true returned if your action has to display its text along with the icon when placed in the toolbar

Overrides:

displayTextInToolbar in class AnAction

createCustomComponent

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

Specified by:

createCustomComponent in interface CustomComponentAction

Overrides:

createCustomComponent in class CheckboxAction

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.

isSelected

public boolean isSelected(AnActionEvent e)

Description copied from class: ToggleAction

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

Specified by:

isSelected in class ToggleAction

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 void setSelected(AnActionEvent e,
                        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:

e - the action event which caused the state change.

selected - the new selected state of the action.

isSelected

protected abstract boolean isSelected(SearchSession session)

setSelected

protected abstract void setSelected(SearchSession session,
                                    boolean selected)