com.alee.managers.style

Class StyleManager

java.lang.Object

com.alee.managers.style.StyleManager

public final class StyleManager
extends Object

This manager handles all default Swing and custom WebLaF component styles. It provides API for ComponentDescriptors usage for adjusting default component settings. It also manages global and per-component Skins and custom component Painters.

Author:

Mikle Garin

See Also:

How to use StyleManager, Skin, SkinExtension, StyleId, StyleData

Constructor Summary

Constructors

Constructor and Description
StyleManager()

Method Summary

Modifier and Type	Method and Description
static void	addExtensions(SkinExtension... extensions) Adds new SkinExtensions which will either be loaded right away if manager is initialized or later on if its not.
static void	addSkinListener(SkinListener listener) Adds skin change listener.
static void	addStyleListener(JComponent component, StyleListener listener) Adds StyleListener.
static void	fireSkinChanged(Skin previous, Skin current) Informs listeners about skin change.
static Painter	getCustomPainter(JComponent component) Returns custom Painter used for the specified JComponent.
protected static StyleData	getData(JComponent component) Returns component style data.
static LazyInstance<? extends Skin>	getDefaultSkin() Returns LazyInstance for default Skin.
static ComponentDescriptor	getDescriptor(Class<? extends JComponent> componentClass) Returns ComponentDescriptor for the specified JComponent class.
static ComponentDescriptor	getDescriptor(JComponent component) Returns ComponentDescriptor for the specified JComponent.
static ComponentDescriptor	getDescriptor(String id) Returns ComponentDescriptor with the specified identifier.
static List<ComponentDescriptor>	getDescriptors() Returns immutable list of all registered ComponentDescriptors.
static int	getDescriptorsCount() Returns all registered ComponentDescriptors count.
static List<SkinExtension>	getExtensions() Returns list of installed SkinExtensions.
static Skin	getSkin() Returns currently applied Skin.
static Skin	getSkin(JComponent component) Returns skin currently applied to the specified component.
static StyleId	getStyleId(JComponent component) Returns component StyleId.
static void	initialize() Initializes StyleManager settings.
static void	installSkin(JComponent component) Applies current skin to the skinnable component.
static boolean	isStrictStyleChecks() Returns whether strict style checks are enabled or not.
static boolean	isSupported(JComponent component) Returns whether or not styling of the specified JComponent is supported.
static boolean	isSupported(String id) Returns whether or not styling is supported for the component with the specified identifier.
static void	registerComponentDescriptor(ComponentDescriptor descriptor) Registers new ComponentDescriptor.
static void	removeSkinListener(SkinListener listener) Removes skin change listener.
static void	removeStyleListener(JComponent component, StyleListener listener) Removes StyleListener.
static boolean	resetCustomPainter(JComponent component) Resets custom Painter for the specified JComponent to default one.
static Skin	resetSkin(JComponent component) Resets skin for the specified component and all of its children linked via StyleId.
static StyleId	resetStyleId(JComponent component) Resets StyleId to default value.
static Painter	setCustomPainter(JComponent component, Painter painter) Sets custom Painter for the specified JComponent.
static void	setDefaultSkin(Class<? extends Skin> skin, Object... arguments) Changes default Skin used upon StyleManager initialization.
static void	setDefaultSkin(LazyInstance<? extends Skin> skin) Changes default Skin used upon StyleManager initialization.
static void	setDefaultSkin(String skin, Object... arguments) Changes default Skin used upon StyleManager initialization.
static Skin	setSkin(Class<? extends Skin> skin, Object... arguments) Applies Skin of the specified Class to all Styleable components.
static Skin	setSkin(JComponent component, Skin skin) Applies specified custom skin to the skinnable component and all of its children linked via StyleId.
static Skin	setSkin(JComponent component, Skin skin, boolean recursively) Applies specified custom skin to the skinnable component and all of its children linked via StyleId.
static Skin	setSkin(LazyInstance<? extends Skin> skin) Applies Skin based on the LazyInstance to all Styleable components.
static Skin	setSkin(Skin skin) Applies specified Skin to all Styleable components.
static Skin	setSkin(String skin, Object... arguments) Applies Skin with the specified Class name to all Styleable components.
static void	setStrictStyleChecks(boolean strict) Sets whether strict style checks are enabled or not.
static StyleId	setStyleId(JComponent component, StyleId id) Sets new component StyleId.
static void	uninstallSkin(JComponent component) Removes skin applied to the specified component and returns it.
static void	unregisterComponentDescriptor(ComponentDescriptor descriptor) Unregisters existing ComponentDescriptor.
static void	updateSkin(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

getDescriptorsCount

public static int getDescriptorsCount()

Returns all registered ComponentDescriptors count.

Returns:

all registered ComponentDescriptors count

getDescriptors

@NotNull
public static List<ComponentDescriptor> getDescriptors()

Returns immutable list of all registered ComponentDescriptors.

Returns:

immutable list of all registered ComponentDescriptors

getDescriptor

@NotNull
public static ComponentDescriptor getDescriptor(@NotNull
                                                         String id)

Returns ComponentDescriptor with the specified identifier.

Parameters:

id - ComponentDescriptor identifier

Returns:

ComponentDescriptor with the specified identifier

getDescriptor

@NotNull
public static ComponentDescriptor getDescriptor(@NotNull
                                                         JComponent component)

Returns ComponentDescriptor for the specified JComponent.

Parameters:

component - JComponent to find ComponentDescriptor for

Returns:

ComponentDescriptor for the specified JComponent

getDescriptor

@NotNull
public static ComponentDescriptor getDescriptor(@NotNull
                                                         Class<? extends JComponent> componentClass)

Returns ComponentDescriptor for the specified JComponent class. This method will also ensure that returned ComponentDescriptor is never null.

Parameters:

componentClass - JComponent class to find ComponentDescriptor for

Returns:

ComponentDescriptor for the specified JComponent class

isSupported

public static boolean isSupported(@NotNull
                                  String id)

Returns whether or not styling is supported for the component with the specified identifier.

Parameters:

id - identifier of the component to check styling support for

Returns:

true if styling is supported for the component with the specified identifier, false otherwise

isSupported

public static boolean isSupported(@NotNull
                                  JComponent component)

Returns whether or not styling of the specified JComponent is supported.

Parameters:

component - component to check styling support for

Returns:

true if styling of the specified JComponent is supported, false otherwise

registerComponentDescriptor

public static void registerComponentDescriptor(@NotNull
                                               ComponentDescriptor descriptor)

Registers new ComponentDescriptor. It will replace any other ComponentDescriptor registered for the same JComponent type. Manager initialization is not required to register ComponentDescriptor.

Parameters:

descriptor - ComponentDescriptor to register

unregisterComponentDescriptor

public static void unregisterComponentDescriptor(@NotNull
                                                 ComponentDescriptor descriptor)

Unregisters existing ComponentDescriptor. Manager initialization is not required to unregister ComponentDescriptor.

Parameters:

descriptor - ComponentDescriptor to register

getDefaultSkin

@NotNull
public static LazyInstance<? extends Skin> getDefaultSkin()

Returns LazyInstance for default Skin.

Returns:

LazyInstance for default Skin

setDefaultSkin

public static void setDefaultSkin(@NotNull
                                  String skin,
                                  @NotNull
                                  Object... arguments)

Changes default Skin used upon StyleManager initialization. StyleManager doesn't need to be initialized to change it.

Parameters:

skin - default Skin class name

arguments - default Skin constructor arguments

setDefaultSkin

public static void setDefaultSkin(@NotNull
                                  Class<? extends Skin> skin,
                                  @NotNull
                                  Object... arguments)

Changes default Skin used upon StyleManager initialization. StyleManager doesn't need to be initialized to change it.

Parameters:

skin - default Skin class

arguments - default Skin constructor arguments

setDefaultSkin

public static void setDefaultSkin(@NotNull
                                  LazyInstance<? extends Skin> skin)

Changes default Skin used upon StyleManager initialization. Manager initialization is not required to change default Skin.

Parameters:

skin - default skin class

getSkin

@NotNull
public static Skin getSkin()

Returns currently applied Skin.

Returns:

currently applied Skin

setSkin

@Nullable
public static Skin setSkin(@NotNull
                                     String skin,
                                     @NotNull
                                     Object... arguments)

Applies Skin with the specified Class name to all Styleable components. That Skin will also be applied to all Styleable components created afterwards.

Parameters:

skin - Skin class name

arguments - Skin constructor arguments

Returns:

previously applied Skin

setSkin

@Nullable
public static Skin setSkin(@NotNull
                                     Class<? extends Skin> skin,
                                     @NotNull
                                     Object... arguments)

Applies Skin of the specified Class to all Styleable components. That Skin will also be applied to all Styleable components created afterwards.

Parameters:

skin - Skin class

arguments - Skin constructor arguments

Returns:

previously applied Skin

setSkin

@Nullable
public static Skin setSkin(@NotNull
                                     LazyInstance<? extends Skin> skin)

Applies Skin based on the LazyInstance to all Styleable components. That Skin will also be applied to all Styleable components created afterwards.

Parameters:

skin - LazyInstance for Skin

Returns:

previously applied Skin

setSkin

@Nullable
public static Skin setSkin(@NotNull
                                     Skin skin)

Applies specified Skin to all Styleable components. That Skin will also be applied to all Styleable components created afterwards. In case specified Skin cannot be applied due to an exception StyleManager will attempt to rollback to previous one.

Parameters:

skin - Skin to apply

Returns:

previously applied Skin

addExtensions

public static void addExtensions(@NotNull
                                 SkinExtension... extensions)

Adds new SkinExtensions which will either be loaded right away if manager is initialized or later on if its not. Manager initialization is not required to provide additional SkinExtensions.

Parameters:

extensions - SkinExtensions to add

getExtensions

@NotNull
public static List<SkinExtension> getExtensions()

Returns list of installed SkinExtensions.

Returns:

list of installed SkinExtensions

getStyleId

@NotNull
public static StyleId getStyleId(@NotNull
                                          JComponent component)

Returns component StyleId.

Parameters:

component - component to retrieve StyleId for

Returns:

component StyleId

setStyleId

@NotNull
public static StyleId setStyleId(@NotNull
                                          JComponent component,
                                          @NotNull
                                          StyleId id)

Sets new component StyleId.

Parameters:

component - component to set StyleId for

id - new StyleId

Returns:

previously used StyleId

resetStyleId

@NotNull
public static StyleId resetStyleId(@NotNull
                                            JComponent component)

Resets StyleId to default value.

Parameters:

component - component to reset StyleId for

Returns:

previously used StyleId

installSkin

public static void installSkin(@NotNull
                               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

updateSkin

public static void updateSkin(@NotNull
                              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 void uninstallSkin(@NotNull
                                 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

getSkin

public static Skin getSkin(@NotNull
                           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

@Nullable
public static Skin setSkin(@NotNull
                                     JComponent component,
                                     @NotNull
                                     Skin skin)

Applies specified custom 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

@Nullable
public static Skin setSkin(@NotNull
                                     JComponent component,
                                     @NotNull
                                     Skin skin,
                                     boolean recursively)

Applies specified custom 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

resetSkin

@Nullable
public static Skin resetSkin(@NotNull
                                       JComponent component)

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

Parameters:

component - component to reset skin for

Returns:

skin applied to the specified component after reset

addStyleListener

public static void addStyleListener(@NotNull
                                    JComponent component,
                                    @NotNull
                                    StyleListener listener)

Adds StyleListener.

Parameters:

component - JComponent to add listener for

listener - StyleListener

removeStyleListener

public static void removeStyleListener(@NotNull
                                       JComponent component,
                                       @NotNull
                                       StyleListener listener)

Removes StyleListener.

Parameters:

component - JComponent to remove listener for

listener - StyleListener

getCustomPainter

@Nullable
public static Painter getCustomPainter(@NotNull
                                                 JComponent component)

Returns custom Painter used for the specified JComponent.

Parameters:

component - JComponent to retrieve custom Painter for

Returns:

custom Painter used for the specified JComponent

setCustomPainter

@Nullable
public static Painter setCustomPainter(@NotNull
                                                 JComponent component,
                                                 @NotNull
                                                 Painter painter)

Sets custom Painter for the specified JComponent.

Parameters:

component - JComponent to change custom Painter for

painter - custom Painter

Returns:

custom Painter previously used for the specified JComponent

resetCustomPainter

public static boolean resetCustomPainter(@NotNull
                                         JComponent component)

Resets custom Painter for the specified JComponent to default one.

Parameters:

component - JComponent to reset custom Painter for

Returns:

true if custom Painter was successfully resetted, false otherwise

getData

@NotNull
protected static StyleData getData(@NotNull
                                            JComponent component)

Returns component style data.

Parameters:

component - component to retrieve style data for

Returns:

component style data

addSkinListener

public static void addSkinListener(@NotNull
                                   SkinListener listener)

Adds skin change listener.

Parameters:

listener - skin change listener to add

removeSkinListener

public static void removeSkinListener(@NotNull
                                      SkinListener listener)

Removes skin change listener.

Parameters:

listener - skin change listener to remove

fireSkinChanged

public static void fireSkinChanged(@Nullable
                                   Skin previous,
                                   @NotNull
                                   Skin current)

Informs listeners about skin change.

Parameters:

previous - previously used skin

current - currently used skin