Package swingtree

@NullMarked package 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.
You will find most of what you need for declaring rich graphical user interface, more specifically the UI class, which serves as a namespace for factory methods.

Related Packages

Package	Description
swingtree.animation
swingtree.api
swingtree.components
swingtree.dialogs
swingtree.input
swingtree.layout
swingtree.style
swingtree.threading

Class	Description
AbstractDelegate<C extends JComponent>	Extensions of this class delegate a component as well as provide useful methods for trying the tree of the components in which the delegated component is contained.
AbstractTextComponentDelegate	A delegate object for text event listeners served by the numerous TextComponent types.
CellBuilder<C extends JComponent,E>	A builder type for creating cell renderer for a list, combo box or table using a fluent API, typically through methods like UIForList.withCells(Configurator), UIForCombo.withCells(Configurator) or UIForTable.withCells(Configurator), where the builder is exposed to the configurator lambda.
CellConf<C extends JComponent,V>	This class models the state of an individual table/tree/list/drop down cell alongside various properties that a cell should have, like for example the value of the cell, its position within the component as well as a CellConf.view() (renderer/editor) in the form of an AWT Component which may or may not be replaced or modified.
ComponentDelegate<C extends JComponent,E>	Instances of this are delegates for a specific components and events that are passed to user event action handlers (see Action), with the purpose of providing useful context information to the action handler.
ComponentDragEventDelegate<C extends JComponent>	A JComponent and MouseEvent delegate providing useful context information to various Action listeners used by UIForAnySwing.onMouseDrag(Action) like for example the ComponentMouseEventDelegate.mouseX() and ComponentMouseEventDelegate.mouseY() of the event as well as more drag specific information like ComponentDragEventDelegate.dragEvents() and ComponentDragEventDelegate.dragPositions().
ComponentMouseEventDelegate<C extends JComponent>	A JComponent as well as MouseEvent delegate providing useful context information to various Action listeners which are typically registered through UIForAnySwing.onMouseClick(sprouts.Action)}, UIForAnySwing.onMousePress(sprouts.Action) and UIForAnySwing.onMouseRelease(sprouts.Action), among others.
DragAwayComponentConf<C extends JComponent>	A value based builder object for configuring drag away events of a component using the UIForAnySwing.withDragAway(Configurator) method, where an instance of this class is passed to the Configurator lambda defining how the component should behave and look when dragged away.
DragDropComponentConf<C extends JComponent>	A value based builder object for configuring drop target events for a component using the UIForAnySwing.withDropSite(Configurator) method, where an instance of this class is passed to the Configurator lambda defining how the component should behave and look when something is dragged and dropped on top of it.
OptionalUI<C extends Component>	A container object for AWT Component types which may or may not contain a non-null value.
RenderAs<C extends JComponent,E,T extends E>	This class models the API of the CellBuilder which allows you to specify how a cell should be rendered.
ScrollableComponentDelegate	This class is an immutable builder which defines the Scrollable behavior of a component within a JScrollPane.
SplitButtonDelegate<I extends JMenuItem>	This class is a delegate for events of the JSplitButton component.
SplitItem<I extends JMenuItem>	An immutable data carrier exposing everything needed to configure an item of a JSplitButton.
SplitItemDelegate<I extends JMenuItem>	Instances of this are delegated to the individual JSplitButton items and their ActionEvents exposed to you inside your Action handlers, like for example one you would supply to SplitItem.onSelection(Action).
SwingTree	A SwingTree is a singleton that holds global configuration context for the SwingTree library.
SwingTreeConfigurator	A functional interface for configuring a SwingTree instance through SwingTree.initialiseUsing(SwingTreeConfigurator).
SwingTreeInitConfig	An immutable configuration object for the SwingTree library, which can be configured using a functional SwingTreeConfigurator lambda passed to SwingTree.initialiseUsing(SwingTreeConfigurator).
SwingTreeInitConfig.FontInstallation	Defines how the Font, specified through SwingTreeInitConfig.defaultFont(Font), is installed in the UIManager.
SwingTreeInitConfig.Scaling	Defines how the scaling factor for the UI should be determined.
Tab	An immutable data carrier exposing everything needed to configure a tab of a JTabbedPane.
TabDelegate	A JTabbedPane delegate providing useful context information to various Action listeners used by UIForTabbedPane.onTabMouseClick(Action), UIForTabbedPane.onTabMousePress(Action) and UIForTabbedPane.onTabMouseRelease(Action), for example.
TextInsertDelegate	A delegate object for the Action lambda passed to the UIForAnyTextComponent.onTextInsert(Action) method, which is used to register a listener for text insertion events.
TextRemoveDelegate	A delegate object for the Action lambda passed to the UIForAnyTextComponent.onTextRemove(Action) method, which is used to register a listener for text removal events.
TextReplaceDelegate	A delegate object for the Action lambda passed to the UIForAnyTextComponent.onTextReplace(Action) method, which is used to register a listener for text replacement events.
UI	This class is a static API for exposing swing tree builder types for wrapping and assembling various JComponent types to form a UI tree.
UI.Active	A general purpose enum describing if something is never, always or sometimes active.
UI.Align	Vertical or horizontal alignment.
UI.Alignment	The logical combination of a vertical and horizontal alignment.
UI.Axis	Used to define how a layout manager (typically the BoxLayout) will lay out components along the given axis.
UI.Box	{inheritDoc}
UI.Button	{inheritDoc}
UI.CheckBox	{inheritDoc}
UI.CheckBoxMenuItem	{inheritDoc}
UI.Color	This Color class is a refined and more complete/modernized implementation of the Color class which models colors in the default sRGB color space or colors in arbitrary color spaces identified by a ColorSpace.
UI.ComboBox<E>	{inheritDoc}
UI.Component	{inheritDoc}
UI.ComponentArea	Defines the areas of a component, which is used to by the ImageConf to determine if and how an image should be clipped.
UI.ComponentBoundary	Enum representing the different boundaries of a UI component.
UI.ComponentOrientation	Use this to specify the orientation of a component.
UI.Corner	Use this in the style API (see UIForAnySwing.withStyle(Styler)) to target specific corners of a JComponent and apply custom StyleConf properties to them.
UI.Cursor	An enum set of all the available swing cursors which map to the cursor type id.
UI.Cycle	Used to specify the cycle method for a gradient conf in the style API.
UI.DragAction	This enum contains constant values representing the type of action(s) to be performed by a Drag and Drop operation.
UI.Edge	Use this to target specific edges of a JComponent and apply custom StyleConf properties to them.
UI.EditorPane	{inheritDoc}
UI.FitComponent	This enum is used to specify how an image or icon (usually a SvgIcon) should be scaled to fit the dimensions of the component that it is being rendered into, like for example through the SvgIcon.paintIcon(java.awt.Component, Graphics, int, int) method.
UI.Font	This class represents a SwingTree font and is used to specify the font of a component.
UI.FontStyle	Use this to specify the font style of a component.
UI.FormattedTextField
UI.GradientType	Use these enum instances to specify the gradient type for various sub styles, like for example the gradient style API exposed by ComponentStyleDelegate.gradient(swingtree.UI.Layer, String, Configurator) or ComponentStyleDelegate.gradient(Configurator) methods (see UIForAnySwing.withStyle(Styler)).
UI.HorizontalAlignment	Different positions along a horizontally aligned UI component.
UI.Label	{inheritDoc}
UI.Layer	Instances of this enum are used to configure onto which layer a particular style configuration should be applied.
UI.ListData	Defines whether the list based data model of a JTable is row or column major and whether it is editable or not.
UI.ListView<E>	{inheritDoc}
UI.LookAndFeel	Set of enum instances defining common types of Swing look and feels.
UI.MapData	Defines whether the data model of a JTable should be editable or not.
UI.Menu	{inheritDoc}
UI.MenuBar	{inheritDoc}
UI.MenuItem	{inheritDoc}
UI.NoiseType	Defines the different types of noise functions that can be used to render a NoiseConf style.
UI.OnWindowClose	Defines a set of close operations for a JDialog or JFrame windows.
UI.OverflowPolicy	Overflow policy of UI components.
UI.Panel	{inheritDoc}
UI.PasswordField	{inheritDoc}
UI.Placement	Use this to specify the placement of an image as part of the ImageConf through the ImageConf.placement(swingtree.UI.Placement) method exposed by the style API (see UIForAnySwing.withStyle(Styler)).
UI.PopupMenu	{inheritDoc}
UI.ProgressBar	{inheritDoc}
UI.RadioButton	{inheritDoc}
UI.RadioButtonMenuItem	{inheritDoc}
UI.ScrollPane	{inheritDoc}
UI.Separator	{inheritDoc}
UI.Side	All UI components are at their core rectangular, meaning they always have exactly 4 uniquely identifiable sides.
UI.Slider	{inheritDoc}
UI.Span	Use these enum instances to specify the gradient alignment for various sub styles, like for example the gradient style API exposed by ComponentStyleDelegate.gradient(Configurator) or ComponentStyleDelegate.gradient(Configurator) methods (see UIForAnySwing.withStyle(Styler)).
UI.Spinner	{inheritDoc}
UI.SplitButton
UI.SplitPane	{inheritDoc}
UI.TabbedPane	{inheritDoc}
UI.Table	{inheritDoc}
UI.TableHeader	{inheritDoc}
UI.TextArea	{inheritDoc}
UI.TextField	{inheritDoc}
UI.TextPane	{inheritDoc}
UI.ToggleButton	{inheritDoc}
UI.ToolBar	{inheritDoc}
UI.ToolTip	{inheritDoc}
UI.Tree	{inheritDoc}
UI.VerticalAlignment	Different positions along a vertically aligned UI component.
UIEnum<E extends Enum<E>>	A set of extension methods for various SwingTree enums.
UIFactoryMethods	A namespace for useful factory methods like UIFactoryMethods.color(String) and UIFactoryMethods.font(String), and layout constants (see UILayoutConstants).
UIForAnyButton<I,B extends AbstractButton>	The following is a more specialized type of builder node based on the UIForAnySwing builder type, and provides additional features associated with the more specialized AbstractButton" Swing component type.
UIForAnyEditorPane<I,C extends JEditorPane>
UIForAnyMenuItem<I,M extends JMenuItem>	A builder for JMenuItems.
UIForAnyScrollPane<I,P extends JScrollPane>	Defines an abstract builder for constructing a scroll pane or any subclass of JScrollPane.
UIForAnySwing<I,C extends JComponent>	A generic SwingTree builder node designed as a basis for configuring any kind of JComponent instance.
UIForAnyTextComponent<I,C extends JTextComponent>	A SwingTree builder designed for configuring various kinds of JTextComponent instances in a fluent and declarative way.
UIForAnything<I,C extends E,E extends Component>	This is the root builder type for all other SwingTree builder subtypes.
UIForAnyToggleButton<I,B extends JToggleButton>	An abstract precursor for swing tree builder nodes for JToggleButton instances.
UIForAnyWindow<I extends UIForAnyWindow<I,W>,W extends Window>	A SwingTree builder node for configuring any kind of Window type.
UIForBox<B extends JBox>	A SwingTree builder node designed for configuring JBox instances.
UIForButton<B extends AbstractButton>	A SwingTree builder node designed for configuring AbstractButton sub-type instances, usually the JButton type.
UIForCheckBox<B extends JCheckBox>	A SwingTree builder node designed for configuring JCheckBox instances.
UIForCheckBoxMenuItem<M extends JCheckBoxMenuItem>
UIForCombo<E,C extends JComboBox<E>>	A SwingTree builder node designed for configuring JComboBox instances.
UIForEditorPane<P extends JEditorPane>	A SwingTree builder node designed for configuring JEditorPane instances.
UIForFormattedTextField
UIForIcon<I extends JIcon>	A UIForAnySwing subclass specifically designed for adding icons to your SwingTree.
UIForJDialog<D extends JDialog>
UIForJFrame<F extends JFrame>	A declarative builder for JFrame components.
UIForLabel<L extends JLabel>	A SwingTree builder node designed for configuring JLabel instances.
UIForList<E,L extends JList<E>>	A SwingTree builder node designed for configuring JList instances.
UIForMenu<M extends JMenu>	A SwingTree builder node designed for configuring JMenu instances.
UIForMenuItem<M extends JMenuItem>	A SwingTree builder node designed for configuring JMenuItem instances.
UIForPanel<P extends JPanel>	A SwingTree builder node designed for configuring JPanel instances.
UIForPasswordField<F extends JPasswordField>	A SwingTree builder node designed for configuring JPasswordField instances.
UIForPopup<P extends JPopupMenu>	A SwingTree builder node designed for configuring JPopupMenu instances.
UIForProgressBar<P extends JProgressBar>	A SwingTree builder node designed for configuring JProgressBar instances.
UIForRadioButton<R extends JRadioButton>	A SwingTree builder node designed for configuring JRadioButton instances.
UIForRadioButtonMenuItem<M extends JRadioButtonMenuItem>	A SwingTree builder node designed for configuring JRadioButtonMenuItem instances.
UIForScrollPane<P extends JScrollPane>	A SwingTree builder node designed for configuring JScrollPane instances.
UIForScrollPanels<P extends JScrollPanels>	A builder node for JScrollPanels, a custom SwingTree component, which is similar to a JList but with the ability to interact with the individual components in the list.
UIForSeparator<S extends JSeparator>	A SwingTree builder node designed for configuring JSeparator instances.
UIForSlider<S extends JSlider>	A SwingTree builder node designed for configuring JSlider instances.
UIForSpinner<S extends JSpinner>	A SwingTree builder node designed for configuring JSpinner instances.
UIForSplitButton<B extends JSplitButton>	A SwingTree builder node designed for configuring JSplitButton instances.
UIForSplitPane<P extends JSplitPane>	A SwingTree builder node designed for configuring JSplitPane instances.
UIForSwing<C extends JComponent>	A SwingTree builder node designed for configuring JComponent types.
UIForTabbedPane<P extends JTabbedPane>	A SwingTree builder node designed for configuring JTabbedPane instances.
UIForTable<T extends JTable>	A SwingTree declarative builder designed for configuring JTable instances allowing for a fluent API to build tables in a declarative way.
UIForTableHeader<H extends UI.TableHeader>	A declarative builder node for the UI.TableHeader component.
UIForTextArea<A extends JTextArea>	A SwingTree builder node designed for configuring JTextArea instances.
UIForTextField<F extends JTextField>	A SwingTree builder node designed for configuring JTextField instances.
UIForTextPane<P extends JTextPane>	A declarative SwingTree builder designed for configuring UIForTextPane instances.
UIForToggleButton<B extends JToggleButton>	A SwingTree builder node designed for configuring JToggleButton instances.
UIForToolBar<T extends JToolBar>
UILayoutConstants	Essentially just a namespace for static layout constants for the MigLayout LayoutManager type.
WindowDelegate<W extends Window,E>	A delegate for any kind of Swing window, usually a JFrame or a JDialog, which is passed to the event handlers in the SwingTree API.