java.awt

Class SystemColor

public final class SystemColor extends Color implements Serializable

This class contains the various "system colors" in use by the native windowing system. The getRGB() method is dynamic on systems which support dynamic system color changes, and most methods in the superclass are written to use this dynamic value when reporting colors. However, the equals() method is not dynamic, and does not track the actual color of instances in this class. This means that equals may give surprising results; you are better off relying on getRGB.

Since: 1.1

UNKNOWN: updated to 1.4

Field Summary
static intACTIVE_CAPTION
Array index of the active caption color.
static intACTIVE_CAPTION_BORDER
Array index of the active caption border color.
static intACTIVE_CAPTION_TEXT
Array index of the active caption text color.
static SystemColoractiveCaption
The active caption background color.
static SystemColoractiveCaptionBorder
The active caption border color.
static SystemColoractiveCaptionText
The active caption text color.
static SystemColorcontrol
The control background color.
static intCONTROL
Array index of the control background color.
static intCONTROL_DK_SHADOW
Array index of the darkly shadowed control background color.
static intCONTROL_HIGHLIGHT
Array index of the highlighted control background color.
static intCONTROL_LT_HIGHLIGHT
Array index of the lightly highlighted control background color.
static intCONTROL_SHADOW
Array index of the shadowed control background color.
static intCONTROL_TEXT
Array index of the control text color.
static SystemColorcontrolDkShadow
The control dark shadow color.
static SystemColorcontrolHighlight
The control highlight color.
static SystemColorcontrolLtHighlight
The control light highlight color.
static SystemColorcontrolShadow
The control shadow color.
static SystemColorcontrolText
The control text color.
static SystemColordesktop
The desktop color.
static intDESKTOP
Array index of the desktop color.
static intINACTIVE_CAPTION
Array index of the inactive caption color.
static intINACTIVE_CAPTION_BORDER
Array index of the inactive caption border color.
static intINACTIVE_CAPTION_TEXT
Array index of the inactive caption text color.
static SystemColorinactiveCaption
The inactive caption background color.
static SystemColorinactiveCaptionBorder
The inactive caption border color.
static SystemColorinactiveCaptionText
The inactive caption text color.
static SystemColorinfo
The info text background color.
static intINFO
Array index of the info background color.
static intINFO_TEXT
Array index of the info text color.
static SystemColorinfoText
The info text foreground color.
static SystemColormenu
The menu background color.
static intMENU
Array index of the menu background color.
static intMENU_TEXT
Array index of the menu text color.
static SystemColormenuText
The menu text color.
static intNUM_COLORS
The number of system colors.
static SystemColorscrollbar
The scrollbar color.
static intSCROLLBAR
Array index of the scrollbar background color.
static SystemColortext
The text background color.
static intTEXT
Array index of the text background color.
static intTEXT_HIGHLIGHT
Array index of the highlighted text background color.
static intTEXT_HIGHLIGHT_TEXT
Array index of the highlighted text foreground color.
static intTEXT_INACTIVE_TEXT
Array index of the inactive text foreground color.
static intTEXT_TEXT
Array index of the text foreground color.
static SystemColortextHighlight
The highlighted text background color.
static SystemColortextHighlightText
The highlighted text foreground color.
static SystemColortextInactiveText
The inactive text color.
static SystemColortextText
The text foreground color.
static SystemColorwindow
The window background color.
static intWINDOW
Array index of the window background color.
static intWINDOW_BORDER
Array index of the window border color.
static intWINDOW_TEXT
Array index of the window text color.
static SystemColorwindowBorder
The window border color.
static SystemColorwindowText
The window text color.
Method Summary
PaintContextcreateContext(ColorModel cm, Rectangle deviceBounds, Rectangle2D userBounds, AffineTransform xform, RenderingHints hints)
Returns a paint context, used for filling areas of a raster scan with the current value of this system color.
intgetRGB()
Returns the RGB value for this color, in the sRGB color space.
StringtoString()
Returns a string describing this color.

Field Detail

ACTIVE_CAPTION

public static final int ACTIVE_CAPTION
Array index of the active caption color. Used by (int[]).

See Also: activeCaption

ACTIVE_CAPTION_BORDER

public static final int ACTIVE_CAPTION_BORDER
Array index of the active caption border color. Used by (int[]).

See Also: activeCaptionBorder

ACTIVE_CAPTION_TEXT

public static final int ACTIVE_CAPTION_TEXT
Array index of the active caption text color. Used by (int[]).

See Also: activeCaptionText

activeCaption

public static final SystemColor activeCaption
The active caption background color.

activeCaptionBorder

public static final SystemColor activeCaptionBorder
The active caption border color.

activeCaptionText

public static final SystemColor activeCaptionText
The active caption text color.

control

public static final SystemColor control
The control background color.

CONTROL

public static final int CONTROL
Array index of the control background color. Used by (int[]).

See Also: control

CONTROL_DK_SHADOW

public static final int CONTROL_DK_SHADOW
Array index of the darkly shadowed control background color. Used by (int[]).

See Also: controlDkShadow

CONTROL_HIGHLIGHT

public static final int CONTROL_HIGHLIGHT
Array index of the highlighted control background color. Used by (int[]).

See Also: controlHighlight

CONTROL_LT_HIGHLIGHT

public static final int CONTROL_LT_HIGHLIGHT
Array index of the lightly highlighted control background color. Used by (int[]).

See Also: controlLtHighlight

CONTROL_SHADOW

