com.jgoodies.looks.plastic

Class PlasticLookAndFeel

java.lang.Object

javax.swing.LookAndFeel

javax.swing.plaf.basic.BasicLookAndFeel

javax.swing.plaf.metal.MetalLookAndFeel

com.jgoodies.looks.plastic.PlasticLookAndFeel

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

Plastic3DLookAndFeel

public class PlasticLookAndFeel
extends javax.swing.plaf.metal.MetalLookAndFeel

The base class for the JGoodies Plastic look&feel family. Initializes class and component defaults for the Plastic L&f and provides keys and optional features for the Plastic family.

Version:

$Revision: 1.46 $

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BORDER_STYLE_KEY Client property key to set a border style - shadows the header style.
static java.lang.String	DEFAULT_THEME_KEY A System property key to set the default theme.
static java.lang.String	HIGH_CONTRAST_FOCUS_ENABLED_KEY A System property key that indicates that the high contrast focus colors shall be choosen - if applicable.
private static java.util.List<PlasticTheme>	installedThemes The List of installed Plastic themes.
static java.lang.String	IS_3D_KEY Client property key to disable the pseudo 3D effect.
private static boolean	is3DEnabled The look-global state for the 3D enablement.
private static boolean	selectTextOnKeyboardFocusGained
static java.lang.String	TAB_STYLE_DEFAULT_VALUE A System property value that indicates that Plastic shall render tabs in the Plastic 1.0 style.
protected static java.lang.String	TAB_STYLE_KEY A System property key for the rendering style of the Plastic TabbedPane.
static java.lang.String	TAB_STYLE_METAL_VALUE A System property value that indicates that Plastic shall render tabs in the Metal L&F style.
private static java.lang.String	THEME_CLASSNAME_PREFIX
private static boolean	useHighContrastFocusColors Holds whether we are using the high contrast focus colors.
private static boolean	useMetalTabs Holds whether Plastic uses Metal or Plastic tabbed panes.

Constructor Summary

Constructors

Constructor and Description
PlasticLookAndFeel() Constructs the PlasticLookAndFeel, creates the default theme and sets it as current Plastic theme.

Method Summary

