Class ColorType

java.lang.Object
javax.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 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;
     }
 }
 
Since:
1.5

Field Summary

Modifier and Type Field Description
static final ColorType BACKGROUND
ColorType for the background of a region.
static final ColorType FOCUS
ColorType for the focus.
static final ColorType FOREGROUND
ColorType for the foreground of a region.
static final int MAX_COUNT
Maximum number of ColorTypes.
static final ColorType TEXT_BACKGROUND
ColorType for the background of a region.
static final ColorType TEXT_FOREGROUND
ColorType for the foreground of a region.

Constructor Summary

ColorType(String description)
Modifier Constructor Description
protected
Creates a new ColorType with the specified description.

Method Summary

Modifier and Type Method Description
final int getID()
Returns a unique id, as an integer, for this ColorType.
String toString()
Returns the textual description of this ColorType.

Methods declared in class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

FOREGROUND

public static final ColorType FOREGROUND
ColorType for the foreground of a region.

BACKGROUND

public static final ColorType BACKGROUND
ColorType for the background of a region.

TEXT_FOREGROUND

public static final ColorType TEXT_FOREGROUND
ColorType for the foreground of a region.

TEXT_BACKGROUND

public static final ColorType TEXT_BACKGROUND
ColorType for the background of a region.

FOCUS

public static final ColorType FOCUS
ColorType for the focus.

MAX_COUNT

public static final int MAX_COUNT
Maximum number of ColorTypes.

Constructor Details

ColorType

protected ColorType(String description)
Creates a new ColorType with the specified description.
Parameters:
description - String description of the ColorType.

Method Details

getID

public final int getID()
Returns a unique id, as an integer, for this ColorType.
Returns:
a unique id, as an integer, for this ColorType.

toString

public String toString()
Returns the textual description of this ColorType. This is the same value that the ColorType was created with.
Overrides:
toString in class Object
Returns:
the description of the string

© 1993, 2021, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/17/docs/api/java.desktop/javax/swing/plaf/synth/ColorType.html