01: /*
02: * Copyright (c) 2004 JETA Software, Inc. All rights reserved.
03: *
04: * Redistribution and use in source and binary forms, with or without modification,
05: * are permitted provided that the following conditions are met:
06: *
07: * o Redistributions of source code must retain the above copyright notice,
08: * this list of conditions and the following disclaimer.
09: *
10: * o Redistributions in binary form must reproduce the above copyright notice,
11: * this list of conditions and the following disclaimer in the documentation
12: * and/or other materials provided with the distribution.
13: *
14: * o Neither the name of JETA Software nor the names of its contributors may
15: * be used to endorse or promote products derived from this software without
16: * specific prior written permission.
17: *
18: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19: * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20: * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21: * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
22: * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23: * INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
24: * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
25: * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26: * INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27: * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28: */
29:
30: package com.jeta.forms.colormgr;
31:
32: import java.awt.Color;
33: import java.util.Collection;
34:
35: /**
36: * This interface defines methods for an object that handles color management
37: * for an application. The main purpose of this interface is to allow forms to
38: * update their colors when the look and feel changes. This is especially
39: * important for gradients that fade to the background color of the current
40: * form/control.
41: *
42: * @author Jeff Tassin
43: */
44: public interface ColorManager {
45: /**
46: * The id for the component. Generally used for lookups in the JETARegistry
47: */
48: public static final String COMPONENT_ID = "jeta.color.manager";
49:
50: /**
51: * @return a Collection of color names (String objects) maintained by this
52: * color manager.
53: */
54: public Collection getColorKeys();
55:
56: /**
57: * @param colorKey
58: * the name associated with the color to retrieve.
59: * @param defaultColor
60: * the color to return if not color is found associated with
61: * colorKey
62: * @return the color associated with the given color name. It is up to the
63: * implementation to determine this association. Most
64: * implementations will probabaly use the UIManager.getColor( Object
65: * colorName ) call to get the color. However, it is possible for an
66: * implementation to provide custom logic for a subset of
67: * colorNames.
68: */
69: public Color getColor(String colorKey, Color defaultColor);
70:
71: }
|