Modifier and Type	Method and Description
private static java.lang.Object[]	append(java.lang.Object[] source, java.lang.String key, java.lang.Object value) Appends the key and value to the given source array and returns a copy that has the two new elements at its end.
static PlasticTheme	createMyDefaultTheme() Creates and returns the default color theme.
protected static PlasticTheme	createTheme(java.lang.String themeName) Creates and returns a color theme from the specified theme name.
static javax.swing.plaf.ColorUIResource	getControl()
static javax.swing.plaf.ColorUIResource	getControlDarkShadow()
static javax.swing.plaf.ColorUIResource	getControlHighlight()
private static java.lang.String	getDefaultXPTheme()
java.lang.String	getDescription()
javax.swing.Icon	getDisabledIcon(javax.swing.JComponent component, javax.swing.Icon icon) Returns an icon with a disabled appearance.
static javax.swing.plaf.ColorUIResource	getFocusColor()
static FontPolicy	getFontPolicy() Looks up and retrieves the FontPolicy used by the JGoodies Plastic Look&Feel family.
static boolean	getHighContrastFocusColorsEnabled()
java.lang.String	getID()
static java.util.List	getInstalledThemes() Lazily initializes and returns the List of installed color themes.
static javax.swing.plaf.BorderUIResource	getInternalFrameBorder()
static javax.swing.plaf.ColorUIResource	getMenuItemBackground()
static javax.swing.plaf.ColorUIResource	getMenuItemSelectedBackground()
static javax.swing.plaf.ColorUIResource	getMenuItemSelectedForeground()
static MicroLayoutPolicy	getMicroLayoutPolicy() Looks up and retrieves the MicroLayoutPolicy used by the JGoodies Plastic Look&Fs.
java.lang.String	getName()
static javax.swing.plaf.BorderUIResource	getPaletteBorder()
static PlasticTheme	getPlasticTheme() Lazily initializes and returns the PlasticTheme.
static javax.swing.plaf.ColorUIResource	getPrimaryControl()
static javax.swing.plaf.ColorUIResource	getPrimaryControlDarkShadow()
static javax.swing.plaf.ColorUIResource	getPrimaryControlHighlight()
static javax.swing.plaf.ColorUIResource	getPrimaryControlInfo()
static javax.swing.plaf.ColorUIResource	getPrimaryControlShadow()
static javax.swing.plaf.ColorUIResource	getSimpleInternalFrameBackground()
static javax.swing.plaf.ColorUIResource	getSimpleInternalFrameForeground()
static java.lang.String	getTabStyle()
static javax.swing.plaf.ColorUIResource	getTitleTextColor()
static javax.swing.plaf.FontUIResource	getTitleTextFont()
static javax.swing.plaf.ColorUIResource	getWindowTitleBackground()
static javax.swing.plaf.ColorUIResource	getWindowTitleForeground()
static javax.swing.plaf.ColorUIResource	getWindowTitleInactiveBackground()
static javax.swing.plaf.ColorUIResource	getWindowTitleInactiveForeground()
protected void	initClassDefaults(javax.swing.UIDefaults table) Initializes the class defaults, that is, overrides some UI delegates with JGoodies Plastic implementations.
protected void	initComponentDefaults(javax.swing.UIDefaults table)
void	initialize() Invoked during UIManager#setLookAndFeel.
protected void	initSystemColorDefaults(javax.swing.UIDefaults table) Unlike my superclass I register a unified shadow color.
protected static void	installDefaultThemes() Install the default color themes.
static void	installTheme(PlasticTheme theme) Installs a color theme.
protected boolean	is3DEnabled()
static boolean	isSelectTextOnKeyboardFocusGained()
static void	set3DEnabled(boolean b)
static void	setFontPolicy(FontPolicy fontPolicy) Sets the FontPolicy to be used with the JGoodies Plastic L&F family.
static void	setHighContrastFocusColorsEnabled(boolean b)
static void	setMicroLayoutPolicy(MicroLayout microLayoutPolicy) Sets the MicroLayoutPolicy to be used with the JGoodies Plastic L&Fs.
static void	setPlasticTheme(PlasticTheme theme) Sets the theme for colors and fonts used by the Plastic L&F.
static void	setSelectTextOnKeyboardFocusGained(boolean b) Sets whether text field text shall be selected when it gains focus via the keyboard.
static void	setTabStyle(java.lang.String tabStyle)
void	uninitialize() Invoked during UIManager#setLookAndFeel.

Methods inherited from class javax.swing.plaf.metal.MetalLookAndFeel

createDefaultTheme, getAcceleratorForeground, getAcceleratorSelectedForeground, getBlack, getControlDisabled, getControlInfo, getControlShadow, getControlTextColor, getControlTextFont, getCurrentTheme, getDefaults, getDesktopColor, getDisabledSelectedIcon, getHighlightedTextColor, getInactiveControlTextColor, getInactiveSystemTextColor, getLayoutStyle, getMenuBackground, getMenuDisabledForeground, getMenuForeground, getMenuSelectedBackground, getMenuSelectedForeground, getMenuTextFont, getSeparatorBackground, getSeparatorForeground, getSubTextFont, getSupportsWindowDecorations, getSystemTextColor, getSystemTextFont, getTextHighlightColor, getUserTextColor, getUserTextFont, getWhite, getWindowBackground, getWindowTitleFont, isNativeLookAndFeel, isSupportedLookAndFeel, provideErrorFeedback, setCurrentTheme

Methods inherited from class javax.swing.plaf.basic.BasicLookAndFeel

createAudioAction, getAudioActionMap, loadSystemColors, playSound

Methods inherited from class javax.swing.LookAndFeel

getDesktopPropertyValue, installBorder, installColors, installColorsAndFont, installProperty, loadKeyBindings, makeComponentInputMap, makeIcon, makeInputMap, makeKeyBindings, toString, uninstallBorder

Methods inherited from class java.lang.Object

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

Field Detail

BORDER_STYLE_KEY

