com.alee.managers.style

Class StyleManager

java.lang.Object

com.alee.managers.style.StyleManager

public final class StyleManager
extends java.lang.Object

This class manages WebLaF component styles. It also manages available WebLaF skins and can install/change them in runtime.

See Also:

How to use StyleManager, Skin, Skinnable, SkinInfo, StyleId, StyleData

Constructor Summary

Constructors

Constructor and Description
StyleManager()

Method Summary

Modifier and Type	Method and Description
static void	addStyleListener(javax.swing.JComponent component, StyleListener listener) Adds skin change listener.
static Painter	getCustomPainter(javax.swing.JComponent component) Returns custom base painter for the specified component.
static Painter	getCustomPainter(javax.swing.JComponent component, java.lang.String id) Returns custom painter for the specified component.
static java.util.Map<java.lang.String,Painter>	getCustomPainters(javax.swing.JComponent component) Returns all custom painters for the specified component.
static java.lang.Class<? extends Skin>	getDefaultSkin() Returns default skin.
static Skin	getSkin() Returns currently applied skin.
static Skin	getSkin(javax.swing.JComponent component) Returns skin currently applied to the specified component.
static StyleId	getStyleId(javax.swing.JComponent component) Returns component style ID.
static void	initialize() Initializes StyleManager settings.
static Skin	installSkin(javax.swing.JComponent component) Applies current skin to the skinnable component.
static boolean	isStrictStyleChecks() Returns whether strict style checks are enabled or not.
static void	removeStyleListener(javax.swing.JComponent component, StyleListener listener) Removes skin change listener.
static boolean	restoreDefaultPainters(javax.swing.JComponent component) Restores default painters for the specified component.
static Skin	restoreSkin(javax.swing.JComponent component) Restores global skin for the skinnable component and all of its children linked via StyleId.
static StyleId	restoreStyleId(javax.swing.JComponent component) Restores component default style ID.
static <T extends Painter> T	setCustomPainter(javax.swing.JComponent component, java.lang.String id, T painter) Sets custom painter for the specified component under the specified painter ID.
static <T extends Painter> T	setCustomPainter(javax.swing.JComponent component, T painter) Sets custom base painter for the specified component.
static java.lang.Class<? extends Skin>	setDefaultSkin(java.lang.Class<? extends Skin> skinClass) Sets default skin.
static java.lang.Class<? extends Skin>	setDefaultSkin(java.lang.String skinClassName) Sets default skin.
static Skin	setSkin(java.lang.Class skinClass) Applies specified skin to all existing skinnable components.
static Skin	setSkin(javax.swing.JComponent component, Skin skin) Applies specified skin to the skinnable component and all of its children linked via StyleId.
static Skin	setSkin(javax.swing.JComponent component, Skin skin, boolean recursively) Applies specified skin to the skinnable component and all of its children linked via StyleId.
static Skin	setSkin(Skin skin) Applies specified skin to all existing skinnable components.
static Skin	setSkin(java.lang.String skinClassName) Applies specified skin to all existing skinnable components.
static void	setStrictStyleChecks(boolean strict) Sets whether strict style checks are enabled or not.
static StyleId	setStyleId(javax.swing.JComponent component, StyleId id) Sets new component style ID.
static Skin	uninstallSkin(javax.swing.JComponent component) Removes skin applied to the specified component and returns it.
static void	updateSkin(javax.swing.JComponent component) Updates current skin in the skinnable component.

Methods inherited from class java.lang.Object

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

Constructor Detail

StyleManager

public StyleManager()

Method Detail

initialize

public static void initialize()

Initializes StyleManager settings.

isStrictStyleChecks

public static boolean isStrictStyleChecks()

Returns whether strict style checks are enabled or not.

Returns:

true if strict style checks are enabled, false otherwise

setStrictStyleChecks

public static void setStrictStyleChecks(boolean strict)

Sets whether strict style checks are enabled or not.

Parameters:

strict - whether strict style checks are enabled or not

getDefaultSkin

public static java.lang.Class<? extends Skin> getDefaultSkin()

Returns default skin.

Returns:

default skin

setDefaultSkin

public static java.lang.Class<? extends Skin> setDefaultSkin(java.lang.String skinClassName)

Sets default skin.

Parameters:

skinClassName - default skin class name

Returns:

previous default skin

setDefaultSkin

public static java.lang.Class<? extends Skin> setDefaultSkin(java.lang.Class<? extends Skin> skinClass)

Sets default skin.

Parameters:

skinClass - default skin class

Returns:

previous default skin

getSkin

public static Skin getSkin()

Returns currently applied skin.

Returns:

currently applied skin

setSkin

public static Skin setSkin(java.lang.String skinClassName)

Applies specified skin to all existing skinnable components. This skin will also be applied to all skinnable components created afterwards.

Parameters:

skinClassName - class name of the skin to be applied

Returns:

previously applied skin

setSkin

public static Skin setSkin(java.lang.Class skinClass)

Applies specified skin to all existing skinnable components. This skin will also be applied to all skinnable components created afterwards.

Parameters:

skinClass - class of the skin to be applied

