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
A color registry maintains a mapping between symbolic color names and SWT
Colors.
A color registry owns all of the Color objects registered with
it, and automatically disposes of them when the SWT Display that creates the
Colors is disposed. Because of this, clients do not need to
(indeed, must not attempt to) dispose of Color objects
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
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionCreate 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
Modifier and TypeMethodDescriptionprotected voidDisposes all currently allocated resources.Returns thecolorassociated with the given symbolic color name, ornullif no such definition exists.getColorDescriptor(String symbolicName) Returns the color descriptor associated with the given symbolic color name.getColorDescriptor(String symbolicName, ColorDescriptor defaultValue) Returns the color descriptor associated with the given symbolic color name.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.voidAdds (or replaces) a color to this color registry under the given symbolic name.Methods inherited from class org.eclipse.jface.resource.ResourceRegistry
addListener, fireMappingChanged, removeListenerMethods inherited from class org.eclipse.core.commands.common.EventManager
addListenerObject, clearListeners, getListeners, isListenerAttached, removeListenerObject
-
Field Details
-
display
This registriesDisplay. All colors will be allocated using it. -
displayRunnable
Runnable that cleans up the manager on disposal of the display.
-
-
Constructor Details
-
ColorRegistry
public ColorRegistry()Create a new instance of the receiver that is hooked to the current display.- See Also:
-
ColorRegistry
Create a new instance of the receiver.- Parameters:
display- theDisplayto hook into.
-
ColorRegistry
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 Details
-
get
Returns thecolorassociated with the given symbolic color name, ornullif no such definition exists.- Parameters:
symbolicName- symbolic color name- Returns:
- the
Colorornull
-
getKeySet
- Specified by:
getKeySetin classResourceRegistry- Returns:
- the set of keys this manager knows about. This collection should be immutable.
-
getRGB
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
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
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
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
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
-