public static final java.lang.String BORDER_STYLE_KEY

Client property key to set a border style - shadows the header style.

See Also:

Constant Field Values

IS_3D_KEY

public static final java.lang.String IS_3D_KEY

Client property key to disable the pseudo 3D effect.

See Also:

Constant Field Values

DEFAULT_THEME_KEY

public static final java.lang.String DEFAULT_THEME_KEY

A System property key to set the default theme.

See Also:

Constant Field Values

HIGH_CONTRAST_FOCUS_ENABLED_KEY

public static final java.lang.String HIGH_CONTRAST_FOCUS_ENABLED_KEY

A System property key that indicates that the high contrast focus colors shall be choosen - if applicable. If not set, some focus colors look good but have low contrast. Basically, the low contrast scheme uses the Plastic colors before 1.0.7, and the high contrast scheme is 1.0.7 - 1.0.9.

See Also:

Constant Field Values

TAB_STYLE_KEY

protected static final java.lang.String TAB_STYLE_KEY

A System property key for the rendering style of the Plastic TabbedPane. Valid values are: default for the Plastic 1.0 tabs, and metal for the Metal L&F tabs.

See Also:

Constant Field Values

TAB_STYLE_DEFAULT_VALUE

public static final java.lang.String TAB_STYLE_DEFAULT_VALUE

A System property value that indicates that Plastic shall render tabs in the Plastic 1.0 style. This is the default.

See Also:

Constant Field Values

TAB_STYLE_METAL_VALUE

public static final java.lang.String TAB_STYLE_METAL_VALUE

A System property value that indicates that Plastic shall render tabs in the Metal L&F style.

See Also:

Constant Field Values

useMetalTabs

private static boolean useMetalTabs

Holds whether Plastic uses Metal or Plastic tabbed panes.

useHighContrastFocusColors

private static boolean useHighContrastFocusColors

Holds whether we are using the high contrast focus colors.

installedThemes

private static java.util.List<PlasticTheme> installedThemes

The List of installed Plastic themes.

is3DEnabled

private static boolean is3DEnabled

The look-global state for the 3D enablement.

selectTextOnKeyboardFocusGained

private static boolean selectTextOnKeyboardFocusGained

THEME_CLASSNAME_PREFIX

private static final java.lang.String THEME_CLASSNAME_PREFIX

See Also:

Constant Field Values

Constructor Detail

PlasticLookAndFeel

public PlasticLookAndFeel()

Constructs the PlasticLookAndFeel, creates the default theme and sets it as current Plastic theme.

Method Detail

getID

public java.lang.String getID()

Overrides:

getID in class javax.swing.plaf.metal.MetalLookAndFeel

getName

public java.lang.String getName()

Overrides:

getName in class javax.swing.plaf.metal.MetalLookAndFeel

getDescription

public java.lang.String getDescription()

Overrides:

getDescription in class javax.swing.plaf.metal.MetalLookAndFeel

getFontPolicy

public static FontPolicy getFontPolicy()

Looks up and retrieves the FontPolicy used by the JGoodies Plastic Look&Feel family. If a FontPolicy has been set, it'll be returned. Otherwise, this method checks if a FontPolicy or FontSet is defined in the system properties or UIDefaults. If so, it is returned. If no FontPolicy has been set for this look, in the system properties or UIDefaults, the default Plastic font policy will be returned.

Returns:

the FontPolicy set for this Look&feel - if any, the FontPolicy specified in the system properties or UIDefaults - if any, or the default Plastic font policy.

See Also:

setFontPolicy(com.jgoodies.looks.FontPolicy), Options.PLASTIC_FONT_POLICY_KEY, FontPolicies, FontPolicies.customSettingsPolicy(FontPolicy), FontPolicies.getDefaultPlasticPolicy()

setFontPolicy

public static void setFontPolicy(FontPolicy fontPolicy)

Sets the FontPolicy to be used with the JGoodies Plastic L&F family. If the specified policy is null, the default will be reset.

Parameters:

fontPolicy - the FontPolicy to be used with the JGoodies Plastic L&F family, or null to reset to the default

See Also:

