Class AbstractHandler

  • All Implemented Interfaces:
    IHandler, IHandler2, IHandler
    Direct Known Subclasses:
    ActionHandler

    @Deprecated
    public abstract class AbstractHandler
    extends AbstractHandler
    implements IHandler
    Deprecated.
    Please use the "org.eclipse.core.commands" plug-in instead. This API is scheduled for deletion, see Bug 431177 for details
    This class is a partial implementation of IHandler. This abstract implementation provides support for handler listeners. You should subclass from this method unless you want to implement your own listener support. Subclasses should call fireHandlerChanged(HandlerEvent)when the handler changes. Subclasses should also override getAttributeValuesByName()if they have any attributes.
    Since:
    3.0
    See Also:
    AbstractHandler
    Restriction:
    This class is not intended to be extended by clients.
    Restriction:
    This class is scheduled for deletion.
    • Constructor Detail

      • AbstractHandler

        public AbstractHandler()
        Deprecated.
    • Method Detail

      • addHandlerListener

        @Deprecated
        public void addHandlerListener​(IHandlerListener handlerListener)
        Deprecated.
        Description copied from interface: IHandler
        Registers an instance of IHandlerListener to listen for changes to properties of this instance.
        Specified by:
        addHandlerListener in interface IHandler
        Parameters:
        handlerListener - the instance to register. Must not be null. If an attempt is made to register an instance which is already registered with this instance, no operation is performed.
        See Also:
        IHandler.addHandlerListener(IHandlerListener)
      • execute

        @Deprecated
        public Object execute​(ExecutionEvent event)
                       throws ExecutionException
        Deprecated.
        Description copied from interface: IHandler
        Executes with the map of parameter values by name.
        Specified by:
        execute in interface IHandler
        Parameters:
        event - An event containing all the information about the current state of the application; must not be null.
        Returns:
        the result of the execution. Reserved for future use, must be null.
        Throws:
        ExecutionException - if an exception occurred during execution.
      • fireHandlerChanged

        @Deprecated
        protected void fireHandlerChanged​(HandlerEvent handlerEvent)
        Deprecated.
        Fires an event to all registered listeners describing changes to this instance.
        Overrides:
        fireHandlerChanged in class AbstractHandler
        Parameters:
        handlerEvent - the event describing changes to this instance. Must not be null.
      • getAttributeValuesByName

        @Deprecated
        public Map getAttributeValuesByName()
        Deprecated.
        This simply return an empty map. The default implementation has no attributes.
        Specified by:
        getAttributeValuesByName in interface IHandler
        Returns:
        the map of attribute values by name. This map may be empty, but is guaranteed not to be null. If this map is not empty, its collection of keys is guaranteed to only contain instances of String.
        See Also:
        IHandler.getAttributeValuesByName()
      • hasListeners

        @Deprecated
        protected final boolean hasListeners()
        Deprecated.
        Returns true iff there is one or more IHandlerListeners attached to this AbstractHandler.
        Overrides:
        hasListeners in class AbstractHandler
        Returns:
        true iff there is one or more IHandlerListeners attached to this AbstractHandler
        Since:
        3.1
      • isHandled

        @Deprecated
        public boolean isHandled()
        Deprecated.
        Description copied from class: AbstractHandler
        Whether this handler is capable of handling delegated responsibilities at this time. Subclasses may override this method.
        Specified by:
        isHandled in interface IHandler
        Overrides:
        isHandled in class AbstractHandler
        Returns:
        true
      • removeHandlerListener

        @Deprecated
        public void removeHandlerListener​(IHandlerListener handlerListener)
        Deprecated.
        Description copied from interface: IHandler
        Unregisters an instance of IPropertyListener listening for changes to properties of this instance.
        Specified by:
        removeHandlerListener in interface IHandler
        Parameters:
        handlerListener - the instance to unregister. Must not be null. If an attempt is made to unregister an instance which is not already registered with this instance, no operation is performed.
        See Also:
        IHandler.removeHandlerListener(IHandlerListener)