Package org.pushingpixels.substance.api

Class SubstanceSlices.ColorSchemeAssociationKind

java.lang.Object

org.pushingpixels.substance.api.SubstanceSlices.ColorSchemeAssociationKind

Enclosing class:

SubstanceSlices

public static final class SubstanceSlices.ColorSchemeAssociationKind
extends java.lang.Object

Allows associating different color schemes to different visual parts of UI components. For example, the JCheckBox has three different visual areas:

• Border - assciated with BORDER
• Fill - associated with MARK_BOX
• Check mark - associated with MARK

Applications can create custom instances of this class to further refine the control over the painting. In this case, the custom UI delegates must be created to use these new association kinds.

Field Summary

Fields

Modifier and Type	Field	Description
static SubstanceSlices.ColorSchemeAssociationKind	BORDER	Border visual area of non-tab controls.
static SubstanceSlices.ColorSchemeAssociationKind	FILL	The default visual area that is used for the inner part of most controls.
static SubstanceSlices.ColorSchemeAssociationKind	FOCUS	Visual area of focus indication.
static SubstanceSlices.ColorSchemeAssociationKind	HIGHLIGHT	Highlight visual areas for lists, tables, trees and menus.
static SubstanceSlices.ColorSchemeAssociationKind	HIGHLIGHT_BORDER	Border visual areas for highlighted regions of lists, tables, trees and menus.
static SubstanceSlices.ColorSchemeAssociationKind	HIGHLIGHT_MARK	Visual area of marks in highlighted regions of lists, tables, trees and menus.
static SubstanceSlices.ColorSchemeAssociationKind	HIGHLIGHT_TEXT	Highlight visual areas for text components.
static SubstanceSlices.ColorSchemeAssociationKind	MARK	Visual area of marks.
static SubstanceSlices.ColorSchemeAssociationKind	MARK_BOX	Visual area of mark boxes.
static SubstanceSlices.ColorSchemeAssociationKind	SEPARATOR	Visual area of separators.
static SubstanceSlices.ColorSchemeAssociationKind	TAB	Fill visual area of the tabs.
static SubstanceSlices.ColorSchemeAssociationKind	TAB_BORDER	Border visual area of the tabs.

Constructor Summary

Constructors

Constructor	Description
ColorSchemeAssociationKind(java.lang.String name, SubstanceSlices.ColorSchemeAssociationKind fallback)	Creates a new association kind.

Method Summary

Modifier and Type	Method	Description
SubstanceSlices.ColorSchemeAssociationKind	getFallback()	Returns the fallback for this association kind.
java.lang.String	toString()
static java.util.Set<SubstanceSlices.ColorSchemeAssociationKind>	values()	Returns all available association kinds.

Methods inherited from class java.lang.Object

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

Field Detail

FILL

public static final SubstanceSlices.ColorSchemeAssociationKind FILL

The default visual area that is used for the inner part of most controls.

SEPARATOR

public static final SubstanceSlices.ColorSchemeAssociationKind SEPARATOR

Visual area of separators.

TAB

public static final SubstanceSlices.ColorSchemeAssociationKind TAB

Fill visual area of the tabs.

BORDER

public static final SubstanceSlices.ColorSchemeAssociationKind BORDER

Border visual area of non-tab controls.

MARK

public static final SubstanceSlices.ColorSchemeAssociationKind MARK

Visual area of marks. Used for painting check marks of checkboxes and radio buttons, as well as arrow icons of combo boxes, spinners and more.

MARK_BOX

public static final SubstanceSlices.ColorSchemeAssociationKind MARK_BOX

Visual area of mark boxes. Used for painting the box of checkboxes and radio buttons.

FOCUS

public static final SubstanceSlices.ColorSchemeAssociationKind FOCUS

Visual area of focus indication.

TAB_BORDER

public static final SubstanceSlices.ColorSchemeAssociationKind TAB_BORDER

Border visual area of the tabs.

HIGHLIGHT

public static final SubstanceSlices.ColorSchemeAssociationKind HIGHLIGHT

Highlight visual areas for lists, tables, trees and menus.

HIGHLIGHT_TEXT

public static final SubstanceSlices.ColorSchemeAssociationKind HIGHLIGHT_TEXT

Highlight visual areas for text components.

HIGHLIGHT_BORDER

public static final SubstanceSlices.ColorSchemeAssociationKind HIGHLIGHT_BORDER

Border visual areas for highlighted regions of lists, tables, trees and menus.

HIGHLIGHT_MARK

public static final SubstanceSlices.ColorSchemeAssociationKind HIGHLIGHT_MARK

Visual area of marks in highlighted regions of lists, tables, trees and menus.

Constructor Detail

ColorSchemeAssociationKind

public ColorSchemeAssociationKind(java.lang.String name,
                                  SubstanceSlices.ColorSchemeAssociationKind fallback)

Creates a new association kind.

Parameters:

name - Association kind name.

fallback - Fallback association kind. This is used when no color scheme is associated with this kind. For example, TAB_BORDER specifies that its fallback is BORDER. When the JTabbedPane UI delegate is painting the tabs, it will try to use the color scheme associated with TAB_BORDER. If none was registered, it will fall back to use the color scheme associated with BORDER, and if that is not registered as well, will use the color scheme associated with FILL.

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

values

public static java.util.Set<SubstanceSlices.ColorSchemeAssociationKind> values()

Returns all available association kinds.

Returns:

All available association kinds.

getFallback

public SubstanceSlices.ColorSchemeAssociationKind getFallback()

Returns the fallback for this association kind.

Returns:

The fallback for this association kind.