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

    Fields
    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

    Constructors
    Modifier
    Constructor
    Description
    protected
    ColorType(String description)
    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 Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    Modifier and Type
    Method
    Description
    protected Object
    clone()
    Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
    boolean
    equals(Object o)
    Compares the argument to the receiver, and answers true if they represent the same object using a class specific comparison.
    protected void
    finalize()
    Deprecated, for removal: This API element is subject to removal in a future version.
    May cause performance issues, deadlocks and hangs.
    final Class<? extends Object>
    getClass()
    Answers the unique instance of java.lang.Class which represents the class of the receiver.
    int
    hashCode()
    Answers an integer hash code for the receiver.
    final void
    notify()
    Causes one thread which is waiting on the receiver to be made ready to run.
    final void
    notifyAll()
    Causes all threads which are waiting on the receiver to be made ready to run.
    final void
    wait()
    Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by notify or notifyAll).
    final void
    wait(long time)
    Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.
    final void
    wait(long time, int frac)
    Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.

  • 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