Eclipse Platform
Release 3.1

org.eclipse.core.commands
Class CommandEvent

java.lang.Object
  extended byorg.eclipse.core.commands.common.AbstractBitSetEvent
      extended byorg.eclipse.core.commands.common.AbstractNamedHandleEvent
          extended byorg.eclipse.core.commands.CommandEvent

public final class CommandEvent
extends AbstractNamedHandleEvent

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

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_DEFINED, CHANGED_DESCRIPTION, CHANGED_NAME, LAST_USED_BIT
 
Fields inherited from class org.eclipse.core.commands.common.AbstractBitSetEvent
changedValues
 
Constructor Summary
CommandEvent(Command command, boolean categoryChanged, boolean definedChanged, boolean descriptionChanged, boolean handledChanged, boolean nameChanged, boolean parametersChanged)
          Creates a new instance of this class.
 
Method Summary
 Command getCommand()
          Returns the instance of the interface that changed.
 boolean isCategoryChanged()
          Returns whether or not the category property changed.
 boolean isHandledChanged()
          Returns whether or not the handled property changed.
 boolean isParametersChanged()
          Returns whether or not the parameters have changed.
 
Methods inherited from class org.eclipse.core.commands.common.AbstractNamedHandleEvent
isDefinedChanged, isDescriptionChanged, isNameChanged
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

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 - true if the parameters have changed; false otherwise.
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.

isParametersChanged

public final boolean isParametersChanged()
Returns whether or not the parameters have changed.

Returns:
true, iff the parameters property changed.

Eclipse Platform
Release 3.1

Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2000, 2005. All rights reserved.