Class FlatStylingSupport

java.lang.Object

com.formdev.flatlaf.ui.FlatStylingSupport

public class FlatStylingSupport
extends Object

Support for styling components in CSS syntax.

Since:

2

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static @interface	FlatStylingSupport.Styleable	Indicates that a field is intended to be used by FlatLaf styling support.
static @interface	FlatStylingSupport.StyleableField	Indicates that a field in the specified (super) class is intended to be used by FlatLaf styling support.
static @interface	FlatStylingSupport.StyleableFields	Container annotation for FlatStylingSupport.StyleableField.
static interface	FlatStylingSupport.StyleableLookupProvider
static interface	FlatStylingSupport.StyleableObject	An object that implements this interface is intended to support FlatLaf styling.
static interface	FlatStylingSupport.StyleableUI
static class	FlatStylingSupport.UnknownStyleException

Constructor Summary

Constructors

Constructor	Description
FlatStylingSupport()

Method Summary

Modifier and Type	Method	Description
static Object	applyToAnnotatedObject(Object obj, String key, Object value)	Applies the given value to an annotated field of the given object.
static Object	applyToAnnotatedObjectOrComponent(Object obj, Object comp, String key, Object value)	Applies the given value to an annotated field of the given object or to a property of the given component.
static void	collectAnnotatedStyleableInfos(Object obj, Map<String,Class<?>> infos)	Search for all fields annotated with FlatStylingSupport.Styleable and add them to the given map.
static void	collectStyleableInfos(Border border, Map<String,Class<?>> infos)
static String	concatStyles(String style1, String style2)	Concatenates two styles in CSS syntax.
static Map<String,Class<?>>	getAnnotatedStyleableInfos(Object obj)	Returns a map of all fields annotated with FlatStylingSupport.Styleable.
static Map<String,Class<?>>	getAnnotatedStyleableInfos(Object obj, Border border)
static Object	getAnnotatedStyleableValue(Object obj, String key)
static Object	getAnnotatedStyleableValue(Object obj, Border border, String key)
static Object	getResolvedStyle(JComponent c, String type)
static Object	getStyle(JComponent c)	Returns the style specified in client property FlatClientProperties.STYLE.
static Object	getStyleClass(JComponent c)	Returns the style class(es) specified in client property FlatClientProperties.STYLE_CLASS.
static Object	getStyleForClasses(Object styleClass, String type)	Returns the styles for the given style class(es) and the given type.
static Object	joinStyles(Object style1, Object style2)	Joins two styles.
static Map<String,Object>	parse(String style)	Parses styles in CSS syntax ("key1: value1; key2: value2; ..."), converts the value strings into binary and returns all key/value pairs as map.
static Map<String,Object>	parseAndApply(Map<String,Object> oldStyleValues, Object style, BiFunction<String,Object,Object> applyProperty)	Parses styles in CSS syntax ("key1: value1; key2: value2; ..."), converts the value strings into binary and invokes the given function to apply the properties.
static void	putAllPrefixKey(Map<String,Class<?>> infos, String keyPrefix, Map<String,Class<?>> infos2)

Methods inherited from class Object

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

Constructor Details

FlatStylingSupport

public FlatStylingSupport()

Method Details

getStyle

public static Object getStyle(JComponent c)

Returns the style specified in client property FlatClientProperties.STYLE.

getStyleClass

public static Object getStyleClass(JComponent c)

Returns the style class(es) specified in client property FlatClientProperties.STYLE_CLASS.

getResolvedStyle

public static Object getResolvedStyle(JComponent c,
 String type)
                               throws IllegalArgumentException

Throws:

IllegalArgumentException

getStyleForClasses

public static Object getStyleForClasses(Object styleClass,
 String type)
                                 throws IllegalArgumentException

Returns the styles for the given style class(es) and the given type.

The style rules must be defined in UI defaults either as strings (in CSS syntax) or as Map<String, Object> (with binary values). The key must be in syntax: [style]type.styleClass, where the type is optional. E.g. in FlatLaf properties file:

[style]Button.primary = borderColor: #08f; background: #08f; foreground: #fff
[style].secondary = borderColor: #0f8; background: #0f8

or in Java code:

UIManager.put( "[style]Button.primary", "borderColor: #08f; background: #08f; foreground: #fff" );
UIManager.put( "[style].secondary", "borderColor: #0f8; background: #0f8" );

The rule "Button.primary" can be applied to buttons only. The rule ".secondary" can be applied to any component.

To have similar behavior as in CSS, this method first gets the rule without type, then the rule with type and concatenates both rules. E.g. invoking this method with parameters styleClass="foo" and type="Button" does following:

return joinStyles(
    UIManager.get( "[style].foo" ),
    UIManager.get( "[style]Button.foo" ) );

Parameters:

