Package swingtree.api

@NullMarked package swingtree.api

The core API for SwingTree containing interfaces and classes for building, configuring, styling, and rendering Swing components in a declarative manner. This includes builders, configurators, painters, and various utility interfaces for customizing component appearance and behavior.

Related Packages

Package	Description
swingtree	This is he root package for the SwingTree library, a Swing based UI framework for creating boilerplate free and composition based Swing UIs fluently.
swingtree.api.laf
swingtree.api.model
swingtree.api.mvvm

Class	Description
AnimatedItemStyler<T,C extends JComponent>	An AnimatedItemStyler is conceptually a union of the ItemStyler and AnimatedStyler functions, which is to say that it takes the current item of a bound Val property, an AnimationStatus and a ComponentStyleDelegate to produce a new ComponentStyleDelegate with some style properties applied to it (usually based on both the item and the animation progress).
AnimatedStyler<C extends JComponent>	An AnimatedStyler is conceptually a union of the Animation and Styler functions, which is to say that it takes both an AnimationStatus and a ComponentStyleDelegate to produce a new ComponentStyleDelegate with some style properties applied to it (usually based on the AnimationStatus).
Buildable<T>	A generic interface for builder objects which is used by the SwingTree API to call the build methods of the builder objects for you and then use the built object as part of a SwingTree UI.
Configurator<T>	A configurator is a functional interface that takes a configuration object and returns a transformed configuration object.
FloatFunction	Used by NoiseFunction.andThen(FloatFunction) to apply a scalar function to the result of a noise function or to the input of a noise function using NoiseFunction.compose(FloatFunction).
IconDeclaration	Primarily designed to be implemented by an Enum type that declares a set of icon paths so that the enum instances can be used to identify and load (cached) icons across your application.
IconDeclaration.SourceFormat	Defines the format of the source string returned by IconDeclaration.source().
ItemStyler<T,C extends JComponent>	An ItemStyler is conceptually a union of a property observer and the Styler function, which is to say that it takes both the current item of a bound Val property and a ComponentStyleDelegate to produce a new ComponentStyleDelegate with some style properties applied to it (usually based on the supplied item).
Layout	An abstract representation of an immutable layout configuration for a specific component, for which layout manager specific implementations can be instantiated through various factory methods like Layout.border(), Layout.flow(), Layout.grid(int, int)...
Layout.BorderLayoutInstaller	The Layout.BorderLayoutInstaller layout is a layout that represents a BorderLayout layout configuration for a component, which consists of the horizontal gap and vertical gap.
Layout.ForBoxLayout	The Layout.ForBoxLayout layout is a layout that represents a BoxLayout layout configuration for a component, which consists of the axis.
Layout.ForFlowLayout	An immutable Layout implementation that configures and installs a ResponsiveGridFlowLayout onto a component.
Layout.ForMigLayout	An immutable Layout implementation that configures and installs a MigLayout onto a component.
Layout.GridLayoutInstaller	The Layout.GridLayoutInstaller layout is a layout that represents a GridLayout layout configuration for a component, which consists of the number of rows, number of columns, horizontal gap and vertical gap.
Layout.None	The Layout.None layout removes any existing LayoutManager from a component (sets it to null), enabling fully manual positioning of child components via Component.setBounds(int, int, int, int).
Layout.Unspecific	The Layout.Unspecific layout is a layout that represents the lack of a specific layout being set for a component.
ListEntryDelegate<E,L extends JList<E>>	A context object providing JList entry specific context information for the functional ListEntryRenderer interface, which is used to render list entries.
ListEntryRenderer<E,L extends JList<E>>	A functional interface allowing you to define how a JList entry should be rendered in a declarative manner through method UIForList.withRenderComponent(ListEntryRenderer).
MenuBuilder<M extends JMenuItem>	If you are using builders for your custom Swing components, implement this to allow the UI builder to call the MenuBuilder.build() method for you!
NoiseFunction	A noise function is used to render NoiseConf styles by taking a float based coordinate and returning a gradient value between 0 and 1.
Painter	A functional interface for doing custom painting on a component using the Graphics2D API.
Peeker<C>	Applies an action to the current component typically as part of UIForAnySwing through method UIForAnything.peek(Peeker) with the purpose of expose the underlying component to the user while preserving a declarative method chaining based builder API usage pattern.
ScrollIncrementSupplier	A supplier of scrollable increments for a JScrollPane.
ShadowFractionsSupplier	A shadow fractions supplier is used to render ShadowConf styles by supplying the shape of a shadow's "falloff curve", that is to say, the way in which the shadow color fades from its full strength into full transparency across the blur region.
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)).
SwingBuilder<C extends JComponent>	If you are using builders for your custom Swing components, implement this to allow the UI builder to call the SwingBuilder.build() method for you!
UIVerifier<C extends JComponent>	A functional interface for doing swing component validity verification.