public static final int CONTROL_SHADOW
Array index of the shadowed control background color. Used by (int[]).

See Also: controlShadow

CONTROL_TEXT

public static final int CONTROL_TEXT
Array index of the control text color. Used by (int[]).

See Also: controlText

controlDkShadow

public static final SystemColor controlDkShadow
The control dark shadow color.

controlHighlight

public static final SystemColor controlHighlight
The control highlight color.

controlLtHighlight

public static final SystemColor controlLtHighlight
The control light highlight color.

controlShadow

public static final SystemColor controlShadow
The control shadow color.

controlText

public static final SystemColor controlText
The control text color.

desktop

public static final SystemColor desktop
The desktop color.

DESKTOP

public static final int DESKTOP
Array index of the desktop color. Used by (int[]).

See Also: desktop

INACTIVE_CAPTION

public static final int INACTIVE_CAPTION
Array index of the inactive caption color. Used by (int[]).

See Also: inactiveCaption

INACTIVE_CAPTION_BORDER

public static final int INACTIVE_CAPTION_BORDER
Array index of the inactive caption border color. Used by (int[]).

See Also: inactiveCaptionBorder

INACTIVE_CAPTION_TEXT

public static final int INACTIVE_CAPTION_TEXT
Array index of the inactive caption text color. Used by (int[]).

See Also: inactiveCaptionText

inactiveCaption

public static final SystemColor inactiveCaption
The inactive caption background color.

inactiveCaptionBorder

public static final SystemColor inactiveCaptionBorder
The inactive caption border color.

inactiveCaptionText

public static final SystemColor inactiveCaptionText
The inactive caption text color.

info

public static final SystemColor info
The info text background color.

INFO

public static final int INFO
Array index of the info background color. Used by (int[]).

See Also: info

INFO_TEXT

public static final int INFO_TEXT
Array index of the info text color. Used by (int[]).

See Also: infoText

infoText

public static final SystemColor infoText
The info text foreground color.

menu

public static final SystemColor menu
The menu background color.

MENU

public static final int MENU
Array index of the menu background color. Used by (int[]).

See Also: menu

MENU_TEXT

public static final int MENU_TEXT
Array index of the menu text color. Used by (int[]).

See Also: menuText

menuText

public static final SystemColor menuText
The menu text color.

NUM_COLORS

public static final int NUM_COLORS
The number of system colors. Used by (int[]).

scrollbar

public static final SystemColor scrollbar
The scrollbar color.

SCROLLBAR

public static final int SCROLLBAR
Array index of the scrollbar background color. Used by (int[]).

See Also: scrollbar

text

public static final SystemColor text
The text background color.

TEXT

public static final int TEXT
Array index of the text background color. Used by (int[]).

See Also: text

TEXT_HIGHLIGHT

public static final int TEXT_HIGHLIGHT
Array index of the highlighted text background color. Used by (int[]).

See Also: textHighlight

TEXT_HIGHLIGHT_TEXT

public static final int TEXT_HIGHLIGHT_TEXT
Array index of the highlighted text foreground color. Used by (int[]).

See Also: textHighlightText

TEXT_INACTIVE_TEXT

public static final int TEXT_INACTIVE_TEXT
Array index of the inactive text foreground color. Used by (int[]).

See Also: textInactiveText

TEXT_TEXT

public static final int TEXT_TEXT
Array index of the text foreground color. Used by (int[]).

See Also: textText

textHighlight

public static final SystemColor textHighlight
The highlighted text background color.

textHighlightText

public static final SystemColor textHighlightText
The highlighted text foreground color.

textInactiveText

public static final SystemColor textInactiveText
The inactive text color.

textText

public static final SystemColor textText
The text foreground color.

window

public static final SystemColor window
The window background color.

WINDOW

public static final int WINDOW
Array index of the window background color. Used by (int[]).

See Also: window

WINDOW_BORDER

public static final int WINDOW_BORDER
Array index of the window border color. Used by (int[]).

See Also: windowBorder

WINDOW_TEXT

public static final int WINDOW_TEXT
Array index of the window text color. Used by (int[]).

See Also: windowText

windowBorder

public static final SystemColor windowBorder
The window border color.

windowText

public static final SystemColor windowText
The window text color.

Method Detail

createContext

public PaintContext createContext(ColorModel cm, Rectangle deviceBounds, Rectangle2D userBounds, AffineTransform xform, RenderingHints hints)
Returns a paint context, used for filling areas of a raster scan with the current value of this system color. Since the system colors may be dynamically updated, the returned value may not always be the same; but as the system color is solid, the context does not need any of the passed parameters to do its job.

Parameters: cm the requested color model deviceBounds the bounding box in device coordinates, ignored userBounds the bounding box in user coordinates, ignored xform the bounds transformation, ignored hints any rendering hints, ignored

Returns: a context for painting this solid color

getRGB

public int getRGB()
Returns the RGB value for this color, in the sRGB color space. The blue value will be in bits 0-7, green in 8-15, red in 6-23, and the alpha value (bits 24-31) is 0xff. This is dynamically updated, so it may not match the results of getRed(), getGreen(), or getBlue().

Returns: the current RGB value

toString

public String toString()
Returns a string describing this color. This is in the format "java.awt.SystemColor[i=" + index + ']', where index is one of the integer constants of this class. Unfortunately, this description does not describe the current value of the color; for that you should use new Color(syscolor.getRGB()).toString().

Returns: a string describing this color