Package org.eclipse.ui.commands

Class CommandEvent

java.lang.Object

org.eclipse.ui.commands.CommandEvent

@Deprecated
public final class CommandEvent
extends Object

Deprecated.

Please use the "org.eclipse.core.commands" plug-in instead. This API is scheduled for deletion, see Bug 431177 for details

An instance of this class describes changes to an instance of ICommand.

This class is not intended to be extended by clients.

Since:

3.0

See Also:

• ICommandListener.commandChanged(CommandEvent)
• CommandEvent

Restriction:

This class is scheduled for deletion.

Constructor Summary

Constructors

Constructor	Description
CommandEvent(ICommand command, boolean attributeValuesByNameChanged, boolean categoryIdChanged, boolean definedChanged, boolean descriptionChanged, boolean handledChanged, boolean keySequenceBindingsChanged, boolean nameChanged, Map previousAttributeValuesByName)	Deprecated. Creates a new instance of this class.

Method Summary

Modifier and Type	Method	Description
ICommand	getCommand()	Deprecated.
Map	getPreviousAttributeValuesByName()	Deprecated.
boolean	hasCategoryIdChanged()	Deprecated.
boolean	hasDefinedChanged()	Deprecated.
boolean	hasDescriptionChanged()	Deprecated.
boolean	hasHandledChanged()	Deprecated.
boolean	hasNameChanged()	Deprecated.
boolean	haveAttributeValuesByNameChanged()	Deprecated.
boolean	haveKeySequenceBindingsChanged()	Deprecated.

Methods inherited from class java.lang.Object

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

Constructor Details

CommandEvent

public CommandEvent(ICommand command,
 boolean attributeValuesByNameChanged,
 boolean categoryIdChanged,
 boolean definedChanged,
 boolean descriptionChanged,
 boolean handledChanged,
 boolean keySequenceBindingsChanged,
 boolean nameChanged,
 Map previousAttributeValuesByName)

Deprecated.

Creates a new instance of this class.

Parameters:

command - the instance of the interface that changed.

attributeValuesByNameChanged - true, iff the attributeValuesByName property changed.

categoryIdChanged - true, iff the categoryId property changed.

definedChanged - true, iff the defined property changed.

descriptionChanged - true, iff the description property changed.

handledChanged - true, iff the handled property changed.

keySequenceBindingsChanged - true, iff the keySequenceBindings property changed.

nameChanged - true, iff the name property changed.

previousAttributeValuesByName - the map of previous attribute values by name. This map may be empty. If this map is not empty, it's collection of keys must only contain instances of String. This map must be null if attributeValuesByNameChanged is false and must not be null if attributeValuesByNameChanged is true.

Method Details

getCommand

@Deprecated
public ICommand getCommand()

Deprecated.

Returns the instance of the interface that changed.

Returns:

the instance of the interface that changed. Guaranteed not to be null.

getPreviousAttributeValuesByName

@Deprecated
public Map getPreviousAttributeValuesByName()

Deprecated.

Returns the map of previous attribute values by name.

Returns:

the map of previous attribute values by name. This map may be empty. If this map is not empty, it's collection of keys is guaranteed to only contain instances of String. This map is guaranteed to be null if haveAttributeValuesByNameChanged() is false and is guaranteed to not be null if haveAttributeValuesByNameChanged() is true.

hasCategoryIdChanged

@Deprecated
public boolean hasCategoryIdChanged()

Deprecated.

Returns whether or not the categoryId property changed.

Returns:

true, iff the categoryId property changed.

hasDefinedChanged

@Deprecated
public boolean hasDefinedChanged()

Deprecated.

Returns whether or not the defined property changed.

Returns:

true, iff the defined property changed.

hasDescriptionChanged

@Deprecated
public boolean hasDescriptionChanged()

Deprecated.

Returns whether or not the description property changed.

Returns:

true, iff the description property changed.

hasHandledChanged

@Deprecated
public boolean hasHandledChanged()

Deprecated.

Returns whether or not the handled property changed.

Returns:

true, iff the handled property changed.

hasNameChanged

@Deprecated
public boolean hasNameChanged()

Deprecated.

Returns whether or not the name property changed.

Returns:

true, iff the name property changed.

haveAttributeValuesByNameChanged

@Deprecated
public boolean haveAttributeValuesByNameChanged()

Deprecated.

Returns whether or not the attributeValuesByName property changed.

Returns:

true, iff the attributeValuesByName property changed.

haveKeySequenceBindingsChanged

@Deprecated
public boolean haveKeySequenceBindingsChanged()

Deprecated.

Returns whether or not the keySequenceBindings property changed.

Returns:

true, iff the keySequenceBindings property changed.