Returns:

previously applied skin

setSkin

public static Skin setSkin(Skin skin)

Applies specified skin to all existing skinnable components. This skin will also be applied to all skinnable components created afterwards.

Parameters:

skin - skin to be applied

Returns:

previously applied skin

getStyleId

public static StyleId getStyleId(javax.swing.JComponent component)

Returns component style ID.

Parameters:

component - component to retrieve style ID for

Returns:

component style ID

setStyleId

public static StyleId setStyleId(javax.swing.JComponent component,
                                 StyleId id)

Sets new component style ID.

Parameters:

component - component to set style ID for

id - new style ID

Returns:

previously used style ID

restoreStyleId

public static StyleId restoreStyleId(javax.swing.JComponent component)

Restores component default style ID.

Parameters:

component - component to restore style ID for

Returns:

previously used style ID

installSkin

public static Skin installSkin(javax.swing.JComponent component)

Applies current skin to the skinnable component.

This method is used only to setup style data into UI on install. It is not recommended to use it outside of that install behavior.

Parameters:

component - component to apply skin to

Returns:

previously applied skin

updateSkin

public static void updateSkin(javax.swing.JComponent component)

Updates current skin in the skinnable component.

This method is used only to properly update skin on various changes. It is not recommended to use it outside of style manager behavior.

Parameters:

component - component to update skin for

uninstallSkin

public static Skin uninstallSkin(javax.swing.JComponent component)

Removes skin applied to the specified component and returns it.

This method is used only to cleanup style data from UI on uninstall. It is not recommended to use it outside of that uninstall behavior.

Parameters:

component - component to remove skin from

Returns:

previously applied skin

getSkin

public static Skin getSkin(javax.swing.JComponent component)

Returns skin currently applied to the specified component.

Parameters:

component - component to retrieve applied skin from

Returns:

skin currently applied to the specified component

setSkin

public static Skin setSkin(javax.swing.JComponent component,
                           Skin skin)

Applies specified skin to the skinnable component and all of its children linked via StyleId. Actual linked children information is stored within StyleData data objects. Custom skin provided using this method will not be replaced if application skin changes.

Parameters:

component - component to apply skin to

skin - skin to be applied

Returns:

previously applied skin

setSkin

public static Skin setSkin(javax.swing.JComponent component,
                           Skin skin,
                           boolean recursively)

Applies specified skin to the skinnable component and all of its children linked via StyleId. Actual linked children information is stored within StyleData data objects. Custom skin provided using this method will not be replaced if application skin changes.

Parameters:

component - component to apply skin to

skin - skin to be applied

recursively - whether or not should apply skin to child components

Returns:

previously applied skin

restoreSkin

public static Skin restoreSkin(javax.swing.JComponent component)

Restores global skin for the skinnable component and all of its children linked via StyleId. Actual linked children information is stored within StyleData data objects. Restoring component skin will also include it back into the skin update cycle in case global skin will be changed.

Parameters:

component - component to restore global skin for

Returns:

skin applied to the specified component after restoration

addStyleListener

public static void addStyleListener(javax.swing.JComponent component,
                                    StyleListener listener)

Adds skin change listener.

Parameters:

component - component to listen skin changes on

listener - skin change listener to add

removeStyleListener

public static void removeStyleListener(javax.swing.JComponent component,
                                       StyleListener listener)

Removes skin change listener.

Parameters:

component - component to listen skin changes on

listener - skin change listener to remove

getCustomPainters

public static java.util.Map<java.lang.String,Painter> getCustomPainters(javax.swing.JComponent component)

Returns all custom painters for the specified component.

Parameters:

component - component to retrieve custom painters for

Returns:

all custom painters for the specified component

getCustomPainter

public static Painter getCustomPainter(javax.swing.JComponent component)

Returns custom base painter for the specified component.

Parameters:

component - component to retrieve custom base painter for

Returns:

custom base painter for the specified component

getCustomPainter

public static Painter getCustomPainter(javax.swing.JComponent component,
                                       java.lang.String id)

Returns custom painter for the specified component.

Parameters:

component - component to retrieve custom painter for

id - painter ID

Returns:

custom painter for the specified component

setCustomPainter

public static <T extends Painter> T setCustomPainter(javax.swing.JComponent component,
                                                     T painter)

Sets custom base painter for the specified component. You should call this method when setting painter outside of the UI.

Type Parameters:

T - painter type

Parameters:

component - component to set painter for

painter - painter

Returns:

old custom painter

setCustomPainter

public static <T extends Painter> T setCustomPainter(javax.swing.JComponent component,
                                                     java.lang.String id,
                                                     T painter)

Sets custom painter for the specified component under the specified painter ID. You should call this method when setting painter outside of the UI.

Type Parameters:

T - painter type

Parameters:

component - component to set painter for

id - painter ID

painter - painter

Returns:

old custom painter

restoreDefaultPainters

public static boolean restoreDefaultPainters(javax.swing.JComponent component)

Restores default painters for the specified component.

Parameters:

component - component to restore default painters for

Returns:

true if default painters were restored, false otherwise