getFontPolicy(), Options.PLASTIC_FONT_POLICY_KEY

getMicroLayoutPolicy

public static MicroLayoutPolicy getMicroLayoutPolicy()

Looks up and retrieves the MicroLayoutPolicy used by the JGoodies Plastic Look&Fs. If a MicroLayoutPolicy has been set for this look, it'll be returned. Otherwise, the default Plastic micro layout policy will be returned.

Returns:

the MicroLayoutPolicy set for this Look&feel - if any, or the default Plastic MicroLayoutPolicy.

See Also:

setMicroLayoutPolicy(com.jgoodies.looks.MicroLayout), Options.PLASTIC_MICRO_LAYOUT_POLICY_KEY, MicroLayoutPolicies

setMicroLayoutPolicy

public static void setMicroLayoutPolicy(MicroLayout microLayoutPolicy)

Sets the MicroLayoutPolicy to be used with the JGoodies Plastic L&Fs. If the specified policy is null, the default will be reset.

Parameters:

microLayoutPolicy - the MicroLayoutPolicy to be used with the JGoodies Plastic L&Fs, or null to reset to the default

See Also:

getMicroLayoutPolicy(), Options.PLASTIC_MICRO_LAYOUT_POLICY_KEY

is3DEnabled

protected boolean is3DEnabled()

set3DEnabled

public static void set3DEnabled(boolean b)

getTabStyle

public static java.lang.String getTabStyle()

setTabStyle

public static void setTabStyle(java.lang.String tabStyle)

getHighContrastFocusColorsEnabled

public static boolean getHighContrastFocusColorsEnabled()

setHighContrastFocusColorsEnabled

public static void setHighContrastFocusColorsEnabled(boolean b)

isSelectTextOnKeyboardFocusGained

public static boolean isSelectTextOnKeyboardFocusGained()

setSelectTextOnKeyboardFocusGained

public static void setSelectTextOnKeyboardFocusGained(boolean b)

Sets whether text field text shall be selected when it gains focus via the keyboard. This is enabled on Windows by default and disabled on all other platforms.

Parameters:

b - true to enabled, false to disable

initialize

public void initialize()

Invoked during UIManager#setLookAndFeel. In addition to the superclass behavior, we install the ShadowPopupFactory.

Overrides:

initialize in class javax.swing.plaf.basic.BasicLookAndFeel

See Also:

uninitialize()

uninitialize

public void uninitialize()

Invoked during UIManager#setLookAndFeel. In addition to the superclass behavior, we uninstall the ShadowPopupFactory.

Overrides:

uninitialize in class javax.swing.plaf.basic.BasicLookAndFeel

See Also:

initialize()

getDisabledIcon

public javax.swing.Icon getDisabledIcon(javax.swing.JComponent component,
                                        javax.swing.Icon icon)

Returns an icon with a disabled appearance. This method is used to generate a disabled icon when one has not been specified.

This method will be used only on JDK 5.0 and later.

Overrides:

getDisabledIcon in class javax.swing.plaf.metal.MetalLookAndFeel

Parameters:

component - the component that will display the icon, may be null.

icon - the icon to generate disabled icon from.

Returns:

disabled icon, or null if a suitable icon can not be generated.

initClassDefaults

protected void initClassDefaults(javax.swing.UIDefaults table)

Initializes the class defaults, that is, overrides some UI delegates with JGoodies Plastic implementations.

Overrides:

initClassDefaults in class javax.swing.plaf.metal.MetalLookAndFeel

Parameters:

table - the UIDefaults table to work with

See Also:

BasicLookAndFeel.getDefaults()

initComponentDefaults

protected void initComponentDefaults(javax.swing.UIDefaults table)

Overrides:

initComponentDefaults in class javax.swing.plaf.metal.MetalLookAndFeel

initSystemColorDefaults

protected void initSystemColorDefaults(javax.swing.UIDefaults table)

Unlike my superclass I register a unified shadow color. This color is used by my ThinBevelBorder class.

Overrides:

initSystemColorDefaults in class javax.swing.plaf.metal.MetalLookAndFeel

Parameters:

