Package com.intellij.ide.actions

Class ActivateToolWindowAction

java.lang.Object

com.intellij.openapi.actionSystem.AnAction

com.intellij.openapi.project.DumbAwareAction

com.intellij.ide.actions.ActivateToolWindowAction

All Implemented Interfaces:

DumbAware, PossiblyDumbAware

public class ActivateToolWindowAction
extends DumbAwareAction

Toggles tool window visibility. Usually shown in View|Tool-windows sub-menu. Dynamically registered in Settings|Keymap for each newly-registered tool window.

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

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(AnActionEvent e) Implement this method to provide your action handler.
static void	ensureToolWindowActionRegistered(ToolWindow toolWindow)
static java.lang.String	getActionIdForToolWindow(java.lang.String id) This is the "rule" method constructs ID of the action for activating tool window with specified ID.
static int	getMnemonicForToolWindow(java.lang.String toolWindowId)
java.lang.String	getToolWindowId()
void	update(AnActionEvent e) Updates the state of the action.
static void	updateToolWindowActionPresentation(ToolWindow toolWindow)

Methods inherited from class com.intellij.openapi.project.DumbAwareAction

create, create

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.project.PossiblyDumbAware

isDumbAware

Method Detail

getToolWindowId

public java.lang.String getToolWindowId()

ensureToolWindowActionRegistered

public static void ensureToolWindowActionRegistered(ToolWindow toolWindow)

updateToolWindowActionPresentation

public static void updateToolWindowActionPresentation(ToolWindow toolWindow)

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

actionPerformed

public 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

getActionIdForToolWindow

public static java.lang.String getActionIdForToolWindow(java.lang.String id)

This is the "rule" method constructs ID of the action for activating tool window with specified ID.

Parameters:

id - id of tool window to be activated.

getMnemonicForToolWindow

public static int getMnemonicForToolWindow(java.lang.String toolWindowId)

Returns:

mnemonic for action if it has Alt+digit/Meta+digit shortcut. Otherwise the method returns -1. Meta mask is OK for Mac OS X user, because Alt+digit types strange characters into the editor.