Package swingtree.api

Interface Styler<C extends JComponent>

Type Parameters:

C - the type of the JComponent that the ComponentStyleDelegate is delegating to.

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface Styler<C extends JComponent>

A Styler is a function that takes a ComponentStyleDelegate and then transforms and returns it with some new style properties (see UIForAnySwing.withStyle(Styler)).
Note that all of this is done in a functional manner, so the original ComponentStyleDelegate as well as the delegated StyleConf object is not modified because ComponentStyleDelegate is an immutable object.
This design makes the underlying style engine of SwingTree very flexible and scalable because it allows for the composition of styles and reuse of style logic across many components (see StyleSheet for more advanced usage).

Method Summary

Modifier and Type	Method	Description
default Styler<C>	andThen(Styler<C> other)	Returns a new Styler that applies the style of this Styler and then applies the style of the given Styler.
static <C extends JComponent> Styler<C>	none()	A Styler that does nothing, meaning it simply returns the given ComponentStyleDelegate without applying any style to it.
ComponentStyleDelegate<C>	style(ComponentStyleDelegate<C> delegate)	Applies some style to the given ComponentStyleDelegate and returns a new ComponentStyleDelegate that has the style applied (if any).

Method Details

none

static <C extends JComponent> Styler<C> none()

A Styler that does nothing, meaning it simply returns the given ComponentStyleDelegate without applying any style to it.

Type Parameters:

C - The type of the JComponent that the ComponentStyleDelegate is delegating to.

Returns:

A Styler that does nothing.

style

ComponentStyleDelegate<C> style(ComponentStyleDelegate<C> delegate)
                         throws Exception

Applies some style to the given ComponentStyleDelegate and returns a new ComponentStyleDelegate that has the style applied (if any).
Note that this method deliberately requires the handling of checked exceptions at its invocation sites because there may be any number of implementations hiding behind this interface and so it is unwise to assume that all of them will be able to execute gracefully without throwing exceptions.

Parameters:

delegate - The ComponentStyleDelegate to apply the style to.

Returns:

A new ComponentStyleDelegate that has the style applied.

Throws:

Exception - if the style could not be applied by the client code.

andThen

default Styler<C> andThen(Styler<C> other)

Returns a new Styler that applies the style of this Styler and then applies the style of the given Styler.
This method is conceptually equivalent to the Function.andThen(java.util.function.Function).

Parameters:

other - the Styler to apply after this Styler.

Returns:

a new Styler that applies the style of this Styler and then applies the style of the given Styler.