table - the UIDefaults table to work with

createMyDefaultTheme

public static PlasticTheme createMyDefaultTheme()

Creates and returns the default color theme. Honors the current platform and platform flavor - if available.

Returns:

the default color theme for the current environment

getDefaultXPTheme

private static java.lang.String getDefaultXPTheme()

getInstalledThemes

public static java.util.List getInstalledThemes()

Lazily initializes and returns the List of installed color themes.

Returns:

a list of installed color/font themes

installDefaultThemes

protected static void installDefaultThemes()

Install the default color themes.

createTheme

protected static PlasticTheme createTheme(java.lang.String themeName)

Creates and returns a color theme from the specified theme name.

Parameters:

themeName - the unqualified name of the theme to create

Returns:

the associated color theme or null in case of a problem

installTheme

public static void installTheme(PlasticTheme theme)

Installs a color theme.

Parameters:

theme - the theme to install

getPlasticTheme

public static PlasticTheme getPlasticTheme()

Lazily initializes and returns the PlasticTheme.

Returns:

the current PlasticTheme

setPlasticTheme

public static void setPlasticTheme(PlasticTheme theme)

Sets the theme for colors and fonts used by the Plastic L&F.

After setting the theme, you need to re-install the Look&Feel, as well as update the UI's of any previously created components - just as if you'd change the Look&Feel.

Parameters:

theme - the PlasticTheme to be set

Throws:

java.lang.NullPointerException - if the theme is null.

See Also:

getPlasticTheme()

getInternalFrameBorder

public static javax.swing.plaf.BorderUIResource getInternalFrameBorder()

getPaletteBorder

public static javax.swing.plaf.BorderUIResource getPaletteBorder()

getPrimaryControlDarkShadow

public static javax.swing.plaf.ColorUIResource getPrimaryControlDarkShadow()

getPrimaryControlHighlight

public static javax.swing.plaf.ColorUIResource getPrimaryControlHighlight()

getPrimaryControlInfo

public static javax.swing.plaf.ColorUIResource getPrimaryControlInfo()

getPrimaryControlShadow

public static javax.swing.plaf.ColorUIResource getPrimaryControlShadow()

getPrimaryControl

public static javax.swing.plaf.ColorUIResource getPrimaryControl()

getControlHighlight

public static javax.swing.plaf.ColorUIResource getControlHighlight()

getControlDarkShadow

public static javax.swing.plaf.ColorUIResource getControlDarkShadow()

getControl

public static javax.swing.plaf.ColorUIResource getControl()

getFocusColor

public static javax.swing.plaf.ColorUIResource getFocusColor()

getMenuItemBackground

public static javax.swing.plaf.ColorUIResource getMenuItemBackground()

getMenuItemSelectedBackground

public static javax.swing.plaf.ColorUIResource getMenuItemSelectedBackground()

getMenuItemSelectedForeground

public static javax.swing.plaf.ColorUIResource getMenuItemSelectedForeground()

getWindowTitleBackground

public static javax.swing.plaf.ColorUIResource getWindowTitleBackground()

getWindowTitleForeground

public static javax.swing.plaf.ColorUIResource getWindowTitleForeground()

getWindowTitleInactiveBackground

public static javax.swing.plaf.ColorUIResource getWindowTitleInactiveBackground()

getWindowTitleInactiveForeground

public static javax.swing.plaf.ColorUIResource getWindowTitleInactiveForeground()

getSimpleInternalFrameForeground

public static javax.swing.plaf.ColorUIResource getSimpleInternalFrameForeground()

getSimpleInternalFrameBackground

public static javax.swing.plaf.ColorUIResource getSimpleInternalFrameBackground()

getTitleTextColor

public static javax.swing.plaf.ColorUIResource getTitleTextColor()

getTitleTextFont

public static javax.swing.plaf.FontUIResource getTitleTextFont()

append

private static java.lang.Object[] append(java.lang.Object[] source,
                                         java.lang.String key,
                                         java.lang.Object value)

Appends the key and value to the given source array and returns a copy that has the two new elements at its end.

Returns:

an array with the key and value appended