|
Eclipse Platform Release 3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.jface.resource.ResourceRegistry
org.eclipse.jface.resource.ColorRegistry
A color registry maintains a mapping between symbolic color names and SWT
Color
s.
A color registry owns all of the Color
objects registered with
it, and automatically disposes of them when the SWT Display that creates the
Color
s 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).
Field Summary | |
protected Display |
display
This registries Display . |
protected Runnable |
displayRunnable
Runnable that cleans up the manager on disposal of the display. |
Constructor Summary | |
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. |
Method Summary | |
protected void |
clearCaches()
Disposes all currently allocated resources. |
Color |
get(String symbolicName)
Returns the color associated with the given symbolic color
name, or null if no such definition exists. |
Set |
getKeySet()
|
RGB |
getRGB(String symbolicName)
Returns the color data associated with the given symbolic color name. |
boolean |
hasValueFor(String colorKey)
Return whether or not the receiver has a value for the supplied key. |
void |
put(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 java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected Display display
Display
. All colors will be allocated using
it.
protected Runnable displayRunnable
Constructor Detail |
public ColorRegistry()
Display.getCurrent()
public ColorRegistry(Display display)
display
- the Display
to hook into.Method Detail |
public Color get(String symbolicName)
color
associated with the given symbolic color
name, or null
if no such definition exists.
symbolicName
- symbolic color name
Color
or null
public Set getKeySet()
getKeySet
in class ResourceRegistry
public RGB getRGB(String symbolicName)
symbolicName
- symbolic color name.
RGB
data.protected void clearCaches()
ResourceRegistry
clearCaches
in class ResourceRegistry
public boolean hasValueFor(String colorKey)
ResourceRegistry
hasValueFor
in class ResourceRegistry
colorKey
- the key
true
if there is a value for this keypublic void put(String symbolicName, RGB colorData)
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.
symbolicName
- the symbolic color namecolorData
- an RGB
object
|
Eclipse Platform Release 3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2004. All rights reserved.