Package swingtree.api
@NullMarked
package swingtree.api
-
ClassDescriptionAnimatedStyler<C extends JComponent>An
AnimatedStyler
is conceptually a union of theAnimation
andStyler
functions, which is to say that it takes both anAnimationState
and aComponentStyleDelegate
to produce a newComponentStyleDelegate
with some style properties applied to it (usually based on theAnimationState
).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.Used byNoiseFunction.andThen(FloatFunction)
to apply a scalar function to the result of a noise function or to the input of a noise function usingNoiseFunction.compose(FloatFunction)
.Primarily designed to be implemented by anEnum
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.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 likeLayout.border()
,Layout.flow()
,Layout.grid(int, int)
...TheLayout.BorderLayoutInstaller
layout is a layout that represents aBorderLayout
layout configuration for a component, which consists of the horizontal gap and vertical gap.TheLayout.ForBoxLayout
layout is a layout that represents aBoxLayout
layout configuration for a component, which consists of the axis.TheLayout.ForFlowLayout
layout is a layout that represents aFlowLayout
layout configuration for a component.TheLayout.ForMigLayout
layout is a layout that represents aMigLayout
layout configuration for a component.TheLayout.GridLayoutInstaller
layout is a layout that represents aGridLayout
layout configuration for a component, which consists of the number of rows, number of columns, horizontal gap and vertical gap.TheLayout.None
layout is a layout that represents the absence of aLayoutManager
for a component.TheLayout.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 providingJList
entry specific context information for the functionalListEntryRenderer
interface, which is used to render list entries.ListEntryRenderer<E,L extends JList<E>> A functional interface allowing you to define how aJList
entry should be rendered in a declarative manner through methodUIForList.withRenderComponent(ListEntryRenderer)
.MenuBuilder<M extends JMenuItem>If you are using builders for your custom Swing components, implement this to allow theUI
builder to call theMenuBuilder.build()
method for you!A noise function is used to renderNoiseConf
styles by taking a float based coordinate and returning a gradient value between 0 and 1.A functional interface for doing custom painting on a component using theGraphics2D
API.Peeker<C>Applies an action to the current component typically as part ofUIForAnySwing
through methodUIForAnything.peek(Peeker)
with the purpose of expose the underlying component to the user while preserving a declarative method chaining based builder API usage pattern.Styler<C extends JComponent>AStyler
is a function that takes aComponentStyleDelegate
and then transforms and returns it with some new style properties (seeUIForAnySwing.withStyle(Styler)
).SwingBuilder<C extends JComponent>If you are using builders for your custom Swing components, implement this to allow theUI
builder to call theSwingBuilder.build()
method for you!UIVerifier<C extends JComponent>A functional interface for doing swing component validity verification.