FileDocCategorySizeDatePackage
ColorType.javaAPI DocJava SE 6 API3836Tue Jun 10 00:26:54 BST 2008javax.swing.plaf.synth

ColorType

public class ColorType extends Object
A typesafe enumeration of colors that can be fetched from a style.

Each SynthStyle has a set of ColorTypes that are accessed by way of the {@link SynthStyle#getColor(SynthContext, ColorType)} method. SynthStyle's installDefaults will install the FOREGROUND color as the foreground of the Component, and the BACKGROUND color to the background of the component (assuming that you have not explicitly specified a foreground and background color). Some components support more color based properties, for example JList has the property selectionForeground which will be mapped to FOREGROUND with a component state of SynthConstants.SELECTED.

The following example shows a custom SynthStyle that returns a red Color for the DISABLED state, otherwise a black color.

class MyStyle extends SynthStyle {
private Color disabledColor = new ColorUIResource(Color.RED);
private Color color = new ColorUIResource(Color.BLACK);
protected Color getColorForState(SynthContext context, ColorType type){
if (context.getComponentState() == SynthConstants.DISABLED) {
return disabledColor;
}
return color;
}
}
version
1.13, 11/17/05
since
1.5
author
Scott Violet

Fields Summary
public static final ColorType
FOREGROUND
ColorType for the foreground of a region.
public static final ColorType
BACKGROUND
ColorType for the background of a region.
public static final ColorType
TEXT_FOREGROUND
ColorType for the foreground of a region.
public static final ColorType
TEXT_BACKGROUND
ColorType for the background of a region.
public static final ColorType
FOCUS
ColorType for the focus.
public static final int
MAX_COUNT
Maximum number of ColorTypes.
private static int
nextID
private String
description
private int
index
Constructors Summary
protected ColorType(String description)
Creates a new ColorType with the specified description.

param
description String description of the ColorType.


     
        MAX_COUNT = Math.max(FOREGROUND.getID(), Math.max(
                                 BACKGROUND.getID(), FOCUS.getID())) + 1;
    
        if (description == null) {
            throw new NullPointerException(
                          "ColorType must have a valid description");
        }
        this.description = description;
        synchronized(ColorType.class) {
            this.index = nextID++;
        }
    
Methods Summary
public final intgetID()
Returns a unique id, as an integer, for this ColorType.

return
a unique id, as an integer, for this ColorType.

        return index;
    
public java.lang.StringtoString()
Returns the textual description of this ColorType. This is the same value that the ColorType was created with.

return
the description of the string

        return description;