Package org.eclipse.jface.resource
Class ColorRegistry
- java.lang.Object
-
- org.eclipse.core.commands.common.EventManager
-
- org.eclipse.jface.resource.ResourceRegistry
-
- org.eclipse.jface.resource.ColorRegistry
-
public class ColorRegistry extends ResourceRegistry
A color registry maintains a mapping between symbolic color names and SWTColors.A color registry owns all of the
Colorobjects registered with it, and automatically disposes of them when the SWT Display that creates theColors is disposed. Because of this, clients do not need to (indeed, must not attempt to) dispose ofColorobjects themselves.Methods are provided for registering listeners that will be kept apprised of changes to list of registed colors.
Clients may instantiate this class (it was not designed to be subclassed).
- Since:
- 3.0
- Restriction:
- This class is not intended to be subclassed by clients.
-
-
Field Summary
Fields Modifier and Type Field Description protected DisplaydisplayThis registriesDisplay.protected RunnabledisplayRunnableRunnable that cleans up the manager on disposal of the display.
-
Constructor Summary
Constructors Constructor Description ColorRegistry()Create a new instance of the receiver that is hooked to the current display.ColorRegistry(Display display)Create a new instance of the receiver.ColorRegistry(Display display, boolean cleanOnDisplayDisposal)Create a new instance of the receiver.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected voidclearCaches()Disposes all currently allocated resources.Colorget(String symbolicName)Returns thecolorassociated with the given symbolic color name, ornullif no such definition exists.ColorDescriptorgetColorDescriptor(String symbolicName)Returns the color descriptor associated with the given symbolic color name.ColorDescriptorgetColorDescriptor(String symbolicName, ColorDescriptor defaultValue)Returns the color descriptor associated with the given symbolic color name.Set<String>getKeySet()RGBgetRGB(String symbolicName)Returns the color data associated with the given symbolic color name.booleanhasValueFor(String colorKey)Return whether or not the receiver has a value for the supplied key.voidput(String symbolicName, RGB colorData)Adds (or replaces) a color to this color registry under the given symbolic name.-
Methods inherited from class org.eclipse.jface.resource.ResourceRegistry
addListener, fireMappingChanged, removeListener
-
Methods inherited from class org.eclipse.core.commands.common.EventManager
addListenerObject, clearListeners, getListeners, isListenerAttached, removeListenerObject
-
-
-
-
Constructor Detail
-
ColorRegistry
public ColorRegistry()
Create a new instance of the receiver that is hooked to the current display.- See Also:
Display.getCurrent()
-
ColorRegistry
public ColorRegistry(Display display)
Create a new instance of the receiver.- Parameters:
display- theDisplayto hook into.
-
ColorRegistry
public ColorRegistry(Display display, boolean cleanOnDisplayDisposal)
Create a new instance of the receiver.- Parameters:
display- theDisplayto hook intocleanOnDisplayDisposal- whether all colors allocated by thisColorRegistryshould be disposed when the display is disposed- Since:
- 3.1
-
-
Method Detail
-
get
public Color get(String symbolicName)
Returns thecolorassociated with the given symbolic color name, ornullif no such definition exists.- Parameters:
symbolicName- symbolic color name- Returns:
- the
Colorornull
-
getKeySet
public Set<String> getKeySet()
- Specified by:
getKeySetin classResourceRegistry- Returns:
- the set of keys this manager knows about. This collection should be immutable.
-
getRGB
public RGB getRGB(String symbolicName)
Returns the color data associated with the given symbolic color name.- Parameters:
symbolicName- symbolic color name.- Returns:
- the
RGBdata, ornullif the symbolic name is not valid.
-
getColorDescriptor
public ColorDescriptor getColorDescriptor(String symbolicName)
Returns the color descriptor associated with the given symbolic color name. As of 3.4 if this color is not defined then an unspecified color is returned. Users that wish to ensure a reasonable default value should usegetColorDescriptor(String, ColorDescriptor)instead.- Parameters:
symbolicName- symbolic color name- Returns:
- the color descriptor associated with the given symbolic color name or an unspecified sentinel.
- Since:
- 3.1
-
getColorDescriptor
public ColorDescriptor getColorDescriptor(String symbolicName, ColorDescriptor defaultValue)
Returns the color descriptor associated with the given symbolic color name. If this name does not exist within the registry the supplied default value will be used.- Parameters:
symbolicName- symbolic color namedefaultValue- return value if symbolic color name is unknown- Returns:
- the color descriptor associated with the given symbolic color name or the default
- Since:
- 3.4
-
clearCaches
protected void clearCaches()
Description copied from class:ResourceRegistryDisposes all currently allocated resources.- Specified by:
clearCachesin classResourceRegistry
-
hasValueFor
public boolean hasValueFor(String colorKey)
Description copied from class:ResourceRegistryReturn whether or not the receiver has a value for the supplied key.- Specified by:
hasValueForin classResourceRegistry- Parameters:
colorKey- the key- Returns:
trueif there is a value for this key
-
put
public void put(String symbolicName, RGB colorData)
Adds (or replaces) a color to this color registry under the given symbolic name.A property change event is reported whenever the mapping from a symbolic name to a color changes. The source of the event is this registry; the property name is the symbolic color name.
- Parameters:
symbolicName- the symbolic color namecolorData- anRGBobject
-
-