|
Eclipse Platform Release 3.4 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.ui.AbstractSourceProvider
An implementation of ISourceProvider
that provides listener
support. Subclasses need only call fireSourceChanged
whenever
appropriate.
Field Summary | |
protected static boolean |
DEBUG
Whether source providers should print out debugging information to the console when events arrive. |
Constructor Summary | |
AbstractSourceProvider()
|
Method Summary | |
void |
addSourceProviderListener(ISourceProviderListener listener)
Adds a listener to this source provider. |
protected void |
fireSourceChanged(int sourcePriority,
Map sourceValuesByName)
Notifies all listeners that multiple sources have changed. |
protected void |
fireSourceChanged(int sourcePriority,
String sourceName,
Object sourceValue)
Notifies all listeners that a single source has changed. |
void |
initialize(IServiceLocator locator)
This method is called when the source provider is instantiated by org.eclipse.ui.services . |
protected void |
logDebuggingInfo(String message)
Logs a debugging message in an appropriate manner. |
void |
removeSourceProviderListener(ISourceProviderListener listener)
Removes a listener from this source provider. |
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.ISourceProvider |
dispose, getCurrentState, getProvidedSourceNames |
Field Detail |
protected static boolean DEBUG
Constructor Detail |
public AbstractSourceProvider()
Method Detail |
public final void addSourceProviderListener(ISourceProviderListener listener)
ISourceProvider
addSourceProviderListener
in interface ISourceProvider
listener
- The listener to add; must not be null
.protected final void fireSourceChanged(int sourcePriority, String sourceName, Object sourceValue)
sourcePriority
- The source priority that has changed.sourceName
- The name of the source that has changed; must not be
null
.sourceValue
- The new value for the source; may be null
.protected final void fireSourceChanged(int sourcePriority, Map sourceValuesByName)
sourcePriority
- The source priority that has changed.sourceValuesByName
- The map of source names (String
) to source
values (Object
) that have changed; must not
be null
. The names must not be
null
, but the values may be null
.protected final void logDebuggingInfo(String message)
null
or the DEBUG
is false
,
then this method does nothing.
message
- The debugging message to log; if null
, then
nothing is logged.public final void removeSourceProviderListener(ISourceProviderListener listener)
ISourceProvider
removeSourceProviderListener
in interface ISourceProvider
listener
- The listener to remove; must not be null
.public void initialize(IServiceLocator locator)
org.eclipse.ui.services
. Clients may override this method
to perform initialization.
locator
- The global service locator. It can be used to retrieve
services like the IContextService
|
Eclipse Platform Release 3.4 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.