org.esa.beam.framework.ui.command

Class CommandGroup

java.lang.Object

org.esa.beam.framework.ui.command.Command

org.esa.beam.framework.ui.command.CommandGroup

All Implemented Interfaces:

com.bc.ceres.core.runtime.ConfigurableExtension

Direct Known Subclasses:

ActionGroup

public class CommandGroup
extends Command

The CommandGroup is a group of commands represented by a menu item group or a tool bar. As of BEAM 5, CommandGroups can also be used to collect group items. There can be either (forward declarations of) contained command IDs or other commands group IDs or separators.

Author:

Norman Fomferra

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACTION_KEY_GROUP_ITEMS

Fields inherited from class org.esa.beam.framework.ui.command.Command

ACTION_KEY_CONTEXT, ACTION_KEY_LARGE_ICON, ACTION_KEY_LOCATION, ACTION_KEY_PARENT, ACTION_KEY_PLACE_AFTER, ACTION_KEY_PLACE_BEFORE, ACTION_KEY_PLACE_CONTEXT_TOP, ACTION_KEY_PLACE_FIRST, ACTION_KEY_PLACE_LAST, ACTION_KEY_POPUP_TEXT, ACTION_KEY_SEPARATOR_AFTER, ACTION_KEY_SEPARATOR_BEFORE, ACTION_KEY_SORT_CHILDREN, HELP_ID_KEY

Constructor Summary

Constructors

Constructor and Description
CommandGroup()
CommandGroup(String commandGroupID, CommandStateListener listener)

Method Summary

Methods

Modifier and Type	Method and Description
void	addCommandStateListener(CommandStateListener l) Adds a command listener.
void	configure(com.bc.ceres.core.runtime.ConfigurationElement config)
protected Action	createAction() Creates an appropriate action instance for this command.
JMenuItem	createMenuItem() Creates a menu item (a JMenu instance) for this command group.
AbstractButton	createToolBarButton() Creates an appropriate tool bar button for this command.
String[]	getGroupItems()
void	removeCommandStateListener(CommandStateListener l) Removes a command listener.
void	setGroupItems(String[] groupItems)

Methods inherited from class org.esa.beam.framework.ui.command.Command

addEventListener, configure, containsContext, containsLocation, containsProperty, containsPropertyValue, createResourceKey, fireUpdateState, getAccelerator, getAction, getCommandID, getCommandUIFactory, getConfigBoolean, getConfigIcon, getConfigString, getConfigStrings, getContexts, getEventListenerList, getHelpId, getLargeIcon, getLocations, getLongDescription, getMnemonic, getParent, getPlaceAfter, getPlaceBefore, getPlaceFirst, getPlaceLast, getPopupText, getProperty, getProperty, getProperty, getProperty, getResourceBoolean, getResourceIcon, getResourceString, getResourceStringArray, getResourceStrings, getShortDescription, getSmallIcon, getSortChildren, getText, getValue, isEnabled, isPlaceAtContextTop, isSeparatorAfter, isSeparatorBefore, removeEventListener, setAccelerator, setCommandID, setCommandUIFactory, setContexts, setEnabled, setHelpId, setLargeIcon, setLocations, setLongDescription, setMnemonic, setParent, setPlaceAfter, setPlaceAtContextTop, setPlaceBefore, setPlaceFirst, setPlaceLast, setPopupText, setProperty, setProperty, setSeparatorAfter, setSeparatorBefore, setShortDescription, setSmallIcon, setText, toString, updateComponentTreeUI, updateState, updateState

Methods inherited from class java.lang.Object

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

Field Detail

ACTION_KEY_GROUP_ITEMS

public static final String ACTION_KEY_GROUP_ITEMS

See Also:

Constant Field Values

Constructor Detail

CommandGroup

public CommandGroup()

CommandGroup

public CommandGroup(String commandGroupID,
            CommandStateListener listener)

Method Detail

createMenuItem

public JMenuItem createMenuItem()

Creates a menu item (a JMenu instance) for this command group.

Specified by:

createMenuItem in class Command

createToolBarButton

public AbstractButton createToolBarButton()

Creates an appropriate tool bar button for this command.

Specified by:

createToolBarButton in class Command

addCommandStateListener

public void addCommandStateListener(CommandStateListener l)

Adds a command listener.

Parameters:

l - the command listener

removeCommandStateListener

public void removeCommandStateListener(CommandStateListener l)

Removes a command listener.

Parameters:

l - the command listener

getGroupItems

public String[] getGroupItems()

setGroupItems

public void setGroupItems(String[] groupItems)

configure

public void configure(com.bc.ceres.core.runtime.ConfigurationElement config)
               throws com.bc.ceres.core.CoreException

Specified by:

configure in interface com.bc.ceres.core.runtime.ConfigurableExtension

Overrides:

configure in class Command

Throws:

com.bc.ceres.core.CoreException

createAction

protected Action createAction()

Description copied from class: Command

Creates an appropriate action instance for this command.

Specified by:

createAction in class Command