Package com.intellij.ide.ui.customization

Class CustomisedActionGroup

java.lang.Object

com.intellij.openapi.actionSystem.AnAction

com.intellij.openapi.actionSystem.ActionGroup

com.intellij.ide.ui.customization.CustomisedActionGroup

All Implemented Interfaces:

PossiblyDumbAware

public class CustomisedActionGroup
extends ActionGroup

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.ActionGroup

EMPTY_GROUP

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

ACTIONS_KEY, EMPTY_ARRAY

Constructor Summary

Constructors

Constructor and Description
CustomisedActionGroup(java.lang.String shortName, ActionGroup group, CustomActionsSchema schema, java.lang.String defaultGroupName, java.lang.String name)

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(AnActionEvent e) This method can be called in popup menus if ActionGroup.canBePerformed(DataContext) is true.
boolean	canBePerformed(DataContext context)
AnAction []	getChildren(AnActionEvent e) Returns the children of the group.
AnAction	getFirstAction()
ActionGroup	getOrigin()
boolean	isDumbAware()
boolean	isPopup() Returns the type of the group.
void	resetChildren()
void	update(AnActionEvent e) Updates the state of the action.

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

addPropertyChangeListener, disableIfNoVisibleChildren, firePropertyChange, getChildren, hideIfNoVisibleChildren, isPopup, isPrimary, removePropertyChangeListener, replace, setPopup

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

Constructor Detail

CustomisedActionGroup

public CustomisedActionGroup(java.lang.String shortName,
                             ActionGroup group,
                             CustomActionsSchema schema,
                             java.lang.String defaultGroupName,
                             java.lang.String name)

Method Detail

getChildren

public AnAction [] getChildren(AnActionEvent e)

Description copied from class: ActionGroup

Returns the children of the group.

Specified by:

getChildren in class ActionGroup

Returns:

An array representing children of this group. All returned children must be not null.

isPopup

public boolean isPopup()

Description copied from class: ActionGroup

Returns the type of the group.

Overrides:

isPopup in class ActionGroup

Returns:

true if the group is a popup, false otherwise

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

isDumbAware

public boolean isDumbAware()

Specified by:

isDumbAware in interface PossiblyDumbAware

Overrides:

isDumbAware in class ActionGroup

canBePerformed

public boolean canBePerformed(DataContext context)

Overrides:

canBePerformed in class ActionGroup

Returns:

true if ActionGroup.actionPerformed(AnActionEvent) should be called.

actionPerformed

public void actionPerformed(AnActionEvent e)

Description copied from class: ActionGroup

This method can be called in popup menus if ActionGroup.canBePerformed(DataContext) is true.

Overrides:

actionPerformed in class ActionGroup

Parameters:

e - Carries information on the invocation place

getFirstAction

public AnAction getFirstAction()

getOrigin

public ActionGroup getOrigin()

resetChildren

public void resetChildren()