com.intellij.openapi.actionSystem
Class ActionGroup

java.lang.Object
  com.intellij.openapi.actionSystem.AnAction
      com.intellij.openapi.actionSystem.ActionGroup

Direct Known Subclasses:

DefaultActionGroup

public abstract class ActionGroup
extends AnAction

Represents a group of actions.

Field Summary

static java.lang.String

PROP_POPUP The actual value is a Boolean.

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

EMPTY_ARRAY, ourClientProperty

Constructor Summary

ActionGroup()
Creates a new ActionGroup with shortName set to null and popup set to false.

ActionGroup(java.lang.String shortName, boolean popup)
Creates a new ActionGroup with the specified shortName and popup.

Method Summary

void	actionPerformed(AnActionEvent e) This method is final and empty because a group cannot have a handler.
void	addPropertyChangeListener(java.beans.PropertyChangeListener l)
protected void	firePropertyChange(java.lang.String propertyName, java.lang.Object oldValue, java.lang.Object newValue)
abstract AnAction[]	getChildren(AnActionEvent e) Returns the children of the group.
boolean	isPopup() Returns the type of the group.
void	removePropertyChangeListener(java.beans.PropertyChangeListener l)
void	setPopup(boolean popup) Sets the type of the group.

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

copyFrom, createTooltipText, displayTextInToolbar, getShortcutSet, getTemplatePresentation, isDefaultIcon, isEnabledInModalContext, registerCustomShortcutSet, setDefaultIcon, setEnabledInModalContext, setShortcutSet, unregisterCustomShortcutSet, update

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PROP_POPUP

public static final java.lang.String PROP_POPUP

The actual value is a Boolean.

See Also:

Constant Field Values

Constructor Detail

ActionGroup

public ActionGroup()

Creates a new ActionGroup with shortName set to null and popup set to false.

ActionGroup

public ActionGroup(java.lang.String shortName,
                   boolean popup)

Creates a new ActionGroup with the specified shortName and popup.

Parameters:

shortName - Text that represents a short name for this action group

popup - true if this group is a popup, false otherwise

Method Detail

actionPerformed

public final void actionPerformed(AnActionEvent e)

This method is final and empty because a group cannot have a handler.

Specified by:

actionPerformed in class AnAction

Parameters:

e - Carries information on the invocation place

isPopup

public final boolean isPopup()

Returns the type of the group.

Returns:

true if the group is a popup, false otherwise

setPopup

public final void setPopup(boolean popup)

Sets the type of the group.

Parameters:

popup - If true the group will be shown as a popup in menus

addPropertyChangeListener

public final void addPropertyChangeListener(java.beans.PropertyChangeListener l)

removePropertyChangeListener

public final void removePropertyChangeListener(java.beans.PropertyChangeListener l)

firePropertyChange

protected final void firePropertyChange(java.lang.String propertyName,
                                        java.lang.Object oldValue,
                                        java.lang.Object newValue)

getChildren

public abstract AnAction[] getChildren(@Nullable
                                       AnActionEvent e)

Returns the children of the group.

Returns:

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