org.eclipse.ui
Interface IDecoratorManager

public interface IDecoratorManager

Manages the decorators contributed via the decorators extension point. Views which allow decoration of their elements should use the label decorator returned by getLabelDecorator().

Method Summary

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 label decorator for the specified decorator if it is enabled.
void	setEnabled(String decoratorId, boolean enabled) Sets whether the specified decorator is enabled.

Method Detail

getLabelDecorator

public ILabelDecorator getLabelDecorator()

Returns the label decorator which applies the decorations from all enabled decorators. Views which allow decoration of their elements should use this label decorator.

Returns:

the label decorator

See Also:

DecoratingLabelProvider

getLabelDecorator

public ILabelDecorator getLabelDecorator(String decoratorId)

Returns the label decorator for the specified decorator if it is enabled. Otherwise returns null.

Parameters:

decoratorId - the decorator id

Returns:

the label decorator

getEnabled

public boolean getEnabled(String decoratorId)

Returns whether the specified decorator is enabled.

Parameters:

decoratorId - the decorator id

Returns:

true if the decorator is enabled, or false if not

setEnabled

public void setEnabled(String decoratorId,
                       boolean enabled)
                throws CoreException

Sets whether the specified decorator is enabled.

Parameters:

decoratorId - the decorator id

enabled - true to enable the decorator, or false to disable it

Throws:

CoreException - if the decorator cannot be instantiated