public interface IDecoratorManager extends IDelayedLabelDecorator
org.eclipse.ui.decorator extension point. Views which allow
decoration of their elements should use the label decorator returned by
getLabelDecorator().
This class is not intended to be implemented by clients.
| Modifier and Type | Method and Description |
|---|---|
IBaseLabelProvider |
getBaseLabelProvider(String decoratorId)
Return the IBaseLabelProvider that corresponds to the
decoratorId.
|
boolean |
getEnabled(String decoratorId)
Returns whether the specified decorator is enabled.
|
ILabelDecorator |
getLabelDecorator()
Returns the label decorator which applies the decorations from all
enabled decorators.
|
ILabelDecorator |
getLabelDecorator(String decoratorId)
Returns the full label decorator instance for the specified decorator id
if it is enabled.
|
ILightweightLabelDecorator |
getLightweightLabelDecorator(String decoratorId)
Deprecated.
use getBaseLabelProvider(String) instead.
|
void |
setEnabled(String decoratorId,
boolean enabled)
Sets whether the specified decorator is enabled.
|
void |
update(String decoratorId)
Fire a LabelProviderChangedEvent for the decorator that corresponds to
decoratorID if it exists and is enabled using the IBaseLabelProvider
as the argument to the event.
|
prepareDecorationdecorateImage, decorateTextaddListener, dispose, isLabelProperty, removeListenerILabelDecorator getLabelDecorator()
JFaceResources.getResources() is disposed.ILabelDecoratorDecoratingLabelProvider,
IBaseLabelProvider.dispose()IBaseLabelProvider getBaseLabelProvider(String decoratorId)
decoratorId - the decorator idILabelDecorator getLabelDecorator(String decoratorId)
null. Returns
null for lightweight decorators. It is recommended that
getBaseLabelProvider is used instead so that lightweight decorators are
also checked.decoratorId - the decorator id@Deprecated ILightweightLabelDecorator getLightweightLabelDecorator(String decoratorId)
null.
Returns null for heavyweight decorators.
Use getLabelDecorator instead for heavyweight
decorators.decoratorId - the decorator idboolean getEnabled(String decoratorId)
decoratorId - the decorator idtrue if the decorator is enabled, or
false if notvoid setEnabled(String decoratorId, boolean enabled) throws CoreException
decoratorId - the decorator idenabled - true to enable the decorator, or
false to disable itCoreException - if the decorator cannot be instantiatedvoid update(String decoratorId)
This method must be called from the user interface thread as widget updates may result.
decoratorId - the decorator id
Copyright (c) 2000, 2014 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.