Package org.eclipse.core.commands
Class CommandEvent
-
public final class CommandEvent extends AbstractNamedHandleEvent
An instance of this class describes changes to an instance ofCommand.This class is not intended to be extended by clients.
- Since:
- 3.1
- See Also:
ICommandListener.commandChanged(CommandEvent)
-
-
Field Summary
-
Fields inherited from class org.eclipse.core.commands.common.AbstractNamedHandleEvent
CHANGED_DESCRIPTION, CHANGED_NAME, LAST_USED_BIT
-
Fields inherited from class org.eclipse.core.commands.common.AbstractHandleObjectEvent
CHANGED_DEFINED, LAST_BIT_USED_ABSTRACT_HANDLE
-
Fields inherited from class org.eclipse.core.commands.common.AbstractBitSetEvent
changedValues
-
-
Constructor Summary
Constructors Constructor Description CommandEvent(Command command, boolean categoryChanged, boolean definedChanged, boolean descriptionChanged, boolean handledChanged, boolean nameChanged, boolean parametersChanged)Creates a new instance of this class.CommandEvent(Command command, boolean categoryChanged, boolean definedChanged, boolean descriptionChanged, boolean handledChanged, boolean nameChanged, boolean parametersChanged, boolean returnTypeChanged)Creates a new instance of this class.CommandEvent(Command command, boolean categoryChanged, boolean definedChanged, boolean descriptionChanged, boolean handledChanged, boolean nameChanged, boolean parametersChanged, boolean returnTypeChanged, boolean helpContextIdChanged)Creates a new instance of this class.CommandEvent(Command command, boolean categoryChanged, boolean definedChanged, boolean descriptionChanged, boolean handledChanged, boolean nameChanged, boolean parametersChanged, boolean returnTypeChanged, boolean helpContextIdChanged, boolean enabledChanged)Creates a new instance of this class.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CommandgetCommand()Returns the instance of the interface that changed.booleanisCategoryChanged()Returns whether or not the category property changed.booleanisEnabledChanged()Return whether the enable property changed.booleanisHandledChanged()Returns whether or not the handled property changed.booleanisHelpContextIdChanged()Returns whether or not the help context identifier changed.booleanisParametersChanged()Returns whether or not the parameters have changed.booleanisReturnTypeChanged()Returns whether or not the return type property changed.-
Methods inherited from class org.eclipse.core.commands.common.AbstractNamedHandleEvent
isDescriptionChanged, isNameChanged
-
Methods inherited from class org.eclipse.core.commands.common.AbstractHandleObjectEvent
isDefinedChanged
-
-
-
-
Constructor Detail
-
CommandEvent
public CommandEvent(Command command, boolean categoryChanged, boolean definedChanged, boolean descriptionChanged, boolean handledChanged, boolean nameChanged, boolean parametersChanged)
Creates a new instance of this class.- Parameters:
command- the instance of the interface that changed.categoryChanged-true, iff the category property changed.definedChanged-true, iff the defined property changed.descriptionChanged-true, iff the description property changed.handledChanged-true, iff the handled property changed.nameChanged-true, iff the name property changed.parametersChanged-trueif the parameters have changed;falseotherwise.
-
CommandEvent
public CommandEvent(Command command, boolean categoryChanged, boolean definedChanged, boolean descriptionChanged, boolean handledChanged, boolean nameChanged, boolean parametersChanged, boolean returnTypeChanged)
Creates a new instance of this class.- Parameters:
command- the instance of the interface that changed.categoryChanged-true, iff the category property changed.definedChanged-true, iff the defined property changed.descriptionChanged-true, iff the description property changed.handledChanged-true, iff the handled property changed.nameChanged-true, iff the name property changed.parametersChanged-trueif the parameters have changed;falseotherwise.returnTypeChanged-trueiff the return type property changed;falseotherwise.- Since:
- 3.2
-
CommandEvent
public CommandEvent(Command command, boolean categoryChanged, boolean definedChanged, boolean descriptionChanged, boolean handledChanged, boolean nameChanged, boolean parametersChanged, boolean returnTypeChanged, boolean helpContextIdChanged)
Creates a new instance of this class.- Parameters:
command- the instance of the interface that changed.categoryChanged-true, iff the category property changed.definedChanged-true, iff the defined property changed.descriptionChanged-true, iff the description property changed.handledChanged-true, iff the handled property changed.nameChanged-true, iff the name property changed.parametersChanged-trueif the parameters have changed;falseotherwise.returnTypeChanged-trueiff the return type property changed;falseotherwise.helpContextIdChanged-trueiff the help context identifier changed;falseotherwise.- Since:
- 3.2
-
CommandEvent
public CommandEvent(Command command, boolean categoryChanged, boolean definedChanged, boolean descriptionChanged, boolean handledChanged, boolean nameChanged, boolean parametersChanged, boolean returnTypeChanged, boolean helpContextIdChanged, boolean enabledChanged)
Creates a new instance of this class.- Parameters:
command- the instance of the interface that changed.categoryChanged-true, iff the category property changed.definedChanged-true, iff the defined property changed.descriptionChanged-true, iff the description property changed.handledChanged-true, iff the handled property changed.nameChanged-true, iff the name property changed.parametersChanged-trueif the parameters have changed;falseotherwise.returnTypeChanged-trueiff the return type property changed;falseotherwise.helpContextIdChanged-trueiff the help context identifier changed;falseotherwise.enabledChanged-trueiff the comand enablement changed;falseotherwise.- Since:
- 3.3
-
-
Method Detail
-
getCommand
public final Command getCommand()
Returns the instance of the interface that changed.- Returns:
- the instance of the interface that changed. Guaranteed not to be
null.
-
isCategoryChanged
public final boolean isCategoryChanged()
Returns whether or not the category property changed.- Returns:
true, iff the category property changed.
-
isHandledChanged
public final boolean isHandledChanged()
Returns whether or not the handled property changed.- Returns:
true, iff the handled property changed.
-
isHelpContextIdChanged
public final boolean isHelpContextIdChanged()
Returns whether or not the help context identifier changed.- Returns:
true, iff the help context identifier changed.- Since:
- 3.2
-
isParametersChanged
public final boolean isParametersChanged()
Returns whether or not the parameters have changed.- Returns:
true, iff the parameters property changed.
-
isReturnTypeChanged
public final boolean isReturnTypeChanged()
Returns whether or not the return type property changed.- Returns:
true, iff the return type property changed.- Since:
- 3.2
-
isEnabledChanged
public final boolean isEnabledChanged()
Return whether the enable property changed.- Returns:
trueiff the comand enablement changed- Since:
- 3.3
-
-