|
Eclipse Platform Release 3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.ui.commands.AbstractHandler
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.
Constructor Summary | |
AbstractHandler()
|
Method Summary | |
void |
addHandlerListener(IHandlerListener handlerListener)
Registers an instance of IHandlerListener to listen for
changes to properties of this instance. |
void |
dispose()
The default implementation does nothing. |
protected void |
fireHandlerChanged(HandlerEvent handlerEvent)
Fires an event to all registered listeners describing changes to this instance. |
Map |
getAttributeValuesByName()
This simply return an empty map. |
void |
removeHandlerListener(IHandlerListener handlerListener)
Unregisters an instance of IPropertyListener listening for
changes to properties of this instance. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.eclipse.ui.commands.IHandler |
execute |
Constructor Detail |
public AbstractHandler()
Method Detail |
public void addHandlerListener(IHandlerListener handlerListener)
IHandler
IHandlerListener
to listen for
changes to properties of this instance.
addHandlerListener
in interface IHandler
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.IHandler.addHandlerListener(IHandlerListener)
public void dispose()
dispose
in interface IHandler
IHandler.dispose()
protected void fireHandlerChanged(HandlerEvent handlerEvent)
handlerEvent
- the event describing changes to this instance. Must not be
null
.public Map getAttributeValuesByName()
getAttributeValuesByName
in interface IHandler
null
. If this map is not
empty, its collection of keys is guaranteed to only contain
instances of String
.IHandler.getAttributeValuesByName()
public void removeHandlerListener(IHandlerListener handlerListener)
IHandler
IPropertyListener
listening for
changes to properties of this instance.
removeHandlerListener
in interface IHandler
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.IHandler.removeHandlerListener(IHandlerListener)
|
Eclipse Platform Release 3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2004. All rights reserved.