styleClass - the style class(es) either as string (single class or multiple classes separated by space characters) or as String[] or List<String> (multiple classes)

type - the type of the component

Returns:

the styles

Throws:

IllegalArgumentException

joinStyles

public static Object joinStyles(Object style1,
 Object style2)
                         throws IllegalArgumentException

Joins two styles. They can be either strings (in CSS syntax) or Map<String, Object> (with binary values).

If both styles are strings, then a joined string is returned. If both styles are maps, then a joined map is returned. If one style is a map and the other style a string, then the string is parsed (using parse(String)) to a map and a joined map is returned.

Parameters:

style1 - first style as string or map, or null

style2 - second style as string or map, or null

Returns:

new joined style

Throws:

IllegalArgumentException

concatStyles

public static String concatStyles(String style1,
 String style2)

Concatenates two styles in CSS syntax.

Parameters:

style1 - first style, or null

style2 - second style, or null

Returns:

concatenation of the two styles separated by a semicolon

parseAndApply

public static Map<String,Object> parseAndApply(Map<String,Object> oldStyleValues,
 Object style,
 BiFunction<String,Object,Object> applyProperty)
                                        throws FlatStylingSupport.UnknownStyleException,
IllegalArgumentException

Parses styles in CSS syntax ("key1: value1; key2: value2; ..."), converts the value strings into binary and invokes the given function to apply the properties.

Parameters:

oldStyleValues - map of old values modified by the previous invocation, or null

style - the style in CSS syntax as string, or a Map, or null

applyProperty - function that is invoked to apply the properties; first parameter is the key, second the binary value; the function must return the old value

Returns:

map of old values modified by the given style, or null

Throws:

FlatStylingSupport.UnknownStyleException - on unknown style keys

IllegalArgumentException - on syntax errors

ClassCastException - if value type does not fit to expected type

parse

public static Map<String,Object> parse(String style)
                                throws IllegalArgumentException

Parses styles in CSS syntax ("key1: value1; key2: value2; ..."), converts the value strings into binary and returns all key/value pairs as map.

Parameters:

style - the style in CSS syntax, or null

Returns:

map of parsed styles, or null

Throws:

IllegalArgumentException - on syntax errors

applyToAnnotatedObject

public static Object applyToAnnotatedObject(Object obj,
 String key,
 Object value)
                                     throws FlatStylingSupport.UnknownStyleException,
IllegalArgumentException

Applies the given value to an annotated field of the given object. The field must be annotated with FlatStylingSupport.Styleable.

Parameters:

obj - the object

key - the name of the field

value - the new value

Returns:

the old value of the field

Throws:

FlatStylingSupport.UnknownStyleException - if object does not have an annotated field with given name

IllegalArgumentException - if value type does not fit to expected type

applyToAnnotatedObjectOrComponent

public static Object applyToAnnotatedObjectOrComponent(Object obj,
 Object comp,
 String key,
 Object value)
                                                throws FlatStylingSupport.UnknownStyleException,
IllegalArgumentException

Applies the given value to an annotated field of the given object or to a property of the given component. The field must be annotated with FlatStylingSupport.Styleable. The component property must have public getter and setter methods.

Parameters:

obj - the object

comp - the component, or null

key - the name of the field

value - the new value

Returns:

the old value of the field

Throws:

FlatStylingSupport.UnknownStyleException - if object does not have an annotated field with given name

IllegalArgumentException - if value type does not fit to expected type

getAnnotatedStyleableInfos

public static Map<String,Class<?>> getAnnotatedStyleableInfos(Object obj)
                                                       throws IllegalArgumentException

Returns a map of all fields annotated with FlatStylingSupport.Styleable. The key is the name of the field and the value the type of the field.

Throws:

IllegalArgumentException

getAnnotatedStyleableInfos

public static Map<String,Class<?>> getAnnotatedStyleableInfos(Object obj,
 Border border)
                                                       throws IllegalArgumentException

Throws:

IllegalArgumentException

collectAnnotatedStyleableInfos

public static void collectAnnotatedStyleableInfos(Object obj,
 Map<String,Class<?>> infos)
                                           throws IllegalArgumentException

Search for all fields annotated with FlatStylingSupport.Styleable and add them to the given map. The key is the name of the field and the value the type of the field.

Throws:

IllegalArgumentException

collectStyleableInfos

public static void collectStyleableInfos(Border border,
 Map<String,Class<?>> infos)

putAllPrefixKey

public static void putAllPrefixKey(Map<String,Class<?>> infos,
 String keyPrefix,
 Map<String,Class<?>> infos2)

getAnnotatedStyleableValue

public static Object getAnnotatedStyleableValue(Object obj,
 String key)
                                         throws IllegalArgumentException

Throws:

IllegalArgumentException

getAnnotatedStyleableValue

public static Object getAnnotatedStyleableValue(Object obj,
 Border border,
 String key)